SCR_AreaGeneratorBaseEntity Interface Reference

SCR_AreaGeneratorBaseEntity responsibilities: More...

Inheritance diagram for SCR_AreaGeneratorBaseEntity:

Public Member Functions
void	SCR_AreaGeneratorBaseEntity (IEntitySource src, IEntity parent)
Public Member Functions inherited from SCR_GeneratorBaseEntity
override void	_WB_OnParentChange (IEntitySource src, IEntitySource prevParentSrc)
override bool	_WB_OnKeyChanged (BaseContainer src, string key, BaseContainerList ownerContainers, IEntity parent)
override bool	_WB_CanSelect (IEntitySource src)
override void	OnShapeChangedInternal (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, array< vector > mins, array< vector > maxes)
override void	OnShapeInitInternal (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity)
override void	_WB_OnCreate (IEntitySource src)
void	SCR_GeneratorBaseEntity (IEntitySource src, IEntity parent)

Protected Member Functions
void	RefreshObstacles ()
void	SetAvoidOptions ()
bool	HasObstacle (vector worldPos, array< IEntity > exclusionList=null)
bool	HasObstaclesList ()
void	ClearObstacles ()
override void	OnIntersectingShapeChangedXZInternal (IEntitySource shapeEntitySrc, IEntitySource other, array< vector > mins, array< vector > maxes)
void	OnRegenerate ()
Protected Member Functions inherited from SCR_GeneratorBaseEntity
void	ResetGeneratorPosition (ShapeEntity shapeEntity=null)
void	DeleteAllChildren ()
	Delete all children without distinction, using WorldEditorAPI.
array< vector >	GetWorldAnchorPoints (notnull IEntitySource shapeEntitySrc)
array< vector >	GetTesselatedShapePoints (notnull IEntitySource shapeEntitySrc)
array< vector >	GetWorldTesselatedShapePoints (notnull IEntitySource shapeEntitySrc)
Color	GetColor ()
void	ColorShape ()
	Set shape's line colour to GetColor() value.

Protected Attributes
bool	m_bAvoidObjects
bool	m_bAvoidRoads
bool	m_bAvoidRivers
bool	m_bAvoidPowerLines
bool	m_bAvoidTracks
bool	m_bAvoidLakes
bool	m_bRegenerateByObstacleChanges
Protected Attributes inherited from SCR_GeneratorBaseEntity
IEntitySource	m_Source
IEntitySource	m_ParentShapeSource
bool	m_bIsChangingWorkbenchKey

Static Protected Attributes
static ref SCR_ObstacleDetector	s_ObstacleDetector
static const float	BBOX_CHECK_HEIGHT = 100.0
static const float	AVOID_OBJECTS_CHECK_RADIUS = 0.1
Static Protected Attributes inherited from SCR_GeneratorBaseEntity
static const ref Color	BASE_GENERATOR_COLOR = Color.White

Additional Inherited Members
Static Protected Member Functions inherited from SCR_GeneratorBaseEntity
static array< vector >	GetPoints (notnull IEntitySource shapeEntitySrc)

Detailed Description

SCR_AreaGeneratorBaseEntity responsibilities:

• carry obstacle detection interface

Constructor & Destructor Documentation

SCR_AreaGeneratorBaseEntity()

void SCR_AreaGeneratorBaseEntity.SCR_AreaGeneratorBaseEntity	(	IEntitySource	src,
		IEntity	parent
	)

Member Function Documentation

ClearObstacles()

void SCR_AreaGeneratorBaseEntity.ClearObstacles ( )

protected

HasObstacle()

bool SCR_AreaGeneratorBaseEntity.HasObstacle ( vector  worldPos, array< IEntity >  exclusionList = null  )

protected

HasObstaclesList()

bool SCR_AreaGeneratorBaseEntity.HasObstaclesList ( )

protected

OnIntersectingShapeChangedXZInternal()

override void SCR_AreaGeneratorBaseEntity.OnIntersectingShapeChangedXZInternal ( IEntitySource  shapeEntitySrc, IEntitySource  other, array< vector >  mins, array< vector >  maxes  )

protected

OnRegenerate()

void SCR_AreaGeneratorBaseEntity.OnRegenerate ( )

protected

Implemented in ForestGeneratorEntity.

RefreshObstacles()

void SCR_AreaGeneratorBaseEntity.RefreshObstacles ( )

protected

SetAvoidOptions()

void SCR_AreaGeneratorBaseEntity.SetAvoidOptions ( )

protected

Member Data Documentation

AVOID_OBJECTS_CHECK_RADIUS

const float SCR_AreaGeneratorBaseEntity.AVOID_OBJECTS_CHECK_RADIUS = 0.1

staticprotected

BBOX_CHECK_HEIGHT

const float SCR_AreaGeneratorBaseEntity.BBOX_CHECK_HEIGHT = 100.0

staticprotected

m_bAvoidLakes

bool SCR_AreaGeneratorBaseEntity.m_bAvoidLakes

protected

m_bAvoidObjects

bool SCR_AreaGeneratorBaseEntity.m_bAvoidObjects

protected

m_bAvoidPowerLines

bool SCR_AreaGeneratorBaseEntity.m_bAvoidPowerLines

protected

m_bAvoidRivers

bool SCR_AreaGeneratorBaseEntity.m_bAvoidRivers

protected

m_bAvoidRoads

bool SCR_AreaGeneratorBaseEntity.m_bAvoidRoads

protected

m_bAvoidTracks

bool SCR_AreaGeneratorBaseEntity.m_bAvoidTracks

protected

m_bRegenerateByObstacleChanges

bool SCR_AreaGeneratorBaseEntity.m_bRegenerateByObstacleChanges

protected

s_ObstacleDetector

ref SCR_ObstacleDetector SCR_AreaGeneratorBaseEntity.s_ObstacleDetector

staticprotected

---

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

• Game/Generators/SCR_AreaGeneratorBaseEntity.c