SCR_CampaignBuildingStartUserAction Interface Reference

Inheritance diagram for SCR_CampaignBuildingStartUserAction:

Public Member Functions
void	InitializeSuppliesComponent ()
override void	PerformAction (IEntity pOwnerEntity, IEntity pUserEntity)
	Called when someone tries to perform the action, user entity is typically character.
override bool	CanBePerformedScript (IEntity user)
	Can this action be performed by the provided user entity?
SCR_ECharacterRank	GetUserRank (notnull IEntity user)
override bool	CanBeShownScript (IEntity user)
	Can this entity be shown in the UI by the provided user entity?
override bool	GetActionNameScript (out string outName)
	If overridden and true is returned, outName is returned when BaseUserAction.GetActionName is called.
override bool	HasLocalEffectOnlyScript ()
	Does this action only have client side effect?
void	SetNewCompartmentComponent (IEntity from, IEntity to)
	Sets a new compartment component. Controlled by an event when the controlled entity has changed.
void	SetTemporaryBlockedAccess ()
	Set temporary blocked access.
void	ResetTemporaryBlockedAccess ()
	Set temporary blocked access back to default false value.
bool	EvaluateEntity (IEntity ent)
	Check if this entity can block player to enter a building mode. If such anentity is found, return false to stop evaluating next enttiy found by query.
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
override void	Init (IEntity pOwnerEntity, GenericComponent pManagerComponent)
	Called when object is initialized and registered to actions manager.
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
LocalizedString	m_sActionNameNoSupplies
SCR_ResourceSystemSubscriptionHandleBase	m_ResourceSubscriptionHandleConsumer
RplId	m_ResourceInventoryPlayerComponentRplId
SCR_ResourceComponent	m_ResourceComponent
SCR_ResourceConsumer	m_ResourceConsumer
SCR_CampaignBuildingProviderComponent	m_ProviderComponent
Physics	m_ProviderPhysics
RplComponent	m_RplComponent
DamageManagerComponent	m_DamageManager
SCR_CompartmentAccessComponent	m_CompartmentAccess
bool	m_bUseRankLimitedAccess
bool	m_bTemporarilyBlockedAccess
bool	m_bAccessCanBeBlocked
bool	m_bRankLimitationCanBeUsed
Protected Attributes inherited from BaseUserAction
string	m_sCannotPerformReason
	The reason why action cannot be performed.

Static Protected Attributes
const int	PROVIDER_SPEED_TO_REMOVE_BUILDING_SQ = 1
const int	TEMPORARY_BLOCKED_ACCESS_RESET_TIME = 1000

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.

Member Function Documentation

CanBePerformedScript()

override bool SCR_CampaignBuildingStartUserAction.CanBePerformedScript

(

IEntity

user

)

Can this action be performed by the provided user entity?

Implements ScriptedUserAction.

CanBeShownScript()

override bool SCR_CampaignBuildingStartUserAction.CanBeShownScript

(

IEntity

user

)

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

Implements ScriptedUserAction.

EvaluateEntity()

bool SCR_CampaignBuildingStartUserAction.EvaluateEntity

(

IEntity

ent

)

Check if this entity can block player to enter a building mode. If such anentity is found, return false to stop evaluating next enttiy found by query.

GetActionNameScript()

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

GetUserRank()

SCR_ECharacterRank SCR_CampaignBuildingStartUserAction.GetUserRank

(

notnull IEntity

user

)

Parameters

[in]

user

Returns

HasLocalEffectOnlyScript()

override bool SCR_CampaignBuildingStartUserAction.HasLocalEffectOnlyScript

(

)

Does this action only have client side effect?

Implements ScriptedUserAction.

Init()

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

protected

Called when object is initialized and registered to actions manager.

Implements ScriptedUserAction.

InitializeSuppliesComponent()

void SCR_CampaignBuildingStartUserAction.InitializeSuppliesComponent

(

)

PerformAction()

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

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

Implements ScriptedUserAction.

ResetTemporaryBlockedAccess()

void SCR_CampaignBuildingStartUserAction.ResetTemporaryBlockedAccess

(

)

Set temporary blocked access back to default false value.

SetNewCompartmentComponent()

void SCR_CampaignBuildingStartUserAction.SetNewCompartmentComponent	(	IEntity	from,
		IEntity	to
	)

Sets a new compartment component. Controlled by an event when the controlled entity has changed.

SetTemporaryBlockedAccess()

void SCR_CampaignBuildingStartUserAction.SetTemporaryBlockedAccess

(

)

Set temporary blocked access.

Member Data Documentation

m_bAccessCanBeBlocked

bool SCR_CampaignBuildingStartUserAction.m_bAccessCanBeBlocked

protected

m_bRankLimitationCanBeUsed

bool SCR_CampaignBuildingStartUserAction.m_bRankLimitationCanBeUsed

protected

m_bTemporarilyBlockedAccess

bool SCR_CampaignBuildingStartUserAction.m_bTemporarilyBlockedAccess

protected

m_bUseRankLimitedAccess

bool SCR_CampaignBuildingStartUserAction.m_bUseRankLimitedAccess

protected

m_CompartmentAccess

SCR_CompartmentAccessComponent SCR_CampaignBuildingStartUserAction.m_CompartmentAccess

protected

m_DamageManager

DamageManagerComponent SCR_CampaignBuildingStartUserAction.m_DamageManager

protected

m_ProviderComponent

SCR_CampaignBuildingProviderComponent SCR_CampaignBuildingStartUserAction.m_ProviderComponent

protected

m_ProviderPhysics

Physics SCR_CampaignBuildingStartUserAction.m_ProviderPhysics

protected

m_ResourceComponent

SCR_ResourceComponent SCR_CampaignBuildingStartUserAction.m_ResourceComponent

protected

m_ResourceConsumer

SCR_ResourceConsumer SCR_CampaignBuildingStartUserAction.m_ResourceConsumer

protected

m_ResourceInventoryPlayerComponentRplId

RplId SCR_CampaignBuildingStartUserAction.m_ResourceInventoryPlayerComponentRplId

protected

m_ResourceSubscriptionHandleConsumer

SCR_ResourceSystemSubscriptionHandleBase SCR_CampaignBuildingStartUserAction.m_ResourceSubscriptionHandleConsumer

protected

m_RplComponent

RplComponent SCR_CampaignBuildingStartUserAction.m_RplComponent

protected

m_sActionNameNoSupplies

LocalizedString SCR_CampaignBuildingStartUserAction.m_sActionNameNoSupplies

protected

PROVIDER_SPEED_TO_REMOVE_BUILDING_SQ

const int SCR_CampaignBuildingStartUserAction.PROVIDER_SPEED_TO_REMOVE_BUILDING_SQ = 1

staticprotected

TEMPORARY_BLOCKED_ACCESS_RESET_TIME

const int SCR_CampaignBuildingStartUserAction.TEMPORARY_BLOCKED_ACCESS_RESET_TIME = 1000

staticprotected

---

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

• Game/UserActions/SCR_CampaignBuildingStartUserAction.c