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

Protected Member Functions

void BtnFixBuildingPrefabRuins ()
 
void BtnSetBuildingDestructionEffects ()
 
void FixBuildingPrefabRuins (notnull array< ResourceName > resourceNames)
 
bool FixPrefabRuin (notnull IEntitySource ancestor, notnull map< ResourceName, string > ruinPrefabFileNameMap, notnull WorldEditorAPI worldEditorAPI)
 
ResourceName GetBestRuinByName (string fileName, notnull map< ResourceName, string > ruinPrefabFileNameMap)
 
float GetBestRuinScore (string fileName, notnull map< ResourceName, string > ruinPrefabFileNameMap)
 
void SetBuildingDestructionEffects (notnull array< ResourceName > resourceNames, notnull array< ref SCR_TimedEffect > effects)
 BeginEntityAction/EndEntityAction must be dealt with a level above.
 
bool SetEffectsValue (notnull BaseContainer actualPrefab, notnull array< ref SCR_TimedEffect > timedEffects)
 
bool InsertTimedParticleValue (notnull BaseContainer actualPrefab, notnull array< ref ContainerIdPathEntry > destructionComponentPath, int effectIndex, notnull SCR_TimedParticle effect)
 
bool InsertTimedSoundValue (notnull BaseContainer actualPrefab, notnull array< ref ContainerIdPathEntry > destructionComponentPath, int effectIndex, notnull SCR_TimedSound effect)
 
bool InsertTimedEffectValue (notnull BaseContainer actualPrefab, notnull array< ref ContainerIdPathEntry > path, notnull SCR_TimedEffect effect)
 called by
 

Static Protected Member Functions

static array< ref ContainerIdPathEntry > GetDestructionComponentPath (BaseContainer actualPrefab)
 
static array< ref ContainerIdPathEntry > GetTimedEffectPath (notnull array< ref ContainerIdPathEntry > destructionComponentPath, int effectIndex)
 
static string ToString (notnull ContainerIdPathEntry containerIdPathEntry)
 
static string ToString (notnull array< ref ContainerIdPathEntry > containerIdPathEntries)
 

Protected Attributes

ref SCR_BuildingDestructionSetupToolConfig m_DestructionEffectsConfig
 

Static Protected Attributes

static const string PREFAB_EXTENSION = "et"
 
static const string BUILDING_CLASS = "SCR_DestructibleBuildingEntity"
 
static const string RUIN_FILTER = "_Ruin"
 
static const string FILE_NAME_FILTER [] = { "_Ruin", "_ruin", "_Ruins", "_ruins", "_Base", "_base", "_Dst_", "_dst_" }
 
static const int FILE_NAME_FILTER_COUNT = 8
 
static const ResourceName DEFAULT_RUIN = "{11B789B5F476A4B5}Prefabs/Structures/Debris/DebrisPile_HouseVillage/DebrisPile_HouseVillage_01_Large.et"
 
static const string COMPONENTS_ARRAY = "components"
 
static const string DESTRUCTION_COMPONENT = "SCR_DestructibleBuildingComponent"
 
static const string DESTRUCTION_COMPONENT_EFFECTS_ARRAY = "m_aEffects"
 
static const string TIMED_PARTICLE_CLASSNAME = "SCR_TimedParticle"
 
static const string TIMED_PARTICLE_PARTICLE = "m_Particle"
 
static const string TIMED_PARTICLE_PARTICLE_CLASSNAME = "SCR_ParticleSpawnable"
 
static const string TIMED_SOUND_CLASSNAME = "SCR_TimedSound"
 
static const string TIMED_SOUND_AUDIO_CONFIG = "m_AudioSourceConfiguration"
 
static const string TIMED_SOUND_AUDIO_CONFIG_CLASSNAME = "SCR_AudioSourceConfiguration"
 
static const string TIMED_PREFAB_CLASSNAME = "SCR_TimedPrefab"
 
static const string TIMED_PREFAB_PATH = "m_sRuinsPrefab"
 
static const float LEVENSHTEIN_THRESHOLD = 0.75
 

Member Function Documentation

◆ BtnFixBuildingPrefabRuins()

void SCR_BuildingDestructionSetupTool.BtnFixBuildingPrefabRuins ( )
protected

