Inheritance diagram for SCR_BaseUseSupportStationAction:

Protected Member Functions
ESupportStationType	GetSupportStationType ()
SCR_BaseSupportStationComponent	GetClosestValidSupportStation (IEntity actionOwner, IEntity actionUser, out ESupportStationReasonInvalid reasonInvalid=0)
override bool	CanBeShownScript (IEntity user)
bool	CanShowDestroyed ()
override bool	CanBePerformedScript (IEntity user)
void	SetCanPerform (bool canPerform, ESupportStationReasonInvalid reasonInvalid)
bool	CanPerform (out ESupportStationReasonInvalid cannotPerformReason)
void	CanBePerformedUpdate (IEntity user)
LocalizedString	GetInvalidPerformReasonString (ESupportStationReasonInvalid reasonInvalid)
void	ResetReferencesOnServer ()
override void	PerformContinuousAction (IEntity pOwnerEntity, IEntity pUserEntity, float timeSlice)
override void	PerformAction (IEntity pOwnerEntity, IEntity pUserEntity)
override void	Init (IEntity pOwnerEntity, GenericComponent pManagerComponent)
void	DelayedInit (IEntity owner)
override bool	CanBroadcastScript ()
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.
int	GetSupportStationSuppliesOnUse ()
override void	OnActionStart (IEntity pUserEntity)
bool	IsUserInVehicle (notnull IEntity user)
override void	OnActionCanceled (IEntity pOwnerEntity, IEntity pUserEntity)
string	GetActionStringParam ()
override void	OnActionSelected ()
override void	OnActionDeselected ()
override bool	GetActionNameScript (out string outName)
void	~SCR_BaseUseSupportStationAction ()

Protected Attributes
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
const int	DELAY_CAN_PERFORM = 500
int	m_iSuppliesOnUse
int	m_iAvailableSupplies
bool	m_bCanPerform
ESupportStationReasonInvalid	m_eCannotPerformReason
SCR_SupportStationGadgetComponent	m_SupportStationGadget
bool	m_bOnActionAnimationInDone
const float	MAXIMUM_VEHICLE_SPEED_FOR_INTERACTION_SQ = 0.04
const LocalizedString	INVALID_TARGET_VEHICLE_SPEED = "#AR-SupportStation_ActionInvalid_IsTargetMoving"
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"

Detailed Description

Definition at line 1 of file SCR_BaseUseSupportStationAction.c.

Constructor & Destructor Documentation

◆ ~SCR_BaseUseSupportStationAction()

void SCR_BaseUseSupportStationAction::~SCR_BaseUseSupportStationAction ( )

inlineprotected

Definition at line 619 of file SCR_BaseUseSupportStationAction.c.

Member Function Documentation

◆ AllowGetSupportStationFromGadget()

bool SCR_BaseUseSupportStationAction::AllowGetSupportStationFromGadget ( )

inlineprotected

If true it allows getting the support station from gadgets.

Definition at line 459 of file SCR_BaseUseSupportStationAction.c.

◆ CanBePerformedScript()

override bool SCR_BaseUseSupportStationAction::CanBePerformedScript ( IEntity user )

inlineprotected

Definition at line 194 of file SCR_BaseUseSupportStationAction.c.

◆ CanBePerformedUpdate()

void SCR_BaseUseSupportStationAction::CanBePerformedUpdate ( IEntity user )

inlineprotected

Definition at line 268 of file SCR_BaseUseSupportStationAction.c.

◆ CanBeShownScript()

override bool SCR_BaseUseSupportStationAction::CanBeShownScript ( IEntity user )

inlineprotected

Definition at line 151 of file SCR_BaseUseSupportStationAction.c.

◆ CanBroadcastScript()

override bool SCR_BaseUseSupportStationAction::CanBroadcastScript ( )

inlineprotected

Definition at line 419 of file SCR_BaseUseSupportStationAction.c.

◆ CanHaveMultipleUsers()

bool SCR_BaseUseSupportStationAction::CanHaveMultipleUsers ( )

inlineprotected

Definition at line 425 of file SCR_BaseUseSupportStationAction.c.

◆ CanPerform()

bool SCR_BaseUseSupportStationAction::CanPerform ( out ESupportStationReasonInvalid cannotPerformReason )

inlineprotected

Definition at line 260 of file SCR_BaseUseSupportStationAction.c.

◆ CanShowDestroyed()

bool SCR_BaseUseSupportStationAction::CanShowDestroyed ( )

inlineprotected

