Modules
	Diag menu API definition

Enumerations
enum	ShapeType { BBOX , LINE , SPHERE , CYLINDER , DIAMOND , PYRAMID }

enum	ShapeFlags { NOZBUFFER , NOZWRITE , WIREFRAME , TRANSP , DOUBLESIDE , ONCE , NOOUTLINE , BACKFACE , NOCULL , VISIBLE , ADDITIVE }

enum	CollisionFlags

Functions
proto native void	GetMatrix (out vector mat[4])

proto native void	SetMatrix (vector mat[4])

proto native void	SetDirection (vector direction)

proto native void	SetPosition (vector position)
	Set the world position of the Effect.

proto native void	SetColor (int color)

proto native void	SetFlags (ShapeFlags flags)

proto native void	Destroy ()
	Cleans up the Effect, including unregistering if needed.

static proto native Shape	Create (ShapeType type, int color, ShapeFlags flags, vector p1, vector p2)

static proto native Shape	CreateLines (int color, ShapeFlags flags, vector p[], int num)

static proto native Shape	CreateTris (int color, ShapeFlags flags, vector p[], int num)

static proto native Shape	CreateSphere (int color, ShapeFlags flags, vector origin, float radius)

static proto native Shape	CreateFrustum (float horizontalAngle, float verticalAngle, float length, int color, ShapeFlags flags)

static proto native Shape	CreateCylinder (int color, ShapeFlags flags, vector origin, float radius, float length)

static Shape	CreateArrow (vector from, vector to, float size, int color, ShapeFlags flags)

static Shape	CreateBridgeArrow (vector from, vector to, float size, int color, ShapeFlags flags)

static void	CreateMatrix (vector mat[4], float axisLength=0.05, float arrowSize=0.0)

Variables
enum ShapeType	ErrorEx

Destroy
Methods regarding automatic cleanup
void	SetAutodestroy (bool auto_destroy)
	Sets whether Effect automatically cleans up when it stops.

bool	IsAutodestroy ()
	Get whether Effect automatically cleans up when it stops.

bool	IsPendingDeletion ()
	Get whether the Effect is queued up for being cleaned up.

bool	CanDestroy ()
	Get whether the Effect can be destroyed right now.

void	SetEnableEventFrame (bool enable)
	Enable Event_OnFrameUpdate for the effect.

Detailed Description

Enumeration Type Documentation

◆ CollisionFlags

enum CollisionFlags

◆ ShapeFlags

enum ShapeFlags

Enumerator
NOZBUFFER
NOZWRITE
WIREFRAME
TRANSP
DOUBLESIDE
ONCE
NOOUTLINE
BACKFACE
NOCULL
VISIBLE
ADDITIVE

◆ ShapeType

enum ShapeType

Enumerator
BBOX
LINE
SPHERE
CYLINDER
DIAMOND
PYRAMID

Function Documentation

◆ CanDestroy()

bool CanDestroy ( )

Get whether the Effect can be destroyed right now.

Returns: bool Whether the Effect can be destroyed right now

◆ Create()

static proto native Shape Create	(	ShapeType	type,
		int	color,
		ShapeFlags	flags,
		vector	p1,
		vector	p2
	)

static

Referenced by CreateMatrix().

◆ CreateArrow()

static Shape CreateArrow	(	vector	from,
		vector	to,
		float	size,
		int	color,
		ShapeFlags	flags
	)

static

References CreateLines(), vector::Normalize(), and vector::Perpend().

Referenced by CreateMatrix().

◆ CreateBridgeArrow()

static Shape CreateBridgeArrow	(	vector	from,
		vector	to,
		float	size,
		int	color,
		ShapeFlags	flags
	)

static

References CreateLines(), vector::Normalize(), vector::Perpend(), and Vector().

◆ CreateCylinder()

static proto native Shape CreateCylinder	(	int	color,
		ShapeFlags	flags,
		vector	origin,
		float	radius,
		float	length
	)

static

◆ CreateFrustum()

static proto native Shape CreateFrustum	(	float	horizontalAngle,
		float	verticalAngle,
		float	length,
		int	color,
		ShapeFlags	flags
	)

static

◆ CreateLines()

static proto native Shape CreateLines	(	int	color,
		ShapeFlags	flags,
		vector	p[],
		int	num
	)

static

Referenced by CreateArrow(), and CreateBridgeArrow().

◆ CreateMatrix()

static void CreateMatrix	(	vector	mat[4],
		float	axisLength = `0.05`,
		float	arrowSize = `0.0`
	)

static

References Create(), and CreateArrow().

◆ CreateSphere()

static proto native Shape CreateSphere	(	int	color,
		ShapeFlags	flags,
		vector	origin,
		float	radius
	)

static

◆ CreateTris()

static proto native Shape CreateTris	(	int	color,
		ShapeFlags	flags,
		vector	p[],
		int	num
	)

static

◆ Destroy()

proto native void Destroy ( )

Cleans up the Effect, including unregistering if needed.

Note: Will stop the Effect and queue up the deletion in the callqueue; Is intended for usage from within the Effect itself, use SEffectManager.DestroyEffect when working from a pointer

Cleans up the Effect, including unregistering if needed.

References ScriptCallQueue::Call(), CALL_CATEGORY_GAMEPLAY, DestroyDamageTriggerEx(), SEffectManager::DestroyEffect(), CGame::GetCallQueue(), GetGame(), IsPendingDeletion(), m_IsPendingDeletion, AreaDamageEvents::OnTriggerDestroyed(), and Stop().

Referenced by EntityLightSource::CheckLifetime(), EntityLightSource::HandleBrightnessFadeing(), EntityLightSource::HandleRadiusFadeing(), and ~AreaDamageManager().