SCR_DataDisplayGadgetComponent Interface Reference

Inheritance diagram for SCR_DataDisplayGadgetComponent:

Public Member Functions
int	GetNumberOfPages ()
void	ChangePage (int direction=0)
	Interface for changing pages that are being displayed.
override EGadgetType	GetType ()
	Get gadget type.
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.
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 void	OnPostInit (IEntity owner)

Public Attributes
int	m_iOpacityMapId
Public Attributes inherited from SCR_GadgetComponent
bool	m_bFocused

Static Public Attributes
const string	PAGE_NUMBER_NAME = "PageNumber"
const string	PAGE_NUMBER_FORMAT = "%1 / %2"

Protected Member Functions
void	UpdateData (bool playSound=true)
	Method used to update currently displayed ballistic data.
override void	ModeSwitch (EGadgetMode mode, IEntity charOwner)
	Set gadget mode.
override void	ModeClear (EGadgetMode mode)
	Clear gadget mode.
bool	InitializeRenderTarget ()
void	ClearRenderTarget ()
override void	EOnInit (IEntity owner)
override void	OnDelete (IEntity owner)
void	RpcDo_SyncPageChange (int selectedPage)
	Authority method for replicating change of currently displayed page.
override bool	RplSave (ScriptBitWriter writer)
override bool	RplLoad (ScriptBitReader reader)
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
RTTextureWidget m_wRenderTargetTexture Widget	m_wRootWidget
int	m_iNumberOfPages
int	m_iCurrentPageID
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

Member Function Documentation

ChangePage()

void SCR_DataDisplayGadgetComponent.ChangePage

(

int

direction = 0

)

Interface for changing pages that are being displayed.

Parameters

[in]

direction

-1 == previous | +1 == next

ClearRenderTarget()

void SCR_DataDisplayGadgetComponent.ClearRenderTarget ( )

protected

EOnInit()

override void SCR_DataDisplayGadgetComponent.EOnInit ( IEntity owner )

protected

GetNumberOfPages()

int SCR_DataDisplayGadgetComponent.GetNumberOfPages

(

)

Returns

GetType()

override EGadgetType SCR_DataDisplayGadgetComponent.GetType

(

)

Get gadget type.

Returns

Returns gadget type

Implements SCR_GadgetComponent.

InitializeRenderTarget()

bool SCR_DataDisplayGadgetComponent.InitializeRenderTarget ( )

protected

ModeClear()

override void SCR_DataDisplayGadgetComponent.ModeClear ( EGadgetMode mode )

protected

Clear gadget mode.

Parameters

[in]

mode

is the mode being cleared

Implements SCR_GadgetComponent.

ModeSwitch()

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

protected

Set gadget mode.

Parameters

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

Implements SCR_GadgetComponent.

OnDelete()

override void SCR_DataDisplayGadgetComponent.OnDelete ( IEntity owner )

protected

Implements SCR_GadgetComponent.

RpcDo_SyncPageChange()

void SCR_DataDisplayGadgetComponent.RpcDo_SyncPageChange ( int selectedPage )

protected

Authority method for replicating change of currently displayed page.

Parameters

[in]

selectedPage

id of newly displayed page

RplLoad()

override bool SCR_DataDisplayGadgetComponent.RplLoad ( ScriptBitReader reader )

protected

Implements SCR_GadgetComponent.

RplSave()

override bool SCR_DataDisplayGadgetComponent.RplSave ( ScriptBitWriter writer )

protected

Implements SCR_GadgetComponent.

UpdateData()

void SCR_DataDisplayGadgetComponent.UpdateData ( bool playSound = true )

protected

Method used to update currently displayed ballistic data.

Member Data Documentation

m_iCurrentPageID

int SCR_DataDisplayGadgetComponent.m_iCurrentPageID

protected

m_iNumberOfPages

int SCR_DataDisplayGadgetComponent.m_iNumberOfPages

protected

m_iOpacityMapId

int SCR_DataDisplayGadgetComponent.m_iOpacityMapId

m_wRootWidget

RTTextureWidget m_wRenderTargetTexture Widget SCR_DataDisplayGadgetComponent.m_wRootWidget

protected

PAGE_NUMBER_FORMAT

const string SCR_DataDisplayGadgetComponent.PAGE_NUMBER_FORMAT = "%1 / %2"

static

PAGE_NUMBER_NAME

const string SCR_DataDisplayGadgetComponent.PAGE_NUMBER_NAME = "PageNumber"

static

---

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

• Game/Components/Gadgets/SCR_DataDisplayGadget.c