Compass component. More...

Inheritance diagram for SCR_CompassComponent:

Public Member Functions
ResourceName	GetMapPrefabResource ()
	Get 2D map prefab resource name.

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.

override void	ModeSwitch (EGadgetMode mode, IEntity charOwner)
	Set gadget mode.

override void	ModeClear (EGadgetMode mode)
	Clear gadget mode.

override void	ActivateGadgetUpdate ()
	Activate gadget frame update.

override void	DeactivateGadgetUpdate ()
	Deactivate gadget frame flag.

override EGadgetType	GetType ()
	Get gadget type.

override bool	CanBeRaised ()
	Gadget has a raised animation version.

override bool	IsUsingADSControls ()
	Gadget uses ADS controls from gadget raisable context.

override bool	RplSave (ScriptBitWriter writer)

override bool	RplLoad (ScriptBitReader reader)

override void	Update (float timeSlice)

override void	OnPostInit (IEntity owner)

Public Member Functions inherited from SCR_GadgetComponent
EGadgetAnimVariable	GetAnimVariable ()

float	GetWeaponNoFireTime ()

bool	IsToggledOn ()
	Is gadget toggled on/off.

void	OnToggleActive (bool state)
	Event called from SCR_GadgetManagerComponent through RPC request.

void	OnParentSlotChanged (InventoryStorageSlot oldSlot, InventoryStorageSlot newSlot)
	InventoryItemComponent event.

void	OnModeChanged (EGadgetMode mode, IEntity charOwner)
	Gadget mode change event.

void	OnSlotOccludedStateChanged (bool occluded)
	Method called when slot to which item is attached to changed its occlusion state.

void	UpdateVisibility (EGadgetMode mode)
	Set visibility when show/hide hand animation starts/finishes.

void	ToggleActive (bool state, SCR_EUseContext context)
	Synchronise gadget state.

void	ActivateAction ()
	Action listener callback.

void	ToggleFocused (bool enable)
	Toggle gadget focus state.

ChimeraCharacter	GetCharacterOwner ()
	Get IEntity in possession of this Gadget.

EGadgetMode	GetMode ()
	Get gadget mode.

bool	CanBeHeld ()
	Can be held in hand.

SCR_EUseContext	GetUseMask ()
	Provides value that contains mask of contexts from which this gadget can be toggled.

bool	IsVisibleEquipped ()
	Visible when attached to character gear, further condition may determine visibility, such as if the equipment slot is obstructed by something else.

override void	OnDelete (IEntity owner)

Static Public Attributes
static const float	E = 2.71828182845904

Protected Member Functions
void	UpdateNeedleDirection (float timeSlice)
	Updates the needle angle around the Y axis, to pointing north.

void	UpdateNeedleShake (float timeSlice)
	Applies shake to the needle based on rotations.

void	UpdateCompassState ()
	Update state of compass active/inactive.

float	GetDampingRatio (float overshootPercentage)
	Get damping ratiot from overshoot percentage.

void	CalculateConstants ()
	Init configurables.

Protected Member Functions inherited from SCR_GadgetComponent
void	ConnectToGadgetsSystem ()
	Starts on frame update event.

void	DisconnectFromGadgetsSystem ()

Protected Member Functions inherited from ScriptGameComponent
bool	OnTicksOnRemoteProxy ()

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

Protected Attributes inherited from SCR_GadgetComponent
EGadgetAnimVariable	m_eAnimVariable

SCR_EUseContext	m_eUseMask

vector	m_vEquipmentSlotOffset

float	m_fWeaponNoFireTime

bool	m_bCanBeHeld

bool	m_bActivated = false

EGadgetMode	m_iMode = EGadgetMode.ON_GROUND

ChimeraCharacter	m_CharacterOwner

Additional Inherited Members
Public Attributes inherited from SCR_GadgetComponent
bool	m_bFocused

Detailed Description

Compass component.

Member Function Documentation

◆ ActivateGadgetUpdate()

override void SCR_CompassComponent.ActivateGadgetUpdate ( )

Activate gadget frame update.

Implements SCR_GadgetComponent.

◆ CalculateConstants()

void SCR_CompassComponent.CalculateConstants ( )

protected

Init configurables.

◆ CanBeRaised()

override bool SCR_CompassComponent.CanBeRaised ( )

Gadget has a raised animation version.

Returns: Returns true if raisable

Implements SCR_GadgetComponent.

◆ DeactivateGadgetUpdate()

override void SCR_CompassComponent.DeactivateGadgetUpdate ( )

Deactivate gadget frame flag.

Implements SCR_GadgetComponent.

◆ DragMapCompass()

void SCR_CompassComponent.DragMapCompass ( )

MapCompassUI drag activation, simulating movement.

◆ GetDampingRatio()

float SCR_CompassComponent.GetDampingRatio ( float overshootPercentage )

protected

Get damping ratiot from overshoot percentage.

Parameters

[in] overshootPercentage is % overshoot of the needle when settling

◆ GetMapCamPosition()

vector SCR_CompassComponent.GetMapCamPosition ( )

