SCR_AdjustSpeedManualCameraComponent Interface Reference

Inheritance diagram for SCR_AdjustSpeedManualCameraComponent:

Public Member Functions
ScriptInvoker	GetOnSpeedChange ()
	Get event called every time the speed is adjusted.
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 Member Functions
void	OnInputDeviceIsGamepad (bool isGamepad)
void	ManualCameraSpeedReset (float value, EActionTrigger trigger)
void	UpdateWidget ()
void	FadeOutWidget (float timeSlice)
Protected Member Functions inherited from SCR_BaseManualCameraComponent
SCR_ManualCamera	GetCameraEntity ()
InputManager	GetInputManager ()
vector	CoordToCamera (vector pos)
vector	CoordFromCamera (vector pos)

Protected Attributes
float	m_fMinMultiplier
float	m_fMaxMultiplier
ResourceName	m_Layout
float	m_fLayoutDuration
float	m_fMultiplier = 1
TextWidget	m_Widget
float	m_fWidgetAlpha
ref ScriptInvoker	m_OnSpeedChange = new ScriptInvoker()
Protected Attributes inherited from SCR_BaseManualCameraComponent
int	m_iPriority
SCR_ManualCamera	m_Camera
InputManager	m_InputManager

Detailed Description

Adjusting speed at small increments for manual camera.

Member Function Documentation

EOnCameraExit()

override void SCR_AdjustSpeedManualCameraComponent.EOnCameraExit

(

)

Terminate the component.

Implements SCR_BaseManualCameraComponent.

EOnCameraFrame()

override void SCR_AdjustSpeedManualCameraComponent.EOnCameraFrame

(

SCR_ManualCameraParam

param

)

Evaluate the component every frame.

Parameters

[in]

param

Object carrying camera properties

Implements SCR_BaseManualCameraComponent.

EOnCameraInit()

override bool SCR_AdjustSpeedManualCameraComponent.EOnCameraInit

(

)

Initialise the component.

Returns

True if the component should be evaluated every frame

Implements SCR_BaseManualCameraComponent.

EOnCameraLoad()

override void SCR_AdjustSpeedManualCameraComponent.EOnCameraLoad

(

SCR_ManualCameraComponentSave

data

)

Load persistent data.

Parameters

[in]

data

Implements SCR_BaseManualCameraComponent.

EOnCameraSave()

override void SCR_AdjustSpeedManualCameraComponent.EOnCameraSave

(

SCR_ManualCameraComponentSave

data

)

Save persistent data.

Parameters

[in]

data

Implements SCR_BaseManualCameraComponent.

FadeOutWidget()

void SCR_AdjustSpeedManualCameraComponent.FadeOutWidget ( float  timeSlice )

protected

GetOnSpeedChange()

ScriptInvoker SCR_AdjustSpeedManualCameraComponent.GetOnSpeedChange

(

)

Get event called every time the speed is adjusted.

Returns

Script invoker

ManualCameraSpeedReset()

void SCR_AdjustSpeedManualCameraComponent.ManualCameraSpeedReset ( float  value, EActionTrigger  trigger  )

protected

OnInputDeviceIsGamepad()

void SCR_AdjustSpeedManualCameraComponent.OnInputDeviceIsGamepad ( bool  isGamepad )

protected

UpdateWidget()

void SCR_AdjustSpeedManualCameraComponent.UpdateWidget ( )

protected

Member Data Documentation

m_fLayoutDuration

float SCR_AdjustSpeedManualCameraComponent.m_fLayoutDuration

protected

m_fMaxMultiplier

float SCR_AdjustSpeedManualCameraComponent.m_fMaxMultiplier

protected

m_fMinMultiplier

float SCR_AdjustSpeedManualCameraComponent.m_fMinMultiplier

protected

m_fMultiplier

float SCR_AdjustSpeedManualCameraComponent.m_fMultiplier = 1

protected

m_fWidgetAlpha

float SCR_AdjustSpeedManualCameraComponent.m_fWidgetAlpha

protected

m_Layout

ResourceName SCR_AdjustSpeedManualCameraComponent.m_Layout

protected

m_OnSpeedChange

ref ScriptInvoker SCR_AdjustSpeedManualCameraComponent.m_OnSpeedChange = new ScriptInvoker()

protected

m_Widget

TextWidget SCR_AdjustSpeedManualCameraComponent.m_Widget

protected

---

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

• Game/Camera/Components/SCR_AdjustSpeedManualCameraComponent.c