s&box
News Api History
DebugOverlay . DebugOverlay
listApi Index feedDebugOverlay
classDebugOverlay

Constructors

note_add DebugOverlay()

Methods

code Axis( position, rotation, length, duration, depthTest ) code Box( mins, maxs ) code Box( mins, maxs, color, duration, depthTest ) code Box( position, mins, maxs, color, duration, depthTest ) code Box( position, rotation, mins, maxs, color, duration, depthTest ) code Box( ent, color, duration ) code Box( body, color, duration ) code Box( bounds, color, duration ) code Circle( position, rotation, radius, color, duration, depthTest ) code Line( start, end, color, duration, depthTest ) code Line( start, end, duration, depthTest ) code ScreenText( text, position, line, color, duration ) code ScreenText( text, position, duration ) code ScreenText( text, line, duration ) code Skeleton( ent, color, duration, depthTest ) code Sphere( position, radius, color, duration, depthTest ) code Sphere( sphere, color, duration ) code Text( text, pos, offset, color, duration, maxDistance ) code Text( text, pos, color, duration, maxDistance ) code Text( text, pos, duration, maxDistance ) code Texture( texture, position, duration ) code Texture( texture, rect, duration ) code Texture( texture, rect, color, topLeftUV, bottomRightUV, duration ) code TraceResult( tr, duration )
DebugOverlay
Sandbox.Game
Derives from object

Summary

Overlays to show useful information whilst debugging.

Constructors

DebugOverlay( )

Methods

void Axis( Vector3 position, Rotation rotation, float length = 10, float duration = 0, bool depthTest = true, )

Draw a 3D Axis representation in 3D

void Box( Vector3 mins, Vector3 maxs, )

Draw an axis aligned yellow box in 3D space for 1 frame

void Box( Vector3 mins, Vector3 maxs, Color color, float duration = 0, bool depthTest = true, )

Draw an axis aligned box in 3D space

void Box( Vector3 position, Vector3 mins, Vector3 maxs, Color color, float duration = 0, bool depthTest = true, )

Draw an axis aligned box in 3D space

void Box( Vector3 position, Rotation rotation, Vector3 mins, Vector3 maxs, Color color, float duration = 0, bool depthTest = true, )

Draw a rotated box in 3D space

void Box( Entity ent, Color color, float duration = 0, )

Draw orientated bounds of an entity.

void Box( PhysicsBody body, Color color, float duration = 0, )

Draw axis aligned bounds of a physics body.

void Box( BBox bounds, Color color, float duration = 0, )

Visualize given AABB.

void Circle( Vector3 position, Rotation rotation, float radius, Color color, float duration = 0, bool depthTest = true, )

Render a flat circle in 3D space

void Line( Vector3 start, Vector3 end, Color color, float duration = 0, bool depthTest = true, )

Draw a line in 3D space

void Line( Vector3 start, Vector3 end, float duration = 0, bool depthTest = true, )

Draw a yellow line in 3D space

void ScreenText( string text, Vector2 position, int line, Color color, float duration = 0, )

Draw 2D text

void ScreenText( string text, Vector2 position, float duration = 0, )

Draw yellow 2D text

void ScreenText( string text, int line = 0, float duration = 0, )

Draw yellow 2D text @ {100, 100}

bool Skeleton( Entity ent, Color color, float duration = 0, bool depthTest = true, )

Draw this entity's skeleton (if it has one)

void Sphere( Vector3 position, float radius, Color color, float duration = 0, bool depthTest = true, )

Render a sphere in 3D space

void Sphere( Sphere sphere, Color color, float duration = 0, )

Visualize a given sphere.

void Text( string text, Vector3 pos, int offset, Color color, float duration = 0, float maxDistance = 1500, )

Draw text in 3D space

void Text( string text, Vector3 pos, Color color, float duration = 0, float maxDistance = 1500, )

Draw text in 3D space

void Text( string text, Vector3 pos, float duration = 0, float maxDistance = 1500, )

Draw yellow text in 3D space

void Texture( Texture texture, Vector2 position, float duration = 0, )

Render a 2D texture

void Texture( Texture texture, Rect rect, float duration = 0, )

Render a 2D texture

void Texture( Texture texture, Rect rect, Color color, Vector2 topLeftUV, Vector2 bottomRightUV, float duration = 0, )

Render a 2D texture

void TraceResult( TraceResult tr, float duration = 0, )

Visualize a trace