Arma Reforger

https://github.com/tacticalcatboy/armareforgerdocs
Admin
Tokens:9,193,592
Snippets:146,040
Trust Score:4.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### Attempting Engine Start in Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceVehicleControllerComponent.html

Try to start the engine with the chance of getting the engine not started based on engine startup chance.

```Enforce Script
proto external void TryStartEngine()
```

--------------------------------

### Setting Up Tutorial Stage (C)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__SW__START.html

This protected function overrides the base class method to perform necessary setup operations when the tutorial stage begins. It initializes the stage's state and dependencies.

```C
override void SCR_Tutorial_SW_START.Setup
(

)
```

--------------------------------

### Setting Up Tutorial Stage C++

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__SW__GL__FIRE.html

Initializes the tutorial stage. This method overrides the base SCR_BaseTutorialStage::Setup method and is responsible for setting up components like the destruction component.

```C++
override void SCR_Tutorial_SW_GL_FIRE.Setup
(

)
```

--------------------------------

### Get Animation Deactivation Delay

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__2DOpticsComponent.html

Gets the delay in milliseconds before the deactivation animation starts.

```Enforce Script
int GetAnimationDeactivationDelay ()
```

--------------------------------

### Get Animation Activation Delay

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__2DOpticsComponent.html

Gets the delay in milliseconds before the activation animation starts.

```Enforce Script
int GetAnimationActivationDelay ()
```

--------------------------------

### Setting Up Squad Leadership Tutorial Stage (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__SquadLeadership__ORDER__DEFEND-members.html

This method performs the initial setup for the Squad Leadership DEFEND tutorial stage. It takes no parameters.

```Enforce Script
Setup()
```

--------------------------------

### Try Start Engine Enfusion Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__HelicopterControllerComponent.html

Try to start the engine with the chance of getting the engine not started based on engine startup chance. This simulates realistic engine starting behavior.

```Enfusion Script
proto external void TryStartEngine ()
```

--------------------------------

### Setting Up Tutorial Stage (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__VehicleMaintenance__START.html

Initializes the tutorial stage with necessary configurations. This protected method overrides the Setup method defined in the SCR_BaseTutorialStage interface.

```Enforce Script
override void SCR_Tutorial_VehicleMaintenance_START.Setup()
```

--------------------------------

### Init Method (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Navigation__MAP__INTROCTUCTION.html

Initializes the tutorial stage with specific configuration information.

```Enforce Script
void Init (SCR_TutorialStageInfo stageInfo)
```

--------------------------------

### Get On Game Start Invoker - Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__GameModeEditor.html

Retrieves the ScriptInvoker for the game start event.

```Enforce Script
ScriptInvoker GetOnGameStart ()
```

--------------------------------

### OnStart Function (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__TutorialCourse.html

Callback function invoked when the tutorial course is started. Implement custom initialization logic here.

```Enforce Script
void OnStart ()
```

--------------------------------

### Get Source Path - EditablePrefabsConfig - Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceEditablePrefabsConfig.html

Get the source path without the GUID.

```Enforce Script
string EditablePrefabsConfig.GetSourcePath
(
)
```

--------------------------------

### Get On Start Invoker - SCR_InfoDisplay (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__FuelTankInfo.html

Gets the invoker for the display's start event. This method is inherited from SCR_InfoDisplay and allows other systems to subscribe to the display's initialization event.

```Enforce Script
SCR_InfoDisplayInvoker GetOnStart ()
```

--------------------------------

### Implementing Setup in SCR_Tutorial_Navigation_END (Enfusion Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Navigation__END.html

Overrides the base class method to set up the tutorial stage. This method implements SCR_BaseTutorialStage::Setup.

```Enfusion Script
override void SCR_Tutorial_Navigation_END.Setup
(

)
```

--------------------------------

### Override Setup Method (Enfusion Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__VehicleMaintenance__GETIN.html

Overrides the base Setup method to initialize the tutorial stage. Implements the corresponding method from SCR_BaseTutorialStage.

```Enfusion Script
override void SCR_Tutorial_VehicleMaintenance_GETIN.Setup
(

)
```

--------------------------------

### Get Start Variant Index - Enfusion Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/EnfusionScriptAPIPublic/interfaceWeatherState.html

Retrieves the index of the starting weather variant for this state.

```Enfusion Script
proto external int WeatherState.GetStartVariantIndex ()
```

--------------------------------

### Implementing Setup Method (C++)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__SquadLeadership__GETIN.html

Overrides the `Setup` method from the base class `SCR_BaseTutorialStage`. This method is typically called to initialize the tutorial stage when it becomes active.

```C++
override void SCR_Tutorial_SquadLeadership_GETIN.Setup()
```

--------------------------------

### Get Target Path - EditablePrefabsConfig - Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceEditablePrefabsConfig.html

Get the raw target path without the GUID.

```Enforce Script
string EditablePrefabsConfig.GetTargetPath
(
)
```

--------------------------------

### Trying to Start Engine (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceHelicopterControllerComponent.html

Try to start the engine with the chance of getting the engine not started based on engine startup chance.

```Enforce Script
proto external void TryStartEngine()
```

--------------------------------

### Method Init in SCR_BaseTutorialStage (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Obstacle__VAULTLOW.html

Initializes the tutorial stage with specific information. Requires a SCR_TutorialStageInfo object containing configuration details.

```Enforce Script
void Init(SCR_TutorialStageInfo stageInfo)
```

--------------------------------

### Setup Method - SCR_Tutorial_Seizing_WEAPON - C++

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Seizing__WEAPON.html

Overrides the base class method for setting up the tutorial stage. Implements SCR_BaseTutorialStage::Setup.

```C++
override void SCR_Tutorial_Seizing_WEAPON.Setup()
```

