Arma Reforger Script API
Loading...
Searching...
No Matches
Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
SCR_WorldEntitiesStatisticsPlugin Interface Reference
Inheritance diagram for SCR_WorldEntitiesStatisticsPlugin:

Protected Member Functions

override void Run ()
 
int ScanWorld ()
 
float GetLandAboveWaterRatio (notnull WorldEditorAPI worldEditorAPI, vector terrainOrigin, vector terrainSize, float terrainUnitScale)
 
array< string > GetReportLines (notnull SCR_WorldEntitiesStatisticsPlugin_Report report)
 
void OutputLines (notnull array< string > lines, string filePath)
 Print statistics results in log console.
 
array< string > GetFormattedMapLines (string description, notnull map< ResourceName, int > resultMap, notnull SCR_WorldEntitiesStatisticsPlugin_Report report)
 Print statistics results in log console.
 
bool CreateDensityImage (string imagePath, int resolution, vector terrainMin, vector terrainMax, notnull array< vector > entityPositions)
 
bool CreateVarietyImage (string imagePath, int resolution, vector terrainMin, vector terrainMax, notnull array< ResourceName > models, notnull array< vector > prefabPositions)
 
int ButtonAnalyse ()
 
int ButtonClose ()
 

Protected Attributes

bool m_bOutputToFile
 
bool m_bActiveLayerOnly
 
int m_iMaxDisplayedEntries
 
int m_iDisplayThreshold
 
bool m_bOutputHeatmap
 
int m_iHeatmapType
 
bool m_bOutputHeatmapForAllLayers
 
int m_iHeatmapColourMode
 
bool m_bHeatmapValueInversion
 
int m_iHeatmapMaxValueMode
 
bool m_bHeatmapHighlightValuesAboveMax
 
int m_iHeatmapDefinition
 
int m_iHeatmapResolutionFactor
 
bool m_bDebug
 
ref SCR_DebugShapeManager m_DebugShapeManager
 

Static Protected Attributes

static const string WORLD_DIRECTORY_FORMAT = "WorldStatistics_%1"
 
static const string LAYERS_SUBDIR = "Layers"
 
static const string OUTPUT_FILE_NAME = "PrefabStatistics.txt"
 
static const string LAYER_OUTPUT_FILE_NAME = "%1_%2_PrefabStatistics.txt"
 %1 = subScene ID, %2 = layer name
 
static const string OUTPUT_MAP_NAME = "Heatmap_%1_%2.dds"
 %1 = data type (density, variety), %2 = colour mode (BW, RGB)
 
static const string LAYER_OUTPUT_MAP_NAME = "%1_%2_Heatmap_%3_%4.dds"
 %1 = subScene ID, %2 = layer name, %3 = data type (density, variety), %4 = colour mode (BW, RGB)
 
static const string NO_MAP_CONTENT_FORMAT = "No %1 found"
 %1 = resultMap provided description
 
static const int MIN_TERRAIN_DEBUG_RESOLUTION = 50
 
static const float SQM_TO_SQKM = 0.000001
 
static const int TYPE_DENSITY = 0
 
static const int TYPE_VARIETY = 1
 
static const int MIN_ENTITIES_RGB = 8
 minimum entities per pixel in RGB mode; if less than that, prints a warning
 

Member Function Documentation

◆ ButtonAnalyse()

int SCR_WorldEntitiesStatisticsPlugin.ButtonAnalyse ( )
protected

◆ ButtonClose()

int SCR_WorldEntitiesStatisticsPlugin.ButtonClose ( )
protected

◆ CreateDensityImage()

bool SCR_WorldEntitiesStatisticsPlugin.CreateDensityImage ( string imagePath,
int resolution,
vector terrainMin,
vector terrainMax,
notnull array< vector > entityPositions )
protected
Parameters
[in]imagePath
[in]resolution
[in]terrainMin
[in]terrainMax
[in]entityPositions
Returns
true on success, false otherwise

◆ CreateVarietyImage()

bool SCR_WorldEntitiesStatisticsPlugin.CreateVarietyImage ( string imagePath,
int resolution,
vector terrainMin,
vector terrainMax,
notnull array< ResourceName > models,
notnull array< vector > prefabPositions )
protected
Parameters
[in]imagePath
[in]resolution
[in]terrainMin
[in]terrainMax
[in]models
[in]prefabPositions
Returns
true on success, false otherwise

◆ GetFormattedMapLines()

array< string > SCR_WorldEntitiesStatisticsPlugin.GetFormattedMapLines ( string description,
notnull map< ResourceName, int > resultMap,
notnull SCR_WorldEntitiesStatisticsPlugin_Report report )
protected

Print statistics results in log console.

Parameters
[in]description
[in]resultMap

◆ GetLandAboveWaterRatio()

float SCR_WorldEntitiesStatisticsPlugin.GetLandAboveWaterRatio ( notnull WorldEditorAPI worldEditorAPI,
vector terrainOrigin,
vector terrainSize,
float terrainUnitScale )
protected
Parameters
[in]worldEditorAPI
[in]terrainOrigin
[in]terrainSize
[in]terrainUnitScale
Returns
land ratio 0..1 land coverage ratio (dry terrain / total terrain)

◆ GetReportLines()

array< string > SCR_WorldEntitiesStatisticsPlugin.GetReportLines ( notnull SCR_WorldEntitiesStatisticsPlugin_Report report)
protected
Parameters
[in]report
Returns

