SCR_GadgetManagerComponent Class Reference

Inheritance diagram for SCR_GadgetManagerComponent:

Protected Member Functions
IEntity	GetHeldGadget ()
bool	GetIsGadgetADS ()
SCR_GadgetComponent	GetHeldGadgetComponent ()
void	SetGadgetMode (IEntity gadget, EGadgetMode targetMode, bool doFocus=false)
void	RemoveHeldGadget ()
	Remove gadget held in hand.
void	OnActivateHeldGadget ()
	Activate held gadget.
void	ToggleHeldGadget (bool state)
array< SCR_GadgetComponent >	GetGadgetsByType (EGadgetType type)
IEntity	GetGadgetByType (EGadgetType type)
IEntity	GetQuickslotGadgetByType (EGadgetType type)
bool	IsGadgetOwned (SCR_GadgetComponent gadgetComp)
bool	CanChangeGadgetMode (IEntity gadget, SCR_GadgetComponent gadgetComp, EGadgetMode targetMode)
void	UpdateHeldGadget (IEntity gadget)
void	HandleInput (IEntity gadget, float inputVal)
void	ClearToggleState ()
	Clear toggle state for cases where it needs to be done without waiting for animation.
void	OnItemAdded (IEntity item, BaseInventoryStorageComponent storageOwner)
void	OnItemRemoved (IEntity item, BaseInventoryStorageComponent storageOwner)
void	OnPlayerDeath (SCR_CharacterControllerComponent charController, IEntity instigatorEntity, notnull Instigator instigator)
void	OnControlledByPlayer (IEntity owner, bool controlled)
void	OnGadgetStateChanged (IEntity gadget, bool isInHand, bool isOnGround)
void	OnGadgetFocusStateChanged (IEntity gadget, bool isFocused)
void	OnEditorOpened ()
	SCR_EditorManagerEntity event //TODO we shouldnt need this, probably needs to be dependent on camera instead.
void	OnGadgetInput (float value, EActionTrigger reason)
void	ActionFlashlightToggle (float value, EActionTrigger reason)
void	OnPauseMenu ()
	Input action callback.
void	OnGadgetADS ()
	Input action callback.
void	OnGadgetADSHold (float value, EActionTrigger reason)
void	SetGadgetADS (bool gadgetADS)
void	CancelADSInput ()
	Cancel weapon and turret ADS input state.
void	RegisterInitialGadgets (IEntity character)
void	RegisterVONEntries ()
	Register radio gadgets into the VON system as entries.
void	UnregisterVONEntries ()
void	RegisterInputs ()
	Register input actions.
void	UnregisterInputs ()
	Register input actions.
EGadgetType	GetGadgetInputAction ()
void	InitComponent (IEntity owner)
void	AskToggleGadget (SCR_GadgetComponent gadgetComp, bool state)
void	RPC_AskToggleGadget (RplId id, bool state)
void	RPC_DoToggleGadget (RplId id, bool state)
void	ConnectToGadgetsManagerSystem ()
void	DisconnectFromGadgetsManagerSystem ()
override void	OnDelete (IEntity owner)
void	Update (float timeSlice)
override void	OnPostInit (IEntity owner)
override void	EOnInit (IEntity owner)

Static Protected Member Functions
static ScriptInvoker	GetOnGadgetInitDoneInvoker ()
static SCR_GadgetManagerComponent	GetGadgetManager (IEntity entity)
static bool	ValidController (IEntity owner)
static void	SetGadgetModeStashed (SCR_GadgetComponent gadgetComp, EGadgetMode targetMode)

Protected Attributes
bool	m_bIsGadgetADS
IEntity	m_HeldGadget
SCR_GadgetComponent	m_HeldGadgetComponent
SCR_GadgetComponent	m_HiddenGadgetComponent
InputManager	m_InputManager
SCR_InventoryStorageManagerComponent	m_InventoryStorageMgr
SCR_CharacterControllerComponent	m_Controller
SCR_VONController	m_VONController
ref SCR_GadgetInvokersInitState	m_pInvokersState = new SCR_GadgetInvokersInitState(this)
ref array< ref array< SCR_GadgetComponent > >	m_aInventoryGadgetTypes = {}
ref map< EGadgetType, int >	m_aGadgetArrayMap = new map<EGadgetType, int>()
SCR_GadgetComponent	m_LastHeldGadgetComponent

