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

๐Ÿ› Debug

Draws Debug shapes in the world.

๐Ÿ—ฟStatic Class
This is a Static Class. Access it's methods directly with .. It's not possible to spawn new instances.
๐Ÿ’‚Authority
This static class can be accessed only on ๐ŸŸง Client side.
๐Ÿง‘โ€๐Ÿ’ปAPI Source
This page is auto-generated! The Functions, Properties and Events described here are defined in our GitHub's API Repository! Feel free to commit suggestions and changes to the source .json API files!

๐Ÿ—ฟย Static Functionsโ€‹

ReturnsNameDescription
DrawBoxDraws a Debug box 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

DrawBox

Draws a Debug box in the world

Debug.DrawBox(location, extent, rotation, color, life_time, thickness)
TypeParameterDefaultDescription
Vectorlocation Required parameter No description provided
Vectorextent Required parameter No description provided
Rotatorrotation Required parameter No description provided
Colorcolor Required parameter No description provided
floatlife_time Required parameter No description provided
floatthickness Required parameter No description provided

DrawCoordinateSystem

Draws a Debug coordinate system in the world

Debug.DrawCoordinateSystem(location, rotation, size, life_time, thickness)
TypeParameterDefaultDescription
Vectorlocation Required parameter No description provided
Rotatorrotation Required parameter No description provided
floatsize Required parameter No description provided
floatlife_time Required parameter No description provided
floatthickness Required parameter No description provided

DrawCrosshairs

Draws a Debug crosshair in the world

Debug.DrawCrosshairs(location, rotation, size?, color?, life_time, thickness)
TypeParameterDefaultDescription
Vectorlocation Required parameter No description provided
Rotatorrotation Required parameter No description provided
floatsize?100No description provided
Colorcolor?Color.REDNo description provided
floatlife_time Required parameter No description provided
floatthickness Required parameter No description provided

DrawCylinder

Draws a Debug cylinder in the world

Debug.DrawCylinder(start_location, end_location, radius, segments, color?, life_time, thickness)
TypeParameterDefaultDescription
Vectorstart_location Required parameter No description provided
Vectorend_location Required parameter No description provided
floatradius Required parameter No description provided
integersegments Required parameter No description provided
Colorcolor?Color.REDNo description provided
floatlife_time Required parameter No description provided
floatthickness Required parameter No description provided

DrawDirectionalArrow

Draws a Debug directional arrow in the world

Debug.DrawDirectionalArrow(start_location, end_location, arrow_size?, color?, life_time, thickness)
TypeParameterDefaultDescription
Vectorstart_location Required parameter No description provided
Vectorend_location Required parameter No description provided
floatarrow_size?100No description provided
Colorcolor?Color.REDNo description provided
floatlife_time Required parameter No description provided
floatthickness Required parameter No description provided

DrawLine

Draws a Debug Line in the World

Debug.DrawLine(start_position, end_position, color?, life_time, thickness)
TypeParameterDefaultDescription
Vectorstart_position Required parameter No description provided
Vectorend_position Required parameter No description provided
Colorcolor?Color.REDNo description provided
floatlife_time Required parameter No description provided
floatthickness Required parameter No description provided

DrawPoint

Draws a Debug Point in the World

Debug.DrawPoint(start_position, color?, life_time, size)
TypeParameterDefaultDescription
Vectorstart_position Required parameter No description provided
Colorcolor?Color.REDNo description provided
floatlife_time Required parameter No description provided
floatsize Required parameter No description provided

DrawSphere

Draws a Debug sphere in the World

Debug.DrawSphere(start_location, radius, segments, color?, life_time, thickness)
TypeParameterDefaultDescription
Vectorstart_location Required parameter No description provided
floatradius Required parameter No description provided
integersegments Required parameter No description provided
Colorcolor?Color.REDNo description provided
floatlife_time Required parameter No description provided
floatthickness Required parameter No description provided

DrawString

Draws a Debug string in the world

Debug.DrawString(location, text, color?, life_time, draw_shadow, font_scale)
TypeParameterDefaultDescription
Vectorlocation Required parameter No description provided
stringtext Required parameter No description provided
Colorcolor?Color.REDNo description provided
floatlife_time Required parameter No description provided
booleandraw_shadow Required parameter No description provided
floatfont_scale Required parameter No description provided

๐Ÿš€ย Eventsโ€‹

This class doesn't have own events.