PrefabGeneratorEntity Interface Reference

Inheritance diagram for PrefabGeneratorEntity:

Protected Member Functions
override bool	_WB_OnKeyChanged (BaseContainer src, string key, BaseContainerList ownerContainers, IEntity parent)
override void	OnShapeInitInternal (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity)
float	SamplePerlin (float time, float frequency=20, float seed=1, float amplitude=1, float phaseOffset=0)
	Get a perlin value given specific parameters.
void	GenerateAssetPoints (notnull array< ref SCR_PrefabGeneratorPointMeta > metas)
	generates array of positions(+other data) where each asset is supposed to spawn
array< ref SCR_PrefabGeneratorPointMeta >	GetMetaListLineFromOffsetShape ()
array< ref SCR_PrefabGeneratorPointMeta >	GetMetaListSplineFromShapeOffset ()
override void	OnShapeChangedInternal (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, array< vector > mins, array< vector > maxes)
void	Generate ()
	Generate the assets.
void	DrawCurveDebug (array< ref SCR_PrefabGeneratorPointMeta > metas)
	Draws debug curve.
void	PrefabGeneratorEntity (IEntitySource src, IEntity parent)
Protected Member Functions inherited from SCR_LineTerrainShaperGeneratorBaseEntity
override void	OnShapeTransformInternal (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, array< vector > mins, array< vector > maxes)
void	UpdateTerrainSimple (bool forceUpdate=false)
	wrapper method around UpdateTerrain that sets m_ShapeEntity up
void	UpdateTerrain (notnull ShapeEntity shapeEntity, bool forceUpdate, notnull array< vector > updateMins, notnull array< vector > updateMaxes)
void	SCR_LineTerrainShaperGeneratorBaseEntity (IEntitySource src, IEntity parent)
Protected Member Functions inherited from SCR_LineGeneratorBaseEntity
void	ResetShapeNextPointHelper ()
override void	_WB_AfterWorldUpdate (float timeSlice)
override int	_WB_GetAfterWorldUpdateSpecs (IEntitySource src)
Protected Member Functions inherited from SCR_GeneratorBaseEntity
override void	OnIntersectingShapeChangedXZInternal (IEntitySource shapeEntitySrc, IEntitySource other, array< vector > mins, array< vector > maxes)
void	ResetGeneratorPosition (ShapeEntity shapeEntity=null)
void	DeleteAllChildren ()
	Delete all children without distinction, using WorldEditorAPI.
array< vector >	GetWorldAnchorPoints (notnull IEntitySource shapeEntitySrc)
array< vector >	GetWorldTesselatedShapePoints (notnull IEntitySource shapeEntitySrc)
Color	GetColor ()
void	ColorShape ()
	Set shape's line colour to GetColor() value.
IEntitySource	GetShapeSource ()
	Get the parent shape above this generator (has to be the direct parent)
void	SCR_GeneratorBaseEntity (IEntitySource src, IEntity parent)

Protected Attributes
ref array< float >	m_aMirrorDistances
bool	m_bMirrorRandomPrefabs
ref array< ResourceName >	m_PrefabNames
ref array< float >	m_Weights
bool	m_bOnlyToVertices
float	m_fDistance
bool	m_bAlignWithShape
bool	m_bUseXAsForward
bool	m_bFlipForward
float	m_fOffsetRight
float	m_fOffsetVariance
float	m_fGap
bool	m_fRandomSpacing
float	m_fOffsetUp
float	m_fOffsetForward
bool	m_bPerlinDens
float	m_fPerlinThreshold
bool	m_bPerlinAssetDistribution
bool	m_bPerlinSize
float	m_fPerlinFrequency
float	m_fPerlinSeed
float	m_fPerlinAmplitude
float	m_fPerlinOffset
bool	m_fPerlinThrowAway
bool	m_bDrawDebug
ref array< ref SCR_PrefabGeneratorAssetPoint >	m_aPoints = {}
Protected Attributes inherited from SCR_LineTerrainShaperGeneratorBaseEntity
bool	m_bSculptTerrain
int	m_iTerrainSculptingPriority
float	m_fTerrainSculptingPathWidth
float	m_fTerrainSculptingFallOffWidth
ShapeEntity	m_ShapeEntity
	Read by WorldEditorAPI.AddTerrainFlatterEntity, CANNOT be renamed defined at the last moment in UpdateTerrainSimple from m_ParentShapeSource / m_OffsetShapeSource.
