articleHome
published_with_changesApi Changes
bookDocumentation

Groups

publicGlobals
sceneScene System
library_booksUtility
diagnosisDiagnostics
arrow_selector_toolInput
music_noteAudio
shapesGraphics
library_booksNetwork
library_booksCommon Structs
library_booksComponents
leak_addLive Services
library_booksAttributes
library_booksClasses
library_booksEnums

Methods

Box
GameObject
Line
Model
Normal
ScreenText
Sphere
Text
Texture
Api
DebugOverlaySystem

class DebugOverlaySystem : GameObjectSystem<T>

robot_2Generated
code_blocksInput

Description

The DebugOverlaySystem class in the Sandbox namespace provides a set of methods to draw various debug overlays in the game world. These overlays can be used for visual debugging purposes, allowing developers to render shapes, lines, text, and textures in both the 3D world and on the screen.

Members

Instance Methods

Member NameSummary
Box(Vector3 position, Vector3 size, Color color, float duration, Transform transform, bool overlay)Draw a box at a specified position with a given size and color.
Box(BBox box, Color color, float duration, Transform transform, bool overlay)Draw a box using a bounding box object.
GameObject(GameObject go, Color color, float duration, Transform transform, bool overlay, bool castShadows, Material materialOveride)Draw a GameObject in the world with specified properties.
Normal(Vector3 position, Vector3 direction, Color color, float duration, Transform transform, bool overlay)Draw a line from a position in a specified direction.
Line(Line line, Color color, float duration, Transform transform, bool overlay)Draw a line using a line object.
Line(Vector3 from, Vector3 to, Color color, float duration, Transform transform, bool overlay)Draw a line between two points.
Line(IEnumerable<Vector3> points, Color color, float duration, Transform transform, bool overlay)Draw a line through a series of points.
Model(Model model, Color color, float duration, Transform transform, bool overlay, bool castShadows, Material materialOveride)Draw a model in the world with specified properties.
Sphere(Sphere sphere, Color color, float duration, Transform transform, bool overlay)Draw a sphere with specified properties.
Text(Vector3 position, string text, float size, TextFlag flags, Color color, float duration, bool overlay)Draw text in the world at a specified position.
Text(Vector3 position, TextRendering.Scope scope, TextFlag flags, float duration, bool overlay)Draw text in the world using a text rendering scope.
ScreenText(Vector2 pixelPosition, string text, float size, TextFlag flags, Color color, float duration)Draw text on the screen at a specified pixel position.
ScreenText(Vector2 pixelPosition, TextRendering.Scope textBlock, TextFlag flags, float duration)Draw text on the screen using a text rendering scope.
Texture(Texture texture, Vector2 position, Color color, float duration)Draw a texture on the screen at a specified position.
Texture(Texture texture, Rect screenRect, Color color, float duration)Draw a texture on the screen within a specified rectangle.