Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Attributes | List of all members
SCR_ScenarioFrameworkConversionPlugin_Phase1 Interface Reference

This plugin converts old scenarios using Scenario Framework from 1.0.0 to the new 1.1.0 format. More...

Inheritance diagram for SCR_ScenarioFrameworkConversionPlugin_Phase1:
[legend]

Public Member Functions

override void Run ()
 

Static Public Attributes

static const string GENERIC_CLASSNAME = "GenericEntity"
 
static const string SLOT_WAYPOINT_PREFAB = "{EBD91177954E8236}Prefabs/ScenarioFramework/Components/SlotWaypoint.et"
 
static const string SLOT_WAYPOINT_COMPONENT_CLASSNAME = "SCR_ScenarioFrameworkSlotWaypoint"
 
static const string WAYPOINT_COMPONENT_FIELD = "m_Waypoint"
 

Protected Member Functions

array< IEntitySource > GetEntitySources ()
 
void CreateCycleWaypoints (notnull array< IEntitySource > allEntitySources)
 Create cycle waypoints under targeted layers (with the name LayerName_Cycle)
 
void GetLayersAndWaypointSets (notnull array< IEntitySource > allEntitySources, out notnull map< string, IEntitySource > namedLayers, out notnull array< ref SCR_WaypointSet > cycleWaypointSets)
 
void Convert (notnull array< IEntitySource > allEntitySources)
 
void TryConvertSlot (notnull IEntitySource entitySource)
 
bool ConvertSlotTo (notnull IEntitySource entitySource, notnull IEntitySource componentSource, notnull SCR_ScenarioFrameworkConversionPlugin_Rune rune)
 
void TryAndConvertSlotWaypointGroups (notnull IEntitySource entitySource)
 all-in-one Try AND Convert method
 
void SCR_ScenarioFrameworkConversionPlugin_Phase1 ()
 

Static Protected Attributes

static const string LAYER_PREFAB = "{5F9FFF4BF027B3A3}Prefabs/ScenarioFramework/Components/Layer.et"
 
static const string CYCLE_WAYPOINT_CLASSNAME = "SCR_ScenarioFrameworkWaypointCycle"
 
static const string BASE_SLOT_CLASSNAME = "SCR_ScenarioFrameworkSlotBase"
 
static const string SLOT_PREFAB = "{AA01691FDC4E9167}Prefabs/ScenarioFramework/Components/Slot.et"
 
static const string BASE_SLOT_FIELD = "m_sObjectToSpawn"
 
static const string SLOT_AI_PREFAB = "{8D43830F02C3F114}Prefabs/ScenarioFramework/Components/SlotAI.et"
 
static const string SLOT_KILL_PREFAB = "{C70DC6CBD1AAEC9A}Prefabs/ScenarioFramework/Components/SlotKill.et"
 
static const string SLOT_DEFEND_PREFAB = "{E123BAC59A9B3D5F}Prefabs/ScenarioFramework/Components/SlotDefend.et"
 
static const ref array< string > BASE_SLOTWP_CLASSNAMES
 
static const string BASE_SLOTWP_FIELD_FROM = "m_aWaypointGroupNames"
 
static const string BASE_SLOTWP_FIELD_TO = "m_WaypointSet"
 
static const string WAYPOINT_CLASSNAME = "SCR_ScenarioFrameworkWaypointSet"
 
static const string CYCLE_SUFFIX = "_Cycle"
 
static const ref array< ref SCR_ScenarioFrameworkConversionPlugin_Rune > CONVERSION_TABLE = {}
 

Detailed Description

This plugin converts old scenarios using Scenario Framework from 1.0.0 to the new 1.1.0 format.


The plugin must be run once, then the world must be saved and loaded before running part 2.

See also
SCR_ScenarioFrameworkConversionPlugin_Phase2

Constructor & Destructor Documentation

◆ SCR_ScenarioFrameworkConversionPlugin_Phase1()

void SCR_ScenarioFrameworkConversionPlugin_Phase1.SCR_ScenarioFrameworkConversionPlugin_Phase1 ( )
protected

Member Function Documentation

◆ Convert()

void SCR_ScenarioFrameworkConversionPlugin_Phase1.Convert ( notnull array< IEntitySource >  allEntitySources)
protected
Parameters
[in]allEntitySources

◆ ConvertSlotTo()

bool SCR_ScenarioFrameworkConversionPlugin_Phase1.ConvertSlotTo ( notnull IEntitySource  entitySource,
notnull IEntitySource  componentSource,
notnull SCR_ScenarioFrameworkConversionPlugin_Rune  rune 
)
protected
Parameters
[in]entitySource
[in]componentSource
[in]rune
Returns
true on success, false otherwise

◆ CreateCycleWaypoints()

void SCR_ScenarioFrameworkConversionPlugin_Phase1.CreateCycleWaypoints ( notnull array< IEntitySource >  allEntitySources)
protected

Create cycle waypoints under targeted layers (with the name LayerName_Cycle)

Parameters
[in]allEntitySources

◆ GetEntitySources()

array< IEntitySource > SCR_ScenarioFrameworkConversionPlugin_Phase1.GetEntitySources ( )
protected
Parameters
[in]getAllEntitiesAndNotJustSelectedOnes
Returns
entitysources that are GenericEntity and have an ancestor

◆ GetLayersAndWaypointSets()

