SCR_CatalogSpawnerUserAction Interface Reference

Action to spawn entities using the ActionsManagerComponent. More...

Inheritance diagram for SCR_CatalogSpawnerUserAction:

Public Member Functions
void	SetSpawnerData (SCR_EntityCatalogEntry entityData)
override bool	HasLocalEffectOnlyScript ()
	Does this action only have client side effect?
override void	Init (IEntity pOwnerEntity, GenericComponent pManagerComponent)
	Called when object is initialized and registered to actions manager.
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.
override void	PerformAction (IEntity pOwnerEntity, IEntity pUserEntity)
	Called when someone tries to perform the action, user entity is typically character.
override bool	GetActionNameScript (out string outName)
	If overridden and true is returned, outName is returned when BaseUserAction.GetActionName is called.
override bool	CanBePerformedScript (IEntity user)
	Can this action be performed by the provided user entity?
override bool	CanBeShownScript (IEntity user)
	Can this entity be shown in the UI by the provided user entity?
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 Member Functions
void	SetPreviewSlot (SCR_EntitySpawnerSlotComponent previewSlot)
bool	IsAnySlotAvailable ()
int	GetActionIndex ()
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.

Protected Attributes
EResourceType	m_eResourceType
SCR_ResourceSystemSubscriptionHandleBase	m_ResourceSubscriptionHandleConsumer
SCR_ResourceSystemSubscriptionHandleBase	m_ResourceSubscriptionHandleGenerator
SCR_ResourceComponent	m_ResourceComponent
SCR_ResourceGenerator	m_ResourceGenerator
SCR_ResourceConsumer	m_ResourceConsumer
RplId	m_ResourceInventoryPlayerComponentRplId
SCR_CatalogEntitySpawnerComponent	m_EntitySpawner
SCR_EEntityRequestStatus	m_iRequestStatus
SCR_EntitySpawnerSlotComponent	m_PreviewSlot
SCR_EntityCatalogEntry m_EntityData SCR_EntityCatalogSpawnerData	m_EntitySpawnerData
bool	m_bIsSelected
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.

Detailed Description

Action to spawn entities using the ActionsManagerComponent.

Member Function Documentation

CanBePerformedScript()

override bool SCR_CatalogSpawnerUserAction.CanBePerformedScript

(

IEntity

user

)

Can this action be performed by the provided user entity?

Implements ScriptedUserAction.

CanBeShownScript()

override bool SCR_CatalogSpawnerUserAction.CanBeShownScript

(

IEntity

user

)

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

Implements ScriptedUserAction.

GetActionIndex()

int SCR_CatalogSpawnerUserAction.GetActionIndex ( )

protected

GetActionNameScript()

override bool SCR_CatalogSpawnerUserAction.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.

HasLocalEffectOnlyScript()

override bool SCR_CatalogSpawnerUserAction.HasLocalEffectOnlyScript

(

)

Does this action only have client side effect?

Implements ScriptedUserAction.

Init()

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

Called when object is initialized and registered to actions manager.

Implements ScriptedUserAction.

IsAnySlotAvailable()

bool SCR_CatalogSpawnerUserAction.IsAnySlotAvailable ( )

protected

OnActionDeselected()

override void SCR_CatalogSpawnerUserAction.OnActionDeselected

(

)

Callback for when action is deselected by the local player and the local player ONLY.

Implements BaseUserAction.

OnActionSelected()

override void SCR_CatalogSpawnerUserAction.OnActionSelected

(

)

Callback for when action is selected by the local player and the local player ONLY.

Implements BaseUserAction.

PerformAction()

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

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

Implements ScriptedUserAction.

SetPreviewSlot()

void SCR_CatalogSpawnerUserAction.SetPreviewSlot ( SCR_EntitySpawnerSlotComponent  previewSlot )

protected

SetSpawnerData()

void SCR_CatalogSpawnerUserAction.SetSpawnerData

(

SCR_EntityCatalogEntry

entityData

)

Member Data Documentation

m_bIsSelected

bool SCR_CatalogSpawnerUserAction.m_bIsSelected

protected

m_EntitySpawner

SCR_CatalogEntitySpawnerComponent SCR_CatalogSpawnerUserAction.m_EntitySpawner

protected

m_EntitySpawnerData

SCR_EntityCatalogEntry m_EntityData SCR_EntityCatalogSpawnerData SCR_CatalogSpawnerUserAction.m_EntitySpawnerData

protected

m_eResourceType

EResourceType SCR_CatalogSpawnerUserAction.m_eResourceType

protected

m_iRequestStatus

SCR_EEntityRequestStatus SCR_CatalogSpawnerUserAction.m_iRequestStatus

protected

m_PreviewSlot

SCR_EntitySpawnerSlotComponent SCR_CatalogSpawnerUserAction.m_PreviewSlot

protected

m_ResourceComponent

SCR_ResourceComponent SCR_CatalogSpawnerUserAction.m_ResourceComponent

protected

m_ResourceConsumer

SCR_ResourceConsumer SCR_CatalogSpawnerUserAction.m_ResourceConsumer

protected

m_ResourceGenerator

SCR_ResourceGenerator SCR_CatalogSpawnerUserAction.m_ResourceGenerator

protected

m_ResourceInventoryPlayerComponentRplId

RplId SCR_CatalogSpawnerUserAction.m_ResourceInventoryPlayerComponentRplId

protected

m_ResourceSubscriptionHandleConsumer

SCR_ResourceSystemSubscriptionHandleBase SCR_CatalogSpawnerUserAction.m_ResourceSubscriptionHandleConsumer

protected

m_ResourceSubscriptionHandleGenerator

SCR_ResourceSystemSubscriptionHandleBase SCR_CatalogSpawnerUserAction.m_ResourceSubscriptionHandleGenerator

protected

---

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

• Game/UserActions/SCR_CatalogSpawnerUserAction.c