--------------------------------

### Get Total Projectiles in Barrage (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__BarrageEffectsModule.html

Gets the total number of projectiles configured at the start of the barrage.

```Enforce Script
int GetTotalProjectilesInBarrage ()
```

--------------------------------

### Implementing Setup in SCR_Tutorial_Navigation_CLOSEMAP (Enfusion Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Navigation__CLOSEMAP.html

Documents the override of the Setup method for the SCR_Tutorial_Navigation_CLOSEMAP class. This method is called when the tutorial stage is initialized or started. It implements the base class method SCR_BaseTutorialStage.Setup.

```Enfusion Script
override void SCR_Tutorial_Navigation_CLOSEMAP.Setup()
```

--------------------------------

### Setting Up Tutorial Stage (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__SquadLeadership__END.html

Overrides the Setup method from SCR_BaseTutorialStage. This protected method is called to initialize the tutorial stage, setting up necessary components or states. It does not return any value.

```Enforce Script
override void SCR_Tutorial_SquadLeadership_END.Setup()
```

--------------------------------

### Get Start Variant Name - Enfusion Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/EnfusionScriptAPIPublic/interfaceWeatherState.html

Retrieves the name ID of the starting weather variant for this state.

```Enfusion Script
proto external string GetStartVariantName ()
```

--------------------------------

### Initialize Menu and Search - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/examples.html

