Inheritance diagram for SCR_SupportStationGadgetComponent:

[legend]

Public Member Functions
int	GetSupportStationTypes (out notnull array< ESupportStationType > types)

bool	IsGadgetOfSupportStationType (ESupportStationType type)

bool	InUseAnimationLoop (IEntity character)

void	StartGadgetAnimation (notnull IEntity character, int animationCommand, notnull SCR_ScriptedUserAction action)
	Start the animation if animation 'in' and looping than it will go to the loop animation and StopGadgetAnimation() needs to be called.

void	StopGadgetAnimation (notnull IEntity character, int animationCommand)
	Start the animation if animation 'out'.

SCR_BaseSupportStationComponent	GetSupportStation (ESupportStationType supportStationType)
	Get action support station of given type.

override void	EOnInit (IEntity owner)

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.

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)

Static Public Member Functions
static SCR_BaseSupportStationComponent	GetHeldSupportStation (ESupportStationType supportStationType, notnull IEntity character)
	Get held gadget of given type from character.

static SCR_SupportStationGadgetComponent	GetHeldSupportStationGadget (ESupportStationType supportStationType, notnull IEntity character)
	Get support station of the given type from held gadget of the character.

static bool	GetHeldSupportStationAndGadget (ESupportStationType supportStationType, notnull IEntity character, out SCR_BaseSupportStationComponent supportStation, out SCR_SupportStationGadgetComponent supportStationGadget)
	Get support station of the given type from held gadget as well as Support statioon gadget.

Protected Member Functions
void	AnimateCharacterWithGadget (notnull IEntity character, int animationCMD, vector animationTarget=vector.Zero)

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
ref array< ESupportStationType >	m_aSupportStationTypes

bool	m_bUseActionAsAnimationTarget

ref map< ESupportStationType, SCR_BaseSupportStationComponent >	m_mSupportStations = new map<ESupportStationType, SCR_BaseSupportStationComponent>()

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

Member Function Documentation

◆ AnimateCharacterWithGadget()

void SCR_SupportStationGadgetComponent.AnimateCharacterWithGadget	(	notnull IEntity	character,
		int	animationCMD,
		vector	animationTarget = `vector::Zero`
	)

protected

◆ EOnInit()

override void SCR_SupportStationGadgetComponent.EOnInit ( IEntity owner )

◆ GetHeldSupportStation()

static SCR_BaseSupportStationComponent SCR_SupportStationGadgetComponent.GetHeldSupportStation	(	ESupportStationType	supportStationType,
		notnull IEntity	character
	)

static

Get held gadget of given type from character.

Parameters

[in]	supportStationType	Type of gadget to find
[in]	character	Character to find gadget on

Returns: Support Station gadget component (if any)

◆ GetHeldSupportStationAndGadget()

static bool SCR_SupportStationGadgetComponent.GetHeldSupportStationAndGadget	(	ESupportStationType	supportStationType,
		notnull IEntity	character,
		out SCR_BaseSupportStationComponent	supportStation,
		out SCR_SupportStationGadgetComponent	supportStationGadget
	)

static

Get support station of the given type from held gadget as well as Support statioon gadget.

Parameters

[in]	supportStationType	Type of support station and gadget to find
[in]	character	Character to get support station gadget off
[out]	supportStation	Found support station
[out]	supportStationGadget	Found gadget

Returns: True if both Support station and gadget were found of given type

◆ GetHeldSupportStationGadget()

static SCR_SupportStationGadgetComponent SCR_SupportStationGadgetComponent.GetHeldSupportStationGadget	(	ESupportStationType	supportStationType,
		notnull IEntity	character
	)

static

Get support station of the given type from held gadget of the character.

Parameters

[in]	supportStationType	Type of support station to find
[in]	character	Character to get support station gadget off

Returns: Support Station component (if any)

◆ GetSupportStation()

SCR_BaseSupportStationComponent SCR_SupportStationGadgetComponent.GetSupportStation ( ESupportStationType supportStationType )

Get action support station of given type.

Parameters

[in] supportStationType Type of gadget to find

Returns: Support Station on gadget (if any)

◆ GetSupportStationTypes()

int SCR_SupportStationGadgetComponent.GetSupportStationTypes ( out notnull array< ESupportStationType > types )

Parameters

[out] Get List of all support station types this gadget has

Returns: Count of support station type array

◆ GetType()

override EGadgetType SCR_SupportStationGadgetComponent.GetType ( )

Get gadget type.

Returns: Returns gadget type

Implements SCR_GadgetComponent.

◆ InUseAnimationLoop()

bool SCR_SupportStationGadgetComponent.InUseAnimationLoop ( IEntity character )

Parameters

[in] character Character that animates

Returns: True if character is currently in an animation loop

◆ IsGadgetOfSupportStationType()

bool SCR_SupportStationGadgetComponent.IsGadgetOfSupportStationType ( ESupportStationType type )

Parameters

[in] Type to check

Returns: True if gadget is of the given type

◆ StartGadgetAnimation()

void SCR_SupportStationGadgetComponent.StartGadgetAnimation	(	notnull IEntity	character,
		int	animationCommand,
		notnull SCR_ScriptedUserAction	action
	)

Start the animation if animation 'in' and looping than it will go to the loop animation and StopGadgetAnimation() needs to be called.

Parameters

[in]	character	Character to animate
[in]	animationCommand
[in]	action	Action that is used for the animation

◆ StopGadgetAnimation()

void SCR_SupportStationGadgetComponent.StopGadgetAnimation	(	notnull IEntity	character,
		int	animationCommand
	)

Start the animation if animation 'out'.

Used when animation is looping

Parameters

[in]	character	Character to animate
[in]	animationCommand

Member Data Documentation

◆ m_aSupportStationTypes

ref array<ESupportStationType> SCR_SupportStationGadgetComponent.m_aSupportStationTypes

protected

◆ m_bUseActionAsAnimationTarget

bool SCR_SupportStationGadgetComponent.m_bUseActionAsAnimationTarget

protected

◆ m_mSupportStations

ref map<ESupportStationType, SCR_BaseSupportStationComponent> SCR_SupportStationGadgetComponent.m_mSupportStations = new map<ESupportStationType, SCR_BaseSupportStationComponent>()

protected

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

Game/Components/Gadgets/SCR_SupportStationGadgetComponent.c

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ AnimateCharacterWithGadget()

◆ EOnInit()

◆ GetHeldSupportStation()

◆ GetHeldSupportStationAndGadget()

◆ GetHeldSupportStationGadget()

◆ GetSupportStation()

◆ GetSupportStationTypes()

◆ GetType()

◆ InUseAnimationLoop()

◆ IsGadgetOfSupportStationType()

◆ StartGadgetAnimation()

◆ StopGadgetAnimation()

Member Data Documentation

◆ m_aSupportStationTypes

◆ m_bUseActionAsAnimationTarget

◆ m_mSupportStations