Static Protected Attributes
static ref ScriptInvoker< IEntity, SCR_GadgetManagerComponent >	s_OnGadgetInitDone = new ScriptInvoker()

Detailed Description

Definition at line 139 of file SCR_GadgetManagerComponent.c.

Member Function Documentation

ActionFlashlightToggle()

void SCR_GadgetManagerComponent::ActionFlashlightToggle ( float value, EActionTrigger reason )

inlineprotected

Explicit flashlight toggle action

Parameters

[in]	value
[in]	reason

Definition at line 800 of file SCR_GadgetManagerComponent.c.

AskToggleGadget()

void SCR_GadgetManagerComponent::AskToggleGadget ( SCR_GadgetComponent gadgetComp, bool state )

inlineprotected

Ask method for toggle synchronization called from individual gadgets

Parameters

[in]	gadgetComp	is gadget component
[in]	state	is desired toggle state, true: active

Definition at line 1111 of file SCR_GadgetManagerComponent.c.

CancelADSInput()

void SCR_GadgetManagerComponent::CancelADSInput ( )

inlineprotected

Cancel weapon and turret ADS input state.

Definition at line 866 of file SCR_GadgetManagerComponent.c.

CanChangeGadgetMode()

bool SCR_GadgetManagerComponent::CanChangeGadgetMode ( IEntity gadget, SCR_GadgetComponent gadgetComp, EGadgetMode targetMode )

inlineprotected

Rules for gadget mode change

Parameters

[in]	gadget	is the subject
[in]	gadgetComp	is the subjects gadget component
[in]	targetMode	is the wanted mode

Definition at line 421 of file SCR_GadgetManagerComponent.c.

ClearToggleState()

void SCR_GadgetManagerComponent::ClearToggleState ( )

inlineprotected

Clear toggle state for cases where it needs to be done without waiting for animation.

Definition at line 530 of file SCR_GadgetManagerComponent.c.

ConnectToGadgetsManagerSystem()

void SCR_GadgetManagerComponent::ConnectToGadgetsManagerSystem ( )

inlineprotected

Definition at line 1153 of file SCR_GadgetManagerComponent.c.

DisconnectFromGadgetsManagerSystem()

void SCR_GadgetManagerComponent::DisconnectFromGadgetsManagerSystem ( )

inlineprotected

Definition at line 1168 of file SCR_GadgetManagerComponent.c.

EOnInit()

override void SCR_GadgetManagerComponent::EOnInit ( IEntity owner )

inlineprotected

Definition at line 1243 of file SCR_GadgetManagerComponent.c.

GetGadgetByType()

IEntity SCR_GadgetManagerComponent::GetGadgetByType ( EGadgetType type )

inlineprotected

Get first owned gadget by type

Parameters

[in]

type

is the type of gadget being searched

Returns

Returns gadget of given type or null if not found

Definition at line 348 of file SCR_GadgetManagerComponent.c.

GetGadgetInputAction()

EGadgetType SCR_GadgetManagerComponent::GetGadgetInputAction ( )

inlineprotected

Convert invoked input to gadget type

Returns

gadget type

Definition at line 1048 of file SCR_GadgetManagerComponent.c.

GetGadgetManager()

SCR_GadgetManagerComponent SCR_GadgetManagerComponent::GetGadgetManager ( IEntity entity )

inlinestaticprotected

Get gadget manager of entity

Returns

gadget manager

Definition at line 177 of file SCR_GadgetManagerComponent.c.

GetGadgetsByType()

array< SCR_GadgetComponent > SCR_GadgetManagerComponent::GetGadgetsByType ( EGadgetType type )

inlineprotected

Get all owned gadgets by type

Parameters

[in]

type

is the type of gadget being searched

Returns

Returns array of gadget of the given type or null if not found

Definition at line 330 of file SCR_GadgetManagerComponent.c.

GetHeldGadget()

IEntity SCR_GadgetManagerComponent::GetHeldGadget ( )

inlineprotected

Get held (currently in hand) gadget

Returns

held gadget entity

Definition at line 191 of file SCR_GadgetManagerComponent.c.

GetHeldGadgetComponent()

SCR_GadgetComponent SCR_GadgetManagerComponent::GetHeldGadgetComponent ( )

inlineprotected

Get held (currently in hand) gadget component

Returns

held gadget component

Definition at line 212 of file SCR_GadgetManagerComponent.c.

GetIsGadgetADS()

