Arma Reforger Script API

https://github.com/tacticalcatboy/armareforgerscriptapipublic
Admin
Arma Reforger Script API Public Docs
Tokens:10,695,932
Snippets:76,192
Trust Score:4.8
Update:11 months ago
Show doc for...
Tokens:
Raw
### Get Place Start Effects in SCR_PlacingEditorComponent

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__PlacingEditorComponentClass.html

Returns a list of editor effects that are triggered when a place action is initiated. This allows for pre-placement visual cues or setup operations.

```cpp
array< ref SCR_BaseEditorEffect > SCR_PlacingEditorComponentClass.GetEffectsPlaceStart
(
)

```

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

### Setup Function Implementation (C)

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

Implements the Setup method from the SCR_BaseTutorialStage interface. This function is responsible for initializing the tutorial stage. It takes no arguments and returns void.

```C
override void SCR_Tutorial_Navigation_LIGHTHOUSE.Setup
(
)

protected
```

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

### SCR_BaseGameMode - Get On Game Start

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__GameModeCampaign-members.html

Registers a listener for when the game session starts.

```APIDOC
## POST /api/gamemode/base/on_game_start

### Description
Registers a listener for when the game session starts. This endpoint would typically trigger a callback or event upon game initiation.

### Method
POST

### Endpoint
/api/gamemode/base/on_game_start

### Parameters
#### Request Body
- **callbackUrl** (string) - Required - The URL to send notifications to when the game starts.

### Response
#### Success Response (200)
- **status** (string) - Confirmation message indicating the listener has been registered.

#### Response Example
{
  "status": "Callback registered for game start events."
}
```

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

### SCR_Tutorial_Intro_WakeUp: Setup Function

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

The 'Setup' function is an override method within the SCR_Tutorial_Intro_WakeUp interface. It likely initializes the tutorial stage or related components. Its exact parameters and return values are not detailed here, but it's a standard part of the tutorial stage lifecycle.

```cpp
override void Setup ()

```

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

### Implement Setup in C

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__CombatEngineering__Move__5.html

The Setup method is an override that is called to initialize the tutorial stage. It does not take any parameters and is protected.

```C
override void SCR_Tutorial_CombatEngineering_Move_5.Setup
(
)
protected
Implements SCR_BaseTutorialStage.Setup.
```

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

### SCR_GameModeCampaign - Get Min Starting Supplies

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__GameModeCampaign-members.html

Retrieves the minimum amount of starting supplies available in the campaign game mode.

```APIDOC
## GET /api/gamemode/campaign/supplies/min/starting

### Description
Retrieves the minimum amount of starting supplies available in the campaign game mode.

### Method
GET

### Endpoint
/api/gamemode/campaign/supplies/min/starting

### Parameters
None

### Response
#### Success Response (200)
- **minSupplies** (int) - The minimum starting supply value.

#### Response Example
{
  "minSupplies": 1000
}
```

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

### SCR_GameModeCampaign - Get Max Starting Supplies

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__GameModeCampaign-members.html

Retrieves the maximum amount of starting supplies available in the campaign game mode.

```APIDOC
## GET /api/gamemode/campaign/supplies/max/starting

### Description
Retrieves the maximum amount of starting supplies available in the campaign game mode.

### Method
GET

### Endpoint
/api/gamemode/campaign/supplies/max/starting

### Parameters
None

### Response
#### Success Response (200)
- **maxSupplies** (int) - The maximum starting supply value.

#### Response Example
{
  "maxSupplies": 5000
}
```

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

### Setup Method in C

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__CombatEngineering__SpawnEntity__1.html

Initializes the tutorial stage. This protected override method, implementing SCR_BaseTutorialStage.Setup, is called when the stage begins.

```c
override void SCR_Tutorial_CombatEngineering_SpawnEntity_1.Setup()
{
    // Implementation details would go here
}
```

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

### C: Setup Method Implementation

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__ShootingRange__MG__PICK.html

Implements the Setup method for the SCR_Tutorial_ShootingRange_MG_PICK class. This method, inherited from SCR_BaseTutorialStage, is responsible for initializing the tutorial stage. No specific dependencies or input/output details are provided in the documentation.

```c
override void SCR_Tutorial_ShootingRange_MG_PICK.Setup
(
)
protected
```

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

### Get On Engine Start Event (VehicleControllerComponent)

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

Returns a ScriptInvokerVoid that is invoked when the vehicle's engine starts. This allows other systems to subscribe to engine start events.

```C++
ScriptInvokerVoid GetOnEngineStart ()

```

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

### Setup Function in C

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__VehicleMaintenance__GETOUT.html

The Setup function overrides the base implementation to initialize the tutorial stage for vehicle maintenance (GET OUT). It is called when the stage begins and sets up the necessary conditions. This function is part of the SCR_BaseTutorialStage interface.

```c
override void SCR_Tutorial_VehicleMaintenance_GETOUT.Setup
(
)

protected

Implements [SCR_BaseTutorialStage](interfaceSCR__BaseTutorialStage.html#ae51bde7a3df83104c28c8134156d2acb).
```

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

### Define Game Mode Setup Descriptions

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__GameModeSetupPlugin.html

These constants provide detailed explanations and instructions for different stages of the game mode setup process. They guide the user through creating entities, configuring mission headers, and understanding validation steps.

