s&box docs
API ReferenceSandbox

public sealed class Sandbox.DebugOverlaySystem : Sandbox.GameObjectSystem<T>

Constructors

Showing 1 constructors

Methods

Showing 21 methods

public void Capsule(Capsule capsule, Color color = null, float duration = 0, Transform transform = null, bool overlay = False, int segments = 12)

Draw a wireframe capsule, simple cylinder with 2 hemispheres.

Parameters

  • color: Default: null
  • duration: Default: 0
  • transform: Default: null
  • overlay: Default: False
  • segments: Default: 12

public void Cylinder(Capsule capsule, Color color = null, float duration = 0, Transform transform = null, bool overlay = False, int segments = 12)

Draw a wireframe cylinder, like a capsule without the hemispheres, showing all sides.

Parameters

  • color: Default: null
  • duration: Default: 0
  • transform: Default: null
  • overlay: Default: False
  • segments: Default: 12

public void Frustum(Sandbox.Frustum frustum, Color color = null, float duration = 0, Transform transform = null, bool overlay = False)

Draw a frustum

Parameters

  • color: Default: null
  • duration: Default: 0
  • transform: Default: null
  • overlay: Default: False

public void GameObject(Sandbox.GameObject go, Color color = null, float duration = 0, Transform transform = null, bool overlay = False, bool castShadows = True, Sandbox.Material materialOveride = null)

Draw a GameObject in the world

Parameters

  • color: Default: null
  • duration: Default: 0
  • transform: Default: null
  • overlay: Default: False
  • castShadows: Default: True
  • materialOveride: Default: null

public void Model(Sandbox.Model model, Color color = null, float duration = 0, Transform transform = null, bool overlay = False, bool castShadows = True, Sandbox.Material materialOveride = null, Transform[] localBoneTransforms = null)

Draw model in the world

Parameters

  • color: Default: null
  • duration: Default: 0
  • transform: Default: null
  • overlay: Default: False
  • castShadows: Default: True
  • materialOveride: Default: null
  • localBoneTransforms: Default: null

public void Normal(Vector3 position, Vector3 direction, Color color = null, float duration = 0, Transform transform = null, bool overlay = False)

Draw a line

Parameters

  • color: Default: null
  • duration: Default: 0
  • transform: Default: null
  • overlay: Default: False

public void ScreenTexture(Vector3 worldPos, Sandbox.Texture texture, Vector2 size, float duration = 0)

Parameters

  • duration: Default: 0

public void Sphere(Sandbox.Sphere sphere, Color color = null, float duration = 0, Transform transform = null, bool overlay = False)

Draw a sphere

Parameters

  • color: Default: null
  • duration: Default: 0
  • transform: Default: null
  • overlay: Default: False

public void Trace(Sandbox.SceneTraceResult trace, float duration = 0, bool overlay = False)

Draws the result of a physics trace, showing the start and end points, the hit location and normal (if any), and the traced shape (ray, sphere, box, capsule, cylinder) at both the start and end positions.

Parameters

  • duration: Default: 0
  • overlay: Default: False

Metadata

FieldValue
NamespaceSandbox
Typeclass
AssemblySandbox.Engine
Doc IDT:Sandbox.DebugOverlaySystem

DamageInfo

Previous Page

Decal

Next Page

On this page

Constructorspublic DebugOverlaySystem(Sandbox.Scene scene)Methodspublic System.Void Box(BBox box, Color color = null, System.Single duration = 0, Transform transform = null, System.Boolean overlay = False)public System.Void Box(Vector3 position, Vector3 size, Color color = null, System.Single duration = 0, Transform transform = null, System.Boolean overlay = False)public System.Void Capsule(Capsule capsule, Color color = null, System.Single duration = 0, Transform transform = null, System.Boolean overlay = False, System.Int32 segments = 12)public System.Void Cylinder(Capsule capsule, Color color = null, System.Single duration = 0, Transform transform = null, System.Boolean overlay = False, System.Int32 segments = 12)public System.Void Frustum(Sandbox.Frustum frustum, Color color = null, System.Single duration = 0, Transform transform = null, System.Boolean overlay = False)public System.Void GameObject(Sandbox.GameObject go, Color color = null, System.Single duration = 0, Transform transform = null, System.Boolean overlay = False, System.Boolean castShadows = True, Sandbox.Material materialOveride = null)public System.Void Line(Line line, Color color = null, System.Single duration = 0, Transform transform = null, System.Boolean overlay = False)public System.Void Line(System.Collections.Generic.IEnumerable`1<Vector3> points, Color color = null, System.Single duration = 0, Transform transform = null, System.Boolean overlay = False)public System.Void Line(Vector3 from, Vector3 to, Color color = null, System.Single duration = 0, Transform transform = null, System.Boolean overlay = False)public System.Void Model(Sandbox.Model model, Color color = null, System.Single duration = 0, Transform transform = null, System.Boolean overlay = False, System.Boolean castShadows = True, Sandbox.Material materialOveride = null, Transform[] localBoneTransforms = null)public System.Void Normal(Vector3 position, Vector3 direction, Color color = null, System.Single duration = 0, Transform transform = null, System.Boolean overlay = False)public System.Void ScreenText(Vector2 pixelPosition, Sandbox.TextRendering.Scope textBlock, Sandbox.TextFlag flags = 132, System.Single duration = 0)public System.Void ScreenText(Vector2 pixelPosition, System.String text, System.Single size = 14, Sandbox.TextFlag flags = 132, Color color = null, System.Single duration = 0)public System.Void ScreenTexture(Vector3 worldPos, Sandbox.Texture texture, Vector2 size, System.Single duration = 0)public System.Void Sphere(Sandbox.Sphere sphere, Color color = null, System.Single duration = 0, Transform transform = null, System.Boolean overlay = False)public System.Void Text(Vector3 position, Sandbox.TextRendering.Scope scope, Sandbox.TextFlag flags = 132, System.Single duration = 0, System.Boolean overlay = False)public System.Void Text(Vector3 position, System.String text, System.Single size = 32, Sandbox.TextFlag flags = 132, Color color = null, System.Single duration = 0, System.Boolean overlay = False)public System.Void Texture(Sandbox.Texture texture, Sandbox.Rect screenRect, System.Nullable`1<Color> color = null, System.Single duration = 0)public System.Void Texture(Sandbox.Texture texture, Vector2 position, System.Nullable`1<Color> color = null, System.Single duration = 0)public System.Void Texture(Vector2 pixelPosition, Sandbox.Texture texture, Vector2 size, System.Single duration = 0)public System.Void Trace(Sandbox.SceneTraceResult trace, System.Single duration = 0, System.Boolean overlay = False)Metadata