bool SCR_GadgetManagerComponent::GetIsGadgetADS ( )

inlineprotected

Get is player in gadget ADS

Returns

if gadget is in ADS

Definition at line 204 of file SCR_GadgetManagerComponent.c.

GetOnGadgetInitDoneInvoker()

ScriptInvoker SCR_GadgetManagerComponent::GetOnGadgetInitDoneInvoker ( )

inlinestaticprotected

Returns

Definition at line 169 of file SCR_GadgetManagerComponent.c.

GetQuickslotGadgetByType()

IEntity SCR_GadgetManagerComponent::GetQuickslotGadgetByType ( EGadgetType type )

inlineprotected

Get first owned gadget assigned in quickslot by type

Parameters

[in]

type

is the type of gadget being searched

Returns

Returns gadget of given type or null if not found

Definition at line 369 of file SCR_GadgetManagerComponent.c.

HandleInput()

void SCR_GadgetManagerComponent::HandleInput ( IEntity gadget, float inputVal )

inlineprotected

Additonal pre SetGadgetMode logic for local player, modfying the behavior based on input used & current held gadget state

Parameters

[in]	gadget	is the subject
[in]	inputVal	determines type of input we want to execute, click/hold version

Definition at line 503 of file SCR_GadgetManagerComponent.c.

InitComponent()

void SCR_GadgetManagerComponent::InitComponent ( IEntity owner )

inlineprotected

Initialise component

Parameters

[in]

owner

the owner entity

Definition at line 1071 of file SCR_GadgetManagerComponent.c.

IsGadgetOwned()

bool SCR_GadgetManagerComponent::IsGadgetOwned ( SCR_GadgetComponent gadgetComp )

inlineprotected

Check whether gadget is owned by this entity

Parameters

[in]

gadgetComp

Returns

true if owned

Definition at line 401 of file SCR_GadgetManagerComponent.c.

OnActivateHeldGadget()

void SCR_GadgetManagerComponent::OnActivateHeldGadget ( )

inlineprotected

Activate held gadget.

Definition at line 307 of file SCR_GadgetManagerComponent.c.

OnControlledByPlayer()

void SCR_GadgetManagerComponent::OnControlledByPlayer ( IEntity owner, bool controlled )

inlineprotected

SCR_CharacterControllerComponent event

Parameters

[in]	owner
[in]	controlled

Definition at line 666 of file SCR_GadgetManagerComponent.c.

OnDelete()

override void SCR_GadgetManagerComponent::OnDelete ( IEntity owner )

inlineprotected

Definition at line 1179 of file SCR_GadgetManagerComponent.c.

OnEditorOpened()

void SCR_GadgetManagerComponent::OnEditorOpened ( )

inlineprotected

SCR_EditorManagerEntity event //TODO we shouldnt need this, probably needs to be dependent on camera instead.

Definition at line 766 of file SCR_GadgetManagerComponent.c.

OnGadgetADS()

void SCR_GadgetManagerComponent::OnGadgetADS ( )

inlineprotected

Input action callback.

Definition at line 825 of file SCR_GadgetManagerComponent.c.

OnGadgetADSHold()

void SCR_GadgetManagerComponent::OnGadgetADSHold ( float value, EActionTrigger reason )

inlineprotected

Input action callback

Parameters

[in]	value
[in]	reason

Definition at line 834 of file SCR_GadgetManagerComponent.c.

OnGadgetFocusStateChanged()

void SCR_GadgetManagerComponent::OnGadgetFocusStateChanged ( IEntity gadget, bool isFocused )

inlineprotected

CharacterControllerComponent event, used only for local character

Parameters

[in]	gadget
[in]	isFocused

Definition at line 740 of file SCR_GadgetManagerComponent.c.

OnGadgetInput()

void SCR_GadgetManagerComponent::OnGadgetInput ( float value, EActionTrigger reason )

inlineprotected

Input action callback

Parameters

[in]	value
[in]	reason

Definition at line 779 of file SCR_GadgetManagerComponent.c.

OnGadgetStateChanged()

void SCR_GadgetManagerComponent::OnGadgetStateChanged ( IEntity gadget, bool isInHand, bool isOnGround )

inlineprotected

CharacterControllerComponent event

Parameters

[in]	gadget
[in]	isInHand
[in]	isOnGround

Definition at line 695 of file SCR_GadgetManagerComponent.c.

OnItemAdded()

