SCR_ScenarioFrameworkActionShowHint Interface Reference

Inheritance diagram for SCR_ScenarioFrameworkActionShowHint:

Public Member Functions
override void	OnActivate (IEntity object)
void	ShowHint (int playerID)
void	ComposeHintText ()
Public Member Functions inherited from SCR_ScenarioFrameworkActionBase
void	Init (IEntity entity)
	Initializes entity, sets OnActivate and OnDeactivate event handlers for SCR_BaseTriggerEntity.
bool	CanActivate ()
	Checks if action can be activated, handles maximum activation limit, increments activation count if possible.
bool	ValidateInputEntity (IEntity object, SCR_ScenarioFrameworkGet getter, out IEntity entity)
	Validates input entity for ScenarioFramework Action, checks if it's from layer or getter, returns true if valid.
void	OnActivate (IEntity object)
array< ref SCR_ScenarioFrameworkActionBase >	GetSubActions ()
void	RestoreToDefault ()
	Restores default settings for action and resets number of activations.
void	SpawnObjects (notnull array< string > aObjectsNames, SCR_ScenarioFrameworkEActivationType eActivationType)
	Spawns objects from an array, checks for existence, activation type, and initializes them with specified activation type.

Public Attributes
string	m_sTitle
string	m_sText
string	m_sActionName
string	m_sActionText
int	m_iTimeout
FactionKey	m_sFactionKey
ref SCR_ScenarioFrameworkGet	m_Getter
Public Attributes inherited from SCR_ScenarioFrameworkActionBase
bool	m_bDebug
int	m_iMaxNumberOfActivations
IEntity	m_Entity
int	m_iNumberOfActivations

Static Protected Attributes
static const string	DOUBLE_LINE_SPACE = "<br/><br/>"

Member Function Documentation

ComposeHintText()

void SCR_ScenarioFrameworkActionShowHint.ComposeHintText

(

)

OnActivate()

override void SCR_ScenarioFrameworkActionShowHint.OnActivate

(

IEntity

object

)

Parameters

[in]

object

Implements SCR_ScenarioFrameworkActionBase.

ShowHint()

void SCR_ScenarioFrameworkActionShowHint.ShowHint

(

int

playerID

)

Member Data Documentation

DOUBLE_LINE_SPACE

const string SCR_ScenarioFrameworkActionShowHint.DOUBLE_LINE_SPACE = "<br/><br/>"

staticprotected

m_Getter

ref SCR_ScenarioFrameworkGet SCR_ScenarioFrameworkActionShowHint.m_Getter

m_iTimeout

int SCR_ScenarioFrameworkActionShowHint.m_iTimeout

m_sActionName

string SCR_ScenarioFrameworkActionShowHint.m_sActionName

m_sActionText

string SCR_ScenarioFrameworkActionShowHint.m_sActionText

m_sFactionKey

FactionKey SCR_ScenarioFrameworkActionShowHint.m_sFactionKey

m_sText

string SCR_ScenarioFrameworkActionShowHint.m_sText

m_sTitle

string SCR_ScenarioFrameworkActionShowHint.m_sTitle

---

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

• Game/ScenarioFramework/Actions/SCR_ScenarioFrameworkActionShowHint.c