```C#
const string SCR_GameModeSetupPlugin.DESCRIPTION_GENERATION = "The plugin can now create required entities in the world.\nThey will be created in the current layer, but you can later move them to any other layer."
const string SCR_GameModeSetupPlugin.DESCRIPTION_GENERATION_RESULTS = "Required entities were created in the current layer.\nTry to re-scan the world to see if nothing is missing anymore.\n"
const string SCR_GameModeSetupPlugin.DESCRIPTION_INTRO = "Welcome to step-by-step setup of a game mode.\nA game mode is a set of rules that define how the world will function.\nWithout it, players won't be able to try your world in game.\nEven opening the world in Game Master requires you to create a Game Master game mode for it.\n\nThe plugin will explain what's needed to get a game mode up an running,\nand offer automatic creation of required configuration.\n\nBefore we start, please select a template of the game mode you wish to set up.\n"
const string SCR_GameModeSetupPlugin.DESCRIPTION_MISSION_HEADER = "For the game mode to appear in main menu's scenario list, it needs a mission header.\nIt's a config file which exists outside of the world, but points to it.\n\nIn this step you can let the plugin create the file automatically."
const string SCR_GameModeSetupPlugin.DESCRIPTION_MISSION_HEADER_RESULTS = ""
const string SCR_GameModeSetupPlugin.DESCRIPTION_OUTRO_COMPLETE = "Congratulations, the game mode is configured correctly.\n\nGive it a try and hit that Play button!"
const string SCR_GameModeSetupPlugin.DESCRIPTION_OUTRO_INCOMPLETE = "Configuration was not finished.\nTo ensure the game mode is set up correctly, please fix all issues and go through each step again."
const string SCR_GameModeSetupPlugin.DESCRIPTION_VALIDATION = "To know what needs to be configured the plugin will scan all entities currently present in the world.\nDepending on the size of the world, this may take several seconds or minutes.\n\nYou can decide to skip this step, but unless you understand how to set up game mode manually,\nit's better to let the plugin check the current status first."
```

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

### Setup

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__Obstacle__LADDEROFF-members.html

Sets up the obstacle.

```APIDOC
## Setup

### Description
Sets up the obstacle configuration.

### Method
Not applicable (this appears to be a function call within the script engine).

### Endpoint
Not applicable.

### Parameters
#### Path Parameters
None.

#### Query Parameters
None.

#### Request Body
None.

### Request Example
```
Setup();
```

### Response
#### Success Response (200)
No specific return value documented. Assumed to successfully set up the obstacle.

#### Response Example
None.
```

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

### SCR_InfoDisplay: Get On Start (void)

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__VONRadialDisplay.html

Returns the invoker for the 'On Start' event of the InfoDisplay. This allows other systems to register callbacks that will be executed when the InfoDisplay starts its lifecycle.

```cpp
SCR_InfoDisplayInvoker
GetOnStart()
```

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

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

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__CombatEngineering__EnterBuilding__1.html

The Setup method initializes the current tutorial stage. It overrides the base implementation from SCR_BaseTutorialStage. This function is called when the tutorial stage begins.

```C++
override void SCR_Tutorial_CombatEngineering_EnterBuilding_1.Setup
(
)
protected
Implements [SCR_BaseTutorialStage](interfaceSCR__BaseTutorialStage.html#ae51bde7a3df83104c28c8134156d2acb).

```

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

### Vehicle Interface: Get Vehicle Controller (C++ Example)

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceVehicle.html

This example demonstrates how to retrieve the VehicleControllerComponent for a given vehicle entity. The VehicleControllerComponent is essential for controlling and managing vehicle operations. Ensure the entity is a valid vehicle before attempting to get its controller.

```cpp
VehicleControllerComponent GetVehicleController()
{
    // Returns the vehicle controller component.
    return m_VehicleController;
}
```

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

### Get Start Origin for Evacuate Task

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

Retrieves the starting origin (position) for the evacuation task.

```C++
vector SCR_EvacuateTask.GetStartOrigin
(
)

```

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

### Setup() Function Implementation in C

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__SW__MOVE__TO__OBSTACLE.html

This C code snippet defines the 'Setup()' function, an override method for the SCR_BaseTutorialStage interface. It's a protected member function responsible for initializing the tutorial stage. No external dependencies are explicitly mentioned, and it takes no arguments.

```c
override void SCR_Tutorial_SW_MOVE_TO_OBSTACLE.Setup
(
)
protected
```

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

### Get OnInit Event

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__EditorManagerEntity.html

Gets the script invoker event that is called when the editor is initialized. This event is part of the SCR_EditorBaseEntity interface and signals the start of the editor's lifecycle.

```csharp
ScriptInvoker SCR_EditorManagerEntity.GetOnInit()
{
    // Returns script invoker
}
```

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

### Implement Setup() Method in C

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__Intro__Move.html

This C code snippet shows the implementation of the protected 'Setup()' method within the SCR_Tutorial_Intro_Move class. This method overrides a base class method from SCR_BaseTutorialStage and is part of a game mode tutorial's intro sequence.

```c
override void SCR_Tutorial_Intro_Move.Setup
(
)
protected
Implements [SCR_BaseTutorialStage](interfaceSCR__BaseTutorialStage.html#ae51bde7a3df83104c28c8134156d2acb).
```

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

### Get Engine Start Invoker - Arma Reforger API

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

Obtains an invoker for the 'Engine Started' event. This allows scripts to subscribe to or trigger the engine start event. It returns a ScriptInvokerVoid object.

```Arma Reforger Script API
ScriptInvokerVoid 
[GetOnEngineStart](interfaceVehicleControllerComponent.html#a53d0a02c1945ae2fb03d35365b90fe09) ()
```

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

### Setup Method (C)

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__Driving__START.html

Overrides the Setup method from the SCR_BaseTutorialStage interface. This function is responsible for initializing the driving tutorial stage. It takes no arguments and returns void.

```C
override void SCR_Tutorial_Driving_START.Setup
(
)

```

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

### Get GUID from Resource Name (Arma Script)

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

Extracts the GUID from a full resource name string. Optionally removes the surrounding brackets from the GUID. This is useful for uniquely identifying resources.

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

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

### Tutorial Stage State Checking and Setup

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__CombatEngineering__LoadSupplies__1.html

This snippet includes functions for managing the state of a tutorial stage. 'GetIsFinished' checks if the current stage is complete, while 'Setup' initializes the stage. 'SetupSupplyConsumer' is a specific function likely related to resource management within the stage.

```C++
override bool GetIsFinished();
override void Setup();
void SetupSupplyConsumer();
```

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

### Get Effects for Placing Start (SCR_PlacingEditorComponentClass)

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__CampaignBuildingPlacingEditorComponentClass.html

Retrieves an array of SCR_BaseEditorEffect objects that are applied when placing an entity starts. This is inherited from SCR_PlacingEditorComponentClass.

```sqf
array< ref SCR_BaseEditorEffect > GetEffectsPlaceStart()
```

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

### Setup Function Reference

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__Seizing__Place__Antenna.html

This function is likely responsible for initializing or setting up the tutorial stage. It takes no arguments and has a void return type. Inherited from SCR_BaseTutorialStage.

