SCR_CampaignBuildingDisassemblyUserAction Interface Reference

Inheritance diagram for SCR_CampaignBuildingDisassemblyUserAction:

Public Member Functions
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.
void	CancelPlayerAnimation (notnull IEntity entity)
override void	PerformAction (IEntity pOwnerEntity, IEntity pUserEntity)
	Called when someone tries to perform the action, user entity is typically character.
void	TryToSendNotification (IEntity pOwnerEntity, IEntity pUserEntity, notnull SCR_CampaignBuildingNetworkComponent networkComponent)
bool	HasCompositionService ()
override bool	CanBeShownScript (IEntity user)
	Can this entity be shown in the UI by the provided user entity?
void	SetNewGadgetManager (IEntity from, IEntity to)
	Sets a new gadget manager. Controlled by an event when the controlled entity has changed.
override bool	CanBePerformedScript (IEntity user)
	Can this action be performed by the provided user entity?
override bool	HasLocalEffectOnlyScript ()
	Does this action only have client side effect?
void	GetBuildingAction ()
	Search for first instance of building action, as we can safely assume there is only one per entity.
void	SetEditorManager ()
void	GetAllTurretsInComposition ()
	Check the hierarchy of the composition for any turret and make a list of them.
void	OnCompositionSpawned (bool compositionSpawned)
	Get call once the composition is fully spawned.
void	CacheFactionAffiliationComponent ()
	Get call once the provider is set.
IEntity	GetBuildingTool (notnull IEntity ent)
	Get building tool entity.
bool	IsPlayerFactionSame (notnull IEntity user)
	Is user faction same as the composition one.
void	SetTemporaryBlockedAccess ()
	Set temporary blocked access.
void	~SCR_CampaignBuildingDisassemblyUserAction ()
Public Member Functions inherited from ScriptedUserAction
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.
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	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 ()
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?

Public Attributes
SCR_CampaignBuildingBuildUserAction	m_BuildAction
SCR_FactionManager	m_FactionManager
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
override void	Init (IEntity pOwnerEntity, GenericComponent pManagerComponent)
	Called when object is initialized and registered to actions manager.
SCR_CampaignBuildingNetworkComponent	GetNetworkManager ()
	GetNetworkManager.
bool	IsHQService ()
SCR_CampaignMilitaryBaseComponent	GetBase ()
bool	CanBeDisassembled ()
bool	CanBeBaseDisassembled (IEntity playerEntity)
bool	HasCompositionService (SCR_CampaignBuildingCompositionComponent composition)
bool	HasBaseCompositionsAnyService ()
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
SCR_CampaignBuildingLayoutComponent	m_LayoutComponent
SCR_CampaignBuildingCompositionComponent	m_CompositionComponent
SCR_EditableEntityComponent	m_EditableEntity
SCR_EditorManagerEntity	m_EditorManager
FactionAffiliationComponent	m_FactionComponent
SCR_MilitaryBaseComponent	m_BaseComponent
ref array< SCR_EditableVehicleComponent >	m_EditableVehicle = {}
SCR_CampaignBuildingProviderComponent	m_MasterProviderComponent
bool	m_bCompositionSpawned
bool	m_bTurretCollected
IEntity	m_RootEntity
IEntity	m_User
bool	m_bDisassembleOnlyWhenCapturing = false
bool	m_bSameFactionDisassembleOnly = false
bool	m_bTemporarilyBlockedAccess
bool	m_bAccessCanBeBlocked
WorldTimestamp	m_ResetTemporaryBlockedAccessTimestamp
SCR_GadgetManagerComponent	m_GadgetManager
Protected Attributes inherited from BaseUserAction
string	m_sCannotPerformReason
	The reason why action cannot be performed.

Static Protected Attributes
const string	DISMANTLE_ALL_BUILDINGS = "#AR-FactionCommander_DismantleAllBuildings"
const string	ENEMY_PRESENCE = "#AR-Campaign_Action_ShowBuildPreviewEnemyPresence"
const int	TEMPORARY_BLOCKED_ACCESS_RESET_TIME = 2

Constructor & Destructor Documentation

