Inheritance diagram for SCR_TeleportToCursorManualCameraComponent:

Public Member Functions
bool	TeleportCamera (vector position, bool forceDefaultDistance=false, bool forceDefaultAngle=false, bool forceStartAtCurrentPos=false, bool disableInterruption=false, float distance=-1, bool noSound=false)
	Teleport camera to given coordinates.

override void	EOnCameraFrame (SCR_ManualCameraParam param)
	Evaluate the component every frame.

override bool	EOnCameraInit ()
	Initialise the component.

override void	EOnCameraParentChange (bool attached, IEntity parent)
	Terminate the component.

Public Member Functions inherited from SCR_BaseManualCameraComponent
void	SetEnabled (bool enabled)
	Enable the component.

int	IsEnabled ()
	Check if the component is enabled.

int	GetPriority ()
	Get evaluation priority.

bool	HasFlag (EManualCameraFlag flag)
	Check if the required flag is active.

bool	InitBase (SCR_ManualCamera camera)

void	EOnCameraExit ()
	Terminate the component.

void	EOnCameraReset ()
	Camera value are reset.

void	EOnCameraSave (SCR_ManualCameraComponentSave data)
	Save persistent data.

void	EOnCameraLoad (SCR_ManualCameraComponentSave data)
	Load persistent data.

Static Protected Attributes
static const float	SETTLE_THRESHOLD = 0.01

Additional Inherited Members
Protected Member Functions inherited from SCR_BaseManualCameraComponent
SCR_ManualCamera	GetCameraEntity ()

InputManager	GetInputManager ()

vector	CoordToCamera (vector pos)

vector	CoordFromCamera (vector pos)

Protected Attributes inherited from SCR_BaseManualCameraComponent
int	m_iPriority

SCR_ManualCamera	m_Camera

InputManager	m_InputManager

Detailed Description

Teleport the camera to the cursor's world position

Member Function Documentation

override void SCR_TeleportToCursorManualCameraComponent.EOnCameraFrame ( SCR_ManualCameraParam param )

Evaluate the component every frame.

Parameters

[in] param Object carrying camera properties

override bool SCR_TeleportToCursorManualCameraComponent.EOnCameraInit ( )

Initialise the component.

override void SCR_TeleportToCursorManualCameraComponent.EOnCameraParentChange	(	bool	attached,
		IEntity	parent
	)

Terminate the component.

Parameters

[in]	attached
[in]	parent

bool SCR_TeleportToCursorManualCameraComponent.TeleportCamera	(	vector	position,
		bool	forceDefaultDistance = `false`,
		bool	forceDefaultAngle = `false`,
		bool	forceStartAtCurrentPos = `false`,
		bool	disableInterruption = `false`,
		float	distance = `-1`,
		bool	noSound = `false`
	)

Teleport camera to given coordinates.

Parameters

[in]	position	Target position
[in]	forceDefaultDistance	True to force default offset from the target, even when the camera starts closer
[in]	forceDefaultAngle	True to force default angle instead preserving current camera angle
[in]	forceStartAtCurrentPos	True to move camera smoothly to the position, even when it's too far
[in]	disableInterruption	True to prevent user input when teleporting animation is playing
[in]	distance	How far from target position will the camera be positioned (also influenced by forceDefaultDistance setting)
[in]	noSound	When true, no sound effect will be played

const float SCR_TeleportToCursorManualCameraComponent.SETTLE_THRESHOLD = 0.01

staticprotected

The documentation for this interface was generated from the following file: