SCR_WeaponAction Class Reference

Inheritance diagram for SCR_WeaponAction:

Protected Member Functions
override void	Init (IEntity pOwnerEntity, GenericComponent pManagerComponent)
override bool	CanBeShownScript (IEntity user)
override bool	CanBePerformedScript (IEntity user)
bool	GetState ()
	Current state of the feature.
void	SetState (bool enable)
	Script to change state of the feature.
override void	PerformAction (IEntity pOwnerEntity, IEntity pUserEntity)
	By default toggle the current state of the interaction.
override bool	GetActionNameScript (out string outName)
override bool	HasLocalEffectOnlyScript ()

Protected Attributes
bool	m_bIsToggle
	Should action behave as a toggle.
bool	m_bTargetState
	Target state of the action, ignored if toggle.
string	m_sActionStateOn
	Description of action to toggle on.
string	m_sActionStateOff
	Description of action to toggle off.
EWeaponActionType	m_WeaponActionType
BaseWeaponComponent	m_Weapon

Detailed Description

Definition at line 6 of file SCR_WeaponAction.c.

Member Function Documentation

CanBePerformedScript()

override bool SCR_WeaponAction::CanBePerformedScript ( IEntity user )

inlineprotected

Definition at line 58 of file SCR_WeaponAction.c.

CanBeShownScript()

override bool SCR_WeaponAction::CanBeShownScript ( IEntity user )

inlineprotected

Definition at line 35 of file SCR_WeaponAction.c.

GetActionNameScript()

override bool SCR_WeaponAction::GetActionNameScript ( out string outName )

inlineprotected

Definition at line 98 of file SCR_WeaponAction.c.

GetState()

bool SCR_WeaponAction::GetState ( )

inlineprotected

Current state of the feature.

Definition at line 65 of file SCR_WeaponAction.c.

HasLocalEffectOnlyScript()

override bool SCR_WeaponAction::HasLocalEffectOnlyScript ( )

inlineprotected

Definition at line 129 of file SCR_WeaponAction.c.

Init()

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

inlineprotected

Definition at line 29 of file SCR_WeaponAction.c.

PerformAction()

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

inlineprotected

By default toggle the current state of the interaction.

Definition at line 89 of file SCR_WeaponAction.c.

SetState()

void SCR_WeaponAction::SetState ( bool enable )

inlineprotected

Script to change state of the feature.

Definition at line 78 of file SCR_WeaponAction.c.

Member Data Documentation

m_bIsToggle

bool SCR_WeaponAction::m_bIsToggle

protected

Should action behave as a toggle.

Definition at line 10 of file SCR_WeaponAction.c.

m_bTargetState

bool SCR_WeaponAction::m_bTargetState

protected

Target state of the action, ignored if toggle.

Definition at line 14 of file SCR_WeaponAction.c.

m_sActionStateOff

string SCR_WeaponAction::m_sActionStateOff

protected

Description of action to toggle off.

Definition at line 22 of file SCR_WeaponAction.c.

m_sActionStateOn

string SCR_WeaponAction::m_sActionStateOn

protected

Description of action to toggle on.

Definition at line 18 of file SCR_WeaponAction.c.

m_Weapon

BaseWeaponComponent SCR_WeaponAction::m_Weapon

protected

Definition at line 27 of file SCR_WeaponAction.c.

m_WeaponActionType

EWeaponActionType SCR_WeaponAction::m_WeaponActionType

protected

Definition at line 25 of file SCR_WeaponAction.c.

---

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

• scripts/Game/UserActions/SCR_WeaponAction.c