SCR_LineTerrainShaperGeneratorBaseEntity Interface Reference

Inheritance diagram for SCR_LineTerrainShaperGeneratorBaseEntity:

Public Member Functions
override void	_WB_OnInit (inout vector mat[4], IEntitySource src)
override bool	_WB_OnKeyChanged (BaseContainer src, string key, BaseContainerList ownerContainers, IEntity parent)
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)

Protected Member Functions
override void	OnShapeInitInternal (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity)
override void	OnShapeTransformInternal (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, array< vector > mins, array< vector > maxes)
override void	OnShapeChangedInternal (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
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 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
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

SCR_LineTerrainShaperGeneratorBaseEntity()

void SCR_LineTerrainShaperGeneratorBaseEntity.SCR_LineTerrainShaperGeneratorBaseEntity ( IEntitySource src, IEntity parent )

protected

Member Function Documentation

_WB_OnCreate()

override void SCR_LineTerrainShaperGeneratorBaseEntity._WB_OnCreate

(

IEntitySource

src

)

Implements SCR_GeneratorBaseEntity.

_WB_OnDelete()

override void SCR_LineTerrainShaperGeneratorBaseEntity._WB_OnDelete

(

IEntitySource

src

)

_WB_OnInit()

override void SCR_LineTerrainShaperGeneratorBaseEntity._WB_OnInit	(	inout vector	mat[4],
		IEntitySource	src )

Implements SCR_LineGeneratorBaseEntity.

_WB_OnKeyChanged()

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

Implements SCR_LineGeneratorBaseEntity.

Implemented in PrefabGeneratorEntity, SCR_PowerlineGeneratorEntity, and WallGeneratorEntity.

_WB_OnParentChange()

override void SCR_LineTerrainShaperGeneratorBaseEntity._WB_OnParentChange	(	IEntitySource	src,
		IEntitySource	prevParentSrc )

Implements SCR_LineGeneratorBaseEntity.

OnShapeChangedInternal()

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

protected

Implements SCR_LineGeneratorBaseEntity.

Implemented in PrefabGeneratorEntity, SCR_PowerlineGeneratorEntity, and WallGeneratorEntity.

OnShapeInitInternal()

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

protected

Implements SCR_GeneratorBaseEntity.

Implemented in PrefabGeneratorEntity, and SCR_PowerlineGeneratorEntity.

OnShapeTransformInternal()

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

protected

UpdateTerrain()

void SCR_LineTerrainShaperGeneratorBaseEntity.UpdateTerrain ( notnull ShapeEntity shapeEntity, bool forceUpdate, notnull array< vector > updateMins, notnull array< vector > updateMaxes )

protected

Parameters

[in]	shapeEntity	the shape to follow for terrain update - is assigned to m_ShapeEntity as C++ reads this variable ("hardcoded" C++-side)
[in]	forceUpdate
[in]	updateMins
[in]	updateMaxes

UpdateTerrainSimple()

void SCR_LineTerrainShaperGeneratorBaseEntity.UpdateTerrainSimple ( bool forceUpdate = false )

protected

wrapper method around UpdateTerrain that sets m_ShapeEntity up

Parameters

[in]

forceUpdate

WorldEditorAPI.AddTerrainFlatterEntity parameter

Member Data Documentation

m_bSculptTerrain

bool SCR_LineTerrainShaperGeneratorBaseEntity.m_bSculptTerrain

protected

m_fTerrainSculptingFallOffWidth

float SCR_LineTerrainShaperGeneratorBaseEntity.m_fTerrainSculptingFallOffWidth

protected

m_fTerrainSculptingPathWidth

float SCR_LineTerrainShaperGeneratorBaseEntity.m_fTerrainSculptingPathWidth

protected

m_iTerrainSculptingPriority

int SCR_LineTerrainShaperGeneratorBaseEntity.m_iTerrainSculptingPriority

protected

m_ShapeEntity

ShapeEntity SCR_LineTerrainShaperGeneratorBaseEntity.m_ShapeEntity

protected

Read by WorldEditorAPI.AddTerrainFlatterEntity, CANNOT be renamed defined at the last moment in UpdateTerrainSimple from m_ParentShapeSource / m_OffsetShapeSource.

OFFSET_SHAPE_COLOUR

const string SCR_LineTerrainShaperGeneratorBaseEntity.OFFSET_SHAPE_COLOUR = "1 0 1 1"

staticprotected

TERRAIN_UPDATE_KEYS

const ref array<string> SCR_LineTerrainShaperGeneratorBaseEntity.TERRAIN_UPDATE_KEYS

staticprotected

Initial value:

= {
        "m_bSculptTerrain", "m_iTerrainSculptingPriority",
        "m_fTerrainSculptingPathWidth", "m_fTerrainSculptingFallOffWidth",
    }

---

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

• Game/Generators/SCR_LineTerrainShaperGeneratorBaseEntity.c