SCR_ScenarioFrameworkActionBase Interface Reference

Inheritance diagram for SCR_ScenarioFrameworkActionBase:

Public Member Functions
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 Member Functions inherited from BaseContainerObject
proto external string	GetStoreName ()
	Retrieve the store name, usually just a GUID.

Public Attributes
bool	m_bDebug
int	m_iMaxNumberOfActivations
IEntity	m_Entity
int	m_iNumberOfActivations

Member Function Documentation

CanActivate()

bool SCR_ScenarioFrameworkActionBase.CanActivate

(

)

Checks if action can be activated, handles maximum activation limit, increments activation count if possible.

Returns

true if action can be activated, false otherwise.

GetSubActions()

array< ref SCR_ScenarioFrameworkActionBase > SCR_ScenarioFrameworkActionBase.GetSubActions

(

)

Parameters

[out]

subActions

Implemented in SCR_ScenarioFrameworkActionBasedOnConditions, SCR_ScenarioFrameworkActionCompareCounterAndExecute, SCR_ScenarioFrameworkActionCountInventoryItemsAndExecuteAction, SCR_ScenarioFrameworkActionEventOnProjectileShot, SCR_ScenarioFrameworkActionItemSafeguard, SCR_ScenarioFrameworkActionLoopOverNotRandomlySelectedLayers, SCR_ScenarioFrameworkActionOnAnimationEvent, SCR_ScenarioFrameworkActionOnCinematicFinished, SCR_ScenarioFrameworkActionOnCompartmentEnteredOrLeft, SCR_ScenarioFrameworkActionOnDamage, SCR_ScenarioFrameworkActionOnDamageStateChanged, SCR_ScenarioFrameworkActionOnEngineStartedOrStop, SCR_ScenarioFrameworkActionOnResourceChanged, SCR_ScenarioFrameworkActionOnResourceConsumerChange, SCR_ScenarioFrameworkActionOnUserActionEvent, SCR_ScenarioFrameworkActionQRFDispacher, SCR_ScenarioFrameworkActionRandomAction, SCR_ScenarioFrameworkActionVoiceOverPlayLine, SCR_ScenarioFrameworkActionVoiceOverPlaySequence, SCR_ScenarioFrameworkActionWaitAndExecute, and SCR_ScenarioFrameworkOnWeaponAmmoCountChangedAction.

Init()

void SCR_ScenarioFrameworkActionBase.Init

(

IEntity

entity

)

Initializes entity, sets OnActivate and OnDeactivate event handlers for SCR_BaseTriggerEntity.

Parameters

[in]

entity

that initialized this action.

Implemented in SCR_ScenarioFrameworkActionQRFDispacher.

OnActivate()

void SCR_ScenarioFrameworkActionBase.OnActivate

(

IEntity

object

)

Parameters

[in]

object