```csharp
void
[Setup](interfaceSCR__BaseTutorialStage.html#ae51bde7a3df83104c28c8134156d2acb) ()
```

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

### SCR_Tutorial_Obstace_WALLONE: Setup() Implementation

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__Obstacle__WALLONE.html

Implements the Setup method for the SCR_Tutorial_Obstace_WALLONE class, overriding the base tutorial stage functionality. This method is responsible for initializing the 'WALLONE' obstacle during a tutorial stage.

```C
override void SCR_Tutorial_Obstacle_WALLONE.Setup
(
)

protected

Implements SCR_BaseTutorialStage.Setup
```

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

### Initialize Game Mode Setup in Arma Reforger Script API

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceGameModeSetupConfig.html

Initializes the game mode setup process. This function is called by the SCR_GameModeSetupPlugin.RunValidation() method and is essential for starting the setup sequence. It does not return any value.

```C#
void Init()
```

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

### C++ Setup Method

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__Driving__DRIVEROAD3.html

The Setup method is an override from the SCR_BaseTutorialStage interface. It is called when the tutorial stage is initialized, performing necessary setup operations. This method likely configures the game state or UI elements required for the driving tutorial.

```cpp
override void SCR_Tutorial_Driving_DRIVEROAD3.Setup
(
)
protected
```

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

### Get Engine Start Invoker (VehicleControllerComponent)

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

Provides an invoker for the Engine Started event. This allows external scripts to hook into and react when the vehicle's engine successfully starts. It is inherited from the base VehicleControllerComponent.

```cpp
ScriptInvokerVoid 
[GetOnEngineStart](interfaceVehicleControllerComponent.html#a53d0a02c1945ae2fb03d35365b90fe09) ()
```

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

### SCR_Tutorial_Navigation_CLOSEMAP Setup Method

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

The Setup method is called to initialize the tutorial stage. It overrides the base class method and performs specific setup tasks for the map closing tutorial stage. It takes no arguments and has a protected access level.

```c
override void SCR_Tutorial_Navigation_CLOSEMAP.Setup
(
)
protected
Implements SCR_BaseTutorialStage.ae51bde7a3df83104c28c8134156d2acb.
```

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

### SCR_RespawnTimer: Get Start Time

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__RespawnTimer.html

Retrieves the current start time of the respawn timer. Returns the time in seconds as synchronized time.

```Script
WorldTimestamp GetStartTime()
```

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

### Get Time Started for Hint UI

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__HintUIInfo-members.html

Retrieves the time when the hint UI element was started. This method is part of the SCR_HintUIInfo interface.

```csharp
public float GetTimeStarted()
```

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

### SCR_Tutorial_CombatEngineering_LoadSupplies_2: Setup Methods

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__CombatEngineering__LoadSupplies__2.html

Provides the 'Setup' method for initializing the tutorial stage and 'SetupSupplyConsumer' for setting up the supply consumption logic. These methods are crucial for the initial configuration of the supply loading phase.

```C++
override void Setup()

void SetupSupplyConsumer()
```

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

### On Engine Start Fail Event (VehicleControllerComponent)

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

Gets called when the engine start routine has failed. This function accepts a reason for the failure, allowing for specific handling based on why the engine did not start. It's an overridden method from VehicleControllerComponent.

```cpp
override void 
[OnEngineStartFail](interfaceVehicleControllerComponent.html#a9f39d2928d7001a3491ad37868a7918f) ([EVehicleEngineStartFailedReason](group__Components.html#ga1f74a0c2c2236a2296acdbde0b06e9b2) reason)
```

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

### Setup Method - SCR_Tutorial_Driving_STARTENGINE (C)

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__Driving__STARTENGINE.html

Implements the protected Setup method for the SCR_Tutorial_Driving_STARTENGINE class. This function is responsible for initializing or setting up the tutorial stage. It overrides the base implementation from SCR_BaseTutorialStage.

```c
override void SCR_Tutorial_Driving_STARTENGINE.Setup
(
)

protected

Implements SCR_BaseTutorialStage.ae51bde7a3df83104c28c8134156d2acb.
```

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

### Get Reading Init State - ArmaScript

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__DestructionDamageManagerComponent.html

A static function to get or set the 'readingInit' state. This is likely used internally to manage initialization logic, possibly related to script reading or component setup.

```ArmaScript
static bool SCR_DestructionDamageManagerComponent.GetReadingInit

(

bool
_readingInit_
)
```

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

### Implement Setup in C

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__CombatEngineering__Move__1.html

Overrides the Setup method from the SCR_BaseTutorialStage interface. This function is responsible for initializing the tutorial stage. It does not take any parameters and returns void.

```C
override void SCR_Tutorial_CombatEngineering_Move_1.Setup
(
)
protected
Implements SCR_BaseTutorialStage.Setup.
```

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

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

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

Overrides the Setup method from the base tutorial stage interface. This protected method is responsible for initializing the tutorial stage. It takes no parameters and returns void.

```c++
override void SCR_Tutorial_Seizing_START.Setup
(
)

```

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

### Get SCR_HintUIInfo Time Started

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__HintUIInfo.html

Retrieves the timestamp when the hint started, which is necessary for map implementation. Returns the replication time of hint creation.

```C++
WorldTimestamp SCR_HintUIInfo.GetTimeStarted()
```

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

### Get Minimum Distance from Start for Evacuate Task

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

Returns the minimum required distance from the starting point for an evacuation task. This is a static method.

```C++
static float SCR_EvacuateTask.GetMinDistanceFromStart
(
)

```

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

### Setup() - SCR_Tutorial_SquadLeadership_GETIN

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

Sets up the tutorial stage for squad leadership. This is an override of the base class method and is responsible for initializing the stage.

```C#
override void SCR_Tutorial_SquadLeadership_GETIN.Setup
(
)
protected
Implements SCR_BaseTutorialStage.Setup()
```

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

### Setup Method - SCR_Tutorial_Obstacle_START (C++)

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

Implements the protected Setup method for the SCR_Tutorial_Obstacle_START class. This method is responsible for initializing the tutorial obstacle and overrides the method from the SCR_BaseTutorialStage interface.

```cpp
override void SCR_Tutorial_Obstacle_START.Setup
(
)
protected
Implements SCR_BaseTutorialStage.Setup
```

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