void SCR_ScenarioFrameworkConversionPlugin_Phase1.GetLayersAndWaypointSets ( notnull array< IEntitySource >  allEntitySources,
out notnull map< string, IEntitySource >  namedLayers,
out notnull array< ref SCR_WaypointSet >  cycleWaypointSets 
)
protected
Parameters
[in]allEntitySources
[out]namedLayers
[out]cycleWaypointSets

◆ Run()

override void SCR_ScenarioFrameworkConversionPlugin_Phase1.Run ( )

◆ TryAndConvertSlotWaypointGroups()

void SCR_ScenarioFrameworkConversionPlugin_Phase1.TryAndConvertSlotWaypointGroups ( notnull IEntitySource  entitySource)
protected

all-in-one Try AND Convert method

Parameters
[in]entitySource

◆ TryConvertSlot()

void SCR_ScenarioFrameworkConversionPlugin_Phase1.TryConvertSlot ( notnull IEntitySource  entitySource)
protected
Parameters
[in]entitySource

Member Data Documentation

◆ BASE_SLOT_CLASSNAME

const string SCR_ScenarioFrameworkConversionPlugin_Phase1.BASE_SLOT_CLASSNAME = "SCR_ScenarioFrameworkSlotBase"
staticprotected

◆ BASE_SLOT_FIELD

const string SCR_ScenarioFrameworkConversionPlugin_Phase1.BASE_SLOT_FIELD = "m_sObjectToSpawn"
staticprotected

◆ BASE_SLOTWP_CLASSNAMES

const ref array<string> SCR_ScenarioFrameworkConversionPlugin_Phase1.BASE_SLOTWP_CLASSNAMES
staticprotected
Initial value:
= {
"SCR_ScenarioFrameworkSlotAI",
"SCR_ScenarioFrameworkSlotKill",
"SCR_ScenarioFrameworkSlotDefend",
}

◆ BASE_SLOTWP_FIELD_FROM

const string SCR_ScenarioFrameworkConversionPlugin_Phase1.BASE_SLOTWP_FIELD_FROM = "m_aWaypointGroupNames"
staticprotected

◆ BASE_SLOTWP_FIELD_TO

const string SCR_ScenarioFrameworkConversionPlugin_Phase1.BASE_SLOTWP_FIELD_TO = "m_WaypointSet"
staticprotected

◆ CONVERSION_TABLE

const ref array<ref SCR_ScenarioFrameworkConversionPlugin_Rune> SCR_ScenarioFrameworkConversionPlugin_Phase1.CONVERSION_TABLE = {}
staticprotected

◆ CYCLE_SUFFIX

const string SCR_ScenarioFrameworkConversionPlugin_Phase1.CYCLE_SUFFIX = "_Cycle"
staticprotected

◆ CYCLE_WAYPOINT_CLASSNAME

const string SCR_ScenarioFrameworkConversionPlugin_Phase1.CYCLE_WAYPOINT_CLASSNAME = "SCR_ScenarioFrameworkWaypointCycle"
staticprotected

◆ GENERIC_CLASSNAME

const string SCR_ScenarioFrameworkConversionPlugin_Phase1.GENERIC_CLASSNAME = "GenericEntity"
static

◆ LAYER_PREFAB

const string SCR_ScenarioFrameworkConversionPlugin_Phase1.LAYER_PREFAB = "{5F9FFF4BF027B3A3}Prefabs/ScenarioFramework/Components/Layer.et"
staticprotected

◆ SLOT_AI_PREFAB

const string SCR_ScenarioFrameworkConversionPlugin_Phase1.SLOT_AI_PREFAB = "{8D43830F02C3F114}Prefabs/ScenarioFramework/Components/SlotAI.et"
staticprotected

◆ SLOT_DEFEND_PREFAB

const string SCR_ScenarioFrameworkConversionPlugin_Phase1.SLOT_DEFEND_PREFAB = "{E123BAC59A9B3D5F}Prefabs/ScenarioFramework/Components/SlotDefend.et"
staticprotected

◆ SLOT_KILL_PREFAB

const string SCR_ScenarioFrameworkConversionPlugin_Phase1.SLOT_KILL_PREFAB = "{C70DC6CBD1AAEC9A}Prefabs/ScenarioFramework/Components/SlotKill.et"
staticprotected

◆ SLOT_PREFAB

const string SCR_ScenarioFrameworkConversionPlugin_Phase1.SLOT_PREFAB = "{AA01691FDC4E9167}Prefabs/ScenarioFramework/Components/Slot.et"
staticprotected

◆ SLOT_WAYPOINT_COMPONENT_CLASSNAME

const string SCR_ScenarioFrameworkConversionPlugin_Phase1.SLOT_WAYPOINT_COMPONENT_CLASSNAME = "SCR_ScenarioFrameworkSlotWaypoint"
static

◆ SLOT_WAYPOINT_PREFAB

const string SCR_ScenarioFrameworkConversionPlugin_Phase1.SLOT_WAYPOINT_PREFAB = "{EBD91177954E8236}Prefabs/ScenarioFramework/Components/SlotWaypoint.et"
static

◆ WAYPOINT_CLASSNAME

const string SCR_ScenarioFrameworkConversionPlugin_Phase1.WAYPOINT_CLASSNAME = "SCR_ScenarioFrameworkWaypointSet"
staticprotected

◆ WAYPOINT_COMPONENT_FIELD

const string SCR_ScenarioFrameworkConversionPlugin_Phase1.WAYPOINT_COMPONENT_FIELD = "m_Waypoint"
static
The documentation for this interface was generated from the following file:
Generated by doxygen 1.9.6