◆ BtnSetBuildingDestructionEffects()

void SCR_BuildingDestructionSetupTool.BtnSetBuildingDestructionEffects ( )
protected

◆ FixBuildingPrefabRuins()

void SCR_BuildingDestructionSetupTool.FixBuildingPrefabRuins ( notnull array< ResourceName > resourceNames)
protected
Parameters
[in]resourceNames

◆ FixPrefabRuin()

bool SCR_BuildingDestructionSetupTool.FixPrefabRuin ( notnull IEntitySource ancestor,
notnull map< ResourceName, string > ruinPrefabFileNameMap,
notnull WorldEditorAPI worldEditorAPI )
protected
Parameters
[in]ancestor
[in]ruinPrefabFileNameMap
[in]worldEditorAPI

◆ GetBestRuinByName()

ResourceName SCR_BuildingDestructionSetupTool.GetBestRuinByName ( string fileName,
notnull map< ResourceName, string > ruinPrefabFileNameMap )
protected
Parameters
[in]fileName
[in]ruinPrefabFileNameMap
[in]thresholdvalue above (or equal) which a name matching is accepted
Returns
the best-matching ResourceName, empty if no good enough match was found

◆ GetBestRuinScore()

float SCR_BuildingDestructionSetupTool.GetBestRuinScore ( string fileName,
notnull map< ResourceName, string > ruinPrefabFileNameMap )
protected

◆ GetDestructionComponentPath()

static array< ref ContainerIdPathEntry > SCR_BuildingDestructionSetupTool.GetDestructionComponentPath ( BaseContainer actualPrefab)
staticprotected
Parameters
[in]actualPrefab
Returns

◆ GetTimedEffectPath()

static array< ref ContainerIdPathEntry > SCR_BuildingDestructionSetupTool.GetTimedEffectPath ( notnull array< ref ContainerIdPathEntry > destructionComponentPath,
int effectIndex )
staticprotected
Parameters
[in]destructionComponentPath
[in]effectIndex
Returns
a copy of destructionComponentPath with the timed effect path entry inserted, never returns null

◆ InsertTimedEffectValue()

bool SCR_BuildingDestructionSetupTool.InsertTimedEffectValue ( notnull BaseContainer actualPrefab,
notnull array< ref ContainerIdPathEntry > path,
notnull SCR_TimedEffect effect )
protected

called by

  • InsertTimedParticleValue
  • InsertTimedSoundValue
    Parameters
    [in]actualPrefab
    [in]path
    [in]effect
    Returns

◆ InsertTimedParticleValue()

bool SCR_BuildingDestructionSetupTool.InsertTimedParticleValue ( notnull BaseContainer actualPrefab,
notnull array< ref ContainerIdPathEntry > destructionComponentPath,
int effectIndex,
notnull SCR_TimedParticle effect )
protected
Parameters
[in]actualPrefab
[in]destructionComponentPath
[in]effectIndex
[in]effect
Returns
true on success, false otherwise

◆ InsertTimedSoundValue()

bool SCR_BuildingDestructionSetupTool.InsertTimedSoundValue ( notnull BaseContainer actualPrefab,
notnull array< ref ContainerIdPathEntry > destructionComponentPath,
int effectIndex,
notnull SCR_TimedSound effect )
protected
Parameters
[in]actualPrefab
[in]destructionComponentPath
[in]effectIndex
[in]effect
Returns
true on success, false otherwise

◆ SetBuildingDestructionEffects()

void SCR_BuildingDestructionSetupTool.SetBuildingDestructionEffects ( notnull array< ResourceName > resourceNames,
notnull array< ref SCR_TimedEffect > effects )
protected

BeginEntityAction/EndEntityAction must be dealt with a level above.

Parameters
[in]resourceNames
[in]effects

◆ SetEffectsValue()

bool SCR_BuildingDestructionSetupTool.SetEffectsValue ( notnull BaseContainer actualPrefab,
notnull array< ref SCR_TimedEffect > timedEffects )
protected
Parameters
[in]actualPrefab
[in]timedEffects
Returns

◆ ToString() [1/2]

static string SCR_BuildingDestructionSetupTool.ToString ( notnull array< ref ContainerIdPathEntry > containerIdPathEntries)
staticprotected
Parameters
[in]containerIdPathEntries
Returns

