Inheritance diagram for SCR_BaseItemHolderSupportStationAction:

Public Member Functions
ResourceName	GetItemPrefab ()

Public Member Functions inherited from SCR_BaseUseSupportStationAction
override bool	CanBeShownScript (IEntity user)
	Can this entity be shown in the UI by the provided user entity?

override bool	CanBePerformedScript (IEntity user)
	Can this action be performed by the provided user entity?

bool	CanPerform (out ESupportStationReasonInvalid cannotPerformReason)

override void	PerformContinuousAction (IEntity pOwnerEntity, IEntity pUserEntity, float timeSlice)
	Called when someone tries to perform the continuous action, user entity is typically character.

override void	PerformAction (IEntity pOwnerEntity, IEntity pUserEntity)
	Called when someone tries to perform the action, user entity is typically character.

override void	Init (IEntity pOwnerEntity, GenericComponent pManagerComponent)
	Called when object is initialized and registered to actions manager.

override bool	CanBroadcastScript ()
	If HasLocalEffectOnly() is false this method tells if the server is supposed to broadcast this action to clients.

override void	OnActionStart (IEntity pUserEntity)
	Method called from scripted interaction handler when an action is started (progress bar appeared)

override void	OnActionCanceled (IEntity pOwnerEntity, IEntity pUserEntity)
	Method called when the action is interrupted/canceled.

override bool	GetActionNameScript (out string outName)
	If overridden and true is returned, outName is returned when BaseUserAction.GetActionName is called.

void	~SCR_BaseUseSupportStationAction ()

Public Member Functions inherited from SCR_ScriptedUserAction
vector	GetLocalPositionAction ()
	Get action local position Used for such things like playing audio at the correct location on action use.

vector	GetWorldPositionAction ()
	Get action world position Used for such things like playing audio at the correct location on action use.

override float	GetActionProgressScript (float fProgress, float timeSlice)

bool	IsActionLooping ()

float	GetLoopActionHoldDuration ()

Public Member Functions inherited from ScriptedUserAction
void	OnConfirmed (IEntity pUserEntity)
	If action passed as callback OnConfirmed will be called when reached execution, user entity is typically character.

void	OnRejected (IEntity pUserEntity)
	If action passed as callback OnRejected will be called when execution was rejected, user entity is typically character.

bool	GetActionDescriptionScript (out string outName)
	If overridden and true is returned, outName is returned when BaseUserAction.GetActionDescription is called.

bool	HasLocalEffectOnlyScript ()
	Does this action only have client side effect?

Public Member Functions inherited from BaseUserAction
void	SetCannotPerformReason (string reason)
	Sets the reason why action couldn't be performed.

string	GetCannotPerformReason ()
	Returns the reason why action couldn't be performed.

proto external int	GetContextIndex (string sContextName)
	Returns the index of the context this action is registered in as or -1 if none.

proto external void	SetActiveContext (UserActionContext context)
	Setter for m_pActiveContext.

proto external UserActionContext	GetActiveContext ()
	Getter for m_pActiveContext.

proto external bool	CanBePerformed (IEntity user)
	Can this action be performed by the user?

proto external bool	CanBeShown (IEntity user)
	Can this action be shown in the UI for the user?

proto external bool	HasLocalEffectOnly ()
	Does this action only have client side effect?

proto external bool	CanBroadcast ()
	If HasLocalEffectOnly() is false this method tells if the server is supposed to broadcast this action to clients.

proto external bool	ShouldPerformPerFrame ()
	Should this action be performed every frame the input action is triggered?

proto external string	GetActionName ()
	Return the name of this action.

proto external string	GetActionDescription ()
	Return the description of this action.

proto external float	GetVisibilityRange ()
	Returns the visibility range of this action in metres.

proto external void	SetActionDuration (float duration)
	Sets the duration of this action in seconds.

proto external float	GetActionDuration ()
	Returns the duration of this action in seconds.

proto external float	GetActionProgress (float fProgress, float timeSlice)
	Returns the progress of this action in seconds.

proto external bool	IsInProgress ()
	Returns true while continuous or timed action is being used.