◆ OutputLines()

void SCR_WorldEntitiesStatisticsPlugin.OutputLines ( notnull array< string > lines,
string filePath )
protected

Print statistics results in log console.

Parameters
[in]lines
[in]filePath

◆ Run()

override void SCR_WorldEntitiesStatisticsPlugin.Run ( )
protected

◆ ScanWorld()

int SCR_WorldEntitiesStatisticsPlugin.ScanWorld ( )
protected
Returns
number of scanned entities, -1 on error

Member Data Documentation

◆ LAYER_OUTPUT_FILE_NAME

const string SCR_WorldEntitiesStatisticsPlugin.LAYER_OUTPUT_FILE_NAME = "%1_%2_PrefabStatistics.txt"
staticprotected

%1 = subScene ID, %2 = layer name

◆ LAYER_OUTPUT_MAP_NAME

const string SCR_WorldEntitiesStatisticsPlugin.LAYER_OUTPUT_MAP_NAME = "%1_%2_Heatmap_%3_%4.dds"
staticprotected

%1 = subScene ID, %2 = layer name, %3 = data type (density, variety), %4 = colour mode (BW, RGB)

◆ LAYERS_SUBDIR

const string SCR_WorldEntitiesStatisticsPlugin.LAYERS_SUBDIR = "Layers"
staticprotected

◆ m_bActiveLayerOnly

bool SCR_WorldEntitiesStatisticsPlugin.m_bActiveLayerOnly
protected

◆ m_bDebug

bool SCR_WorldEntitiesStatisticsPlugin.m_bDebug
protected

◆ m_bHeatmapHighlightValuesAboveMax

bool SCR_WorldEntitiesStatisticsPlugin.m_bHeatmapHighlightValuesAboveMax
protected

◆ m_bHeatmapValueInversion

bool SCR_WorldEntitiesStatisticsPlugin.m_bHeatmapValueInversion
protected

◆ m_bOutputHeatmap

bool SCR_WorldEntitiesStatisticsPlugin.m_bOutputHeatmap
protected

◆ m_bOutputHeatmapForAllLayers

bool SCR_WorldEntitiesStatisticsPlugin.m_bOutputHeatmapForAllLayers
protected

◆ m_bOutputToFile

bool SCR_WorldEntitiesStatisticsPlugin.m_bOutputToFile
protected

◆ m_DebugShapeManager

ref SCR_DebugShapeManager SCR_WorldEntitiesStatisticsPlugin.m_DebugShapeManager
protected

◆ m_iDisplayThreshold

int SCR_WorldEntitiesStatisticsPlugin.m_iDisplayThreshold
protected

◆ m_iHeatmapColourMode

int SCR_WorldEntitiesStatisticsPlugin.m_iHeatmapColourMode
protected

◆ m_iHeatmapDefinition

int SCR_WorldEntitiesStatisticsPlugin.m_iHeatmapDefinition
protected

◆ m_iHeatmapMaxValueMode

int SCR_WorldEntitiesStatisticsPlugin.m_iHeatmapMaxValueMode
protected

◆ m_iHeatmapResolutionFactor

int SCR_WorldEntitiesStatisticsPlugin.m_iHeatmapResolutionFactor
protected

◆ m_iHeatmapType

int SCR_WorldEntitiesStatisticsPlugin.m_iHeatmapType
protected

◆ m_iMaxDisplayedEntries

int SCR_WorldEntitiesStatisticsPlugin.m_iMaxDisplayedEntries
protected

◆ MIN_ENTITIES_RGB

const int SCR_WorldEntitiesStatisticsPlugin.MIN_ENTITIES_RGB = 8
staticprotected

minimum entities per pixel in RGB mode; if less than that, prints a warning

◆ MIN_TERRAIN_DEBUG_RESOLUTION

const int SCR_WorldEntitiesStatisticsPlugin.MIN_TERRAIN_DEBUG_RESOLUTION = 50
staticprotected

◆ NO_MAP_CONTENT_FORMAT

const string SCR_WorldEntitiesStatisticsPlugin.NO_MAP_CONTENT_FORMAT = "No %1 found"
staticprotected

%1 = resultMap provided description

◆ OUTPUT_FILE_NAME

const string SCR_WorldEntitiesStatisticsPlugin.OUTPUT_FILE_NAME = "PrefabStatistics.txt"
staticprotected

◆ OUTPUT_MAP_NAME

const string SCR_WorldEntitiesStatisticsPlugin.OUTPUT_MAP_NAME = "Heatmap_%1_%2.dds"
staticprotected

%1 = data type (density, variety), %2 = colour mode (BW, RGB)

◆ SQM_TO_SQKM

const float SCR_WorldEntitiesStatisticsPlugin.SQM_TO_SQKM = 0.000001
staticprotected

◆ TYPE_DENSITY

const int SCR_WorldEntitiesStatisticsPlugin.TYPE_DENSITY = 0
staticprotected

◆ TYPE_VARIETY

const int SCR_WorldEntitiesStatisticsPlugin.TYPE_VARIETY = 1
staticprotected

◆ WORLD_DIRECTORY_FORMAT

const string SCR_WorldEntitiesStatisticsPlugin.WORLD_DIRECTORY_FORMAT = "WorldStatistics_%1"
staticprotected
The documentation for this interface was generated from the following file:
Generated by doxygen 1.13.2