Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_RandomisationEditorData Interface Reference

Public Member Functions

bool RandomiseExt (notnull WorldEditorAPI worldEditorAPI, notnull IEntitySource entitySource, RandomGenerator randomGenerator)
 Randomise the provided entitySource with its Prefab Library values, assuming it is on the ground already
(WorldEditorAPI.CreateEntity vs .CreateEntityExt)
Does not use BeginEntityAction or any other kind of Begin..End action
Place By Bounding Box is not supported (yet?)
 

Static Public Member Functions

static SCR_RandomisationEditorData CreateFromEntitySource (notnull IEntitySource entitySource)
 Get randomisation information from the provided entitySource (WorldEditorAPI.CreateEntity vs .CreateEntityExt)
 

Public Attributes

bool m_bPlaceByBoundingBox
 false = place by origin
 
bool m_bRandomYaw
 
bool m_bAlignToNormal
 
vector m_vRandomScale
 the UI allows for negatives, and WorldEditorAPI too - only entity.SetScale bothers blocking negative scales
 
vector m_vRandomVertOffset
 [0] <= [1], always
 
float m_fRandomPitchAngle
 range 0..180
 
float m_fRandomRollAngle
 range 0..180
 

Protected Member Functions

void SCR_RandomisationEditorData ()
 

Constructor & Destructor Documentation

◆ SCR_RandomisationEditorData()

void SCR_RandomisationEditorData.SCR_RandomisationEditorData ( )
protected

Member Function Documentation

◆ CreateFromEntitySource()

static SCR_RandomisationEditorData SCR_RandomisationEditorData.CreateFromEntitySource ( notnull IEntitySource entitySource)
static

Get randomisation information from the provided entitySource (WorldEditorAPI.CreateEntity vs .CreateEntityExt)

Parameters
[in]entitySourcethe entity source from which to grab randomisation data
Returns
randomisation data if correctly grabbed, null otherwise

◆ RandomiseExt()

bool SCR_RandomisationEditorData.RandomiseExt ( notnull WorldEditorAPI worldEditorAPI,
notnull IEntitySource entitySource,
RandomGenerator randomGenerator )

Randomise the provided entitySource with its Prefab Library values, assuming it is on the ground already
(WorldEditorAPI.CreateEntity vs .CreateEntityExt)
Does not use BeginEntityAction or any other kind of Begin..End action
Place By Bounding Box is not supported (yet?)

Parameters
[in]entitySource
[in]randomGenerator
Returns
true on success, false on failure

Member Data Documentation

◆ m_bAlignToNormal

bool SCR_RandomisationEditorData.m_bAlignToNormal

◆ m_bPlaceByBoundingBox

bool SCR_RandomisationEditorData.m_bPlaceByBoundingBox

false = place by origin

◆ m_bRandomYaw

bool SCR_RandomisationEditorData.m_bRandomYaw

◆ m_fRandomPitchAngle

float SCR_RandomisationEditorData.m_fRandomPitchAngle

range 0..180

◆ m_fRandomRollAngle

float SCR_RandomisationEditorData.m_fRandomRollAngle

range 0..180

◆ m_vRandomScale

vector SCR_RandomisationEditorData.m_vRandomScale

the UI allows for negatives, and WorldEditorAPI too - only entity.SetScale bothers blocking negative scales

◆ m_vRandomVertOffset

vector SCR_RandomisationEditorData.m_vRandomVertOffset

[0] <= [1], always


The documentation for this interface was generated from the following file: