SCR_DrainFuelUserAction Interface Reference

Allows players to drain an entity with a fuel manager. Use with care as it might create a lot of grieving opertunity. More...

Inheritance diagram for SCR_DrainFuelUserAction:

Public Member Functions
override void	Init (IEntity pOwnerEntity, GenericComponent pManagerComponent)
	Called when object is initialized and registered to actions manager.
override string	GetCannotPerformReason ()
	Returns the reason why action couldn't be performed.
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?
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	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.
override void	PerformAction (IEntity pOwnerEntity, IEntity pUserEntity)
	Called when someone tries to perform the action, user entity is typically character.
Public Member Functions inherited from SCR_ScriptedUserAction
override bool	CanBeShownScript (IEntity user)
	Can this entity be shown in the UI by the provided user entity?
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 ()
override void	OnActionStart (IEntity pUserEntity)
	Method called from scripted interaction handler when an action is started (progress bar appeared)
Public Member Functions inherited from ScriptedUserAction
void	Init (IEntity pOwnerEntity, GenericComponent pManagerComponent)
	Called when object is initialized and registered to actions manager.
void	PerformAction (IEntity pOwnerEntity, IEntity pUserEntity)
	Called when someone tries to perform the action, user entity is typically character.
void	PerformContinuousAction (IEntity pOwnerEntity, IEntity pUserEntity, float timeSlice)
	Called when someone tries to perform the continuous action, user entity is typically character.
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.
void	OnActionCanceled (IEntity pOwnerEntity, IEntity pUserEntity)
	Method called when the action is interrupted/canceled.
void	OnActionStart (IEntity pUserEntity)
	Method called from scripted interaction handler when an action is started (progress bar appeared)
bool	GetActionNameScript (out string outName)
	If overridden and true is returned, outName is returned when BaseUserAction.GetActionName is called.
bool	GetActionDescriptionScript (out string outName)
	If overridden and true is returned, outName is returned when BaseUserAction.GetActionDescription is called.
bool	CanBePerformedScript (IEntity user)
	Can this action be performed by the provided user entity?
bool	CanBeShownScript (IEntity user)
	Can this entity be shown in the UI by the provided user entity?
bool	HasLocalEffectOnlyScript ()
	Does this action only have client side effect?
bool	CanBroadcastScript ()
	If HasLocalEffectOnly() is false this method tells if the server is supposed to broadcast this action to clients.
float	GetActionProgressScript (float fProgress, float timeSlice)
	Returns the progress of this action in seconds.
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 ()

Protected Attributes
LocalizedString	m_sCannotPerformNoFuel
IEntity	m_ActionUser
bool	m_bIsMaster
bool	m_bExecutingAction
SCR_FuelManagerComponent	m_FuelManager
SCR_DamageManagerComponent	m_DamageComponent
Protected Attributes inherited from SCR_BaseAudioScriptedUserAction
string	m_sActionSoundEffectEventName
ResourceName	m_sActionSoundEffectFile
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.
Protected Member Functions inherited from SCR_BaseAudioScriptedUserAction
void	PlayActionSoundEffect (IEntity pOwnerEntity)
Protected Member Functions inherited from SCR_ScriptedUserAction
bool	IsSameVehicleOrNone (notnull IEntity user)
bool	LoopActionUpdate (float timeSlice)
override void	OnActionSelected ()
	Callback for when action is selected by the local player and the local player ONLY.
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.
void	OnActionSelected ()
	Callback for when action is selected by the local player and the local player ONLY.
void	OnActionDeselected ()
	Callback for when action is deselected by the local player and the local player ONLY.

Detailed Description

Allows players to drain an entity with a fuel manager. Use with care as it might create a lot of grieving opertunity.

Member Function Documentation

CanBePerformedScript()

override bool SCR_DrainFuelUserAction.CanBePerformedScript

(

IEntity

user

)

Can this action be performed by the provided user entity?

Implements ScriptedUserAction.

CanBeShownScript()

override bool SCR_DrainFuelUserAction.CanBeShownScript

(

IEntity

user

)

Can this entity be shown in the UI by the provided user entity?

Implements SCR_ScriptedUserAction.

GetActionNameScript()

override bool SCR_DrainFuelUserAction.GetActionNameScript

(

out string

outName

)

If overridden and true is returned, outName is returned when BaseUserAction.GetActionName is called.

If not overridden or false is returned the default value from UIInfo is taken (or empty string if no UI info exists)

Implements ScriptedUserAction.

GetCannotPerformReason()

override string SCR_DrainFuelUserAction.GetCannotPerformReason

(

)

Returns the reason why action couldn't be performed.

It is valid only within and after CanBePerformed is called

Implements BaseUserAction.

Init()

override void SCR_DrainFuelUserAction.Init	(	IEntity	pOwnerEntity,
		GenericComponent	pManagerComponent
	)

Called when object is initialized and registered to actions manager.

Implements ScriptedUserAction.

OnActionCanceled()

override void SCR_DrainFuelUserAction.OnActionCanceled	(	IEntity	pOwnerEntity,
		IEntity	pUserEntity
	)

Method called when the action is interrupted/canceled.

Parameters

pUserEntity

The entity that was performing this action prior to interruption

Implements ScriptedUserAction.

OnActionStart()

override void SCR_DrainFuelUserAction.OnActionStart

(

IEntity

pUserEntity

)

Method called from scripted interaction handler when an action is started (progress bar appeared)

Parameters

pUserEntity

The entity that started performing this action

Implements SCR_ScriptedUserAction.

PerformAction()

override void SCR_DrainFuelUserAction.PerformAction	(	IEntity	pOwnerEntity,
		IEntity	pUserEntity
	)

Called when someone tries to perform the action, user entity is typically character.

Implements SCR_BaseAudioScriptedUserAction.

PerformContinuousAction()

override void SCR_DrainFuelUserAction.PerformContinuousAction	(	IEntity	pOwnerEntity,
		IEntity	pUserEntity,
		float	timeSlice
	)

Called when someone tries to perform the continuous action, user entity is typically character.

Implements ScriptedUserAction.

Member Data Documentation

m_ActionUser

IEntity SCR_DrainFuelUserAction.m_ActionUser

protected

m_bExecutingAction

bool SCR_DrainFuelUserAction.m_bExecutingAction

protected

m_bIsMaster

bool SCR_DrainFuelUserAction.m_bIsMaster

protected

m_DamageComponent

SCR_DamageManagerComponent SCR_DrainFuelUserAction.m_DamageComponent

protected

m_FuelManager

SCR_FuelManagerComponent SCR_DrainFuelUserAction.m_FuelManager

protected

m_sCannotPerformNoFuel

LocalizedString SCR_DrainFuelUserAction.m_sCannotPerformNoFuel

protected

---

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

• Game/UserActions/SupportStations/SCR_DrainFuelUserAction.c