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
Api
DebugOverlaySystem

class DebugOverlaySystem : GameObjectSystem<T>

book_4_sparkGenerated
code_blocksInput

Description

The DebugOverlaySystem class in the Sandbox namespace provides methods to draw various debug overlays in the game world. It is a sealed class, meaning it cannot be inherited. This class is part of the game object system and is used to visually represent debugging information such as lines, boxes, text, and models in the game scene.

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 with a specified color.
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 with a specified color.
Line(Vector3 from, Vector3 to, Color color, float duration, Transform transform, bool overlay)Draw a line between two points with a specified color.
Line(IEnumerable<Vector3> points, Color color, float duration, Transform transform, bool overlay)Draw a line through a series of points with a specified color.
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 a specified color.
Text(Vector3 position, string text, float size, TextFlag flags, Color color, float duration, Transform transform, bool overlay)Draw text in the world at a specified position.
Text(Vector3 position, TextRendering.Scope scope, TextFlag flags, float duration, Transform transform, 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, Transform transform)Draw text on the screen at a specified pixel position.
ScreenText(Vector2 pixelPosition, TextRendering.Scope textBlock, TextFlag flags, float duration, Transform transform)Draw text on the screen using a text rendering scope.