SCR_ControlPlayerCameraComponent Interface Reference

Inheritance diagram for SCR_ControlPlayerCameraComponent:

Public Member Functions
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.
void	EOnCameraSave (SCR_ManualCameraComponentSave data)
	Save persistent data.
void	EOnCameraLoad (SCR_ManualCameraComponentSave data)
	Load persistent data.

Protected Attributes
string	m_sBlockingContext
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

Control player's avatar in the camera.

Member Function Documentation

EOnCameraExit()

override void SCR_ControlPlayerCameraComponent.EOnCameraExit

(

)

Terminate the component.

Implements SCR_BaseManualCameraComponent.

EOnCameraFrame()

override void SCR_ControlPlayerCameraComponent.EOnCameraFrame

(

SCR_ManualCameraParam

param

)

Evaluate the component every frame.

Parameters

[in]

param

Object carrying camera properties

Implements SCR_BaseManualCameraComponent.

EOnCameraInit()

override bool SCR_ControlPlayerCameraComponent.EOnCameraInit

(

)

Initialise the component.

Returns

True if the component should be evaluated every frame

Implements SCR_BaseManualCameraComponent.

Member Data Documentation

m_sBlockingContext

string SCR_ControlPlayerCameraComponent.m_sBlockingContext

protected

---

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

• Game/Camera/Components/SCR_ControlPlayerManualCameraComponent.c