Protected Attributes inherited from SCR_LineGeneratorBaseEntity
vector	m_vShapeOffset
bool	m_bYOffsetInShapeSpace
float	m_fShapeOffset
float	m_fSplineSafetyDistanceRatio
bool	m_bSnapOffsetShapeToTheGround
bool	m_bNextPointMeasurementXZ
ref SCR_ShapeNextPointHelper	m_ShapeNextPointHelper
ref SCR_DebugShapeManager	m_DbgShpMgr
ref array< Shape >	m_aOffsetShapeShapes = {}
bool	m_bIsSelectedAlone
bool	m_bForceOffsetShapeShapesRefresh
Protected Attributes inherited from SCR_GeneratorBaseEntity
bool	m_bEnableGeneration
int	m_iSeed
IEntitySource	m_Source
	the generator's entity source
IEntitySource	m_ParentShapeSource
	the parent shape's entity source, if any - must be managed ONLY by SCR_GeneratorBaseEntity
int	m_iSourceLayerID
ref RandomGenerator	m_RandomGenerator
bool	m_bIsChangingWorkbenchKey

Static Protected Attributes
static ref array< ref Shape >	s_aDebugShapes = {}
static const float	PERLIN_STEP_LENGTH = 0.01
Static Protected Attributes inherited from SCR_LineTerrainShaperGeneratorBaseEntity
static const ref array< string >	TERRAIN_UPDATE_KEYS
static const string	OFFSET_SHAPE_COLOUR = "1 0 1 1"
Static Protected Attributes inherited from SCR_GeneratorBaseEntity
static const int	BASE_GENERATOR_COLOUR = Color.WHITE

Additional Inherited Members
Public Member Functions inherited from SCR_LineTerrainShaperGeneratorBaseEntity
override void	_WB_OnInit (inout vector mat[4], IEntitySource src)
override void	_WB_OnCreate (IEntitySource src)
override void	_WB_OnParentChange (IEntitySource src, IEntitySource prevParentSrc)
override void	_WB_OnDelete (IEntitySource src)
Public Member Functions inherited from SCR_GeneratorBaseEntity
override bool	_WB_CanSelect (IEntitySource src)
map< int, ref ShapePointDataScriptBase >	GetFirstPointDataMap (TypeName wantedType=ShapePointDataScriptBase)
map< int, ref array< ref ShapePointDataScriptBase > >	GetPointDataMap (TypeName wantedType=ShapePointDataScriptBase)
Static Protected Member Functions inherited from SCR_GeneratorBaseEntity
static array< vector >	GetPoints (notnull IEntitySource shapeEntitySrc)
static array< vector >	GetAnchorPoints (notnull IEntitySource shapeEntitySrc, float offset=0, bool isShapeClosed=false)
static array< vector >	GetTesselatedShapePoints (notnull IEntitySource shapeEntitySrc, float offset=0, bool isShapeClosed=false)

Constructor & Destructor Documentation

PrefabGeneratorEntity()

void PrefabGeneratorEntity.PrefabGeneratorEntity ( IEntitySource src, IEntity parent )

protected

Member Function Documentation

_WB_OnKeyChanged()

override bool PrefabGeneratorEntity._WB_OnKeyChanged ( BaseContainer src, string key, BaseContainerList ownerContainers, IEntity parent )

protected

Implements SCR_LineTerrainShaperGeneratorBaseEntity.

DrawCurveDebug()

void PrefabGeneratorEntity.DrawCurveDebug ( array< ref SCR_PrefabGeneratorPointMeta > metas )

protected

Draws debug curve.

Generate()

void PrefabGeneratorEntity.Generate ( )

protected

Generate the assets.

GenerateAssetPoints()

void PrefabGeneratorEntity.GenerateAssetPoints ( notnull array< ref SCR_PrefabGeneratorPointMeta > metas )

protected

