Dayz Explorer  1.24.157551 (v105080)
Dayz Code Explorer by Zeroy
Debug Shape API definition

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. More...
 
proto native void SetColor (int color)
 
proto native void SetFlags (ShapeFlags flags)
 
proto native void Destroy ()
 Cleans up the Effect, including unregistering if needed. More...
 

Variables

enum ShapeType ErrorEx
 
class DiagMenu Shape ()
 don't call destructor directly. Use Destroy() instead More...
 

Destroy

Methods regarding automatic cleanup

void SetAutodestroy (bool auto_destroy)
 Sets whether Effect automatically cleans up when it stops. More...
 
bool IsAutodestroy ()
 Get whether Effect automatically cleans up when it stops. More...
 
bool IsPendingDeletion ()
 Get whether the Effect is queued up for being cleaned up. More...
 
bool CanDestroy ()
 Get whether the Effect can be destroyed right now. More...
 
void SetEnableEventFrame (bool enable)
 Enable Event_OnFrameUpdate for the effect. More...
 

Detailed Description

Enumeration Type Documentation

◆ CollisionFlags

Definition at line 140 of file endebug.c.

◆ ShapeFlags

enum ShapeFlags
Enumerator
NOZBUFFER 
NOZWRITE 
WIREFRAME 
TRANSP 
DOUBLESIDE 
ONCE 
NOOUTLINE 
BACKFACE 
NOCULL 
VISIBLE 

Entity is visible. Is rendered if there is some attached object and event EntityEvent.VISIBLE is invoked, when event mask is set.

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 ( )

Get whether the Effect can be destroyed right now.

Returns
bool Whether the Effect can be destroyed right now

Definition at line 265 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 212 of file effect.c.

◆ GetMatrix()

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

◆ IsAutodestroy()

bool IsAutodestroy ( )

Get whether Effect automatically cleans up when it stops.

Returns
bool Whether Effect automatically cleans up when it stops

Definition at line 247 of file effect.c.

◆ IsPendingDeletion()

bool IsPendingDeletion ( )

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 256 of file effect.c.

◆ SetAutodestroy()

void SetAutodestroy ( bool  auto_destroy)

Sets whether Effect automatically cleans up when it stops.

Note
This means that it will be unregistered from SEffectManager as well
Parameters
auto_destroybool Whether Effect automatically cleans up when it stops

Definition at line 238 of file effect.c.

◆ SetColor()

proto native void SetColor ( int  color)

◆ SetDirection()

proto native void SetDirection ( vector  direction)

◆ SetEnableEventFrame()

void SetEnableEventFrame ( bool  enable)

Enable Event_OnFrameUpdate for the effect.

Note
Read SEffectManager.Event_OnFrameUpdate for more info

Definition at line 278 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
posvector The world position for the Effect

Definition at line 436 of file effect.c.

Variable Documentation

◆ ErrorEx

enum ShapeType ErrorEx

◆ Shape

enum CollisionFlags Shape ( )

don't call destructor directly. Use Destroy() instead

Instance of created debug visualizer