SCR_BaseAreaMeshComponent Interface Reference

Inheritance diagram for SCR_BaseAreaMeshComponent:

Public Member Functions
void	ActivateEveryFrame ()
	Activate the area so it could be updated every frame.
void	DeactivateEveryFrame ()
	Deactivate the area.
float	GetRadius ()
	Get radius of the area.
float	GetHeight ()
	Get height of the area.
EAreaMeshShape	GetShape ()
	Return shape if areaMesh.
int	GetResolution ()
	Get Resolution of the area.
void	GetDimensions2D (out float width, out float length)
	Returns width and length To be overloaded by inherited classes.
void	GetDimensions3D (out vector dimensions)
	Returns dimensions in vector.
void	GenerateAreaMesh ()
	Generate area mesh based on its settings.
override void	EOnFrame (IEntity owner, float timeSlice)
override void	OnPostInit (IEntity owner)
override void	_WB_SetTransform (IEntity owner, inout vector mat[4], IEntitySource src)

Static Public Attributes
static const int	PREVIEW_RESOLUTION = 48

Protected Member Functions
vector	GetMeshOffset (IEntity owner)
	Get the offset of the AreaMesh.
ResourceName	GetMaterial ()
	Get material used for area mesh.

Protected Attributes
EAreaMeshShape	m_eShape
float	m_fHeight
int	m_vResolution
bool	m_bFollowTerrain
bool	m_bStretchMaterial
ResourceName	m_Material
bool	m_bActiveEveryFrameOnInit
bool	m_bHideInWorkbench
vector	m_vLastPos
vector	m_vLastDir

Member Function Documentation

_WB_SetTransform()

override void SCR_BaseAreaMeshComponent._WB_SetTransform	(	IEntity	owner,
		inout vector	mat[4],
		IEntitySource	src )

ActivateEveryFrame()

void SCR_BaseAreaMeshComponent.ActivateEveryFrame

(

)

Activate the area so it could be updated every frame.

DeactivateEveryFrame()

void SCR_BaseAreaMeshComponent.DeactivateEveryFrame

(

)

Deactivate the area.

EOnFrame()

override void SCR_BaseAreaMeshComponent.EOnFrame	(	IEntity	owner,
		float	timeSlice )

GenerateAreaMesh()

void SCR_BaseAreaMeshComponent.GenerateAreaMesh

(

)

Generate area mesh based on its settings.

GetDimensions2D()

void SCR_BaseAreaMeshComponent.GetDimensions2D	(	out float	width,
		out float	length )

Returns width and length To be overloaded by inherited classes.

By default uses radius as width and length unless function is overwritten

Parameters

[out]	width	Width of Zone (x)
[out]	length	length of Zone (z)

Implemented in SCR_EffectsModuleAreaMeshComponent.

GetDimensions3D()

void SCR_BaseAreaMeshComponent.GetDimensions3D

(

out vector

dimensions

)

Returns dimensions in vector.

Parameters

[out]

dimensions

width, height, length

GetHeight()

float SCR_BaseAreaMeshComponent.GetHeight

(

)

Get height of the area.

Returns

Height

GetMaterial()

ResourceName SCR_BaseAreaMeshComponent.GetMaterial ( )

protected

Get material used for area mesh.

Implemented in SCR_SupportStationAreaMeshComponent.

GetMeshOffset()

vector SCR_BaseAreaMeshComponent.GetMeshOffset ( IEntity owner )

protected

Get the offset of the AreaMesh.

Can be overwritten to set custom position. Only x and z are used. Height is ignored

Parameters

[in]

owner

Returns

GetRadius()

float SCR_BaseAreaMeshComponent.GetRadius

(

)

Get radius of the area.

To be overloaded by inherited classes.

Returns

Radius

Implemented in SCR_CampaignBuildingAreaMeshComponent, SCR_CapturePointAreaMeshComponent, SCR_CustomAreaMeshComponent, SCR_MilitaryBaseAreaMeshComponent, SCR_SpawnPointAreaMeshComponent, SCR_SupportStationAreaMeshComponent, SCR_TriggerAreaMeshComponent, SCR_WaypointAreaMeshComponent, and SCR_ZoneRestrictionAreaMeshComponent.

GetResolution()

int SCR_BaseAreaMeshComponent.GetResolution

(

)

Get Resolution of the area.

Always 4 if Rectangle

Returns

Resolution

GetShape()

EAreaMeshShape SCR_BaseAreaMeshComponent.GetShape

(

)

Return shape if areaMesh.

Returns

Shape Enum

OnPostInit()

override void SCR_BaseAreaMeshComponent.OnPostInit

(

IEntity

owner

)

Member Data Documentation

m_bActiveEveryFrameOnInit

bool SCR_BaseAreaMeshComponent.m_bActiveEveryFrameOnInit

protected

m_bFollowTerrain

bool SCR_BaseAreaMeshComponent.m_bFollowTerrain

protected

m_bHideInWorkbench

bool SCR_BaseAreaMeshComponent.m_bHideInWorkbench

protected

m_bStretchMaterial

bool SCR_BaseAreaMeshComponent.m_bStretchMaterial

protected

m_eShape

EAreaMeshShape SCR_BaseAreaMeshComponent.m_eShape

protected

m_fHeight

float SCR_BaseAreaMeshComponent.m_fHeight

protected

m_Material

ResourceName SCR_BaseAreaMeshComponent.m_Material

protected

m_vLastDir

vector SCR_BaseAreaMeshComponent.m_vLastDir

protected

m_vLastPos

vector SCR_BaseAreaMeshComponent.m_vLastPos

protected

m_vResolution

int SCR_BaseAreaMeshComponent.m_vResolution

protected

PREVIEW_RESOLUTION

const int SCR_BaseAreaMeshComponent.PREVIEW_RESOLUTION = 48

static

---

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

• Game/Components/AreaMesh/SCR_BaseAreaMeshComponent.c