◆ ToString() [2/2]

static string SCR_BuildingDestructionSetupTool.ToString ( notnull ContainerIdPathEntry containerIdPathEntry)
staticprotected
Parameters
[in]containerIdPathEntry
Returns

Member Data Documentation

◆ BUILDING_CLASS

const string SCR_BuildingDestructionSetupTool.BUILDING_CLASS = "SCR_DestructibleBuildingEntity"
staticprotected

◆ COMPONENTS_ARRAY

const string SCR_BuildingDestructionSetupTool.COMPONENTS_ARRAY = "components"
staticprotected

◆ DEFAULT_RUIN

const ResourceName SCR_BuildingDestructionSetupTool.DEFAULT_RUIN = "{11B789B5F476A4B5}Prefabs/Structures/Debris/DebrisPile_HouseVillage/DebrisPile_HouseVillage_01_Large.et"
staticprotected

◆ DESTRUCTION_COMPONENT

const string SCR_BuildingDestructionSetupTool.DESTRUCTION_COMPONENT = "SCR_DestructibleBuildingComponent"
staticprotected

◆ DESTRUCTION_COMPONENT_EFFECTS_ARRAY

const string SCR_BuildingDestructionSetupTool.DESTRUCTION_COMPONENT_EFFECTS_ARRAY = "m_aEffects"
staticprotected

◆ FILE_NAME_FILTER

const string SCR_BuildingDestructionSetupTool.FILE_NAME_FILTER[] = { "_Ruin", "_ruin", "_Ruins", "_ruins", "_Base", "_base", "_Dst_", "_dst_" }
staticprotected

◆ FILE_NAME_FILTER_COUNT

const int SCR_BuildingDestructionSetupTool.FILE_NAME_FILTER_COUNT = 8
staticprotected

◆ LEVENSHTEIN_THRESHOLD

const float SCR_BuildingDestructionSetupTool.LEVENSHTEIN_THRESHOLD = 0.75
staticprotected

◆ m_DestructionEffectsConfig

ref SCR_BuildingDestructionSetupToolConfig SCR_BuildingDestructionSetupTool.m_DestructionEffectsConfig
protected

◆ PREFAB_EXTENSION

const string SCR_BuildingDestructionSetupTool.PREFAB_EXTENSION = "et"
staticprotected

◆ RUIN_FILTER

const string SCR_BuildingDestructionSetupTool.RUIN_FILTER = "_Ruin"
staticprotected

◆ TIMED_PARTICLE_CLASSNAME

const string SCR_BuildingDestructionSetupTool.TIMED_PARTICLE_CLASSNAME = "SCR_TimedParticle"
staticprotected

◆ TIMED_PARTICLE_PARTICLE

const string SCR_BuildingDestructionSetupTool.TIMED_PARTICLE_PARTICLE = "m_Particle"
staticprotected

◆ TIMED_PARTICLE_PARTICLE_CLASSNAME

const string SCR_BuildingDestructionSetupTool.TIMED_PARTICLE_PARTICLE_CLASSNAME = "SCR_ParticleSpawnable"
staticprotected

◆ TIMED_PREFAB_CLASSNAME

const string SCR_BuildingDestructionSetupTool.TIMED_PREFAB_CLASSNAME = "SCR_TimedPrefab"
staticprotected

◆ TIMED_PREFAB_PATH

const string SCR_BuildingDestructionSetupTool.TIMED_PREFAB_PATH = "m_sRuinsPrefab"
staticprotected

◆ TIMED_SOUND_AUDIO_CONFIG

const string SCR_BuildingDestructionSetupTool.TIMED_SOUND_AUDIO_CONFIG = "m_AudioSourceConfiguration"
staticprotected

◆ TIMED_SOUND_AUDIO_CONFIG_CLASSNAME

const string SCR_BuildingDestructionSetupTool.TIMED_SOUND_AUDIO_CONFIG_CLASSNAME = "SCR_AudioSourceConfiguration"
staticprotected

◆ TIMED_SOUND_CLASSNAME

const string SCR_BuildingDestructionSetupTool.TIMED_SOUND_CLASSNAME = "SCR_TimedSound"
staticprotected
The documentation for this interface was generated from the following file:
Generated by doxygen 1.11.0