SCRIPTING API / Characters and gameplay / ThirdPersonCamera

ThirdPersonCamera

Script access to an entity's Third Person Camera rig: distance, offsets, collision and smoothing.

Kindclass

NamespaceKroys.EngineScripting

Members47

SourceGenerated/NativeComponents.g.cs, NativeComponents.cs

DECLARATION

Declaration

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

Declaration

public static partial class ThirdPersonCamera

REFERENCE

Members

Methods

#public static bool Has(Entity e)

Whether the entity has a Third Person Camera component.

methodstatic

#public static bool IsEnabled(Entity e)

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

methodstatic

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

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

methodstatic

#public static Entity GetTarget(Entity e)

Reads the Third Person Camera component's Target value of the entity.

methodstatic

#public static void SetTarget(Entity e, Entity target)

Sets the Third Person Camera component's Target value on the entity.

methodstatic

#public static float GetDistance(Entity e)

Reads the Third Person Camera component's Distance value of the entity.

methodstatic

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

Sets the Third Person Camera component's Distance value on the entity.

methodstatic

#public static float GetHeight(Entity e)

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

methodstatic

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

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

methodstatic

#public static float GetMouseSensitivity(Entity e)

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

methodstatic

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

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

methodstatic

#public static float GetCollisionRadius(Entity e)

Reads the Third Person Camera component's Collision Radius value of the entity.

methodstatic

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

Sets the Third Person Camera component's Collision Radius value on the entity.

methodstatic

#public static float GetPitch(Entity e)

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

methodstatic

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

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

methodstatic

#public static float GetMinPitch(Entity e)

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

methodstatic

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

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

methodstatic

#public static float GetMaxPitch(Entity e)

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

methodstatic

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

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

methodstatic

#public static float GetShoulderOffset(Entity e)

Camera-right translation in world units, included in camera collision.

methodstatic

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

Sets the Third Person Camera component's Shoulder Offset value on the entity.

methodstatic

#public static bool IsCrosshairShown(Entity e)

Reads the Third Person Camera component's Crosshair Shown value of the entity.

methodstatic

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

Sets the Third Person Camera component's Crosshair Shown value on the entity.

methodstatic

#public static float GetCrosshairOffsetX(Entity e)

Reads the Third Person Camera component's Crosshair Offset X value of the entity.

methodstatic

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

Sets the Third Person Camera component's Crosshair Offset X value on the entity.

methodstatic

#public static float GetCrosshairOffsetY(Entity e)

Reads the Third Person Camera component's Crosshair Offset Y value of the entity.

methodstatic

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

Sets the Third Person Camera component's Crosshair Offset Y value on the entity.

methodstatic

#public static bool RequiresRightMouse(Entity e)

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

methodstatic

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

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

methodstatic

#public static bool GetDriveAimTarget(Entity e)

Reads the Third Person Camera component's Drive Aim Target value of the entity.

methodstatic

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

Sets the Third Person Camera component's Drive Aim Target value on the entity.

methodstatic

#public static Entity GetAimTarget(Entity e)

Reads the Third Person Camera component's Aim Target value of the entity.

methodstatic

#public static void SetAimTarget(Entity e, Entity value)

Sets the Third Person Camera component's Aim Target value on the entity.

methodstatic

#public static float GetAimDefaultDistance(Entity e)

Reads the Third Person Camera component's Aim Default Distance value of the entity.

methodstatic

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

Sets the Third Person Camera component's Aim Default Distance value on the entity.

methodstatic

#public static float GetAimMaxDistance(Entity e)

Reads the Third Person Camera component's Aim Max Distance value of the entity.

methodstatic

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

Sets the Third Person Camera component's Aim Max Distance value on the entity.

methodstatic

#public static bool GetAimUsePhysicsRaycast(Entity e)

Reads the Third Person Camera component's Aim Use Physics Raycast value of the entity.

methodstatic

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

Sets the Third Person Camera component's Aim Use Physics Raycast value on the entity.

methodstatic

#public static bool GetAimRotateTargetToCamera(Entity e)

Reads the Third Person Camera component's Aim Rotate Target To Camera value of the entity.

methodstatic

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

Sets the Third Person Camera component's Aim Rotate Target To Camera value on the entity.

methodstatic

#public static float GetCrosshairGap(Entity e)

Reads the Third Person Camera component's Crosshair Gap value of the entity.

methodstatic

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

Sets the Third Person Camera component's Crosshair Gap value on the entity.

methodstatic

#public static float GetCrosshairLength(Entity e)

Reads the Third Person Camera component's Crosshair Length value of the entity.

methodstatic

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

Sets the Third Person Camera component's Crosshair Length value on the entity.

methodstatic

#public static float GetCrosshairThickness(Entity e)

Reads the Third Person Camera component's Crosshair Thickness value of the entity.

methodstatic

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

Sets the Third Person Camera component's Crosshair Thickness 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 Entity GetTarget(Entity e)
public static void SetTarget(Entity e, Entity target)
public static float GetDistance(Entity e)
public static void SetDistance(Entity e, float value)
public static float GetHeight(Entity e)
public static void SetHeight(Entity e, float value)
public static float GetMouseSensitivity(Entity e)
public static void SetMouseSensitivity(Entity e, float value)
public static float GetCollisionRadius(Entity e)
public static void SetCollisionRadius(Entity e, float value)
public static float GetPitch(Entity e)
public static void SetPitch(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 float GetShoulderOffset(Entity e)
public static void SetShoulderOffset(Entity e, float value)
public static bool IsCrosshairShown(Entity e)
public static void SetCrosshairShown(Entity e, bool value)
public static float GetCrosshairOffsetX(Entity e)
public static void SetCrosshairOffsetX(Entity e, float value)
public static float GetCrosshairOffsetY(Entity e)
public static void SetCrosshairOffsetY(Entity e, float value)
public static bool RequiresRightMouse(Entity e)
public static void SetRequireRightMouse(Entity e, bool value)
public static bool GetDriveAimTarget(Entity e)
public static void SetDriveAimTarget(Entity e, bool value)
public static Entity GetAimTarget(Entity e)
public static void SetAimTarget(Entity e, Entity value)
public static float GetAimDefaultDistance(Entity e)
public static void SetAimDefaultDistance(Entity e, float value)
public static float GetAimMaxDistance(Entity e)
public static void SetAimMaxDistance(Entity e, float value)
public static bool GetAimUsePhysicsRaycast(Entity e)
public static void SetAimUsePhysicsRaycast(Entity e, bool value)
public static bool GetAimRotateTargetToCamera(Entity e)
public static void SetAimRotateTargetToCamera(Entity e, bool value)
public static float GetCrosshairGap(Entity e)
public static void SetCrosshairGap(Entity e, float value)
public static float GetCrosshairLength(Entity e)
public static void SetCrosshairLength(Entity e, float value)
public static float GetCrosshairThickness(Entity e)
public static void SetCrosshairThickness(Entity e, float value)

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