SCR_CompassComponent Class Reference

Compass component. More...

Inheritance diagram for SCR_CompassComponent:

Protected Member Functions
ResourceName	GetMapPrefabResource ()
void	UpdateNeedleDirection (float timeSlice)
void	UpdateNeedleShake (float timeSlice)
void	Init2DMapCompass ()
	Init for 2D map compass UI.
void	DragMapCompass ()
	MapCompassUI drag activation, simulating movement.
void	SetMapMode ()
	Activate in a map UI mode.
vector	GetMapCamPosition ()
	Get compass in map UI camera position configuration.
void	UpdateCompassState ()
	Update state of compass active/inactive.
float	GetDampingRatio (float overshootPercentage)
void	CalculateConstants ()
	Init configurables.
override void	ModeSwitch (EGadgetMode mode, IEntity charOwner)
override void	ModeClear (EGadgetMode mode)
override void	ActivateGadgetUpdate ()
override void	DeactivateGadgetUpdate ()
override EGadgetType	GetType ()
override bool	CanBeRaised ()
override bool	IsUsingADSControls ()
override bool	RplSave (ScriptBitWriter writer)
override bool	RplLoad (ScriptBitReader reader)
override void	Update (float timeSlice)
override void	OnPostInit (IEntity owner)

Protected Attributes
float	m_fNeedleAccelerationConstant = 0
float	m_fNeedleDragConstant = 0
float	m_fNeedleAngle = 0
float	m_fNeedleVelocity = 0
float	m_fShakeAccelerationConstant = 0
float	m_fShakeDragConstant = 0
float	m_fShakeAngle = 0
float	m_fShakeVelocity = 0
vector	m_vPreviousFrameAngles
bool	m_bIsInMapMode
SignalsManagerComponent	m_SignalManager
ref SCR_CompassComponentClass	m_PrefabData

Detailed Description

Compass component.

Definition at line 66 of file SCR_CompassComponent.c.

Member Function Documentation

ActivateGadgetUpdate()

override void SCR_CompassComponent::ActivateGadgetUpdate ( )

inlineprotected

Definition at line 310 of file SCR_CompassComponent.c.

CalculateConstants()

void SCR_CompassComponent::CalculateConstants ( )

inlineprotected

Init configurables.

Definition at line 267 of file SCR_CompassComponent.c.

CanBeRaised()

override bool SCR_CompassComponent::CanBeRaised ( )

inlineprotected

Definition at line 336 of file SCR_CompassComponent.c.

DeactivateGadgetUpdate()

override void SCR_CompassComponent::DeactivateGadgetUpdate ( )

inlineprotected

Definition at line 320 of file SCR_CompassComponent.c.

DragMapCompass()

void SCR_CompassComponent::DragMapCompass ( )

inlineprotected

MapCompassUI drag activation, simulating movement.

Definition at line 184 of file SCR_CompassComponent.c.

GetDampingRatio()

float SCR_CompassComponent::GetDampingRatio ( float overshootPercentage )

inlineprotected

Get damping ratiot from overshoot percentage

Parameters

[in]

overshootPercentage

is % overshoot of the needle when settling

Definition at line 257 of file SCR_CompassComponent.c.

GetMapCamPosition()

vector SCR_CompassComponent::GetMapCamPosition ( )

inlineprotected

Get compass in map UI camera position configuration.

Definition at line 204 of file SCR_CompassComponent.c.

GetMapPrefabResource()

ResourceName SCR_CompassComponent::GetMapPrefabResource ( )

inlineprotected

Get 2D map prefab resource name

Returns

returns prefab ResourceName

Definition at line 98 of file SCR_CompassComponent.c.

GetType()

override EGadgetType SCR_CompassComponent::GetType ( )

inlineprotected

Definition at line 330 of file SCR_CompassComponent.c.

Init2DMapCompass()

void SCR_CompassComponent::Init2DMapCompass ( )

inlineprotected

Init for 2D map compass UI.

Definition at line 168 of file SCR_CompassComponent.c.

IsUsingADSControls()

override bool SCR_CompassComponent::IsUsingADSControls ( )

inlineprotected

Definition at line 342 of file SCR_CompassComponent.c.