proto external UIInfo	GetUIInfo ()
	Returns the UIInfo set for this user action or null if none.

proto external IEntity	GetOwner ()
	Returns the parent entity of this action.

proto external bool	CanAggregate ()
	Whether action can be aggregated by name, this is a temp workaround for localization.

proto external int	GetActionID ()
	Returns the ID with which this action is registered in its parent ActionsManagerComponent.

proto external void	SetSendActionDataFlag ()
	Used to ask to send action data again during continuous action.

proto external ActionsManagerComponent	GetActionsManager ()

proto external void	SetActionEnabled_S (bool enable)
	Action can be enabled/disabled by the server. Disabled actions return false for CanBeShown(). Has no effect when called from the client.

proto external bool	WasDisabledByServer ()
	Was the action disabled by the server?

Protected Member Functions
override LocalizedString	GetInvalidPerformReasonString (ESupportStationReasonInvalid reasonInvalid)

override void	DelayedInit (IEntity owner)

void	SetItemName ()

Protected Member Functions inherited from SCR_BaseUseSupportStationAction
ESupportStationType	GetSupportStationType ()

SCR_BaseSupportStationComponent	GetClosestValidSupportStation (IEntity actionOwner, IEntity actionUser, out ESupportStationReasonInvalid reasonInvalid=0)

bool	CanShowDestroyed ()

void	SetCanPerform (bool canPerform, ESupportStationReasonInvalid reasonInvalid)

void	CanBePerformedUpdate (IEntity user)

void	ResetReferencesOnServer ()

bool	CanHaveMultipleUsers ()

float	GetActionPercentage ()
	If not -1 it will show the percentage on the current action.

int	GetActionDecimalCount ()

bool	RequiresGadget ()
	If true will only show the action if the player is holding the correct support station gadget.

bool	PrioritizeHeldGadget ()
	If true will always take support station from held gadget and skip any other checks if a held support station is found. RequiresGadget() is not required to be true.

bool	AllowGetSupportStationFromGadget ()
	If true it allows getting the support station from gadgets.

IEntity	GetCurrentActionUser ()
	Get which entity is currently activly using the action.

bool	IsUserInVehicle (notnull IEntity user)

string	GetActionStringParam ()

override void	OnActionSelected ()
	Callback for when action is selected by the local player and the local player ONLY.

override void	OnActionDeselected ()
	Callback for when action is deselected by the local player and the local player ONLY.

Protected Member Functions inherited from SCR_ScriptedUserAction
bool	IsSameVehicleOrNone (notnull IEntity user)

bool	LoopActionUpdate (float timeSlice)

Protected Member Functions inherited from BaseUserAction
bool	OnRplSave (ScriptBitWriter writer)

bool	OnRplLoad (ScriptBitReader reader)

bool	OnSaveActionData (ScriptBitWriter writer)
	Before performing the action the caller can store some data in it which is delivered to others.

bool	OnLoadActionData (ScriptBitReader reader)
	If the one performing the action packed some data in it everybody receiving the action.

Protected Attributes
ref SCR_ResupplySupportStationData	m_ResupplyData

LocalizedString	m_sInvalidItemNotInStorage

ResourceName	m_sItemPrefab

string	m_sItemName = "MISSING NAME OR INVALID PREFAB"

Protected Attributes inherited from SCR_BaseUseSupportStationAction
LocalizedString	m_sInvalidRangeActionReason

LocalizedString	m_sInvalidDestroyedActionReason

LocalizedString	m_sInvalidFactionActionReason

LocalizedString	m_sInvalidSuppliesActionReason

LocalizedString	m_sInvalidNoSupplyStorageSpaceActionReason

LocalizedString	m_sInvalidMovingActionReason

LocalizedString	m_sInvalidDisabledActionReason

bool	m_bShowSupplyCostOnAction

bool	m_bAllowCheckChildrenSupportStation

int	m_iGadgetAnimationCommand

bool	m_bDoesGadgetAnimationLoop

bool	m_bAnimateGadgetInVehicle

bool	m_bIsMaster

bool	m_bActionActive

IEntity	m_ActionUser