Implemented in SCR_ScenarioFrameworkActionAddItemToInventory, SCR_ScenarioFrameworkActionAddNotoriety, SCR_ScenarioFrameworkActionAddScoreToCAHFaction, SCR_ScenarioFrameworkActionAddTaskProgress, SCR_ScenarioFrameworkActionAI, SCR_ScenarioFrameworkActionAppendBriefingEntryText, SCR_ScenarioFrameworkActionAppendBriefingEntryTextBasedOnTask, SCR_ScenarioFrameworkActionAssignTask, SCR_ScenarioFrameworkActionAttachToSlotManager, SCR_ScenarioFrameworkActionAudioSystemPauseResume, SCR_ScenarioFrameworkActionAudioSystemSetMasterVolume, SCR_ScenarioFrameworkActionBasedOnConditions, SCR_ScenarioFrameworkActionCallAnimationCommand, SCR_ScenarioFrameworkActionChangeAllTaskState, SCR_ScenarioFrameworkActionChangeLayerActivationType, SCR_ScenarioFrameworkActionChangeLayerTerminationStatus, SCR_ScenarioFrameworkActionChangeTaskIcon, SCR_ScenarioFrameworkActionChangeTaskOwnership, SCR_ScenarioFrameworkActionChangeTaskState, SCR_ScenarioFrameworkActionChangeTaskTaskUIVisibility, SCR_ScenarioFrameworkActionChangeTaskTaskVisibility, SCR_ScenarioFrameworkActionChangeTaskTitleOrDescription, SCR_ScenarioFrameworkActionChangeTime, SCR_ScenarioFrameworkActionChangeTriggerActivationPresence, SCR_ScenarioFrameworkActionChangeUserActionVisibility, SCR_ScenarioFrameworkActionChangeWeather, SCR_ScenarioFrameworkActionCOKLocationSelector, SCR_ScenarioFrameworkActionCompareCounterAndExecute, SCR_ScenarioFrameworkActionCountInventoryItemsAndExecuteAction, SCR_ScenarioFrameworkActionDamageWheel, SCR_ScenarioFrameworkActionDecreaseLogicCounter, SCR_ScenarioFrameworkActionDeleteEntity, SCR_ScenarioFrameworkActionDeleteMarker, SCR_ScenarioFrameworkActionDestruction, SCR_ScenarioFrameworkActionEnableDamageHandling, SCR_ScenarioFrameworkActionEndMission, SCR_ScenarioFrameworkActionEventOnProjectileShot, SCR_ScenarioFrameworkActionExecuteFunction, SCR_ScenarioFrameworkActionFailTaskIfVehiclesInTriggerDestroyed, SCR_ScenarioFrameworkActionFeedParamToTaskDescription, SCR_ScenarioFrameworkActionHideHint, SCR_ScenarioFrameworkActionIncrementCounter, SCR_ScenarioFrameworkActionIntroVoicelineBasedOnTasks, SCR_ScenarioFrameworkActionItemSafeguard, SCR_ScenarioFrameworkActionKillEntity, SCR_ScenarioFrameworkActionLimiter, SCR_ScenarioFrameworkActionLockOrUnlockAllTargetVehiclesInTrigger, SCR_ScenarioFrameworkActionLockOrUnlockVehicle, SCR_ScenarioFrameworkActionLoopOverNotRandomlySelectedLayers, SCR_ScenarioFrameworkActionMapPanZoom, SCR_ScenarioFrameworkActionMedical, SCR_ScenarioFrameworkActionMoveIntoCompartment, SCR_ScenarioFrameworkActionMoveIntoInventory, SCR_ScenarioFrameworkActionOnAllChildrenSpawned, SCR_ScenarioFrameworkActionOnAnimationEvent, SCR_ScenarioFrameworkActionOnCinematicFinished, SCR_ScenarioFrameworkActionOnCompartmentEnteredOrLeft, SCR_ScenarioFrameworkActionOnDamage, SCR_ScenarioFrameworkActionOnDamageStateChanged, SCR_ScenarioFrameworkActionOnEngineStartedOrStop, SCR_ScenarioFrameworkActionOnGroupAgentEntities, SCR_ScenarioFrameworkActionOnResourceChanged, SCR_ScenarioFrameworkActionOnResourceConsumerChange, SCR_ScenarioFrameworkActionOnUserActionEvent, SCR_ScenarioFrameworkActionPlayCinematic, SCR_ScenarioFrameworkActionPlayCommunicationSoundOnEntity, SCR_ScenarioFrameworkActionPlayMusic, SCR_ScenarioFrameworkActionPlaySound, SCR_ScenarioFrameworkActionPlaySoundOnEntity, SCR_ScenarioFrameworkActionPrepareAreaFromDynamicDespawn, SCR_ScenarioFrameworkActionPrepareLayerFromDynamicDespawn, SCR_ScenarioFrameworkActionProcessVoicelineEnumAndString, SCR_ScenarioFrameworkActionQRFDispacher, SCR_ScenarioFrameworkActionRandomAction, SCR_ScenarioFrameworkActionRemoveAreaFromDynamicDespawn, SCR_ScenarioFrameworkActionRemoveItemFromInventory, SCR_ScenarioFrameworkActionRemoveLayerFromDynamicDespawn, SCR_ScenarioFrameworkActionRemoveTaskProgress, SCR_ScenarioFrameworkActionResetCounter, SCR_ScenarioFrameworkActionRestoreLayerToDefault, SCR_ScenarioFrameworkActionSetBriefingEntryText, SCR_ScenarioFrameworkActionSetBriefingEntryTextBasedOnGeneratedTasks, SCR_ScenarioFrameworkActionSetCharacterStance, SCR_ScenarioFrameworkActionSetCharacterUnconscious, SCR_ScenarioFrameworkActionSetEntityFaction, SCR_ScenarioFrameworkActionSetEntityName, SCR_ScenarioFrameworkActionSetEntityPosition, SCR_ScenarioFrameworkActionSetEntityScale, SCR_ScenarioFrameworkActionSetEntityTransformation, SCR_ScenarioFrameworkActionSetExecutionEntryTextBasedOnGeneratedTasks, SCR_ScenarioFrameworkActionSetFactionToCAHArea, SCR_ScenarioFrameworkActionSetFuelConsumption, SCR_ScenarioFrameworkActionSetFuelPercentage, SCR_ScenarioFrameworkActionSetGrenadeLive, SCR_ScenarioFrameworkActionSetMissionEndScreen, SCR_ScenarioFrameworkActionSetParentTask, SCR_ScenarioFrameworkActionSetResourceTypeEnabled, SCR_ScenarioFrameworkActionSetSupplyPercentage, SCR_ScenarioFrameworkActionSetTaskProgress, SCR_ScenarioFrameworkActionSetVehicleCruiseSpeed, SCR_ScenarioFrameworkActionSetWoundState, SCR_ScenarioFrameworkActionShowHint, SCR_ScenarioFrameworkActionShowLayout, SCR_ScenarioFrameworkActionShowPopupNotification, SCR_ScenarioFrameworkActionShowWidget, SCR_ScenarioFrameworkActionSpawnClosestObjectFromList, SCR_ScenarioFrameworkActionSpawnObjectBasedOnDistance, SCR_ScenarioFrameworkActionSpawnObjects, SCR_ScenarioFrameworkActionSpawnObjectsFromVariable, SCR_ScenarioFrameworkActionStartAnimation, SCR_ScenarioFrameworkActionStartSimpleAnimation, SCR_ScenarioFrameworkActionStopAnimation, SCR_ScenarioFrameworkActionToggleEngine, SCR_ScenarioFrameworkActionToggleLights, SCR_ScenarioFrameworkActionUnlockAchievement, SCR_ScenarioFrameworkActionVehicle, SCR_ScenarioFrameworkActionVoiceOverPlayLine, SCR_ScenarioFrameworkActionVoiceOverPlaySequence, SCR_ScenarioFrameworkActionWaitAndExecute, SCR_ScenarioFrameworkAIActionSetRadioFrequency, SCR_ScenarioFrameworkCreateVariable, SCR_ScenarioFrameworkGetVariableValue, SCR_ScenarioFrameworkOnWeaponAmmoCountChangedAction, SCR_ScenarioFrameworkResourceComponentAction, SCR_ScenarioFrameworkSetSignal, SCR_ScenarioFrameworkSetSlotEntity, and SCR_ScenarioFrameworkSetVariable.