### Arma Reforger: Get Start Node (SCR_EditorImagePositionCharacterPose)

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

Retrieves the string name of the starting node for the character animation. This function is part of the SCR_EditorImagePositionCharacterPose interface.

```cpp
string SCR_EditorImagePositionCharacterPose.GetStartNode()
```

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

### SCR_Tutorial_Navigation_NORTH Setup Method

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__Navigation__NORTH.html

The Setup method overrides the base implementation to perform initialization tasks for the tutorial stage. It is called during the setup phase of the tutorial.

```C
override void SCR_Tutorial_Navigation_NORTH.Setup
(
)

```

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

### Setup Function in C

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

The Setup function is an override function that initializes the tutorial stage. It is called to prepare the stage for execution. This function is protected and implements the SCR_BaseTutorialStage interface.

```C
override void SCR_Tutorial_CombatEngineering_EnterBuilding_2.Setup
(
)
protected
```

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

### Get On Sound Event Started - Arma Script

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__CommunicationSoundComponent-members.html

Returns a reference to the signal that is triggered when a sound event starts. This enables other components to react to the beginning of sound events.

```armascript
function GetOnSoundEventStarted()
```

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

### Implement SCR_BaseTutorialStage Setup() in C

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__Navigation__START.html

This C code snippet demonstrates the implementation of the Setup() function, which overrides a method from the SCR_BaseTutorialStage interface. It is declared as protected and has no parameters or return value.

```C
override void SCR_Tutorial_Navigation_START.Setup
(
)
protected
Implements SCR_BaseTutorialStage.ae51bde7a3df83104c28c8134156d2acb.
```

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

### On Engine Start Begin Event (VehicleControllerComponent)

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

Gets called when the engine start routine begins, typically triggered by an animation event. This function allows for logic execution at the very start of the engine ignition process. It's an overridden method from VehicleControllerComponent.

```cpp
override void 
[OnEngineStartBegin](interfaceVehicleControllerComponent.html#a0d76d75e2f7d3b5647b1442f31511b88) ()
```

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

### On Engine Start Begin (VehicleControllerComponent)

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

Called at the very beginning of the engine start sequence. This function can be used for initial setup or checks before the engine officially begins to run.

```C++
void OnEngineStartBegin ()

```

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

### Setup Function Implementation in C++

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__SW__MOVE__BACK.html

The Setup() function is an override method within the SCR_Tutorial_SW_MOVE_BACK class. It is responsible for initializing the tutorial stage related to special weapons that require backward movement. This function is protected and part of the SCR_BaseTutorialStage interface.

```cpp
override void SCR_Tutorial_SW_MOVE_BACK.Setup
(
)
protected
```

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

### Get Hint Start Time (SCR_HintUIInfo)

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__HintUIInfo.html

Retrieves the timestamp when the hint started. This is crucial for accurate timer implementations, especially on maps. Returns a WorldTimestamp value.

```cpp
WorldTimestamp GetTimeStarted ();
```

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

### C++: Setup Method in SCR_Tutorial_VehicleMaintenance_START

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

This protected C++ method is part of the setup process for the SCR_Tutorial_VehicleMaintenance_START stage. It is intended to be overridden by derived classes to provide specific initialization logic.

```cpp
protected:
    override void Setup()
```

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

### Setup Function in C++

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__SquadLeadership__ORDER__GETIN__CAR.html

The Setup function initializes the tutorial stage. It overrides the base class implementation and is called when the stage begins. It has no input parameters.

```cpp
override void SCR_Tutorial_SquadLeadership_ORDER_GETIN_CAR.Setup
(
)
protected
```

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

### SCR_InfoDisplay GetOnStart Method

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__EngineHitZoneInfo.html

Gets the invoker for the 'on start' event of the info display. This allows other systems to register callbacks that should be executed when the display starts. It returns an SCR_InfoDisplayInvoker object.

```cpp
SCR_InfoDisplayInvoker GetOnStart() {
  // Implementation to get the on start invoker
  return null;
}
```

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

### WidgetAnimationBase - GetDelay

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceWidgetAnimationColor.html

Gets the current delay before the animation starts.

```APIDOC
## GET /WidgetAnimationBase/GetDelay

### Description
Retrieves the currently set delay time before the animation initiates.

### Method
GET

### Endpoint
/WidgetAnimationBase/GetDelay

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
GET /WidgetAnimationBase/GetDelay
```

### Response
#### Success Response (200)
- **returnValue** (float) - The delay in seconds.

