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

CLI usage: More...

Inheritance diagram for SCR_TerrainEntityVariantReplacementPlugin:

Static Public Member Functions

static string GetNewWorldFilePath (string terrainFilePath, SCR_ETerrainEntityVariant variant)
 

Protected Member Functions

override void Run ()
 
override void RunCommandline ()
 
bool GetCLIParameterValues (notnull WorldEditor worldEditor, out string worldPath, out SCR_ETerrainEntityVariant variant, out ResourceName config)
 
string GetCLIWorldPath (notnull WorldEditor worldEditor, out string error)
 
SCR_ETerrainEntityVariant GetCLIVariant (notnull WorldEditor worldEditor, out string error)
 
ResourceName GetCLIConfig (notnull WorldEditor worldEditor, out string error)
 
bool LoadConfig (ResourceName configResourceName, SCR_ETerrainEntityVariant variant)
 
bool LoadConfig (notnull SCR_TerrainEntityVariantConfig config, SCR_ETerrainEntityVariant variant)
 
bool ConvertCurrentTerrain (int replacedEntities=ALL_ENTITIES, int replacementMode=SET_ANCESTOR)
 
bool ConvertCurrentTerrainMeasured (int replacedEntities, int replacementMode)
 
array< IEntitySource > GetentitiesToProcess (int replacedEntities)
 
array< ref SCR_TEVR_Data > GetCreationData (notnull array< IEntitySource > entitySources)
 
void DeleteEntities (notnull WorldEditorAPI worldEditorAPI, notnull array< IEntitySource > entitySources)
 
array< IEntitySource > CreateEntities (notnull array< ref SCR_TEVR_Data > creationDataList)
 
void SetAncestor (notnull array< IEntitySource > entitySources, bool forceRefresh)
 
int ButtonOK ()
 
int ButtonCancel ()
 

Protected Attributes

bool m_bReadOnly
 
int m_iReplacedEntities
 
int m_iReplacementMode
 
SCR_ETerrainEntityVariant m_eWantedVariant
 
ref SCR_TerrainEntityVariantConfig m_Config
 
ResourceName m_sConfigFile
 
ResourceName m_sTerrainToDuplicate
 
SCR_ETerrainEntityVariant m_eDuplicationVariant
 
bool m_bDuplicationDebug
 
ref map< ResourceName, ResourceName > m_mReplacementMap = new map<ResourceName, ResourceName>()
 
bool m_bIsUI
 

Static Protected Attributes

static const int ALL_ENTITIES = 0
 
static const int CURRENT_LAYER_MODE = 1
 
static const int SELECTED_ENTITIES_MODE = 2
 
static const int CREATE_AND_DELETE = 0
 
static const int SET_ANCESTOR_REFRESH = 1
 
static const int SET_ANCESTOR = 2
 
static const int SET_ANCESTOR_SAVELOAD = 3
 
static const int SET_ANCESTOR_FORCE_RELOAD = 4
 
static const string PARAM_WORLD = "tevrWorld"
 
static const string PARAM_VARIANT = "tevrVariant"
 
static const string PARAM_CONFIG = "tevrConfig"
 

Detailed Description

CLI usage:

  • -tevrWorld the absolute .ent file of the original world to convert example: -tevrWorld="C:\Reforger\Data\worlds\Arland\Arland.ent"
  • -tevrVariant (case-insensitive) the wanted variant - can be one of SCR_ETerrainEntityVariant values example: -tevrVariant=autumn
  • -tevrConfig the conversion config ResourceName (preferred) or filePath, SCR_TerrainEntityVariantConfig config class example: -tevrConfig="{E10A32BEF1F9E157}Configs/Workbench/WorldEditor/TerrainEntityVariantReplacementTool/Autumn.conf"
    ArmaReforgerWorkbench.exe -gproj="C:\Reforger\Data\ArmaReforger.gproj" -exitAfterInit -wbModule=WorldEditor -plugin=SCR_TerrainEntityVariantReplacementPlugin -tevrWorld="C:\A3.9R\ARData\worlds\Arland\Arland.ent" -tevrVariant=autumn -tevrConfig="{E10A32BEF1F9E157}Configs/Workbench/WorldEditor/TerrainEntityVariantReplacementTool/Autumn.conf"
    SCR_TerrainEntityVariantReplacementPlugin
    CLI usage:
    Definition SCR_TerrainEntityVariantReplacementPlugin.c:21

