SCR_AttachManualCameraComponent Interface Reference

Inheritance diagram for SCR_AttachManualCameraComponent:

Public Member Functions
bool	AttachTo (IEntity target)
	Attach camera to an entity.
void	Detach ()
	Detach camera from its parent entity.
ScriptInvoker	GetOnAttachChange ()
	Get event called when camera is attached or detached.
override void	EOnCameraSave (SCR_ManualCameraComponentSave data)
	Save persistent data.
override void	EOnCameraLoad (SCR_ManualCameraComponentSave data)
	Load persistent data.
override void	EOnCameraFrame (SCR_ManualCameraParam param)
	Evaluate the component every frame.
override bool	EOnCameraInit ()
	Initialise the component.
override void	EOnCameraExit ()
	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	EOnCameraReset ()
	Camera value are reset.
void	EOnCameraParentChange (bool attached, IEntity parent)
	Terminate the component.

Protected Attributes
bool	m_bRotateWithTarget
IEntity	m_Target
SCR_AttachEntity	m_AttachHelper
bool	m_bAttachChanged
ref ScriptInvoker	m_OnAttachChange = new ScriptInvoker()
Protected Attributes inherited from SCR_BaseManualCameraComponent
int	m_iPriority
SCR_ManualCamera	m_Camera
InputManager	m_InputManager

Additional Inherited Members
Protected Member Functions inherited from SCR_BaseManualCameraComponent
SCR_ManualCamera	GetCameraEntity ()
InputManager	GetInputManager ()
vector	CoordToCamera (vector pos)
vector	CoordFromCamera (vector pos)

Detailed Description

Attach camera to a target

Member Function Documentation

AttachTo()

bool SCR_AttachManualCameraComponent.AttachTo

(

IEntity

target

)

Attach camera to an entity.

Parameters

[in]

parent

Target entity

Detach()

void SCR_AttachManualCameraComponent.Detach

(

)

Detach camera from its parent entity.

EOnCameraExit()

override void SCR_AttachManualCameraComponent.EOnCameraExit

(

)

Terminate the component.

Implements SCR_BaseManualCameraComponent.

EOnCameraFrame()

override void SCR_AttachManualCameraComponent.EOnCameraFrame

(

SCR_ManualCameraParam

param

)

Evaluate the component every frame.

Parameters

[in]

param

Object carrying camera properties

Implements SCR_BaseManualCameraComponent.

EOnCameraInit()

override bool SCR_AttachManualCameraComponent.EOnCameraInit

(

)

Initialise the component.

Returns

True if the component should be evaluated every frame

Implements SCR_BaseManualCameraComponent.

EOnCameraLoad()

override void SCR_AttachManualCameraComponent.EOnCameraLoad

(

SCR_ManualCameraComponentSave

data

)

Load persistent data.

Parameters

[in]

data

Implements SCR_BaseManualCameraComponent.

EOnCameraSave()

override void SCR_AttachManualCameraComponent.EOnCameraSave

(

SCR_ManualCameraComponentSave

data

)

Save persistent data.

Parameters

[in]

data

Implements SCR_BaseManualCameraComponent.

GetOnAttachChange()

ScriptInvoker SCR_AttachManualCameraComponent.GetOnAttachChange

(

)

Get event called when camera is attached or detached.

Returns

Script invoker

Member Data Documentation

m_AttachHelper

SCR_AttachEntity SCR_AttachManualCameraComponent.m_AttachHelper

protected

m_bAttachChanged

bool SCR_AttachManualCameraComponent.m_bAttachChanged

protected

m_bRotateWithTarget

bool SCR_AttachManualCameraComponent.m_bRotateWithTarget

protected

m_OnAttachChange

ref ScriptInvoker SCR_AttachManualCameraComponent.m_OnAttachChange = new ScriptInvoker()

protected

m_Target

IEntity SCR_AttachManualCameraComponent.m_Target

protected

---

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

• Game/Camera/Components/SCR_AttachManualCameraComponent.c