#### Response Example
```json
{
  "returnValue": 2.5
}
```
```

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

### C++: SCR_Tutorial_Driving_GETIN Setup() Implementation

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__Driving__GETIN.html

Implements the Setup method for the SCR_Tutorial_Driving_GETIN class. This function overrides the base class method and is responsible for initializing the driving tutorial stage. It takes no arguments and returns void.

```cpp
override void SCR_Tutorial_Driving_GETIN.Setup
(
)
protected
Implements SCR_BaseTutorialStage.Setup
```

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

### SCR_Tutorial_Seizing_ENABLE_RADIO: Setup Method

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__Seizing__ENABLE__RADIO.html

The `Setup` method is an override function within the SCR_Tutorial_Seizing_ENABLE_RADIO interface. It is responsible for initializing the radio component of the tutorial stage. The specific implementation details are not provided here but would typically involve setting up necessary radio communication functionalities.

```csharp
override void Setup()
{
    // Implementation details for setting up the radio component
}
```

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

### Get First Action (Arma Reforger Script)

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceBaseActionsManagerComponent.html

Retrieves the first BaseUserAction from the list of all available actions. This can be used to get a starting point for iterating through actions.

```Arma Reforger Script
proto external [BaseUserAction](interfaceBaseUserAction.html) [GetFirstAction](#ad2ed7b08c890c33d340baaa7a3e836fc) ()
```

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

### Get Capture Start Invoker in SCR_SeizingComponent (C#)

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

This method returns a ScriptInvoker for the capture start event within the SCR_SeizingComponent. This allows other systems to be notified when a capture process begins.

```csharp
ScriptInvoker SCR_SeizingComponent.GetOnCaptureStart()
{
    // Implementation details not provided in the text
    return null;
}
```

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

### Setup

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__TutorialStageMortars__Sights.html

Initializes or sets up the tutorial stage.

```APIDOC
## Setup

### Description
Performs the initial setup for the tutorial stage.

### Method
POST (Assumed, as this is an action)

### Endpoint
/api/tutorial/setup
```

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

### SCR_FactionCallsignInfo GetCompanyOverflowIndex

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__FactionCallsignInfo.html

Gets the index at which overflow companies start.

```APIDOC
## SCR_FactionCallsignInfo.GetCompanyOverflowIndex

### Description
Gets the index at which overflow companies start.

### Method
GET

### Endpoint
/SCR_FactionCallsignInfo/GetCompanyOverflowIndex

### Response
#### Success Response (200)
- **overflowIndex** (int) - The index where overflow companies begin.

#### Response Example
```json
{
  "overflowIndex": 10
}
```
```

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

### Setup - Arma Reforger Script API

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

Protected method for setting up the SCR_Tutorial_Intro_ListenToCaptain stage. This method is intended for internal use or extension by derived classes. It takes no arguments and returns void.

```cpp
override void 
[Setup](#ae1e34aea96dfa8793893b6b09968c78d) ()
```

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

### Setup Method

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__SquadLeadership__ORDER__STOP.html

Implements the Setup method for the SCR_Tutorial_SquadLeadership_ORDER_STOP class, overriding the base tutorial stage implementation. This function is responsible for initializing the specific tutorial stage when it becomes active.

```c++
override void SCR_Tutorial_SquadLeadership_ORDER_STOP.Setup
(
)
protected
```

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

### SCR_BaseGameMode.GetTimeLimit

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__BaseGameMode.html

Gets the game duration from the start of the game in seconds.

```APIDOC
## GET SCR_BaseGameMode/GetTimeLimit

### Description
Returns the game duration from the start of game in seconds or 0 if none.

### Method
GET

### Endpoint
/SCR_BaseGameMode/GetTimeLimit

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **float** - The maximum time in seconds, or 0 if infinite.

#### Response Example
None
```

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

### Get Starting Time and Weather - C++

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

Provides functions to retrieve the starting hour, minutes, and weather preset name from the SCR_TimeAndWeatherState interface. These functions are part of the Arma Reforger Script API.

```cpp
int GetStartingHour();

int GetStartingMinutes();

string GetWeatherPresetName();
```

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

### SCR_Tutorial_SW_EQUIP_CHARGES: Setup Function (SCR)

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__SW__EQUIP__CHARGES.html

The 'Setup' function is an override method within the SCR_Tutorial_SW_EQUIP_CHARGES interface, likely responsible for initializing the tutorial stage. It belongs to the SCR (Script) programming language.

```SCR
override void Setup()
{
    // Implementation details for setting up the equip charges tutorial stage
}
```

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

### Get On Game Start Event (Script API)

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

Returns a ScriptInvoker object that allows subscribing to the event triggered when the game starts. This is useful for initializing systems or performing actions at the beginning of a game.

```C++
ScriptInvoker GetOnGameStart();
```

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

### C: Implement Setup for Tutorial Stage

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__VehicleMaintenance__CANPICKUP.html

This C function overrides the Setup method from the SCR_BaseTutorialStage interface. It is responsible for initializing the tutorial stage when it becomes active, setting up necessary variables, UI elements, or game logic. Proper setup is essential for the stage to function correctly.

```C
override void SCR_Tutorial_VehicleMaintenance_CANPICKUP.Setup
(
)
{
    // Implementation details for setting up the stage
}
```

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

### Setup Function in C++

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

The Setup function is an override of a void member function from the SCR_BaseTutorialStage interface. It is responsible for initializing or setting up the tutorial stage. It takes no arguments.

```cpp
override void SCR_Tutorial_VehicleMaintenance_CANONGROUND.Setup
(
)

```

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

### On Engine Start Interrupt Event (VehicleControllerComponent)

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

Gets called when the engine start routine is interrupted. This function handles scenarios where the ignition process is stopped prematurely. It's an overridden method from VehicleControllerComponent.

```cpp
override void 
[OnEngineStartInterrupt](interfaceVehicleControllerComponent.html#a2b8d3c761612c1d05b5b680106d7cae0) ()
```

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

### Get Start Revision - SCR_WorkshopItemActionDownload.GetStartRevision()

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__WorkshopItemActionDownload.html

Returns the revision number of the workshop item at the time the download was initiated.

```csharp
Revision SCR_WorkshopItemActionDownload.GetStartRevision(
		
		)

```

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

### SCR_Tutorial_SquadLeadership_START Setup Method (C++)

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__SquadLeadership__START.html

The Setup method overrides the base class method and is responsible for initializing the tutorial stage. It is a protected method.

```cpp
override void SCR_Tutorial_SquadLeadership_START.Setup
(
)
protected
Implements SCR_BaseTutorialStage.ae51bde7a3df83104c28c8134156d2acb
```

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

### Setup Function in C

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__Obstacle__COUNTDOWN.html

The Setup function, protected and overridden from SCR_BaseTutorialStage, is responsible for initializing the SCR_Tutorial_Obstace_COUNTDOWN obstacle. It's called during the setup phase of the tutorial stage.

```c
override void SCR_Tutorial_Obstacle_COUNTDOWN.Setup
(
)
protected

```

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

### Setup Method in C

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__Navigation__ISLAND.html

Overrides the Setup method from the SCR_BaseTutorialStage interface. This function is responsible for initializing and setting up the navigation tutorial stage. It takes no arguments and is declared as protected. It implements the setup logic defined in the base interface.

```c
override void SCR_Tutorial_Navigation_ISLAND.Setup
(
)
protected
Implements SCR_BaseTutorialStage.Setup
```

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

### Setup Function - SCR_Tutorial_VehicleMaintenance_OPEN_STORAGE

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

The Setup function is an override used to initialize or set up the tutorial stage. It prepares the necessary components and states for the stage to begin. This function implements the Setup method from the SCR_BaseTutorialStage interface.

```c
override void SCR_Tutorial_VehicleMaintenance_OPEN_STORAGE.Setup
(
)
protected
Implements [SCR_BaseTutorialStage](interfaceSCR__BaseTutorialStage.html#ae51bde7a3df83104c28c8134156d2acb).
```

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

### On Engine Start Success Event (VehicleControllerComponent)

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

Gets called when the engine start routine has successfully completed. This function is executed upon a successful ignition and is ideal for post-start logic. It's an overridden method from VehicleControllerComponent.

```cpp
override void 
[OnEngineStartSuccess](interfaceVehicleControllerComponent.html#a43a468ce9358ad460b3a5f0624cdb791) ()
```

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

### Initialize Game Mode Setup Page History Array (C)

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__GameModeSetupPlugin.html

This snippet initializes a protected array of SCR_EGameModeSetupPage, storing the history of pages visited within the game mode setup process. It starts with the 'INTRO' page.

```c
ref array<SCR_EGameModeSetupPage> SCR_GameModeSetupPlugin.m_aPageHistory = { SCR_EGameModeSetupPage.INTRO }
```

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

### Initialize Tutorial Fake Base Component - C

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__TutorialFakeBaseComponent.html

The OnPostInit method is called after the component has been initialized. It is responsible for performing any setup operations required for the tutorial fake base component.

```C
override void SCR_TutorialFakeBaseComponent.OnPostInit(IEntity _owner)
```

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

### Setup Method Implementation (C)

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__VehicleMaintenance__END.html

Overrides the Setup method from the base tutorial stage interface. This function is responsible for initializing or setting up the current tutorial stage (vehicle maintenance end). It has no parameters and is protected.

```C
override void SCR_Tutorial_VehicleMaintenance_END.Setup
(
)
protected
```

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

### Vehicle Interface: Get Resource Component (C++ Example)

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceVehicle.html

This example illustrates how to obtain the SCR_ResourceComponent associated with a vehicle. This component is used for managing vehicle resources. It's important to note that this component might be null if not initialized.

```cpp
SCR_ResourceComponent GetResourceComponent()
{
    // Returns the resource component.
    return m_ResourceComponent;
}
```

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

### Setup Function - SCR_Tutorial_Driving_DRIVEROAD8

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__Driving__DRIVEROAD8.html

The 'Setup' function is an override method for initializing the SCR_Tutorial_Driving_DRIVEROAD8 stage. It is part of the protected members of the interface.

```csharp
override void Setup ()


```

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

### Get Transformation Start Effects - SCR_TransformingEditorComponentClass

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__TransformingEditorComponentClass.html

Retrieves an array of SCR_BaseEditorEffect objects associated with the start of a transformation process. This function is part of the SCR_TransformingEditorComponentClass and is used within the Arma Reforger editor scripting environment. It does not take any parameters.

```ArmaScript
array< ref SCR_BaseEditorEffect > SCR_TransformingEditorComponentClass.GetEffectsTransforationStart
(
)
```

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

### Implement Tutorial Stage Setup

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__Driving__DRIVEROAD11.html

This function is part of the SCR_Tutorial_Driving_DRIVEROAD11 interface and is intended to be overridden to set up the tutorial stage. It takes no arguments and returns void. It is called during the initialization of the tutorial stage.

```cpp
override void Setup()
{
    // Implementation for setting up the driving tutorial stage
}
```

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

### SCR_InfoDisplay GetOnStart

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

Gets the invoker for the start event of the info display. Inherited from SCR_InfoDisplay.

```typescript
SCR_InfoDisplayInvoker GetOnStart() {
  // Implementation to get on start invoker
}
```

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

### SCR_Tutorial_Heli_START Setup() Method Documentation

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__Heli__START.html

Documentation for the Setup() method in SCR_Tutorial_Heli_START. This method is responsible for initializing the helicopter tutorial stage. It is a protected override method implementing the base class interface.

```c
override void SCR_Tutorial_Heli_START.Setup
(
)
protected
Implements [SCR_BaseTutorialStage](interfaceSCR__BaseTutorialStage.html#ae51bde7a3df83104c28c8134156d2acb).
```

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

### Get Scenario (C++ Example)

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__ContentBrowser__GMSaveLineComponent-members.html

Retrieves scenario-related data. This method belongs to the SCR_ContentBrowser_ScenarioLineComponent interface.

```cpp
GetScenario()
```

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

### SCR_Tutorial_SW_PICKUP_CARBINE Setup Method

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__SW__PICKUP__CARBINE.html

Implements the Setup method, inherited from SCR_BaseTutorialStage. This function is responsible for initializing the tutorial stage.

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


)
protected
```

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

### SCR_WorkshopAddonPresetAddonMeta: Get Name and GUID (C++)

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__WorkshopAddonPresetAddonMeta.html

Retrieves the name and globally unique identifier (GUID) of an addon managed by the SCR_WorkshopAddonPresetAddonMeta interface. These functions are essential for identifying and referencing specific addons within the Arma Reforger environment. They do not require any input parameters.

```C++
string
[GetName](#a31889b38b469eb3e2d9809c4ae67a876) ()

string
[GetGuid](#af9fbbcf59ecccef7ea83834da2646a73) ()
```

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

### Setup Method Implementation (C)

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__Seizing__MhqDeploy.html

Implements the protected Setup method for the SCR_Tutorial_Seizing_MhqDeploy class, overriding the base class functionality. This method is responsible for initializing the tutorial stage.

```c
override void SCR_Tutorial_Seizing_MhqDeploy.Setup
(
)
protected
Implements SCR_BaseTutorialStage.Setup
```

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

### C++: Setup Method

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__Driving__DRIVEROAD10.html

The Setup method, overridden from SCR_BaseTutorialStage, is responsible for initializing the driving tutorial stage. It is called when the stage begins and performs necessary setup operations. This is a protected method.

```C++
override void SCR_Tutorial_Driving_DRIVEROAD10.Setup
(
)
protected
```

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

### Get Download Progress - SCR_WorkshopItemActionDownload.GetRunningAsync()

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__WorkshopItemActionDownload.html

Retrieves the current download progress. Returns 1 for completion, or 0 if paused or not started. This method is asynchronous.

```csharp
bool SCR_WorkshopItemActionDownload.GetRunningAsync(
		
		)

```

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

### Setup Function Implementation in C

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

This C code snippet shows the implementation of the Setup() function for the SCR_Tutorial_Navigation_DRIVE class. It overrides the base interface method and is declared as protected. This function is part of the game mode's tutorial stage for navigation.

```c
override void SCR_Tutorial_Navigation_DRIVE.Setup
(
)
protected
Implements SCR_BaseTutorialStage.ae51bde7a3df83104c28c8134156d2acb.

```

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

### Get OnStart Invoker - SCR_InfoDisplay (Inherited)

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

Inherited from SCR_InfoDisplay, this function returns an invoker for the start event of the display.

```typescript
SCR_InfoDisplayInvoker GetOnStart()
```

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

### GET /api/character/input/weaponIsStartReloading

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceCharacterInputContext.html

Verifies if the character has started the reloading process for their weapon. Useful for interrupting or tracking reloads.

```APIDOC
## GET /api/character/input/weaponIsStartReloading

### Description
Verifies if the character has started the reloading process for their weapon. Useful for interrupting or tracking reloads.

### Method
GET

### Endpoint
/api/character/input/weaponIsStartReloading

### Response
#### Success Response (200)
- **isStartingReload** (boolean) - True if the weapon reload has started, false otherwise.

#### Response Example
```json
{
  "isStartingReload": true
}
```
```

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

### Implement SCR_BaseTutorialStage Setup

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

This function overrides the Setup method from the SCR_BaseTutorialStage interface. It is a protected method responsible for initializing the tutorial stage. No specific dependencies are mentioned.

```C++
override void SCR_Tutorial_VehicleMaintenance_START.Setup
(
)
protected
Implements [SCR_BaseTutorialStage](interfaceSCR__BaseTutorialStage.html#ae51bde7a3df83104c28c8134156d2acb).
```

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

### Get Save Data (C++ Example)

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__ContentBrowser__GMSaveLineComponent-members.html

Retrieves save data associated with the component. This method is part of the SCR_ContentBrowser_GMSaveLineComponent.

```cpp
GetSave()
```

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

### Setup() Implementation in C

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__TutorialStageMedical__PickupTourniquet.html

This C code snippet shows the override implementation of the Setup() method for SCR_TutorialStageMedical_PickupTourniquet. It is responsible for initializing the tutorial stage when it becomes active.

```C
override void SCR_TutorialStageMedical_PickupTourniquet.Setup
(
)
protected
Implements [SCR_BaseTutorialStage](interfaceSCR__BaseTutorialStage.html#ae51bde7a3df83104c28c8134156d2acb).
```

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

### SCR_MilitaryBaseSystem: OnInit()

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__MilitaryBaseSystem.html

Override method for initializing the SCR_MilitaryBaseSystem when the application or world starts. This is where initial setup for base management occurs.

```C#
override void SCR_MilitaryBaseSystem.OnInit(
)
```

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

### Setup Method in C++

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__CombatEngineering__EquipEntrenchingTool.html

Initializes the Equip Entrenching Tool tutorial stage. This method overrides the base class implementation and is protected.

```cpp
override void SCR_Tutorial_CombatEngineering_EquipEntrenchingTool.Setup
(
)
protected
```

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

### SCR_VotingBase.GetServerRuntimeIgnoreJoinServerCooldown

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__VotingBase.html

Gets the server vote delay ignore time, which prevents the join server cooldown if the server has started recently.

```APIDOC
## GET /api/voting/serverRuntimeIgnoreJoinServerCooldown

### Description
Gets the server vote delay ignore time. It will not set a server vote delay time when the player joins if the server has started less seconds ago than this.

### Method
GET

### Endpoint
/api/voting/serverRuntimeIgnoreJoinServerCooldown

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **ignoreTimeSeconds** (int) - The time in seconds to ignore the join server cooldown.

#### Response Example
```json
{
  "ignoreTimeSeconds": 600
}
```
```

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

### SCR_Tutorial_SW_PICKUP_CHARGES::Setup Method

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__SW__PICKUP__CHARGES.html

Initializes the SCR_Tutorial_SW_PICKUP_CHARGES stage. This is an override of the base class's Setup method and is responsible for setting up the necessary components and states for this tutorial stage. It is a protected function.

```cpp
override void SCR_Tutorial_SW_PICKUP_CHARGES.Setup(

)

```

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

### Get On Possessed Event Invoker

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__PlayersManagerEditorComponent.html

Returns a ScriptInvoker that is called locally when a player starts or stops possessing an entity. This is useful for managing player control changes.

```cpp
ScriptInvoker GetOnPossessed()
```

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

### Setup Function

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__SquadLeadership__RECRUITING.html

Initializes the tutorial stage. This is an override of a base class function. It takes no arguments and does not return any value, but performs setup operations.

```C++
override void SCR_Tutorial_SquadLeadership_RECRUITING.Setup
(
)
protected
```

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

### Get Max Health - SCR_DestructibleEntity

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__DestructibleEntity.html

Returns the maximum health value of the destructible entity. This is the starting health before any damage is taken.

```C++
float SCR_DestructibleEntity.GetMaxHealth()
```

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

### Setup Method in C++

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__SquadLeadership__ORDER__DEFEND.html

Initializes the tutorial stage. This protected method is called to set up the necessary components and states for the squad leadership order defend tutorial stage. It overrides the base class implementation.

```cpp
override void SCR_Tutorial_SquadLeadership_ORDER_DEFEND.Setup
(
)
protected
Implements SCR_BaseTutorialStage.Setup
```

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

### Implement SCR_BaseTutorialStage Setup() in C

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

This C code snippet shows the implementation of the Setup() function within the SCR_Tutorial_Obstacle_ZIGZAGSTART class. It overrides the base interface method and is marked as protected.

```c
override void SCR_Tutorial_Obstacle_ZIGZAGSTART.Setup
(
)
protected
Implements SCR_BaseTutorialStage.
```

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

### Get Sound Event Started Invoker

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__CommunicationSoundComponent.html

Retrieves the invoker for the OnSoundEventStarted event. This allows external classes to subscribe to notifications when a sound event has begun playing.

```C++
OnSoundEventStartedInvoker SCR_CommunicationSoundComponent.GetOnSoundEventStarted(
)
```

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

### WidgetAnimationBase: Get Delay

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceWidgetAnimationBase.html

Retrieves the delay in seconds before an animation starts or restarts. This method is part of the WidgetAnimationBase class and returns a float value.

```Squirrel
float WidgetAnimationBase.GetDelay()

```

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

### Setup Function - C++

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__SquadLeadership__ORDER__FOLLOW.html

Initializes the tutorial stage. This is an override of the Setup function from the base SCR_BaseTutorialStage class.

```cpp
override void SCR_Tutorial_SquadLeadership_ORDER_FOLLOW.Setup
(
)
protected
Implements SCR_BaseTutorialStage.Setup.
```

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

### SCR_Tutorial_SW_PICKUP_RPG Setup Method

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__SW__PICKUP__RPG.html

Implements the protected Setup method, overriding the base class functionality. This method is likely responsible for initializing the tutorial stage when it becomes active.

```c++
override void SCR_Tutorial_SW_PICKUP_RPG.Setup
(
)

```

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

### Get Fire Instigator (C#)

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__FlammableHitZone.html

Retrieves the instigator of the fire, which is essential for damage attribution and tracking. This method is likely used to inform a damage manager about who or what started the fire.

```csharp
Instigator SCR_FlammableHitZone.GetFireInstigator()
{
    // Implementation to get the fire instigator
    return null; // Placeholder return
}
```

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

### Get Average Control Point Distance Squared

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__CampaignMilitaryBaseManager.html

Calculates the squared average distance from a headquarters base to a list of its control points. This metric is used in determining the optimal starting location for a headquarters.

```ArmaScript
int GetAvgCPDistanceSq(notnull SCR_CampaignMilitaryBaseComponent HQ, notnull array< SCR_CampaignMilitaryBaseComponent > controlPoints)
```

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

### Implement Setup in C for SCR_Tutorial_CombatEngineering_Move_4

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__CombatEngineering__Move__4.html

The Setup function is an overridden protected member function in SCR_Tutorial_CombatEngineering_Move_4. It implements the base interface SCR_BaseTutorialStage. This function is responsible for setting up the tutorial stage.

```c
override void SCR_Tutorial_CombatEngineering_Move_4.Setup
(
)
protected
Implements SCR_BaseTutorialStage.Setup.
```

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

### Setup Implementation in C

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__VehicleMaintenance__PICKUPTOOLS.html

Overrides the Setup method from the SCR_BaseTutorialStage interface. This C function is responsible for initializing the vehicle maintenance pickup tools tutorial stage. It likely sets up necessary variables, UI elements, or game state. It returns void.

```C
override void SCR_Tutorial_VehicleMaintenance_PICKUPTOOLS.Setup
(
)

protected

Implements SCR_BaseTutorialStage.Setup
```

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

### Get Component (C++ Example)

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__ContentBrowser__GMSaveLineComponent-members.html

Retrieves a component by its type, name, and parent widget. It can optionally search through all children. This is a static method.

```cpp
TypeName componentType, string name, Widget parent, bool searchAllChildren = true
```

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

### C++ Tutorial Stage Navigation END Setup Method

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

The Setup method overrides the base class implementation to initialize the tutorial stage. This method is called when the stage begins. It does not return any value. No specific dependencies are mentioned other than the base interface.

```cpp
override void SCR_Tutorial_Navigation_END.Setup
(
)

```

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

### Protected OnStarted - SCR_ResourceSystem (SQF)

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__ResourceSystem.html

Protected method called once when the SCR_ResourceSystem is started. This is where initial setup and resource allocation typically occur. It has no parameters.

```sqf
override void SCR_ResourceSystem.OnStarted()
```

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

### Get Associated Transceiver Information

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

Provides access to the radio entry's associated transceiver and its ID. The transceiver ID starts from 1.

```C++
BaseTransceiver SCR_VONEntryRadio.GetTransceiver(
	
)
```

```C++
int SCR_VONEntryRadio.GetTransceiverNumber(
	
)
```

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

### SCR_Tutorial_Obstacle_FLAG Setup Function

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__Obstacle__FLAG.html

The 'Setup' function is a protected override method within the SCR_Tutorial_Obstacle_FLAG interface. It is intended for initializing the obstacle stage and is part of the tutorial stage management system.

```cpp
override void

[Setup](#aec6c3173793ea8ce8956d8ecf850cb1f) ()

 
```

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

### Setup Method in C

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__Driving__GETOUT.html

Overrides the Setup method from the SCR_BaseTutorialStage interface. This function is responsible for initializing or preparing the driving tutorial stage. It takes no arguments and is protected, indicating it's invoked by the tutorial framework to begin the stage.

```c
override void SCR_Tutorial_Driving_GETOUT.Setup
(
)
protected
```

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

### Get Indices of Substring - SCR_StringHelper

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__StringHelper.html

Finds all occurrences of a search string within an input string and returns their starting indices as an array of integers.

```csharp
array< int > IndicesOf(string input, string search)
```

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

### SCR_ListViewComponent: AccessingHandlers Method

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__ListViewComponent.html

Gets references to all necessary components for handling list view operations. This protected method is part of the internal setup.

```csharp
void AccessingHandlers()
```

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

### Initialize Tutorial Stage

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__CombatEngineering__ExitBuilding__2.html

Implements the Setup function, overriding the base class implementation to perform initial setup for the tutorial stage. This function is protected and is called when the stage begins.

```C
/// @brief Sets up the tutorial stage.
protected override void Setup()
{
    // Implementation details omitted
}
```

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

### Setup Function in SCR_Tutorial_Obstace_LADDERUP.c (C)

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__Tutorial__Obstacle__LADDERUP.html

The Setup function is an override method within the SCR_Tutorial_Obstace_LADDERUP class. It is protected and implements the corresponding method from the SCR_BaseTutorialStage interface, responsible for initializing or setting up the tutorial stage.

```C
override void SCR_Tutorial_Obstacle_LADDERUP.Setup
(
)
protected
Implements SCR_BaseTutorialStage.Setup
```

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

### Get On Card Initialization Event

Source: https://github.com/tacticalcatboy/armareforgerscriptapipublic/blob/main/interfaceSCR__AssetCardFrontUIComponent.html

Provides access to the ScriptInvoker that is triggered when the card component is initialized. This allows for custom logic to be executed during the card's setup.

```C++
ScriptInvoker GetOnCardInit();
```
Tokens:
Raw