~SCR_CampaignBuildingDisassemblyUserAction()

void SCR_CampaignBuildingDisassemblyUserAction.~SCR_CampaignBuildingDisassemblyUserAction

(

)

Member Function Documentation

CacheFactionAffiliationComponent()

void SCR_CampaignBuildingDisassemblyUserAction.CacheFactionAffiliationComponent

(

)

Get call once the provider is set.

CanBeBaseDisassembled()

bool SCR_CampaignBuildingDisassemblyUserAction.CanBeBaseDisassembled ( IEntity playerEntity )

protected

CanBeDisassembled()

bool SCR_CampaignBuildingDisassemblyUserAction.CanBeDisassembled ( )

protected

CanBePerformedScript()

override bool SCR_CampaignBuildingDisassemblyUserAction.CanBePerformedScript

(

IEntity

user

)

Can this action be performed by the provided user entity?

Implements ScriptedUserAction.

CanBeShownScript()

override bool SCR_CampaignBuildingDisassemblyUserAction.CanBeShownScript

(

IEntity

user

)

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

Implements ScriptedUserAction.

CancelPlayerAnimation()

void SCR_CampaignBuildingDisassemblyUserAction.CancelPlayerAnimation

(

notnull IEntity

entity

)

GetAllTurretsInComposition()

void SCR_CampaignBuildingDisassemblyUserAction.GetAllTurretsInComposition

(

)

Check the hierarchy of the composition for any turret and make a list of them.

GetBase()

SCR_CampaignMilitaryBaseComponent SCR_CampaignBuildingDisassemblyUserAction.GetBase ( )

protected

GetBuildingAction()

void SCR_CampaignBuildingDisassemblyUserAction.GetBuildingAction

(

)

Search for first instance of building action, as we can safely assume there is only one per entity.

GetBuildingTool()

IEntity SCR_CampaignBuildingDisassemblyUserAction.GetBuildingTool

(

notnull IEntity

ent

)

Get building tool entity.

GetNetworkManager()

SCR_CampaignBuildingNetworkComponent SCR_CampaignBuildingDisassemblyUserAction.GetNetworkManager ( )

protected

GetNetworkManager.

HasBaseCompositionsAnyService()

bool SCR_CampaignBuildingDisassemblyUserAction.HasBaseCompositionsAnyService ( )

protected

HasCompositionService() [1/2]

bool SCR_CampaignBuildingDisassemblyUserAction.HasCompositionService

(

)

HasCompositionService() [2/2]

bool SCR_CampaignBuildingDisassemblyUserAction.HasCompositionService ( SCR_CampaignBuildingCompositionComponent composition )

protected

HasLocalEffectOnlyScript()

override bool SCR_CampaignBuildingDisassemblyUserAction.HasLocalEffectOnlyScript

(

)

Does this action only have client side effect?

Implements ScriptedUserAction.

Init()

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

protected

Called when object is initialized and registered to actions manager.

Implements ScriptedUserAction.

IsHQService()

bool SCR_CampaignBuildingDisassemblyUserAction.IsHQService ( )

protected

IsPlayerFactionSame()

bool SCR_CampaignBuildingDisassemblyUserAction.IsPlayerFactionSame

(

notnull IEntity

user

)

Is user faction same as the composition one.

OnActionCanceled()

override void SCR_CampaignBuildingDisassemblyUserAction.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_CampaignBuildingDisassemblyUserAction.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 ScriptedUserAction.

OnCompositionSpawned()

void SCR_CampaignBuildingDisassemblyUserAction.OnCompositionSpawned

(

bool

compositionSpawned

)

Get call once the composition is fully spawned.

PerformAction()

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

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

Implements ScriptedUserAction.

SetEditorManager()

void SCR_CampaignBuildingDisassemblyUserAction.SetEditorManager

(

)

SetNewGadgetManager()

void SCR_CampaignBuildingDisassemblyUserAction.SetNewGadgetManager	(	IEntity	from,
		IEntity	to )

Sets a new gadget manager. Controlled by an event when the controlled entity has changed.

SetTemporaryBlockedAccess()

void SCR_CampaignBuildingDisassemblyUserAction.SetTemporaryBlockedAccess