ModeClear()

override void SCR_CompassComponent::ModeClear ( EGadgetMode mode )

inlineprotected

Definition at line 298 of file SCR_CompassComponent.c.

ModeSwitch()

override void SCR_CompassComponent::ModeSwitch ( EGadgetMode mode, IEntity charOwner )

inlineprotected

Definition at line 286 of file SCR_CompassComponent.c.

OnPostInit()

override void SCR_CompassComponent::OnPostInit ( IEntity owner )

inlineprotected

Definition at line 379 of file SCR_CompassComponent.c.

RplLoad()

override bool SCR_CompassComponent::RplLoad ( ScriptBitReader reader )

inlineprotected

Definition at line 359 of file SCR_CompassComponent.c.

RplSave()

override bool SCR_CompassComponent::RplSave ( ScriptBitWriter writer )

inlineprotected

Definition at line 348 of file SCR_CompassComponent.c.

SetMapMode()

void SCR_CompassComponent::SetMapMode ( )

inlineprotected

Activate in a map UI mode.

Definition at line 193 of file SCR_CompassComponent.c.

Update()

override void SCR_CompassComponent::Update ( float timeSlice )

inlineprotected

Definition at line 372 of file SCR_CompassComponent.c.

UpdateCompassState()

void SCR_CompassComponent::UpdateCompassState ( )

inlineprotected

Update state of compass active/inactive.

Definition at line 211 of file SCR_CompassComponent.c.

UpdateNeedleDirection()

void SCR_CompassComponent::UpdateNeedleDirection ( float timeSlice )

inlineprotected

Updates the needle angle around the Y axis, to pointing north

Parameters

[in]

timeSlice

is OnFrame timeslice

Definition at line 106 of file SCR_CompassComponent.c.

UpdateNeedleShake()

void SCR_CompassComponent::UpdateNeedleShake ( float timeSlice )

inlineprotected

Applies shake to the needle based on rotations

Parameters

[in]

timeSlice

is OnFrame timeslice

Definition at line 131 of file SCR_CompassComponent.c.

Member Data Documentation

m_bIsInMapMode

bool SCR_CompassComponent::m_bIsInMapMode

protected

Definition at line 90 of file SCR_CompassComponent.c.

m_fNeedleAccelerationConstant

float SCR_CompassComponent::m_fNeedleAccelerationConstant = 0

protected

Definition at line 71 of file SCR_CompassComponent.c.

m_fNeedleAngle

float SCR_CompassComponent::m_fNeedleAngle = 0

protected

Definition at line 75 of file SCR_CompassComponent.c.

m_fNeedleDragConstant

float SCR_CompassComponent::m_fNeedleDragConstant = 0

protected

Definition at line 72 of file SCR_CompassComponent.c.

m_fNeedleVelocity

float SCR_CompassComponent::m_fNeedleVelocity = 0

protected

Definition at line 76 of file SCR_CompassComponent.c.

m_fShakeAccelerationConstant

float SCR_CompassComponent::m_fShakeAccelerationConstant = 0

protected

Definition at line 79 of file SCR_CompassComponent.c.

m_fShakeAngle

float SCR_CompassComponent::m_fShakeAngle = 0

protected

Definition at line 83 of file SCR_CompassComponent.c.

m_fShakeDragConstant

float SCR_CompassComponent::m_fShakeDragConstant = 0

protected

Definition at line 80 of file SCR_CompassComponent.c.

m_fShakeVelocity

float SCR_CompassComponent::m_fShakeVelocity = 0

protected

Definition at line 84 of file SCR_CompassComponent.c.

m_PrefabData

ref SCR_CompassComponentClass SCR_CompassComponent::m_PrefabData

protected

Definition at line 93 of file SCR_CompassComponent.c.

m_SignalManager

SignalsManagerComponent SCR_CompassComponent::m_SignalManager

protected

Definition at line 92 of file SCR_CompassComponent.c.

m_vPreviousFrameAngles

vector SCR_CompassComponent::m_vPreviousFrameAngles

protected

Definition at line 87 of file SCR_CompassComponent.c.

---

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

• scripts/Game/Components/Gadgets/SCR_CompassComponent.c