Member Function Documentation

◆ ButtonCancel()

int SCR_TerrainEntityVariantReplacementPlugin.ButtonCancel ( )
protected

◆ ButtonOK()

int SCR_TerrainEntityVariantReplacementPlugin.ButtonOK ( )
protected

◆ ConvertCurrentTerrain()

bool SCR_TerrainEntityVariantReplacementPlugin.ConvertCurrentTerrain ( int replacedEntities = ALL_ENTITIES,
int replacementMode = SET_ANCESTOR )
protected

◆ ConvertCurrentTerrainMeasured()

bool SCR_TerrainEntityVariantReplacementPlugin.ConvertCurrentTerrainMeasured ( int replacedEntities,
int replacementMode )
protected
Returns
true on success, false otherwise - currently always returns true (imagine the code quality©!)

◆ CreateEntities()

array< IEntitySource > SCR_TerrainEntityVariantReplacementPlugin.CreateEntities ( notnull array< ref SCR_TEVR_Data > creationDataList)
protected

◆ DeleteEntities()

void SCR_TerrainEntityVariantReplacementPlugin.DeleteEntities ( notnull WorldEditorAPI worldEditorAPI,
notnull array< IEntitySource > entitySources )
protected

◆ GetCLIConfig()

ResourceName SCR_TerrainEntityVariantReplacementPlugin.GetCLIConfig ( notnull WorldEditor worldEditor,
out string error )
protected

◆ GetCLIParameterValues()

bool SCR_TerrainEntityVariantReplacementPlugin.GetCLIParameterValues ( notnull WorldEditor worldEditor,
out string worldPath,
out SCR_ETerrainEntityVariant variant,
out ResourceName config )
protected

◆ GetCLIVariant()

SCR_ETerrainEntityVariant SCR_TerrainEntityVariantReplacementPlugin.GetCLIVariant ( notnull WorldEditor worldEditor,
out string error )
protected

◆ GetCLIWorldPath()

string SCR_TerrainEntityVariantReplacementPlugin.GetCLIWorldPath ( notnull WorldEditor worldEditor,
out string error )
protected

◆ GetCreationData()

array< ref SCR_TEVR_Data > SCR_TerrainEntityVariantReplacementPlugin.GetCreationData ( notnull array< IEntitySource > entitySources)
protected

◆ GetentitiesToProcess()

array< IEntitySource > SCR_TerrainEntityVariantReplacementPlugin.GetentitiesToProcess ( int replacedEntities)
protected

◆ GetNewWorldFilePath()

static string SCR_TerrainEntityVariantReplacementPlugin.GetNewWorldFilePath ( string terrainFilePath,
SCR_ETerrainEntityVariant variant )
static
Parameters
[in]terrainFilePaththe source world's file path
[in]variantthe terrain variant's enum value, added lowercase after WorldName_ (after the underscore) e.g "autumn"
Returns
the new world's file path

◆ LoadConfig() [1/2]

bool SCR_TerrainEntityVariantReplacementPlugin.LoadConfig ( notnull SCR_TerrainEntityVariantConfig config,
SCR_ETerrainEntityVariant variant )
protected

◆ LoadConfig() [2/2]

bool SCR_TerrainEntityVariantReplacementPlugin.LoadConfig ( ResourceName configResourceName,
SCR_ETerrainEntityVariant variant )
protected

◆ Run()

override void SCR_TerrainEntityVariantReplacementPlugin.Run ( )
protected