void SCR_GadgetManagerComponent::OnItemAdded ( IEntity item, BaseInventoryStorageComponent storageOwner )

inlineprotected

SCR_InventoryStorageManagerComponent, called on every add to slot, not only to inventory

Parameters

[in]	item
[in]	storageOwner

Definition at line 548 of file SCR_GadgetManagerComponent.c.

OnItemRemoved()

void SCR_GadgetManagerComponent::OnItemRemoved ( IEntity item, BaseInventoryStorageComponent storageOwner )

inlineprotected

SCR_InventoryStorageManagerComponent, called on every remove from slot, not only from inventory

Parameters

[in]	item
[in]	storageOwner

Definition at line 606 of file SCR_GadgetManagerComponent.c.

OnPauseMenu()

void SCR_GadgetManagerComponent::OnPauseMenu ( )

inlineprotected

Input action callback.

Definition at line 817 of file SCR_GadgetManagerComponent.c.

OnPlayerDeath()

void SCR_GadgetManagerComponent::OnPlayerDeath ( SCR_CharacterControllerComponent charController, IEntity instigatorEntity, notnull Instigator instigator )

inlineprotected

SCR_CharacterControllerComponent event

Parameters

[in]	charController
[in]	instigatorEntity
[in]	instigator

Definition at line 650 of file SCR_GadgetManagerComponent.c.

OnPostInit()

override void SCR_GadgetManagerComponent::OnPostInit ( IEntity owner )

inlineprotected

Definition at line 1237 of file SCR_GadgetManagerComponent.c.

RegisterInitialGadgets()

void SCR_GadgetManagerComponent::RegisterInitialGadgets ( IEntity character )

inlineprotected

Gather initial gadgets

Parameters

[in]

character

is the query target

Definition at line 895 of file SCR_GadgetManagerComponent.c.

RegisterInputs()

void SCR_GadgetManagerComponent::RegisterInputs ( )

inlineprotected

Register input actions.

Definition at line 1002 of file SCR_GadgetManagerComponent.c.

RegisterVONEntries()

void SCR_GadgetManagerComponent::RegisterVONEntries ( )

inlineprotected

Register radio gadgets into the VON system as entries.

Definition at line 940 of file SCR_GadgetManagerComponent.c.

RemoveHeldGadget()

void SCR_GadgetManagerComponent::RemoveHeldGadget ( )

inlineprotected

Remove gadget held in hand.

Definition at line 297 of file SCR_GadgetManagerComponent.c.

RPC_AskToggleGadget()

void SCR_GadgetManagerComponent::RPC_AskToggleGadget ( RplId id, bool state )

inlineprotected

Ask RPC to server for gadget toggle

Parameters

[in]	id	is unique Rpl id of the gadget
[in]	state	is desired toggle state, true: active

Definition at line 1124 of file SCR_GadgetManagerComponent.c.

RPC_DoToggleGadget()

void SCR_GadgetManagerComponent::RPC_DoToggleGadget ( RplId id, bool state )

inlineprotected

Do RPC to clients for gadget toggle

Parameters

[in]	id	is unique Rpl id of the gadget
[in]	state	is desired toggle state, true: active

Definition at line 1141 of file SCR_GadgetManagerComponent.c.

SetGadgetADS()

void SCR_GadgetManagerComponent::SetGadgetADS ( bool gadgetADS )

inlineprotected

API for setting raised gadget mode

Parameters

[in]

gadgetADS

Definition at line 842 of file SCR_GadgetManagerComponent.c.

SetGadgetMode()

void SCR_GadgetManagerComponent::SetGadgetMode ( IEntity gadget, EGadgetMode targetMode, bool doFocus = false )

inlineprotected

Set mode of a gadget When changing mode FROM EGadgetMode.IN_HAND to inventory, target should be EGadgetMode.IN_STORAGE -> it will do EGadgetMode.IN_SLOT automatically if it is slotted

Parameters

[in]	gadget	is the subject
[in]	targetMode	is the mode being switched into
[in]	doFocus	determines whether the gadget will becomes focused straight away

Definition at line 235 of file SCR_GadgetManagerComponent.c.

SetGadgetModeStashed()

void SCR_GadgetManagerComponent::SetGadgetModeStashed ( SCR_GadgetComponent gadgetComp, EGadgetMode targetMode )

inlinestaticprotected

Static method for setting gadgets to ground/storage modes for containers such as vehicles which do not have gadget manager

