SCR_SupportStationGadgetComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_SupportStationGadgetComponentClass

Functions
SCR_SupportStationGadgetComponentClass SCR_GadgetComponentClass	Attribute (desc:"Which support station this gadget belongs to", uiwidget:UIWidgets.SearchComboBox, enums:ParamEnumArray.FromEnum(ESupportStationType), category:"Support Gadget")] protected ref array< ESupportStationType > m_aSupportStationTypes
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)
void	StopGadgetAnimation (notnull IEntity character, int animationCommand)
protected void	AnimateCharacterWithGadget (notnull IEntity character, int animationCMD, vector animationTarget=vector.Zero)
SCR_BaseSupportStationComponent	GetSupportStation (ESupportStationType supportStationType)
override void	EOnInit (IEntity owner)
override EGadgetType	GetType ()

Variables
protected bool	m_bUseActionAsAnimationTarget
protected ref map< ESupportStationType, SCR_BaseSupportStationComponent >	m_mSupportStations = new map<ESupportStationType, SCR_BaseSupportStationComponent>()

Function Documentation

AnimateCharacterWithGadget()

protected void AnimateCharacterWithGadget	(	notnull IEntity	character,
		int	animationCMD,
		vector	animationTarget = vector.Zero
	)

Definition at line 98 of file SCR_SupportStationGadgetComponent.c.

Attribute()

SCR_SupportStationGadgetComponentClass SCR_GadgetComponentClass Attribute	(	desc:"Which support station this gadget belongs to"	,
		uiwidget:UIWidgets.	SearchComboBox,
		enums:ParamEnumArray.	FromEnumESupportStationType,
		category:"Support Gadget"
	)

GetSupportStation()

SCR_BaseSupportStationComponent 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)

Definition at line 142 of file SCR_SupportStationGadgetComponent.c.

GetSupportStationTypes()

int 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

Definition at line 19 of file SCR_SupportStationGadgetComponent.c.

GetType()

override EGadgetType GetType

(

)

Definition at line 236 of file SCR_SupportStationGadgetComponent.c.

InUseAnimationLoop()

bool InUseAnimationLoop

(

IEntity

character

)

Parameters

[in]

character

Character that animates

Returns

True if character is currently in an animation loop

Definition at line 37 of file SCR_SupportStationGadgetComponent.c.

IsGadgetOfSupportStationType()

bool IsGadgetOfSupportStationType

(

ESupportStationType

type

)

Parameters

[in]

Type

to check

Returns

True if gadget is of the given type

Definition at line 29 of file SCR_SupportStationGadgetComponent.c.

StartGadgetAnimation()

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

Parameters

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

Definition at line 60 of file SCR_SupportStationGadgetComponent.c.

StopGadgetAnimation()

void 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

Definition at line 75 of file SCR_SupportStationGadgetComponent.c.

Variable Documentation

m_bUseActionAsAnimationTarget

protected bool m_bUseActionAsAnimationTarget

Definition at line 12 of file SCR_SupportStationGadgetComponent.c.

m_mSupportStations

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

Definition at line 14 of file SCR_SupportStationGadgetComponent.c.