Debug Shape API definition

Topics
	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.

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

Definition at line 140 of file endebug.c.

ShapeFlags

enum ShapeFlags

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

Definition at line 125 of file endebug.c.

ShapeType

enum ShapeType

Enumerator
BBOX
LINE
SPHERE
CYLINDER
DIAMOND
PYRAMID

Definition at line 115 of file endebug.c.

Function Documentation

CanDestroy()

bool CanDestroy ( )

protected

Get whether the Effect can be destroyed right now.

Returns

bool Whether the Effect can be destroyed right now

Definition at line 269 of file effect.c.

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.

Definition at line 216 of file effect.c.

GetMatrix()

proto native void GetMatrix

(

out vector

mat[4]

)

IsAutodestroy()

bool IsAutodestroy ( )

protected

Get whether Effect automatically cleans up when it stops.

Returns

bool Whether Effect automatically cleans up when it stops

Definition at line 251 of file effect.c.

IsPendingDeletion()

bool IsPendingDeletion ( )

protected

Get whether the Effect is queued up for being cleaned up.

Returns

bool Whether the Effect is queued up for being cleaned up

Definition at line 260 of file effect.c.

SetAutodestroy()

void SetAutodestroy ( bool auto_destroy )

protected

Sets whether Effect automatically cleans up when it stops.

Note

This means that it will be unregistered from SEffectManager as well

Parameters

auto_destroy

bool Whether Effect automatically cleans up when it stops

Definition at line 242 of file effect.c.

SetColor()

proto native void SetColor

(

int

color

)

SetDirection()

proto native void SetDirection

(

vector

direction

)

SetEnableEventFrame()

void SetEnableEventFrame ( bool enable )

protected

Enable Event_OnFrameUpdate for the effect.

Note

Read SEffectManager.Event_OnFrameUpdate for more info

Definition at line 282 of file effect.c.

SetFlags()

proto native void SetFlags

(

ShapeFlags

flags

)

SetMatrix()

proto native void SetMatrix

(

vector

mat[4]

)

SetPosition()

proto native void SetPosition

(

vector

pos

)

Set the world position of the Effect.

Warning

Only sets the cached variable, for immediate effect use SetCurrent variant

Parameters

pos	vector The world position for the Effect

Definition at line 463 of file effect.c.

Variable Documentation

ErrorEx

enum ShapeType ErrorEx