Skip to main content
Version: bleeding-edge ๐Ÿฉธ

๐Ÿ› Debug

Draws Debug shapes in the world.

๐Ÿ—ฟStatic ClassClient Only๐Ÿง‘โ€๐Ÿ’ปAPI Source

๐Ÿ—ฟย Static Functionsโ€‹

ReturnsNameDescription
DrawBoxDraws a Debug box in the world
DrawCapsuleDraws a Debug capsule in the World
DrawCoordinateSystemDraws a Debug coordinate system in the world
DrawCrosshairsDraws a Debug crosshair in the world
DrawCylinderDraws a Debug cylinder in the world
DrawDirectionalArrowDraws a Debug directional arrow in the world
DrawLineDraws a Debug Line in the World
DrawPointDraws a Debug Point in the World
DrawSphereDraws a Debug sphere in the World
DrawStringDraws a Debug string in the world

Moderate

DrawBoxโ€‹

Draws a Debug box in the world
Debug.DrawBox(location, extent, rotation, color, life_time?, thickness?)

Parameters

TypeParameterDefaultDescription
Vectorlocation Required parameter World location
Vectorextent Required parameter Half size of the box on each axis
Rotatorrotation Required parameter World rotation
Colorcolor Required parameter The color to use
floatlife_time?5
Seconds before the drawing disappears
floatthickness?0
Line thickness

Moderate

DrawCapsuleโ€‹

Draws a Debug capsule in the World
Debug.DrawCapsule(center, half_height, radius, rotation, color?, life_time?, thickness?)

Parameters

TypeParameterDefaultDescription
Vectorcenter Required parameter Center of the capsule
floathalf_height Required parameter Half of the capsule height
floatradius Required parameter Radius of the capsule
Rotatorrotation Required parameter Rotation of the capsule
Colorcolor?Color.RED
The color to use
floatlife_time?5
Seconds before the debug drawing disappears
floatthickness?0
Line thickness

Moderate

DrawCoordinateSystemโ€‹

Draws a Debug coordinate system in the world
Debug.DrawCoordinateSystem(location, rotation, size?, life_time?, thickness?)

Parameters

TypeParameterDefaultDescription
Vectorlocation Required parameter World location
Rotatorrotation Required parameter World rotation
floatsize?100
Size of the drawing
floatlife_time?5
Seconds before the drawing disappears
floatthickness?0
Line thickness

Moderate

DrawCrosshairsโ€‹

Draws a Debug crosshair in the world
Debug.DrawCrosshairs(location, rotation, size?, color?, life_time?, thickness?)

Parameters

TypeParameterDefaultDescription
Vectorlocation Required parameter World location
Rotatorrotation Required parameter World rotation
floatsize?100
Size of the drawing
Colorcolor?Color.RED
The color to use
floatlife_time?5
Seconds before the drawing disappears
floatthickness?0
Line thickness

Moderate

DrawCylinderโ€‹

Draws a Debug cylinder in the world
Debug.DrawCylinder(start_location, end_location, radius, segments, color?, life_time?, thickness?)

Parameters

TypeParameterDefaultDescription
Vectorstart_location Required parameter World start location
Vectorend_location Required parameter World end location
floatradius Required parameter Radius
integersegments Required parameter Number of segments used to draw it, more segments look smoother
Colorcolor?Color.RED
The color to use
floatlife_time?5
Seconds before the drawing disappears
floatthickness?0
Line thickness

Moderate

DrawDirectionalArrowโ€‹

Draws a Debug directional arrow in the world
Debug.DrawDirectionalArrow(start_location, end_location, arrow_size?, color?, life_time?, thickness?)

Parameters

TypeParameterDefaultDescription
Vectorstart_location Required parameter World start location
Vectorend_location Required parameter World end location
floatarrow_size?100
Size of the arrow head
Colorcolor?Color.RED
The color to use
floatlife_time?5
Seconds before the drawing disappears
floatthickness?0
Line thickness

Moderate

DrawLineโ€‹

Draws a Debug Line in the World
Debug.DrawLine(start_position, end_position, color?, life_time?, thickness?)

Parameters

TypeParameterDefaultDescription
Vectorstart_position Required parameter World start location
Vectorend_position Required parameter World end location
Colorcolor?Color.RED
The color to use
floatlife_time?5
Seconds before the drawing disappears
floatthickness?0
Line thickness

Moderate

DrawPointโ€‹

Draws a Debug Point in the World
Debug.DrawPoint(start_position, color?, life_time?, size?)

Parameters

TypeParameterDefaultDescription
Vectorstart_position Required parameter World start location
Colorcolor?Color.RED
The color to use
floatlife_time?5
Seconds before the drawing disappears
floatsize?10
Size of the drawing

Moderate

DrawSphereโ€‹

Draws a Debug sphere in the World
Debug.DrawSphere(start_location, radius, segments, color?, life_time?, thickness?)

Parameters

TypeParameterDefaultDescription
Vectorstart_location Required parameter World start location
floatradius Required parameter Radius
integersegments Required parameter Number of segments used to draw it, more segments look smoother
Colorcolor?Color.RED
The color to use
floatlife_time?5
Seconds before the drawing disappears
floatthickness?0
Line thickness

Moderate

DrawStringโ€‹

Draws a Debug string in the world
Debug.DrawString(location, text, color?, life_time?, draw_shadow?, font_scale?)

Parameters

TypeParameterDefaultDescription
Vectorlocation Required parameter World location
stringtext Required parameter The text to draw
Colorcolor?Color.RED
The color to use
floatlife_time?5
Seconds before the drawing disappears
booleandraw_shadow?false
Whether to draw a shadow behind the text
floatfont_scale?1
Scale of the text

๐Ÿš€ย Eventsโ€‹

This class doesn't have own events.