SCR_BaseSupportStationComponent	m_ActionOwnerSupportStationComponent

SCR_BaseSupportStationComponent	m_SupportStationComponent

BaseWorld	m_World

float	m_fLastCheckedCanPerform = 0

bool	m_bSupportStationWasNull = false

int	m_iSuppliesOnUse

int	m_iAvailableSupplies

bool	m_bCanPerform

ESupportStationReasonInvalid	m_eCannotPerformReason

SCR_SupportStationGadgetComponent	m_SupportStationGadget

bool	m_bOnActionAnimationInDone

Protected Attributes inherited from SCR_ScriptedUserAction
bool	m_bLoopAction

float	m_fLoopActionHoldDuration

bool	m_bLowerWeaponOnUse

EUserActionInVehicleState	m_eShownInVehicleState

bool	m_bSameVehicleOnly

UserActionContext	m_LastUserActionContext

float	m_fLoopProgress

float	m_fLoopProgressSmoothVelocity

Protected Attributes inherited from BaseUserAction
string	m_sCannotPerformReason
	The reason why action cannot be performed.

Additional Inherited Members
Public Attributes inherited from BaseUserAction
string	ActionNameParams [9]
	Can be filled in scripts to be used as params when name is being formatted when displayed in UI.

Static Protected Attributes inherited from SCR_BaseUseSupportStationAction
const int	DELAY_CAN_PERFORM = 500

const LocalizedString	ACTION_WITH_SUPPLYCOST_FORMATTING = "#AR-ActionFormat_SupplyCost"

const LocalizedString	ACTION_WITH_SUPPLYGAIN_FORMATTING = "#AR-ActionFormat_SupplyGain"

const LocalizedString	ACTION_WITH_PARAM_FORMATTING = "#AR-SupportStation_ActionFormat_WithParam"

const LocalizedString	ACTION_PERCENTAGE_FORMATTING = "#AR-SupportStation_ActionFormat_Percentage"

Member Function Documentation

◆ DelayedInit()

override void SCR_BaseItemHolderSupportStationAction.DelayedInit ( IEntity owner )

protected

Implements SCR_BaseUseSupportStationAction.

Implemented in SCR_AttachPylonSupportStationAction, SCR_BaseResupplySupportStationAction, SCR_ResupplyOtherSupportStationAction, SCR_ResupplyRocketPodSupportStationAction, SCR_ResupplyTurretBeltSupportStationAction, and SCR_ResupplyVehicleWeaponSupportStationAction.

◆ GetInvalidPerformReasonString()

override LocalizedString SCR_BaseItemHolderSupportStationAction.GetInvalidPerformReasonString ( ESupportStationReasonInvalid reasonInvalid )

protected

Implements SCR_BaseUseSupportStationAction.

Implemented in SCR_BaseResupplySupportStationAction, and SCR_ResupplyVehicleWeaponSupportStationAction.

◆ GetItemPrefab()

ResourceName SCR_BaseItemHolderSupportStationAction.GetItemPrefab ( )

◆ SetItemName()

void SCR_BaseItemHolderSupportStationAction.SetItemName ( )

protected

Member Data Documentation

◆ m_ResupplyData

ref SCR_ResupplySupportStationData SCR_BaseItemHolderSupportStationAction.m_ResupplyData

protected

◆ m_sInvalidItemNotInStorage

LocalizedString SCR_BaseItemHolderSupportStationAction.m_sInvalidItemNotInStorage

protected

◆ m_sItemName

string SCR_BaseItemHolderSupportStationAction.m_sItemName = "MISSING NAME OR INVALID PREFAB"

protected

◆ m_sItemPrefab

ResourceName SCR_BaseItemHolderSupportStationAction.m_sItemPrefab

protected

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

Game/UserActions/SupportStations/SCR_BaseItemHolderSupportStationAction.c

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ DelayedInit()

◆ GetInvalidPerformReasonString()

◆ GetItemPrefab()

◆ SetItemName()

Member Data Documentation

◆ m_ResupplyData

◆ m_sInvalidItemNotInStorage

◆ m_sItemName

◆ m_sItemPrefab