Definition at line 174 of file SCR_BaseUseSupportStationAction.c.

◆ DelayedInit()

void SCR_BaseUseSupportStationAction::DelayedInit ( IEntity owner )

inlineprotected

Definition at line 401 of file SCR_BaseUseSupportStationAction.c.

◆ GetActionDecimalCount()

int SCR_BaseUseSupportStationAction::GetActionDecimalCount ( )

inlineprotected

Definition at line 438 of file SCR_BaseUseSupportStationAction.c.

◆ GetActionNameScript()

override bool SCR_BaseUseSupportStationAction::GetActionNameScript ( out string outName )

inlineprotected

Definition at line 555 of file SCR_BaseUseSupportStationAction.c.

◆ GetActionPercentage()

float SCR_BaseUseSupportStationAction::GetActionPercentage ( )

inlineprotected

If not -1 it will show the percentage on the current action.

Definition at line 432 of file SCR_BaseUseSupportStationAction.c.

◆ GetActionStringParam()

string SCR_BaseUseSupportStationAction::GetActionStringParam ( )

inlineprotected

Definition at line 533 of file SCR_BaseUseSupportStationAction.c.

◆ GetClosestValidSupportStation()

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

inlineprotected

Definition at line 77 of file SCR_BaseUseSupportStationAction.c.

◆ GetCurrentActionUser()

IEntity SCR_BaseUseSupportStationAction::GetCurrentActionUser ( )

inlineprotected

Get which entity is currently activly using the action.

Definition at line 466 of file SCR_BaseUseSupportStationAction.c.

◆ GetInvalidPerformReasonString()

LocalizedString SCR_BaseUseSupportStationAction::GetInvalidPerformReasonString ( ESupportStationReasonInvalid reasonInvalid )

inlineprotected

Definition at line 276 of file SCR_BaseUseSupportStationAction.c.

◆ GetSupportStationSuppliesOnUse()

int SCR_BaseUseSupportStationAction::GetSupportStationSuppliesOnUse ( )

inlineprotected

Definition at line 472 of file SCR_BaseUseSupportStationAction.c.

◆ GetSupportStationType()

ESupportStationType SCR_BaseUseSupportStationAction::GetSupportStationType ( )

inlineprotected

Definition at line 69 of file SCR_BaseUseSupportStationAction.c.

◆ Init()

override void SCR_BaseUseSupportStationAction::Init	(	IEntity	pOwnerEntity,
		GenericComponent	pManagerComponent )

inlineprotected

Definition at line 380 of file SCR_BaseUseSupportStationAction.c.

◆ IsUserInVehicle()

bool SCR_BaseUseSupportStationAction::IsUserInVehicle ( notnull IEntity user )

inlineprotected

Definition at line 511 of file SCR_BaseUseSupportStationAction.c.

◆ OnActionCanceled()

override void SCR_BaseUseSupportStationAction::OnActionCanceled	(	IEntity	pOwnerEntity,
		IEntity	pUserEntity )

inlineprotected

Definition at line 518 of file SCR_BaseUseSupportStationAction.c.

◆ OnActionDeselected()

override void SCR_BaseUseSupportStationAction::OnActionDeselected ( )

inlineprotected

Definition at line 548 of file SCR_BaseUseSupportStationAction.c.

◆ OnActionSelected()

override void SCR_BaseUseSupportStationAction::OnActionSelected ( )

inlineprotected

Definition at line 539 of file SCR_BaseUseSupportStationAction.c.

◆ OnActionStart()

override void SCR_BaseUseSupportStationAction::OnActionStart ( IEntity pUserEntity )

inlineprotected

Definition at line 478 of file SCR_BaseUseSupportStationAction.c.

◆ PerformAction()

override void SCR_BaseUseSupportStationAction::PerformAction	(	IEntity	pOwnerEntity,
		IEntity	pUserEntity )

inlineprotected

Definition at line 340 of file SCR_BaseUseSupportStationAction.c.

◆ PerformContinuousAction()

override void SCR_BaseUseSupportStationAction::PerformContinuousAction	(	IEntity	pOwnerEntity,
		IEntity	pUserEntity,
		float	timeSlice )

inlineprotected

Definition at line 313 of file SCR_BaseUseSupportStationAction.c.

◆ PrioritizeHeldGadget()

bool SCR_BaseUseSupportStationAction::PrioritizeHeldGadget ( )

inlineprotected

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.

Definition at line 452 of file SCR_BaseUseSupportStationAction.c.