generates array of positions(+other data) where each asset is supposed to spawn

GetMetaListLineFromOffsetShape()

array< ref SCR_PrefabGeneratorPointMeta > PrefabGeneratorEntity.GetMetaListLineFromOffsetShape ( )

protected

GetMetaListSplineFromShapeOffset()

array< ref SCR_PrefabGeneratorPointMeta > PrefabGeneratorEntity.GetMetaListSplineFromShapeOffset ( )

protected

OnShapeChangedInternal()

override void PrefabGeneratorEntity.OnShapeChangedInternal ( IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, array< vector > mins, array< vector > maxes )

protected

Implements SCR_LineTerrainShaperGeneratorBaseEntity.

OnShapeInitInternal()

override void PrefabGeneratorEntity.OnShapeInitInternal ( IEntitySource shapeEntitySrc, ShapeEntity shapeEntity )

protected

Implements SCR_LineTerrainShaperGeneratorBaseEntity.

SamplePerlin()

float PrefabGeneratorEntity.SamplePerlin ( float time, float frequency = 20, float seed = 1, float amplitude = 1, float phaseOffset = 0 )

protected

Get a perlin value given specific parameters.

Member Data Documentation

m_aMirrorDistances

ref array<float> PrefabGeneratorEntity.m_aMirrorDistances

protected

m_aPoints

ref array<ref SCR_PrefabGeneratorAssetPoint> PrefabGeneratorEntity.m_aPoints = {}

protected

m_bAlignWithShape

bool PrefabGeneratorEntity.m_bAlignWithShape

protected

m_bDrawDebug

bool PrefabGeneratorEntity.m_bDrawDebug

protected

m_bFlipForward

bool PrefabGeneratorEntity.m_bFlipForward

protected

m_bMirrorRandomPrefabs

bool PrefabGeneratorEntity.m_bMirrorRandomPrefabs

protected

m_bOnlyToVertices

bool PrefabGeneratorEntity.m_bOnlyToVertices

protected

m_bPerlinAssetDistribution

bool PrefabGeneratorEntity.m_bPerlinAssetDistribution

protected

m_bPerlinDens

bool PrefabGeneratorEntity.m_bPerlinDens

protected

m_bPerlinSize

bool PrefabGeneratorEntity.m_bPerlinSize

protected

m_bUseXAsForward

bool PrefabGeneratorEntity.m_bUseXAsForward

protected

m_fDistance

float PrefabGeneratorEntity.m_fDistance

protected

m_fGap

float PrefabGeneratorEntity.m_fGap

protected

m_fOffsetForward

float PrefabGeneratorEntity.m_fOffsetForward

protected

m_fOffsetRight

float PrefabGeneratorEntity.m_fOffsetRight

protected

m_fOffsetUp

float PrefabGeneratorEntity.m_fOffsetUp

protected

m_fOffsetVariance

float PrefabGeneratorEntity.m_fOffsetVariance

protected

m_fPerlinAmplitude

float PrefabGeneratorEntity.m_fPerlinAmplitude

protected

m_fPerlinFrequency

float PrefabGeneratorEntity.m_fPerlinFrequency

protected

m_fPerlinOffset

float PrefabGeneratorEntity.m_fPerlinOffset

protected

m_fPerlinSeed

float PrefabGeneratorEntity.m_fPerlinSeed

protected

m_fPerlinThreshold

float PrefabGeneratorEntity.m_fPerlinThreshold

protected

m_fPerlinThrowAway

bool PrefabGeneratorEntity.m_fPerlinThrowAway

protected

m_fRandomSpacing

bool PrefabGeneratorEntity.m_fRandomSpacing

protected

m_PrefabNames

ref array<ResourceName> PrefabGeneratorEntity.m_PrefabNames

protected

m_Weights

ref array<float> PrefabGeneratorEntity.m_Weights

protected

PERLIN_STEP_LENGTH

const float PrefabGeneratorEntity.PERLIN_STEP_LENGTH = 0.01

staticprotected

s_aDebugShapes

ref array<ref Shape> PrefabGeneratorEntity.s_aDebugShapes = {}

staticprotected

---

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

• Game/Generators/PrefabGeneratorEntity.c