SCR_MapGadgetComponent Interface Reference

Map gadget component. More...

Inheritance diagram for SCR_MapGadgetComponent:

Public Member Functions
void	SetMapMode (bool state)
	Switch between map view.
override void	ModeSwitch (EGadgetMode mode, IEntity charOwner)
	Set gadget mode.
override void	ModeClear (EGadgetMode mode)
	Clear gadget mode.
override void	ToggleFocused (bool enable)
	Toggle gadget focus state.
override EGadgetType	GetType ()
	Get gadget type.
override void	EOnInit (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	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.
IEntity	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	ToggleMapGadget (bool state)
	Open/close map.
void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.
void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.
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
float	m_fActivationDelay
bool	m_bIsMapOpen
bool	m_bIsFirstTimeOpened = true
SCR_MapEntity	m_MapEntity
SCR_FadeInOutEffect	m_FadeInOutEffect
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
IEntity	m_CharacterOwner

Additional Inherited Members
Public Attributes inherited from SCR_GadgetComponent
bool	m_bFocused

Detailed Description

Map gadget component.

Member Function Documentation

EOnInit()

override void SCR_MapGadgetComponent.EOnInit

(

IEntity

owner

)

GetType()

override EGadgetType SCR_MapGadgetComponent.GetType

(

)

Get gadget type.

Returns

Returns gadget type

Implements SCR_GadgetComponent.

ModeClear()

override void SCR_MapGadgetComponent.ModeClear

(

EGadgetMode

mode

)

Clear gadget mode.

Parameters

[in]

mode

is the mode being cleared

Implements SCR_GadgetComponent.

ModeSwitch()

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

Set gadget mode.

Parameters

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

Implements SCR_GadgetComponent.

OnMapClose()

void SCR_MapGadgetComponent.OnMapClose ( MapConfiguration  config )

protected

SCR_MapEntity event.

Parameters

[in]

config

OnMapOpen()

void SCR_MapGadgetComponent.OnMapOpen ( MapConfiguration  config )

protected

SCR_MapEntity event.

Parameters

[in]

config

SetMapMode()

void SCR_MapGadgetComponent.SetMapMode

(

bool

state

)

Switch between map view.

Parameters

[in]

state

is desired state: true = open, false = close

ToggleFocused()

override void SCR_MapGadgetComponent.ToggleFocused

(

bool

enable

)

Toggle gadget focus state.

Parameters

[in]

enable

is target state

Implements SCR_GadgetComponent.

ToggleMapGadget()

void SCR_MapGadgetComponent.ToggleMapGadget ( bool  state )

protected

Open/close map.

Parameters

[in]

state

is desired state: true = open, false = close

Member Data Documentation

m_bIsFirstTimeOpened

bool SCR_MapGadgetComponent.m_bIsFirstTimeOpened = true

protected

m_bIsMapOpen

bool SCR_MapGadgetComponent.m_bIsMapOpen

protected

m_fActivationDelay

float SCR_MapGadgetComponent.m_fActivationDelay

protected

m_FadeInOutEffect

SCR_FadeInOutEffect SCR_MapGadgetComponent.m_FadeInOutEffect

protected

m_MapEntity

SCR_MapEntity SCR_MapGadgetComponent.m_MapEntity

protected

---

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

• Game/Components/Gadgets/SCR_MapGadgetComponent.c