SCRIPTING API / Characters and gameplay / FirstPersonCamera

FirstPersonCamera

Script access to an entity's First Person Camera rig settings.

Kindclass

NamespaceKroys.EngineScripting

Members13

SourceGenerated/NativeComponents.g.cs, NativeComponents.cs

DECLARATION

Declaration

Component access: every member takes the entity first, for example FirstPersonCamera.Has(Entity). The values are the ones the Inspector shows for this component.

Declaration

public static partial class FirstPersonCamera

REFERENCE

Members

Methods

#public static bool Has(Entity e)

Whether the entity has a First Person Camera component.

methodstatic

#public static bool IsEnabled(Entity e)

Reads the First Person Camera component's Enabled value of the entity.

methodstatic

#public static void SetEnabled(Entity e, bool value)

Sets the First Person Camera component's Enabled value on the entity.

methodstatic

#public static float GetMouseSensitivity(Entity e)

Reads the First Person Camera component's Mouse Sensitivity value of the entity.

methodstatic

#public static void SetMouseSensitivity(Entity e, float value)

Sets the First Person Camera component's Mouse Sensitivity value on the entity.

methodstatic

#public static float GetEyeHeight(Entity e)

Reads the First Person Camera component's Eye Height value of the entity.

methodstatic

#public static void SetEyeHeight(Entity e, float value)

Sets the First Person Camera component's Eye Height value on the entity.

methodstatic

#public static float GetMinPitch(Entity e)

Reads the First Person Camera component's Min Pitch value of the entity.

methodstatic

#public static void SetMinPitch(Entity e, float value)

Sets the First Person Camera component's Min Pitch value on the entity.

methodstatic

#public static float GetMaxPitch(Entity e)

Reads the First Person Camera component's Max Pitch value of the entity.

methodstatic

#public static void SetMaxPitch(Entity e, float value)

Sets the First Person Camera component's Max Pitch value on the entity.

methodstatic

#public static bool RequiresRightMouse(Entity e)

Reads the First Person Camera component's Right Mouse value of the entity.

methodstatic

#public static void SetRequireRightMouse(Entity e, bool value)

Sets the First Person Camera component's Require Right Mouse value on the entity.

methodstatic

Signatures

public static bool Has(Entity e)
public static bool IsEnabled(Entity e)
public static void SetEnabled(Entity e, bool value)
public static float GetMouseSensitivity(Entity e)
public static void SetMouseSensitivity(Entity e, float value)
public static float GetEyeHeight(Entity e)
public static void SetEyeHeight(Entity e, float value)
public static float GetMinPitch(Entity e)
public static void SetMinPitch(Entity e, float value)
public static float GetMaxPitch(Entity e)
public static void SetMaxPitch(Entity e, float value)
public static bool RequiresRightMouse(Entity e)
public static void SetRequireRightMouse(Entity e, bool value)

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.