SCR_WristwatchComponent Interface Reference

Inheritance diagram for SCR_WristwatchComponent:

Public Member Functions
ResourceName	GetMapPrefabResource ()
	Get 2D map prefab resource name.
void	UpdateTime ()
void	SetMapMode ()
	Activate in a map UI mode.
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 void	OnPostInit (IEntity owner)
override void	Update (float timeSlice)
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	ActivateGadgetUpdate ()
	Activate gadget frame update.
void	DeactivateGadgetUpdate ()
	Deactivate gadget frame flag.
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.
EGadgetType	GetType ()
	Get gadget type.
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	CanBeRaised ()
	Gadget has a raised animation version.
bool	IsUsingADSControls ()
	Gadget uses ADS controls from gadget raisable context.
bool	IsVisibleEquipped ()
	Visible when attached to character gear, further condition may determine visibility, such as if the equipment slot is obstructed by something else.
void	Update (float timeSlice)
override bool	RplSave (ScriptBitWriter writer)
override bool	RplLoad (ScriptBitReader reader)
override void	OnDelete (IEntity owner)
override void	OnPostInit (IEntity owner)

Protected Member Functions
void	UpdateWristwatchState ()
	Update state of wristwatch -> active/inactive.
Protected Member Functions inherited from SCR_GadgetComponent
void	ModeSwitch (EGadgetMode mode, IEntity charOwner)
	Set gadget mode.
void	ModeClear (EGadgetMode mode)
	Clear gadget mode.
void	ConnectToGadgetsSystem ()
	Starts on frame update event.
void	DisconnectFromGadgetsSystem ()
Protected Member Functions inherited from ScriptGameComponent
bool	OnTicksOnRemoteProxy ()

Protected Attributes
int	m_iSeconds
int	m_iMinutes
int	m_iHours
int	m_iDay
SCR_WristwatchComponentClass	m_PrefabData
SignalsManagerComponent	m_SignalManager
TimeAndWeatherManagerEntity	m_TimeMgr
Protected Attributes inherited from SCR_GadgetComponent
EGadgetAnimVariable	m_eAnimVariable
SCR_EUseContext	m_eUseMask
vector	m_vEquipmentSlotOffset
float	m_fWeaponNoFireTime
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

Member Function Documentation

ActivateGadgetUpdate()

override void SCR_WristwatchComponent.ActivateGadgetUpdate

(

)

Activate gadget frame update.

Implements SCR_GadgetComponent.

CanBeRaised()

override bool SCR_WristwatchComponent.CanBeRaised

(

)

Gadget has a raised animation version.

Returns

Returns true if raisable

Implements SCR_GadgetComponent.

DeactivateGadgetUpdate()

override void SCR_WristwatchComponent.DeactivateGadgetUpdate

(

)

Deactivate gadget frame flag.

Implements SCR_GadgetComponent.

GetMapPrefabResource()

ResourceName SCR_WristwatchComponent.GetMapPrefabResource

(

)

Get 2D map prefab resource name.

Returns

returns prefab ResourceName

GetType()

override EGadgetType SCR_WristwatchComponent.GetType

(

)

Get gadget type.

Returns

Returns gadget type

Implements SCR_GadgetComponent.

IsUsingADSControls()

override bool SCR_WristwatchComponent.IsUsingADSControls

(

)

Gadget uses ADS controls from gadget raisable context.

Returns

Returns true if using the controls

Implements SCR_GadgetComponent.

ModeClear()

override void SCR_WristwatchComponent.ModeClear

(

EGadgetMode

mode

)

Clear gadget mode.

Parameters

[in]

mode

is the mode being cleared

Implements SCR_GadgetComponent.

ModeSwitch()

override void SCR_WristwatchComponent.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_WristwatchComponent.OnPostInit

(

IEntity

owner

)

Implements SCR_GadgetComponent.

SetMapMode()

void SCR_WristwatchComponent.SetMapMode

(

)

Activate in a map UI mode.

Update()

override void SCR_WristwatchComponent.Update

(

float

timeSlice

)

Parameters

[in]

timeSlice

Implements SCR_GadgetComponent.

UpdateTime()

void SCR_WristwatchComponent.UpdateTime

(

)

UpdateWristwatchState()

void SCR_WristwatchComponent.UpdateWristwatchState ( )

protected

Update state of wristwatch -> active/inactive.

Member Data Documentation

m_iDay

int SCR_WristwatchComponent.m_iDay

protected

m_iHours

int SCR_WristwatchComponent.m_iHours

protected

m_iMinutes

int SCR_WristwatchComponent.m_iMinutes

protected

m_iSeconds

int SCR_WristwatchComponent.m_iSeconds

protected

m_PrefabData

SCR_WristwatchComponentClass SCR_WristwatchComponent.m_PrefabData

protected

m_SignalManager

SignalsManagerComponent SCR_WristwatchComponent.m_SignalManager

protected

m_TimeMgr

TimeAndWeatherManagerEntity SCR_WristwatchComponent.m_TimeMgr

protected

---

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

• Game/Components/Gadgets/SCR_WristwatchComponent.c