Arma Reforger Script API
|
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 Attributes | |
bool | m_bDebug |
int | m_iMaxNumberOfActivations |
IEntity | m_Entity |
int | m_iNumberOfActivations |
bool SCR_ScenarioFrameworkActionBase.CanActivate | ( | ) |
Checks if action can be activated, handles maximum activation limit, increments activation count if possible.
array< ref SCR_ScenarioFrameworkActionBase > SCR_ScenarioFrameworkActionBase.GetSubActions | ( | ) |
[out] | subActions |
Implemented in SCR_ScenarioFrameworkActionBasedOnConditions, SCR_ScenarioFrameworkActionCompareCounterAndExecute, SCR_ScenarioFrameworkActionCountInventoryItemsAndExecuteAction, SCR_ScenarioFrameworkActionItemSafeguard, SCR_ScenarioFrameworkActionLoopOverNotRandomlySelectedLayers, SCR_ScenarioFrameworkActionOnCinematicFinished, SCR_ScenarioFrameworkActionOnCompartmentEnteredOrLeft, SCR_ScenarioFrameworkActionOnEngineStartedOrStop, SCR_ScenarioFrameworkActionOnUserActionEvent, SCR_ScenarioFrameworkActionRandomAction, SCR_ScenarioFrameworkActionVoiceOverPlayLine, SCR_ScenarioFrameworkActionVoiceOverPlaySequence, and SCR_ScenarioFrameworkActionWaitAndExecute.
void SCR_ScenarioFrameworkActionBase.Init | ( | IEntity | entity | ) |
Initializes entity, sets OnActivate and OnDeactivate event handlers for SCR_BaseTriggerEntity.
[in] | entity | that initialized this action. |
Implemented in SCR_ScenarioFrameworkActionQRFDispacher.
void SCR_ScenarioFrameworkActionBase.OnActivate | ( | IEntity | object | ) |
[in] | object |
Implemented in SCR_ScenarioFrameworkActionAddItemToInventory, SCR_ScenarioFrameworkActionAddScoreToCAHFaction, SCR_ScenarioFrameworkActionAI, SCR_ScenarioFrameworkActionAppendBriefingEntryText, SCR_ScenarioFrameworkActionAppendBriefingEntryTextBasedOnTask, SCR_ScenarioFrameworkActionBasedOnConditions, SCR_ScenarioFrameworkActionChangeLayerActivationType, SCR_ScenarioFrameworkActionChangeLayerTerminationStatus, SCR_ScenarioFrameworkActionChangeTaskState, SCR_ScenarioFrameworkActionChangeTaskTitleOrDescription, SCR_ScenarioFrameworkActionChangeTime, SCR_ScenarioFrameworkActionChangeTriggerActivationPresence, SCR_ScenarioFrameworkActionChangeUserActionVisibility, SCR_ScenarioFrameworkActionChangeWeather, SCR_ScenarioFrameworkActionCompareCounterAndExecute, SCR_ScenarioFrameworkActionCountInventoryItemsAndExecuteAction, SCR_ScenarioFrameworkActionDamageWheel, SCR_ScenarioFrameworkActionDecreaseLogicCounter, SCR_ScenarioFrameworkActionDeleteEntity, SCR_ScenarioFrameworkActionDeleteMarker, SCR_ScenarioFrameworkActionEndMission, SCR_ScenarioFrameworkActionExecuteFunction, SCR_ScenarioFrameworkActionFailTaskIfVehiclesInTriggerDestroyed, SCR_ScenarioFrameworkActionFeedParamToTaskDescription, SCR_ScenarioFrameworkActionIncrementCounter, SCR_ScenarioFrameworkActionIntroVoicelineBasedOnTasks, SCR_ScenarioFrameworkActionItemSafeguard, SCR_ScenarioFrameworkActionKillEntity, SCR_ScenarioFrameworkActionLockOrUnlockAllTargetVehiclesInTrigger, SCR_ScenarioFrameworkActionLockOrUnlockVehicle, SCR_ScenarioFrameworkActionLoopOverNotRandomlySelectedLayers, SCR_ScenarioFrameworkActionMedical, SCR_ScenarioFrameworkActionMoveIntoCompartment, SCR_ScenarioFrameworkActionOnCinematicFinished, SCR_ScenarioFrameworkActionOnCompartmentEnteredOrLeft, SCR_ScenarioFrameworkActionOnEngineStartedOrStop, SCR_ScenarioFrameworkActionOnUserActionEvent, SCR_ScenarioFrameworkActionPlayMusic, SCR_ScenarioFrameworkActionPlaySound, SCR_ScenarioFrameworkActionPlaySoundOnEntity, SCR_ScenarioFrameworkActionPrepareAreaFromDynamicDespawn, SCR_ScenarioFrameworkActionPrepareLayerFromDynamicDespawn, SCR_ScenarioFrameworkActionProcessVoicelineEnumAndString, SCR_ScenarioFrameworkActionQRFDispacher, SCR_ScenarioFrameworkActionRandomAction, SCR_ScenarioFrameworkActionRemoveAreaFromDynamicDespawn, SCR_ScenarioFrameworkActionRemoveItemFromInventory, SCR_ScenarioFrameworkActionRemoveLayerFromDynamicDespawn, SCR_ScenarioFrameworkActionResetCounter, SCR_ScenarioFrameworkActionRestoreLayerToDefault, SCR_ScenarioFrameworkActionSetBriefingEntryText, SCR_ScenarioFrameworkActionSetBriefingEntryTextBasedOnGeneratedTasks, SCR_ScenarioFrameworkActionSetEntityPosition, SCR_ScenarioFrameworkActionSetEntityScale, SCR_ScenarioFrameworkActionSetExecutionEntryTextBasedOnGeneratedTasks, SCR_ScenarioFrameworkActionSetFactionToCAHArea, SCR_ScenarioFrameworkActionSetFuelConsumption, SCR_ScenarioFrameworkActionSetFuelPercentage, SCR_ScenarioFrameworkActionSetMissionEndScreen, SCR_ScenarioFrameworkActionSetSupplyPercentage, SCR_ScenarioFrameworkActionSetVehicleCruiseSpeed, SCR_ScenarioFrameworkActionShowHint, SCR_ScenarioFrameworkActionShowLayout, SCR_ScenarioFrameworkActionShowPopupNotification, SCR_ScenarioFrameworkActionSpawnClosestObjectFromList, SCR_ScenarioFrameworkActionSpawnObjectBasedOnDistance, SCR_ScenarioFrameworkActionSpawnObjects, SCR_ScenarioFrameworkActionToggleEngine, SCR_ScenarioFrameworkActionToggleLights, SCR_ScenarioFrameworkActionVoiceOverPlayLine, SCR_ScenarioFrameworkActionVoiceOverPlaySequence, SCR_ScenarioFrameworkActionWaitAndExecute, SCR_ScenarioFrameworkAIActionSetRadioFrequency, SCR_ScenarioFrameworkCreateVariable, SCR_ScenarioFrameworkGetVariableValue, SCR_ScenarioFrameworkSetSignal, and SCR_ScenarioFrameworkSetVariable.
void SCR_ScenarioFrameworkActionBase.RestoreToDefault | ( | ) |
Restores default settings for action and resets number of activations.
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.
[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. |
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.
[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 |
bool SCR_ScenarioFrameworkActionBase.m_bDebug |
IEntity SCR_ScenarioFrameworkActionBase.m_Entity |
int SCR_ScenarioFrameworkActionBase.m_iMaxNumberOfActivations |
int SCR_ScenarioFrameworkActionBase.m_iNumberOfActivations |