◆ RunCommandline()

override void SCR_TerrainEntityVariantReplacementPlugin.RunCommandline ( )
protected

◆ SetAncestor()

void SCR_TerrainEntityVariantReplacementPlugin.SetAncestor ( notnull array< IEntitySource > entitySources,
bool forceRefresh )
protected

Member Data Documentation

◆ ALL_ENTITIES

const int SCR_TerrainEntityVariantReplacementPlugin.ALL_ENTITIES = 0
staticprotected

◆ CREATE_AND_DELETE

const int SCR_TerrainEntityVariantReplacementPlugin.CREATE_AND_DELETE = 0
staticprotected

◆ CURRENT_LAYER_MODE

const int SCR_TerrainEntityVariantReplacementPlugin.CURRENT_LAYER_MODE = 1
staticprotected

◆ m_bDuplicationDebug

bool SCR_TerrainEntityVariantReplacementPlugin.m_bDuplicationDebug
protected

◆ m_bIsUI

bool SCR_TerrainEntityVariantReplacementPlugin.m_bIsUI
protected

◆ m_bReadOnly

bool SCR_TerrainEntityVariantReplacementPlugin.m_bReadOnly
protected

◆ m_Config

ref SCR_TerrainEntityVariantConfig SCR_TerrainEntityVariantReplacementPlugin.m_Config
protected

◆ m_eDuplicationVariant

SCR_ETerrainEntityVariant SCR_TerrainEntityVariantReplacementPlugin.m_eDuplicationVariant
protected

◆ m_eWantedVariant

SCR_ETerrainEntityVariant SCR_TerrainEntityVariantReplacementPlugin.m_eWantedVariant
protected

◆ m_iReplacedEntities

int SCR_TerrainEntityVariantReplacementPlugin.m_iReplacedEntities
protected

◆ m_iReplacementMode

int SCR_TerrainEntityVariantReplacementPlugin.m_iReplacementMode
protected

◆ m_mReplacementMap

ref map<ResourceName, ResourceName> SCR_TerrainEntityVariantReplacementPlugin.m_mReplacementMap = new map<ResourceName, ResourceName>()
protected

◆ m_sConfigFile

ResourceName SCR_TerrainEntityVariantReplacementPlugin.m_sConfigFile
protected

◆ m_sTerrainToDuplicate

ResourceName SCR_TerrainEntityVariantReplacementPlugin.m_sTerrainToDuplicate
protected

◆ PARAM_CONFIG

const string SCR_TerrainEntityVariantReplacementPlugin.PARAM_CONFIG = "tevrConfig"
staticprotected

◆ PARAM_VARIANT

const string SCR_TerrainEntityVariantReplacementPlugin.PARAM_VARIANT = "tevrVariant"
staticprotected

◆ PARAM_WORLD

const string SCR_TerrainEntityVariantReplacementPlugin.PARAM_WORLD = "tevrWorld"
staticprotected

◆ SELECTED_ENTITIES_MODE

const int SCR_TerrainEntityVariantReplacementPlugin.SELECTED_ENTITIES_MODE = 2
staticprotected

◆ SET_ANCESTOR

const int SCR_TerrainEntityVariantReplacementPlugin.SET_ANCESTOR = 2
staticprotected

◆ SET_ANCESTOR_FORCE_RELOAD

const int SCR_TerrainEntityVariantReplacementPlugin.SET_ANCESTOR_FORCE_RELOAD = 4
staticprotected

◆ SET_ANCESTOR_REFRESH

const int SCR_TerrainEntityVariantReplacementPlugin.SET_ANCESTOR_REFRESH = 1
staticprotected

◆ SET_ANCESTOR_SAVELOAD

const int SCR_TerrainEntityVariantReplacementPlugin.SET_ANCESTOR_SAVELOAD = 3
staticprotected
The documentation for this interface was generated from the following file:
Generated by doxygen 1.13.2