(

)

Set temporary blocked access.

TryToSendNotification()

void SCR_CampaignBuildingDisassemblyUserAction.TryToSendNotification	(	IEntity	pOwnerEntity,
		IEntity	pUserEntity,
		notnull SCR_CampaignBuildingNetworkComponent	networkComponent )

Member Data Documentation

DISMANTLE_ALL_BUILDINGS

const string SCR_CampaignBuildingDisassemblyUserAction.DISMANTLE_ALL_BUILDINGS = "#AR-FactionCommander_DismantleAllBuildings"

staticprotected

ENEMY_PRESENCE

const string SCR_CampaignBuildingDisassemblyUserAction.ENEMY_PRESENCE = "#AR-Campaign_Action_ShowBuildPreviewEnemyPresence"

staticprotected

m_bAccessCanBeBlocked

bool SCR_CampaignBuildingDisassemblyUserAction.m_bAccessCanBeBlocked

protected

m_BaseComponent

SCR_MilitaryBaseComponent SCR_CampaignBuildingDisassemblyUserAction.m_BaseComponent

protected

m_bCompositionSpawned

bool SCR_CampaignBuildingDisassemblyUserAction.m_bCompositionSpawned

protected

m_bDisassembleOnlyWhenCapturing

bool SCR_CampaignBuildingDisassemblyUserAction.m_bDisassembleOnlyWhenCapturing = false

protected

m_bSameFactionDisassembleOnly

bool SCR_CampaignBuildingDisassemblyUserAction.m_bSameFactionDisassembleOnly = false

protected

m_bTemporarilyBlockedAccess

bool SCR_CampaignBuildingDisassemblyUserAction.m_bTemporarilyBlockedAccess

protected

m_bTurretCollected

bool SCR_CampaignBuildingDisassemblyUserAction.m_bTurretCollected

protected

m_BuildAction

SCR_CampaignBuildingBuildUserAction SCR_CampaignBuildingDisassemblyUserAction.m_BuildAction

m_CompositionComponent

SCR_CampaignBuildingCompositionComponent SCR_CampaignBuildingDisassemblyUserAction.m_CompositionComponent

protected

m_EditableEntity

SCR_EditableEntityComponent SCR_CampaignBuildingDisassemblyUserAction.m_EditableEntity

protected

m_EditableVehicle

ref array<SCR_EditableVehicleComponent> SCR_CampaignBuildingDisassemblyUserAction.m_EditableVehicle = {}

protected

m_EditorManager

SCR_EditorManagerEntity SCR_CampaignBuildingDisassemblyUserAction.m_EditorManager

protected

m_FactionComponent

FactionAffiliationComponent SCR_CampaignBuildingDisassemblyUserAction.m_FactionComponent

protected

m_FactionManager

SCR_FactionManager SCR_CampaignBuildingDisassemblyUserAction.m_FactionManager

m_GadgetManager

SCR_GadgetManagerComponent SCR_CampaignBuildingDisassemblyUserAction.m_GadgetManager

protected

m_LayoutComponent

SCR_CampaignBuildingLayoutComponent SCR_CampaignBuildingDisassemblyUserAction.m_LayoutComponent

protected

m_MasterProviderComponent

SCR_CampaignBuildingProviderComponent SCR_CampaignBuildingDisassemblyUserAction.m_MasterProviderComponent

protected

m_ResetTemporaryBlockedAccessTimestamp

WorldTimestamp SCR_CampaignBuildingDisassemblyUserAction.m_ResetTemporaryBlockedAccessTimestamp

protected

m_RootEntity

IEntity SCR_CampaignBuildingDisassemblyUserAction.m_RootEntity

protected

m_User

IEntity SCR_CampaignBuildingDisassemblyUserAction.m_User

protected

TEMPORARY_BLOCKED_ACCESS_RESET_TIME

const int SCR_CampaignBuildingDisassemblyUserAction.TEMPORARY_BLOCKED_ACCESS_RESET_TIME = 2

staticprotected

---

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

• Game/UserActions/SCR_CampaignBuildingDisassemblyUserAction.c