Get compass in map UI camera position configuration.

◆ GetMapPrefabResource()

ResourceName SCR_CompassComponent.GetMapPrefabResource ( )

Get 2D map prefab resource name.

Returns: returns prefab ResourceName

◆ GetType()

override EGadgetType SCR_CompassComponent.GetType ( )

Get gadget type.

Returns: Returns gadget type

Implements SCR_GadgetComponent.

◆ Init2DMapCompass()

void SCR_CompassComponent.Init2DMapCompass ( )

Init for 2D map compass UI.

◆ IsUsingADSControls()

override bool SCR_CompassComponent.IsUsingADSControls ( )

Gadget uses ADS controls from gadget raisable context.

Returns: Returns true if using the controls

Implements SCR_GadgetComponent.

◆ ModeClear()

override void SCR_CompassComponent.ModeClear ( EGadgetMode mode )

Clear gadget mode.

Parameters

[in] mode is the mode being cleared

Implements SCR_GadgetComponent.

◆ ModeSwitch()

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

Set gadget mode.

Parameters

[in]	mode	is the target mode being switched to
[in]	charOwner

Implements SCR_GadgetComponent.

◆ OnPostInit()

override void SCR_CompassComponent.OnPostInit ( IEntity owner )

Implements SCR_GadgetComponent.

◆ RplLoad()

override bool SCR_CompassComponent.RplLoad ( ScriptBitReader reader )

Implements SCR_GadgetComponent.

◆ RplSave()

override bool SCR_CompassComponent.RplSave ( ScriptBitWriter writer )

Implements SCR_GadgetComponent.

◆ SetMapMode()

void SCR_CompassComponent.SetMapMode ( )

Activate in a map UI mode.

◆ Update()

override void SCR_CompassComponent.Update ( float timeSlice )

Parameters

[in] timeSlice

Implements SCR_GadgetComponent.

◆ UpdateCompassState()

void SCR_CompassComponent.UpdateCompassState ( )

protected

Update state of compass active/inactive.

◆ UpdateNeedleDirection()

void SCR_CompassComponent.UpdateNeedleDirection ( float timeSlice )

protected

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

Parameters

[in] timeSlice is OnFrame timeslice

◆ UpdateNeedleShake()

void SCR_CompassComponent.UpdateNeedleShake ( float timeSlice )

protected

Applies shake to the needle based on rotations.

Parameters

[in] timeSlice is OnFrame timeslice

Member Data Documentation

◆ E

const float SCR_CompassComponent.E = 2.71828182845904

static

◆ m_bIsInMapMode

bool SCR_CompassComponent.m_bIsInMapMode

protected

◆ m_fNeedleAccelerationConstant

float SCR_CompassComponent.m_fNeedleAccelerationConstant = 0

protected

◆ m_fNeedleAngle

float SCR_CompassComponent.m_fNeedleAngle = 0

protected

◆ m_fNeedleDragConstant

float SCR_CompassComponent.m_fNeedleDragConstant = 0

protected

◆ m_fNeedleVelocity

float SCR_CompassComponent.m_fNeedleVelocity = 0

protected

◆ m_fShakeAccelerationConstant

float SCR_CompassComponent.m_fShakeAccelerationConstant = 0

protected

◆ m_fShakeAngle

float SCR_CompassComponent.m_fShakeAngle = 0

protected

◆ m_fShakeDragConstant

float SCR_CompassComponent.m_fShakeDragConstant = 0

protected

◆ m_fShakeVelocity

float SCR_CompassComponent.m_fShakeVelocity = 0

protected

◆ m_PrefabData

ref SCR_CompassComponentClass SCR_CompassComponent.m_PrefabData

protected

◆ m_SignalManager

SignalsManagerComponent SCR_CompassComponent.m_SignalManager

protected

◆ m_vPreviousFrameAngles

vector SCR_CompassComponent.m_vPreviousFrameAngles

protected

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

Game/Components/Gadgets/SCR_CompassComponent.c

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ActivateGadgetUpdate()

◆ CalculateConstants()

◆ CanBeRaised()

◆ DeactivateGadgetUpdate()

◆ DragMapCompass()

◆ GetDampingRatio()

◆ GetMapCamPosition()

◆ GetMapPrefabResource()

◆ GetType()

◆ Init2DMapCompass()

◆ IsUsingADSControls()

◆ ModeClear()

◆ ModeSwitch()

◆ OnPostInit()

◆ RplLoad()

◆ RplSave()

◆ SetMapMode()

◆ Update()

◆ UpdateCompassState()

◆ UpdateNeedleDirection()

◆ UpdateNeedleShake()

Member Data Documentation

◆ E

◆ m_bIsInMapMode

◆ m_fNeedleAccelerationConstant

◆ m_fNeedleAngle

◆ m_fNeedleDragConstant

◆ m_fNeedleVelocity

◆ m_fShakeAccelerationConstant

◆ m_fShakeAngle

◆ m_fShakeDragConstant

◆ m_fShakeVelocity

◆ m_PrefabData

◆ m_SignalManager

◆ m_vPreviousFrameAngles