RestoreToDefault()

void SCR_ScenarioFrameworkActionBase.RestoreToDefault

(

)

Restores default settings for action and resets number of activations.

Implemented in SCR_ScenarioFrameworkActionWaitAndExecute.

SpawnObjects()

void SCR_ScenarioFrameworkActionBase.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.

Parameters

[in]	aObjectsNames	An array of object names for spawning in the scenario.
[in]	eActivationType	eActivationType represents the activation type for the objects being spawned in the scenario.

ValidateInputEntity()

bool SCR_ScenarioFrameworkActionBase.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.

Parameters

[in]	object	Validates if input object is a valid entity for the action
[in]	getter	Getter represents an optional parameter used to retrieve an entity from a scenario framework action.
[out]	entity	that is valid for this action

Returns

true if the input entity is valid, otherwise false.

Member Data Documentation

m_bDebug

bool SCR_ScenarioFrameworkActionBase.m_bDebug

m_Entity

IEntity SCR_ScenarioFrameworkActionBase.m_Entity

m_iMaxNumberOfActivations

int SCR_ScenarioFrameworkActionBase.m_iMaxNumberOfActivations

m_iNumberOfActivations

int SCR_ScenarioFrameworkActionBase.m_iNumberOfActivations

---

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

• Game/ScenarioFramework/Actions/SCR_ScenarioFrameworkActionBase.c