Parameters

[in]	gadgetComp	is the subject component
[in]	targetMode	is the mode being switched into

Definition at line 287 of file SCR_GadgetManagerComponent.c.

ToggleHeldGadget()

void SCR_GadgetManagerComponent::ToggleHeldGadget ( bool state )

inlineprotected

Toggle held gadget on/off

Parameters

[in]

state

true = ON / false = OFF

Definition at line 318 of file SCR_GadgetManagerComponent.c.

UnregisterInputs()

void SCR_GadgetManagerComponent::UnregisterInputs ( )

inlineprotected

Register input actions.

Definition at line 1025 of file SCR_GadgetManagerComponent.c.

UnregisterVONEntries()

void SCR_GadgetManagerComponent::UnregisterVONEntries ( )

inlineprotected

Definition at line 977 of file SCR_GadgetManagerComponent.c.

Update()

void SCR_GadgetManagerComponent::Update ( float timeSlice )

inlineprotected

Runs only on local client

Parameters

[in]

timeSlice

Definition at line 1190 of file SCR_GadgetManagerComponent.c.

UpdateHeldGadget()

void SCR_GadgetManagerComponent::UpdateHeldGadget ( IEntity gadget )

inlineprotected

Update currently held(in hand) gadget

Parameters

[in]

gadget

is the subject

Definition at line 451 of file SCR_GadgetManagerComponent.c.

ValidController()

bool SCR_GadgetManagerComponent::ValidController ( IEntity owner )

inlinestaticprotected

Definition at line 221 of file SCR_GadgetManagerComponent.c.

Member Data Documentation

m_aGadgetArrayMap

ref map<EGadgetType, int> SCR_GadgetManagerComponent::m_aGadgetArrayMap = new map<EGadgetType, int>()

protected

Definition at line 158 of file SCR_GadgetManagerComponent.c.

m_aInventoryGadgetTypes

ref array<ref array<SCR_GadgetComponent> > SCR_GadgetManagerComponent::m_aInventoryGadgetTypes = {}

protected

Definition at line 157 of file SCR_GadgetManagerComponent.c.

m_bIsGadgetADS

bool SCR_GadgetManagerComponent::m_bIsGadgetADS

protected

Definition at line 147 of file SCR_GadgetManagerComponent.c.

m_Controller

SCR_CharacterControllerComponent SCR_GadgetManagerComponent::m_Controller

protected

Definition at line 153 of file SCR_GadgetManagerComponent.c.

m_HeldGadget

IEntity SCR_GadgetManagerComponent::m_HeldGadget

protected

Definition at line 148 of file SCR_GadgetManagerComponent.c.

m_HeldGadgetComponent

SCR_GadgetComponent SCR_GadgetManagerComponent::m_HeldGadgetComponent

protected

Definition at line 149 of file SCR_GadgetManagerComponent.c.

m_HiddenGadgetComponent

SCR_GadgetComponent SCR_GadgetManagerComponent::m_HiddenGadgetComponent

protected

Definition at line 150 of file SCR_GadgetManagerComponent.c.

m_InputManager

InputManager SCR_GadgetManagerComponent::m_InputManager

protected

Definition at line 151 of file SCR_GadgetManagerComponent.c.

m_InventoryStorageMgr

SCR_InventoryStorageManagerComponent SCR_GadgetManagerComponent::m_InventoryStorageMgr

protected

Definition at line 152 of file SCR_GadgetManagerComponent.c.

m_LastHeldGadgetComponent

SCR_GadgetComponent SCR_GadgetManagerComponent::m_LastHeldGadgetComponent

protected

Definition at line 161 of file SCR_GadgetManagerComponent.c.

m_pInvokersState

ref SCR_GadgetInvokersInitState SCR_GadgetManagerComponent::m_pInvokersState = new SCR_GadgetInvokersInitState(this)

protected

Definition at line 155 of file SCR_GadgetManagerComponent.c.

m_VONController

SCR_VONController SCR_GadgetManagerComponent::m_VONController

protected

Definition at line 154 of file SCR_GadgetManagerComponent.c.

s_OnGadgetInitDone

ref ScriptInvoker<IEntity, SCR_GadgetManagerComponent> SCR_GadgetManagerComponent::s_OnGadgetInitDone = new ScriptInvoker()

staticprotected

Definition at line 145 of file SCR_GadgetManagerComponent.c.

---

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

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