SCR_VirtualAreaEntity Interface Reference

Inheritance diagram for SCR_VirtualAreaEntity:

Public Member Functions
int	GetShape ()
	Get area shape.
vector	GetSize ()
	Get area size.
bool	InArea (vector pos)
	Check if given position is inside the area.
void	SetMaterial (ResourceName material)
	Set area material.
void	Generate (vector size, int resolution)
	Generate the mesh with given params.
void	Generate (vector size, int resolution, bool followTerrain=false)
	Generate the mesh with given params.
void	SCR_VirtualAreaEntity (IEntitySource src, IEntity parent)
override void	_WB_GetBoundBox (inout vector min, inout vector max, IEntitySource src)

Constructor & Destructor Documentation

SCR_VirtualAreaEntity()

void SCR_VirtualAreaEntity.SCR_VirtualAreaEntity	(	IEntitySource	src,
		IEntity	parent )

Member Function Documentation

_WB_GetBoundBox()

override void SCR_VirtualAreaEntity._WB_GetBoundBox	(	inout vector	min,
		inout vector	max,
		IEntitySource	src )

Generate() [1/2]

void SCR_VirtualAreaEntity.Generate	(	vector	size,
		int	resolution )

Generate the mesh with given params.

Parameters

size	Minor axes (i.e., XZ values are radius, not diameter, and Y value is half the height).
resolution	How many segments in the ellipse.

Generate() [2/2]

void SCR_VirtualAreaEntity.Generate	(	vector	size,
		int	resolution,
		bool	followTerrain = false )

Generate the mesh with given params.

Parameters

size	Minor axes (i.e., XZ values are radius, not diameter, and Y value is half the height).
resolution	How many segments in the ellipse.
followTerrain	True to let the border copy terrain, creating a 'wall'.

GetShape()

int SCR_VirtualAreaEntity.GetShape

(

)

Get area shape.

Returns

0 for inside radius ellipse, 1 for outside radius ellipse, 2 for rectangle

GetSize()

vector SCR_VirtualAreaEntity.GetSize

(

)

Get area size.

Returns

Minor axes

InArea()

bool SCR_VirtualAreaEntity.InArea

(

vector

pos

)

Check if given position is inside the area.

Returns

True if in the area

SetMaterial()

void SCR_VirtualAreaEntity.SetMaterial

(

ResourceName

material

)

Set area material.

Returns

material New material

---

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

• Game/Editor/Entities/SCR_VirtualAreaEntity.c