SCR_LineGeneratorBaseEntity Interface Reference

SCR_LineGeneratorBaseEntity responsibilities: More...

Inheritance diagram for SCR_LineGeneratorBaseEntity:

Protected Member Functions
void	ResetShapeNextPointHelper ()
override void	OnShapeChangedInternal (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, array< vector > mins, array< vector > maxes)
override bool	_WB_OnKeyChanged (BaseContainer src, string key, BaseContainerList ownerContainers, IEntity parent)
override void	_WB_OnParentChange (IEntitySource src, IEntitySource prevParentSrc)
override void	_WB_OnInit (inout vector mat[4], IEntitySource src)
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.
void	SetSeed ()
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
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
bool	m_bRandomiseSeedOnUse
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

Additional Inherited Members
Public Member Functions inherited from SCR_GeneratorBaseEntity
override bool	_WB_CanSelect (IEntitySource src)
override void	OnShapeInitInternal (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity)
map< int, ref ShapePointDataScriptBase >	GetFirstPointDataMap (TypeName wantedType=ShapePointDataScriptBase)
map< int, ref array< ref ShapePointDataScriptBase > >	GetPointDataMap (TypeName wantedType=ShapePointDataScriptBase)
override void	_WB_OnCreate (IEntitySource src)
Static Protected Member Functions inherited from SCR_GeneratorBaseEntity
static WorldEditorAPI	GetWorldEditorAPI ()
static array< vector >	GetPoints (notnull IEntitySource shapeEntitySrc)
static array< vector >	GetAnchorPoints (notnull IEntitySource shapeEntitySrc, float offset=0, bool isShapeClosed=false)
static array< vector >	GetWorldAnchorPoints (notnull IEntitySource shapeEntitySrc)
static array< vector >	GetTesselatedShapePoints (notnull IEntitySource shapeEntitySrc, float offset=0, bool isShapeClosed=false)
static array< vector >	GetWorldTesselatedShapePoints (notnull IEntitySource shapeEntitySrc)
Static Protected Attributes inherited from SCR_GeneratorBaseEntity
static const int	DEFAULT_SEED = 42
static const int	MIN_RANDOM_SEED = 0
static const int	MAX_RANDOM_SEED = 0x7FFF
static const int	BASE_GENERATOR_COLOUR = Color.WHITE

Detailed Description

SCR_LineGeneratorBaseEntity responsibilities:

• allow and draw a shape offset from the parent shape ("parallel/virtual" shape)
• hold a "next point helper" to get the next point on the parent/offset shape according to the exposed attributes

Member Function Documentation

_WB_AfterWorldUpdate()

override void SCR_LineGeneratorBaseEntity._WB_AfterWorldUpdate ( float timeSlice )

protected

_WB_GetAfterWorldUpdateSpecs()

override int SCR_LineGeneratorBaseEntity._WB_GetAfterWorldUpdateSpecs ( IEntitySource src )

protected

_WB_OnInit()

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

protected

Implemented in SCR_LineTerrainShaperGeneratorBaseEntity.

_WB_OnKeyChanged()

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

protected

Implements SCR_GeneratorBaseEntity.

Implemented in PrefabGeneratorEntity, SCR_LineTerrainShaperGeneratorBaseEntity, SCR_PowerlineGeneratorEntity, and WallGeneratorEntity.

_WB_OnParentChange()

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

protected

Implements SCR_GeneratorBaseEntity.

Implemented in SCR_LineTerrainShaperGeneratorBaseEntity, SCR_PowerlineGeneratorEntity, and WallGeneratorEntity.

OnShapeChangedInternal()

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

protected

Implements SCR_GeneratorBaseEntity.

Implemented in PrefabGeneratorEntity, SCR_LineTerrainShaperGeneratorBaseEntity, SCR_PowerlineGeneratorEntity, and WallGeneratorEntity.

ResetShapeNextPointHelper()

void SCR_LineGeneratorBaseEntity.ResetShapeNextPointHelper ( )

protected

Member Data Documentation

m_aOffsetShapeShapes

ref array<Shape> SCR_LineGeneratorBaseEntity.m_aOffsetShapeShapes = {}

protected

m_bForceOffsetShapeShapesRefresh

bool SCR_LineGeneratorBaseEntity.m_bForceOffsetShapeShapesRefresh

protected

m_bIsSelectedAlone

bool SCR_LineGeneratorBaseEntity.m_bIsSelectedAlone

protected

m_bNextPointMeasurementXZ

bool SCR_LineGeneratorBaseEntity.m_bNextPointMeasurementXZ

protected

m_bSnapOffsetShapeToTheGround

bool SCR_LineGeneratorBaseEntity.m_bSnapOffsetShapeToTheGround

protected

m_bYOffsetInShapeSpace

bool SCR_LineGeneratorBaseEntity.m_bYOffsetInShapeSpace

protected

m_DbgShpMgr

ref SCR_DebugShapeManager SCR_LineGeneratorBaseEntity.m_DbgShpMgr

protected

m_fShapeOffset

float SCR_LineGeneratorBaseEntity.m_fShapeOffset

protected

m_fSplineSafetyDistanceRatio

float SCR_LineGeneratorBaseEntity.m_fSplineSafetyDistanceRatio

protected

m_ShapeNextPointHelper

ref SCR_ShapeNextPointHelper SCR_LineGeneratorBaseEntity.m_ShapeNextPointHelper

protected

m_vShapeOffset

vector SCR_LineGeneratorBaseEntity.m_vShapeOffset

protected

---

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

• Game/Generators/SCR_LineGeneratorBaseEntity.c