Initializes the documentation navigation menu and the search functionality upon document readiness.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Example: Get and Print Local Date (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/EnfusionScriptAPIPublic/interfaceSystem.html

Demonstrates how to declare variables, call System.GetYearMonthDay to get the current local date, and print the year, month, and day using the Print function, including example output.

```Enforce Script
int year = 0;
int month = 0;
int day = 0;
System.GetYearMonthDay(year, month, day);
Print(year);
Print(month);
Print(day);
>> year = 2015
>> month = 3
>> day = 24
```

--------------------------------

### Override Setup Method in SCR_Tutorial_Navigation_MAP_INTROCTUCTION (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Navigation__MAP__INTROCTUCTION.html

Overrides the base Setup method for this specific tutorial stage. Used for initial setup logic.

```Enforce Script
override void Setup ()
```

--------------------------------

### Example: Get and Print UTC Time (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/EnfusionScriptAPIPublic/interfaceSystem.html

Demonstrates how to declare variables, call System.GetHourMinuteSecondUTC to get the current UTC time, and print the hour, minute, and second using the Print function, including example output.

```Enforce Script
int hour = 0;
int minute = 0;
int second = 0;
System.GetHourMinuteSecondUTC(hour, minute, second);
Print(hour);
Print(minute);
Print(second);
>> hour = 15
>> minute = 38
>> second = 7
```

--------------------------------

### Setup Tutorial Stage

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Outro__Return.html

Overrides the base class method to perform initial setup specific to the SCR_Tutorial_Outro_Return stage.

```Enfusion Script
override void Setup ()
```

--------------------------------

### Setup Tutorial Stage - SCR_Tutorial_SW_START - Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__SW__START.html

Overrides the base class method to perform initial setup operations for the SCR_Tutorial_SW_START tutorial stage. This method is typically called when the stage begins to initialize its state, register events, or set up necessary components. It does not return a value.

```Enforce Script
override void Setup ()
```

--------------------------------

### Get Animation Start Time (Enfusion Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/EnfusionScriptAPIPublic/interfaceAnimationPlayerComponent.html

Retrieves the start time configured for the animation.

```Enfusion Script
proto external float AnimationPlayerComponent.GetStartTime
(

)
```

--------------------------------

### Override Setup Method - SCR_Tutorial_Heli_START_ENGINE - Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Heli__START__ENGINE.html

Overrides the base Setup method to perform specific initialization for the helicopter engine start tutorial stage.

```Enforce Script
override void Setup ()
```

--------------------------------

### Setting Up Tutorial Stage (Enfusion Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__VehicleMaintenance__OPEN__STORAGE.html

Overrides the base method to perform specific setup operations for the SCR_Tutorial_VehicleMaintenance_OPEN_STORAGE stage when it starts.

```Enfusion Script
override void Setup ()
```

--------------------------------

### Overriding Setup Method (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__CombatEngineering__START.html

Overrides the base class method to perform initial setup for this tutorial stage when it begins. This method is called once upon stage initialization.

```Enforce Script
override void Setup ()
```

--------------------------------

### Getting Animation Start Time in Enfusion Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/EnfusionScriptAPIPublic/interfaceAnimationPlayerComponent.html

Retrieves the start time configured for the animation.

```Enfusion Script
proto external float GetStartTime ()
```

--------------------------------

### Initialize Menu and Search - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__VehicleMaintenance__ENGINEFULL.html

Sets up the navigation menu and search initialization for the documentation page. It runs on document ready, first initializing the menu and then triggering the search initialization.

```JavaScript
$(function() {
  initMenu('',true,false,'search.php','Search',false);
  $(function() {
    init_search();
  });
});
```

--------------------------------

### Engine Start Interrupt - VehicleControllerComponent.OnEngineStartInterrupt - Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceVehicleControllerComponent.html

Gets called when the engine start routine was interrupted. Implements BaseVehicleControllerComponent.

```Enforce Script
override void VehicleControllerComponent.OnEngineStartInterrupt()
```

--------------------------------

### Get GUID from Resource Name - Arma Reforger Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__ConfigHelper.html

Extracts the GUID string from a full resource name. Optionally removes the surrounding brackets from the GUID.

```Arma Reforger Script
static string SCR_ConfigHelper.GetGUID(
ResourceName resourceName,
bool removeBrackets = false
)
```

--------------------------------

### Setup Tutorial Stage SCR_Tutorial_SW_M72_FIRE Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__SW__M72__FIRE.html

Overrides the base method to perform initial setup for this specific tutorial stage. This typically involves initializing variables, registering callbacks, or setting up dependencies like the destruction component.

```Script
override void Setup ()
```

--------------------------------

### Initialize Menu and Search - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Intro__WakeUp.html

Initializes the documentation menu and search functionality on document ready.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Getting Engine Start Invoker (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__CarControllerComponent.html

Returns a ScriptInvokerVoid that is triggered when the vehicle's engine starts. Subscribe to this invoker to react to engine start events.

```Enforce Script
ScriptInvokerVoid GetOnEngineStart ()
```

--------------------------------

### Setup Method in SCR_TutorialStageMortars_FireShell (C)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__TutorialStageMortars__FireShell.html

Documents the Setup method, a protected function that overrides a base class method, used for initializing the tutorial stage.

```C
override void SCR_TutorialStageMortars_FireShell.Setup()
```

--------------------------------

### Getting Engine Start Invoker - Enfusion Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceAirplaneControllerComponent.html

Retrieves the ScriptInvoker for the Engine Started event. This invoker can be used to subscribe to or trigger actions when the vehicle engine starts.

```Enfusion Script
ScriptInvokerVoid GetOnEngineStart ()
```

--------------------------------

### Get OnStart Invoker (Inherited from SCR_InfoDisplay)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__WeaponSelectionMenu.html

Gets the invoker for the InfoDisplay's start event.

```Enfusion Script
SCR_InfoDisplayInvoker GetOnStart ()
```

--------------------------------

### Setup - SCR_Tutorial_VehicleMaintenance_CANONGROUND (C++)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__VehicleMaintenance__CANONGROUND.html

Overrides the base class method to set up the tutorial stage. Implements SCR_BaseTutorialStage::Setup.

```C++
override void SCR_Tutorial_VehicleMaintenance_CANONGROUND.Setup
(

)
```

--------------------------------

### Engine Start Success - VehicleControllerComponent.OnEngineStartSuccess - Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceVehicleControllerComponent.html

Gets called when the engine start routine has successfully completed. Implements BaseVehicleControllerComponent.

```Enforce Script
override void VehicleControllerComponent.OnEngineStartSuccess()
```

--------------------------------

### Method: OnCourseStart (Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__TutorialLogic__Navigation.html

Called from SCR_TutorialGamemodeComponent on Start of respective course. Implements SCR_BaseTutorialCourseLogic.

```Script
override void SCR_TutorialLogic_Navigation.OnCourseStart()
```

--------------------------------

### Initialize Tutorial Stage Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Obstacle__WINDOW.html

Initializes the tutorial stage with specific information.

```Enforce Script
void Init (SCR_TutorialStageInfo stageInfo)
```

--------------------------------

### Get On Start Invoker InfoDisplay Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__NearbyContextDisplay.html

Retrieves the invoker for the InfoDisplay's start event. Returns an SCR_InfoDisplayInvoker instance.

```Enforce Script
SCR_InfoDisplayInvoker GetOnStart ()
```

--------------------------------

### Setup Tutorial Stage - SCR_BaseTutorialStage - Enforce

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__BaseTutorialStage.html

This protected method is responsible for setting up the tutorial stage when it begins. It takes no parameters.

```Enforce
void SCR_BaseTutorialStage.Setup(
)
```

--------------------------------

### Get On Game Start Event Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__GameModeSectorControl.html

Returns a ScriptInvoker that triggers when the game mode successfully starts.

```Script
ScriptInvoker GetOnGameStart ()
```

--------------------------------

### Get Start Node - SCR_EditorImagePositionCharacterPose (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__EditorImagePositionCharacterPose.html

Retrieves the string name of the starting node within the animation graph for this pose.

```Enforce Script
string SCR_EditorImagePositionCharacterPose.GetStartNode()
```

--------------------------------

### Initializing Tutorial Stage (Inherited) (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__SW__GL__FIRE.html

Inherited from SCR_BaseTutorialStage. Initializes the tutorial stage with the provided SCR_TutorialStageInfo.

```Enforce Script
void Init (SCR_TutorialStageInfo stageInfo)
```

--------------------------------

### Method: Setup (Enfusion Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__ShootingRange__PICKUP__WEAPON.html

This method overrides the base class implementation to perform initial setup logic specifically for the 'Pickup Weapon' tutorial stage.

```Enfusion Script
override void SCR_Tutorial_ShootingRange_PICKUP_WEAPON.Setup()
```

--------------------------------

### Get Engine Start Invoker (Enfusion Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceHelicopterControllerComponent.html

Retrieves the ScriptInvoker for the Engine Started event.

```Enfusion Script
ScriptInvokerVoid GetOnEngineStart ()
```

--------------------------------

### Get Engine Start Invoker VehicleControllerComponent Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceCarControllerComponent.html

Retrieves the ScriptInvoker for the Engine Started event. Subscribe to this invoker to be notified when the vehicle's engine successfully starts.

```Enforce Script
ScriptInvokerVoid GetOnEngineStart ()
```

--------------------------------

### Setup SCR_Tutorial_SW_PLACE_CHARGES stage

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__SW__PLACE__CHARGES.html

Overrides the base class method to perform initial setup for the SCR_Tutorial_SW_PLACE_CHARGES tutorial stage when it begins.

```Enfusion Script
override void SCR_Tutorial_SW_PLACE_CHARGES.Setup()
```

--------------------------------

### Initialize Menu and Search - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Seizing__START.html

Uses jQuery's document ready function to initialize the navigation menu and the search feature for the documentation page.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Getting OnStart Invoker (Inherited) - SCR_InfoDisplay - Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__WheelHitZoneInfo.html

Inherited from SCR_InfoDisplay. Gets the invoker for the display start event. Returns an SCR_InfoDisplayInvoker.

```Enforce Script
SCR_InfoDisplayInvoker GetOnStart()
```

--------------------------------

### Get Target Path Auto - EditablePrefabsConfig - Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceEditablePrefabsConfig.html

Get the path of the auto folder within the target path, without the GUID.

```Enforce Script
string EditablePrefabsConfig.GetTargetPathAuto
(
)
```

--------------------------------

### Initialize Documentation Menu and Search - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__ServerJoinDownloadsConfirmationDialog.html

Initializes the navigation menu and the search functionality for the documentation website upon document readiness.

```JavaScript
$(function() {
  initMenu('',true,false,'search.php','Search',false);
  $(function() {
    init_search();
  });
});
```

--------------------------------

### Initialize Doxygen Menu and Search - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__CombatEngineering__LoadSupplies__1Class.html

Initializes the Doxygen navigation menu and then initializes the search functionality after the menu is ready. This sets up the main navigation and search features for the documentation.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Engine Start Begin - VehicleControllerComponent.OnEngineStartBegin - Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceVehicleControllerComponent.html

Gets called when the engine start routine begins (animation event). Implements BaseVehicleControllerComponent.

```Enforce Script
override void VehicleControllerComponent.OnEngineStartBegin()
```

--------------------------------

### Get Game Start Invoker (Enfusion Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__GameModeCleanSweep.html

Retrieves the script invoker for the game start event.

```Enfusion Script
ScriptInvoker GetOnGameStart ()
```

--------------------------------

### Implementing Setup Method - SCR_Tutorial_Obstacle_ZIGZAGSTART - Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Obstacle__ZIGZAGSTART.html

Documents the signature of the protected Setup method within the SCR_Tutorial_Obstacle_ZIGZAGSTART class. This method overrides the base class implementation from SCR_BaseTutorialStage and is used for stage initialization.

```Enforce Script
override void SCR_Tutorial_Obstacle_ZIGZAGSTART.Setup

(

)

protected
```

--------------------------------

### Setup Method for SCR_Tutorial_Heli_FLIGHT_01 (C-like)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Heli__FLIGHT__01.html

Overrides the base class Setup method. This method is typically called to initialize the tutorial stage, setting up its state and dependencies. It is marked as protected.

```c
override void SCR_Tutorial_Heli_FLIGHT_01.Setup()
```

--------------------------------

### Get Start Origin - SCR_EvacuateTask - Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__EvacuateTask.html

Retrieves the starting origin point previously set for the evacuation task. Returns a vector.

```Enforce Script
vector GetStartOrigin ()
```

--------------------------------

### Getting Associated Transceiver ID Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__VONEntryRadio.html

Gets the ID of the associated transceiver. IDs start with 1.

```Enforce Script
int SCR_VONEntryRadio.GetTransceiverNumber()
```

--------------------------------

### Setting Up Tutorial Stage in SCR_BaseTutorialStage (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Seizing__Exit__Building.html

Initializes the tutorial stage. This method is likely called when the stage begins.

```Enforce Script
void Setup ()
```

--------------------------------

### Engine Start Fail - VehicleControllerComponent.OnEngineStartFail - Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceVehicleControllerComponent.html

Gets called when the engine start routine has failed. Includes a reason parameter. Implements BaseVehicleControllerComponent.

```Enforce Script
override void VehicleControllerComponent.OnEngineStartFail(

EVehicleEngineStartFailedReason

_reason

)
```

--------------------------------

### Initializing Documentation Menu and Search (JavaScript)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__ScenarioFrameworkActionShowHint.html

Initializes the navigation menu and search functionality for the documentation website.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Getting Seizing Start Timestamp SCR_SeizingComponent Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__SeizingComponent.html

Returns the WorldTimestamp indicating when the seizing process started.

```Enforce Script
WorldTimestamp SCR_SeizingComponent.GetSeizingStartTimestamp(

)
```

--------------------------------

### Initialize Doxygen Menu and Search Setup - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__MapMarkerDynamicWComponent-members.html

Initializes the navigation menu and sets up the search functionality for the Doxygen documentation. This ensures the menu and search features are ready for user interaction once the page has loaded. It executes when the DOM is ready.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Getting InfoDisplay Start Invoker (Inherited from SCR_InfoDisplay)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__BaseInteractionDisplay.html

Retrieves the invoker for the InfoDisplay start event. Inherited from SCR_InfoDisplay.

```Enforce Script
SCR_InfoDisplayInvoker GetOnStart ()
```

--------------------------------

### Initialize Documentation Menu and Search - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Seizing__Enter__Building.html

Initializes the documentation navigation menu and then initializes the search functionality after the menu is set up, using jQuery.

```JavaScript
$(function() {
  initMenu('',true,false,'search.php','Search',false);
  $(function() {
    init_search();
  });
});
```

--------------------------------

### Protected Method: SetupHints (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__GalleryComponent.html

Sets up navigation hints based on the item count, with optional animation.

```Enforce Script
void SetupHints (int count, bool animate=true)
```

--------------------------------

### Getting Capture Start Invoker SCR_SeizingComponent Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__SeizingComponent.html

Returns the ScriptInvoker for the event triggered when the capture process starts.

```Enforce Script
ScriptInvoker SCR_SeizingComponent.GetOnCaptureStart(

)
```

--------------------------------

### Get On Engine Start Invoker - VehicleControllerComponent (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceCarControllerComponent__B.html

Retrieves the ScriptInvoker for the Engine Started event, inherited from VehicleControllerComponent.

```Enforce Script
ScriptInvokerVoid GetOnEngineStart ()
```

--------------------------------

### Setting up Tutorial Stage Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Driving__DRIVEROAD4.html

Overrides the base setup method to initialize the specific tutorial stage. It takes no parameters and returns nothing.

```Enforce Script
override void Setup ()
```

--------------------------------

### Get Root World Path (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Global.html

Gets the path to the root world resource, optionally starting from a given world path.

```Enforce Script
static ResourceName GetRootWorld (ResourceName worldPath=ResourceName.Empty)
```

--------------------------------

### Setup Stage SCR_Tutorial_Obstacle_TIME C

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Obstacle__TIME.html

Documents the protected override of the Setup method from SCR_BaseTutorialStage. This method is likely used for initializing the tutorial stage and its components.

```C
override void SCR_Tutorial_Obstacle_TIME.Setup
(
)
```

--------------------------------

### Initializing Doxygen Menu and Search - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Seizing__STARTClass.html

Initializes the Doxygen navigation menu and search functionality. This code runs when the DOM is ready, setting up the menu and then initializing the search feature.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Start Animation Playback (Enfusion Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/EnfusionScriptAPIPublic/interfaceAnimationPlayerComponent.html

Starts playing the animation. It is recommended to call 'Prepare' first if the animation setup needs to be changed.

```Enfusion Script
proto external void AnimationPlayerComponent.Play
(

)
```

--------------------------------

### Initialize Doxygen Menu and Search - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__SW__RPG__FIRE.html

Initializes the navigation menu and the search functionality for the documentation page. This setup is performed once the document is ready, ensuring the UI elements are available.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Getting Start State Name WeatherStateMachine Enfusion Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/EnfusionScriptAPIPublic/interfaceWeatherStateMachine.html

Retrieves the name of the initial weather state. This function returns a string containing the name of the starting state.

```Enfusion Script
proto external [string](interfacestring.html) WeatherStateMachine.GetStartStateName
(

)
```

--------------------------------

### Override Setup Method in SCR_Tutorial_Heli_GETIN (Enfusion Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Heli__GETIN.html

Overrides the base Setup method to initialize the tutorial stage. This method is called when the tutorial stage begins and should contain setup logic specific to the 'Get In Helicopter' task.

```Enfusion Script
override void Setup ()
```

--------------------------------

### Get Day Time (Seconds) - SCR_DayTimeInfoBase - Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__DayTimeInfoBase.html

Gets the starting time of day in seconds for this specific instance. Returns the time of day in seconds.

```Script
float SCR_DayTimeInfoBase.GetDayTime
(
)
```

--------------------------------

### Initialize Documentation Menu and Search

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Outro__Return.html

Initializes the navigation menu and the search functionality for the documentation site upon document load.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Initialize Menu and Search (JavaScript)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__GameplaySettingsSubMenu.html

Initializes the documentation menu and search functionality using jQuery.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Get On Attributes Start Event Arma Reforger Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__AttributesManagerEditorComponent.html

Retrieves the ScriptInvoker for the event triggered when the server confirms that attribute editing has started. Listeners can subscribe to this event.

```Enforce Script
ScriptInvoker GetOnAttributesStart ()
```

--------------------------------

### Getting Engine Start Invoker VehicleControllerComponent Enfusion Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__CarControllerComponent__B.html

Returns a ScriptInvoker that can be used to subscribe to or trigger events related to the vehicle engine starting.

```Enfusion Script
ScriptInvokerVoid GetOnEngineStart ()
```

--------------------------------

### Initializing Doxygen Menu and Search (JavaScript)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__SW__PICKUP__M72__ARSENAL.html

Initializes the navigation menu and search functionality for the Doxygen documentation viewer. This runs when the DOM is ready, setting up the menu and then initializing the search feature.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Initializing Doxygen Menu and Search - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/dir_9f878251f79fe1f91c49d7ab8cb41fd8.html

Initializes the main navigation menu and the search functionality for the Doxygen documentation. It sets up the menu structure and then initializes the search feature.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Initialize Documentation Menu and Search - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__WLibComponentBase.html

Initializes the documentation navigation menu and the search functionality using jQuery, setting up the menu structure and search handler.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Getting Start State Index WeatherStateMachine Enfusion Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/EnfusionScriptAPIPublic/interfaceWeatherStateMachine.html

Retrieves the index of the initial weather state. This function returns an integer corresponding to the starting state's position in the state list.

```Enfusion Script
proto external [int](interfaceint.html) WeatherStateMachine.GetStartStateIndex
(

)
```

--------------------------------

### Get Starting Hour SCR_TimeAndWeatherState Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__TimeAndWeatherState.html

Retrieves the starting hour of the time state configured for this interface. Returns an integer value representing the hour.

```Enforce Script
int SCR_TimeAndWeatherState.GetStartingHour()
```

--------------------------------

### Setting up SCR_Tutorial_Navigation_LIGHTHOUSE Stage - Enfusion Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Navigation__LIGHTHOUSE.html

Overrides the base Setup method to initialize the tutorial stage.

```Enfusion Script
override void Setup ()
```

--------------------------------

### Get On Comm Status Check Start Invoker Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__ServicesStatusHelper.html

Returns a ScriptInvoker that is triggered when a communication status check starts. Use this to subscribe to the event.

```Enforce Script
static ScriptInvokerVoid GetOnCommStatusCheckStart ()
```

--------------------------------

### Initialize Doxygen Menu and Search - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/dir_64fa2f28926f9c85084f9547a759183d.html

Initializes the navigation menu and the search functionality upon the document's ready state.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Handle System Start for Supply System Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__SupplySystem.html

Overrides the base OnStarted method, called when the SCR_SupplySystem is initialized and starts running. Used for system setup.

```Enforce Script
override void OnStarted ()
```

--------------------------------

### Implementing Setup Method (Enfusion Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__VehicleMaintenance__SUPPLY__TRANSFER__GAMEPAD.html

Overrides the base class method to perform initial setup for the tutorial stage. This protected method is called when the stage begins.

```Enfusion Script
override void SCR_Tutorial_VehicleMaintenance_SUPPLY_TRANSFER_GAMEPAD.Setup()
```

--------------------------------

### Method: Setup (Enfusion Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__ShootingRange__SHOOT__REST.html

Protected method used for initializing or setting up the tutorial stage. It overrides the base class method SCR_BaseTutorialStage.Setup.

```Enfusion Script
override void SCR_Tutorial_ShootingRange_SHOOT_REST.Setup
(

)
```

--------------------------------

### Handle Game Start - SCR_DebugCameraCore - Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__DebugCameraCore.html

Override method called when the game starts. This can be used to initialize the debug camera system or perform setup tasks.

```Enforce Script
override void SCR_DebugCameraCore.OnGameStart ()
```

--------------------------------

### Setup Method (Enfusion Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Seizing__CaptureBase.html

Overrides the base class method to perform initial setup for the tutorial stage. This method is protected.

```Enfusion Script
override void SCR_Tutorial_Seizing_CaptureBase.Setup
(

)
```

--------------------------------

### Handle Action Start - SCR_AdjustSignalAction - Enfusion Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__AdjustTimedFuzeAction.html

Invoked by the scripted interaction handler when the action begins execution, typically when a progress bar appears. This is used for setup or visual feedback at the start of the action.

```Enfusion Script
override void OnActionStart (IEntity pUserEntity)
```

--------------------------------

### Getting OnStart Invoker SCR_InfoDisplay Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__HZInfoRotorMain.html

Retrieves the invoker for the display's start event. This allows other systems to subscribe to or trigger actions when the display starts.

```Enforce Script
SCR_InfoDisplayInvoker GetOnStart ()
```

--------------------------------

### Initializing Menu and Search JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__SW__PLACE__CHARGES.html

Initializes the navigation menu and search functionality on page load, setting up the interactive elements for browsing the documentation.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Get Starting Vehicle Prefabs - SCR_CampaignFaction (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__CampaignFaction.html

Retrieves the list of starting vehicle prefabs associated with the campaign faction. The prefabs are returned in the provided array.

```Enforce Script
void GetStartingVehiclePrefabs (out notnull array< ResourceName > prefabs)
```

--------------------------------

### Setup Method Override

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Navigation__COMPASS.html

Overrides the Setup method from SCR_BaseTutorialStage. This method is used to initialize or configure the tutorial stage.

```Enfusion Script
override void SCR_Tutorial_Navigation_COMPASS.Setup
(

)
protected
```

--------------------------------

### Setup Method (C++)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Seizing__Move.html

Protected member function to set up the tutorial stage, overriding the base class method.

```C++
override void SCR_Tutorial_Seizing_Move.Setup()
```

--------------------------------

### Get OnCaptureStart Invoker - SCR_SeizingComponent (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__CampaignSeizingComponent.html

Inherited from SCR_SeizingComponent. Returns a ScriptInvoker that is triggered when the base capture process starts. Useful for subscribing to capture start events.

```Enforce Script
ScriptInvoker GetOnCaptureStart ()
```

--------------------------------

### Getting Starting Vehicle Prefabs - SCR_CampaignFaction (Enfusion Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__CampaignFaction.html

Populates an array with the resource names of the starting vehicle prefabs for the campaign faction. Takes an output array of ResourceName.

```Enfusion Script
void SCR_CampaignFaction.GetStartingVehiclePrefabs(out notnull array<ResourceName> prefabs)
```

--------------------------------

### Initialize Menu and Search - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__SW__MOVE__BACKClass.html

Initializes the navigation menu and search functionality for the documentation page. It sets up the menu structure and prepares the search input field for user queries.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Get Link From Source - EditablePrefabsConfig - Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceEditablePrefabsConfig.html

Get a link from a prefab to its editable prefab. Takes the prefab GUID as input and outputs the found linked prefab resource name. Returns true if a link is found.

```Enforce Script
bool EditablePrefabsConfig.GetLinkFromSource
(
string
_guid_,
out ResourceName
_linkedPrefab_ = ResourceName::Empty
)
```

--------------------------------

### Initializing Doxygen Menu and Search (JavaScript)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__DownloadManagerListCategory.html

Initializes the Doxygen navigation menu and sets up the search functionality upon document readiness.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Perform Delayed Setup

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Outro__Return.html

A method to perform setup tasks for the tutorial stage after an initial delay.

```Enfusion Script
void DelayedSetup ()
```

--------------------------------

### Get OnStart Invoker in SCR_InfoDisplay (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__CaptureAndHoldObjectiveDisplay.html

Retrieves the invoker for the InfoDisplay start event.

```Enforce Script
SCR\_InfoDisplayInvoker GetOnStart ()
```

--------------------------------

### Initializing Doxygen Menu and Search - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/dir_f1b2fb8c32b15cc7f324553c7eb7d181.html

Initializes the Doxygen navigation menu and search functionality. This snippet runs on document ready, first calling `initMenu` to set up the navigation structure, and then calling `init_search` to prepare the search index and UI.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Getting OnStart Invoker SCR_InfoDisplay Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__DamageBlurEffect.html

Inherited from SCR_InfoDisplay, this method returns the SCR_InfoDisplayInvoker for the start event, allowing external code to subscribe to or trigger the display's start event.

```Enforce Script
SCR_InfoDisplayInvoker GetOnStart ()
```

--------------------------------

### Initializing Menu and Search JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/dir_4ff75abe45ab8f19b6d4b8c99247a05c.html

Initializes the documentation menu and the search functionality. This code runs when the document is ready, setting up navigation and search features.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Initialize Documentation Menu and Search - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__AIDebugInfoComponent.html

This jQuery snippet runs on document ready to initialize the navigation menu and search features. It calls `initMenu` with configuration parameters and then calls `init_search` to set up the search functionality.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Callback OnTransitionStarted in Enfusion Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/EnfusionScriptAPIPublic/interfaceBaseWeatherTransitionCallbacks.html

Called when a transition starts. Does not get called if state is transitioned immediately through RequestStateTransitionImmediately.

```Script
void BaseWeatherTransitionCallbacks.OnTransitionStarted ( WeatherStateTransitionNode transition )
```

--------------------------------

### Setup Voice System - SCR_TutorialGamemodeComponent.SetupVoiceSystem - Enfusion Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__TutorialGamemodeComponent.html

Initializes or configures the voice system for the tutorial. This might involve setting up narration or character voice lines.

```Enfusion Script
void SCR_TutorialGamemodeComponent.SetupVoiceSystem(
)
```

--------------------------------

### Get Perpendicular Vector Enforce

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/EnfusionScriptAPIPublic/interfacevector.html

Illustrates how to get a vector perpendicular to the input vector using the Perpend method. The perpendicular vector is computed as the cross product with the up vector (0, 1, 0). The example initializes a vector and prints its perpendicular counterpart.

```Enforce
vector vec = "1 0 0";
Print( vec.Perpend() );
```

--------------------------------

### Initializing Doxygen Menu and Search - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Navigation__STARTClass.html

Initializes the Doxygen navigation menu and search functionality using nested jQuery document ready functions. It first calls `initMenu()` with configuration parameters for the menu and then calls `init_search()` to set up the search feature.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Getting Class Name in Enfusion Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/EnfusionScriptAPIPublic/interfaceClass.html

Illustrates how to retrieve the string name of an object's class using the `ClassName` method in Enfusion Script. The example gets the player object and prints its class name.

```Enfusion Script
Man player = g_Game.GetPlayer();
string className = player.ClassName();
Print(className);
// >> className = 'Man'
```

--------------------------------

### Handle Action Start (OnActionStart) - Enfusion Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__InspectCasualtyUserAction.html

Callback method invoked when a scripted interaction handler initiates this action, typically when a progress bar appears. This allows for setup or visual feedback at the start of the action.

```Enfusion Script
override void
OnActionStart (IEntity pUserEntity)
```

--------------------------------

### Override Setup Method (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Obstacle__START.html

Overrides the base class method to provide specific setup logic for the tutorial stage. This method is typically called to initialize the stage's state or components.

```Enforce Script
override void Setup ()
```

--------------------------------

### Get Link From Target - EditablePrefabsConfig - Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceEditablePrefabsConfig.html

Get a link from an editable prefab back to its source prefab. Takes the editable prefab GUID as input and outputs the found source prefab resource name. Returns true if a link is found.

```Enforce Script
bool EditablePrefabsConfig.GetLinkFromTarget
(
string
_guid_,
out ResourceName
_linkedPrefab_ = ResourceName::Empty
)
```

--------------------------------

### Initialize Documentation Menu and Search - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__SW__ARM__CHARGES.html

Initializes the navigation menu and the search functionality for the documentation page using jQuery, setting up menu behavior and search input handling.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Initializing Doxygen Menu and Search - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__CombatEngineering__STARTClass.html

Initializes the navigation menu and the search functionality for the Doxygen documentation. This ensures the menu is properly set up and the search input is ready to handle user queries.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Get Sights Direction (Zeroing)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__PIPSightsComponent.html

Returns an additional sights position vector used for calculating zeroing. The vector is calculated from a start position to an end position and serves as the direction for zeroing offsets. The end position should be further from the eye position than the start position.

```Enfusion Script
proto external vector
[GetSightsDirection](interfaceBaseSightsComponent.html#ae1e14e88faf119f6fcaa20d9296e2457) (bool localSpace=false, bool normalize=true)
```

--------------------------------

### Initialize Menu and Search (JavaScript)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Intro__ListenToCaptain.html

Initializes the navigation menu and the search functionality on page load using Doxygen's initMenu and init_search functions.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Engine Start Progress - VehicleControllerComponent.OnEngineStartProgress - Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceVehicleControllerComponent.html

Get called while engine starter is active. Implements BaseVehicleControllerComponent.

```Enforce Script
override void VehicleControllerComponent.OnEngineStartProgress()
```

--------------------------------

### Setup Method - SCR_Tutorial_LRS_Targets_Beach - Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__LRS__Targets__Beach.html

Protected method to set up the tutorial stage. Overrides and implements SCR_BaseTutorialStage::Setup().

```Enforce Script
override void SCR_Tutorial_LRS_Targets_Beach.Setup()
```

--------------------------------

### OnEngineStartFail (Enfusion Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceBaseVehicleControllerComponent.html

Gets called when the engine start routine has failed.

```Enfusion Script
void OnEngineStartFail (EVehicleEngineStartFailedReason reason)
```

--------------------------------

### OnEngineStartInterrupt (Enfusion Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceBaseVehicleControllerComponent.html

Gets called when the engine start routine was interrupted.

```Enfusion Script
void OnEngineStartInterrupt ()
```

--------------------------------

### Setup Method in SCR_Tutorial_SW_SWITCH_FIREMODE (C++)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__SW__SWITCH__FIREMODE.html

Documents the Setup method, which overrides a base class method to initialize the tutorial stage. It is a protected member function.

```C++
override void SCR_Tutorial_SW_SWITCH_FIREMODE.Setup()
```

--------------------------------

### Initialize Menu and Search - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__CombatEngineering__EnterBuilding__2.html

Initializes the navigation menu and search features for the documentation page upon document readiness. Configures menu behavior and search integration.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### GetDelay Method - WidgetAnimationBase - Enforce

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceWidgetAnimationPosition.html

Gets the configured start delay for the animation. Inherited from WidgetAnimationBase.

```Enforce
float GetDelay ()
```

--------------------------------

### Initialize Doxygen Menu and Search - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Navigation__DRIVE.html

Initializes the navigation menu and search functionality for the Doxygen documentation page using jQuery. It sets up the menu and then initializes the search feature.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### GetOnStart Method (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__VehicleTurretElevationDisplay.html

Gets the invoker event triggered when the display starts.

```Enforce Script
SCR_InfoDisplayInvoker GetOnStart ()
```

--------------------------------

### Setup Tutorial Stage (Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__VehicleMaintenance__REFUELFULL.html

Overrides the base method to perform initial setup for this specific tutorial stage (Vehicle Maintenance Refuel Full) when it becomes active.

```Script
override void SCR_Tutorial_VehicleMaintenance_REFUELFULL.Setup()
```

--------------------------------

### Get Count of Outdated Addons (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__AddonManager.html

Returns the total number of installed addons that are currently marked as outdated.

```Enforce Script
int SCR_AddonManager.GetCountAddonsOutdated
(
)
```

--------------------------------

### Initialize Documentation Menu and Search - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__AnalogGauge360.html

Initializes the navigation menu and the search functionality for the documentation. This runs when the DOM is ready, setting up the menu structure and preparing the search input.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Method: GetAnimationDeactivationDelay (Arma Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__2DOpticsComponent-members.html

Gets the delay before the ADS deactivation animation starts.

```Arma Script
GetAnimationDeactivationDelay()
```

--------------------------------

### Method: GetAnimationActivationDelay (Arma Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__2DOpticsComponent-members.html

Gets the delay before the ADS activation animation starts.

```Arma Script
GetAnimationActivationDelay()
```

--------------------------------

### Method: Setup (Enforce)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__ShootingRange__SHOOT__BIPOD.html

Protected method that overrides the base setup method. Initializes the tutorial stage, likely setting up targets and conditions.

```Enforce
override void SCR_Tutorial_ShootingRange_SHOOT_BIPOD.Setup
(

)
```

--------------------------------

### Initialize Menu and Search - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/EnfusionScriptAPIPublic/dir_a40c290ad55e700ae38c2f79fb2bb696.html

Initializes the navigation menu and search functionality for the documentation site on document ready, configuring menu options and then initializing the search feature.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### OnEngineStartSuccess (Enfusion Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceBaseVehicleControllerComponent.html

Gets called when the engine start routine has successfully completed.

```Enfusion Script
void OnEngineStartSuccess ()
```

--------------------------------

### Example: Using SetFlags

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/EnfusionScriptAPIPublic/interfaceIEntity.html

Demonstrates how to get the player entity and set the VISIBLE and TRACEABLE flags simultaneously using the bitwise OR operator.

```Enforce Script
Man player = g_Game.GetPlayer();
player.SetFlags(EntityFlags.VISIBLE|EntityFlags.TRACEABLE );
Print( player.GetFlags() );
```

--------------------------------

### Declaring Setup in Enforce Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__WorkshopDownloadSequence.html

Setup new created download sequence.

```Enforce Script
void Setup (notnull array< ref SCR_WorkshopItem > dependencies, bool skipDetails)
```

--------------------------------

### Example: Using SetEventMask

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/EnfusionScriptAPIPublic/interfaceIEntity.html

Demonstrates how to get the current event mask of a player entity, set it to EntityEvent.VISIBLE, and print the mask before and after the change.

```Enforce Script
Man player = g_Game.GetPlayer();
Print( player.GetEventMask() );
player.SetEventMask( EntityEvent.VISIBLE );
Print( player.GetEventMask() );
```

--------------------------------

### Initialize Doxygen Menu and Search - JavaScript

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/dir_6d4143e4dff97711e8216613e915c8b5.html

Uses jQuery's document ready function to initialize the Doxygen navigation menu with specified parameters, and then initializes the search functionality after the menu setup is complete. This sets up the main navigation and search bar.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Example: Getting Time of Day - Engine Script

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/EnfusionScriptAPIPublic/interfaceBaseWeatherManagerEntity.html

Demonstrates how to retrieve and print the current time of the day using GetTimeOfTheDay.

```Engine Script
SetTimeOfTheDay(16.5);
float totd = GetTimeOfTheDay();
Print(totd);
// >> float totd = 16.5
```

--------------------------------

### GetOnStart - SCR_InfoDisplay (Enforce Script)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__NotificationsLogDisplay.html

Gets the invoker object for the InfoDisplay's start event.

```Enforce Script
SCR_InfoDisplayInvoker GetOnStart()
```

--------------------------------

### Initialize Doxygen Menu and Search

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__Tutorial__Intro__GearUpClass.html

Initializes the Doxygen navigation menu and search functionality. This script runs on document ready, first initializing the menu with specified parameters and then initializing the search feature.

```JavaScript
$(function() { initMenu('',true,false,'search.php','Search',false); $(function() { init_search(); }); });
```

--------------------------------

### Get Engine Malfunction Threshold on SCR_VehicleDamageManagerComponent (Enforce)

Source: https://github.com/tacticalcatboy/armareforgerdocs/blob/main/ArmaReforgerScriptAPIPublic/interfaceSCR__HelicopterDamageManagerComponent-members.html

Retrieves the damage threshold at which the vehicle's engine will start to malfunction.

```Enforce
GetEngineMalfunctionThreshold()
```
Tokens:
Raw