🐛 Debug

Debugging tools: profiling for scripts, and drawing Debug shapes in the world.

🗿Static ClassClient & Server🧑‍💻API Source

---

🗿 Fonctions statiques

	Returns	Name	Description
		DrawBox	Dessine une boîte de débogage dans le monde
		DrawCapsule	Dessine une capsule de débogage dans le monde
		DrawCoordinateSystem	Dessine un système de coordonnées de débogage dans le monde
		DrawCrosshairs	Dessine un réticule de débogage dans le monde
		DrawCylinder	Dessine un cylindre de débogage dans le monde
		DrawDirectionalArrow	Dessine une flèche directionnelle de débogage dans le monde
		DrawLine	Dessine une ligne de débogage dans le monde
		DrawPoint	Dessine un point de débogage dans le monde
		DrawSphere	Dessine une sphère de débogage dans le monde
		DrawString	Dessine une chaîne de texte de débogage dans le monde
	boolean	IsProfilerConnected	Returns if a Tracy profiler is connected right now. Useful for skipping debugging logic
		ProfileMessage	Marks an event with a text in the Tracy timeline
		ProfilePlot	Records a value in a graph in Tracy
		ProfileZone	Runs a function and measures it as a zone in Tracy and in the native profiling

---

Moderate

DrawBox

Dessine une boîte de débogage dans le monde

Debug.DrawBox(location, extent, rotation, color, life_time?, thickness?)

Parameters

Type	Parameter	Default	Description
Vector	location	Required parameter	Emplacement du monde
Vector	extent	Required parameter	Half size of the box on each axis
Rotator	rotation	Required parameter	Rotation du monde
Color	color	Required parameter	La couleur à utiliser
float	life_time?	5	Secondes avant que le dessin ne disparaisse
float	thickness?	0	Epaisseur du trait

---

Moderate

DrawCapsule

Dessine une capsule de débogage dans le monde

Debug.DrawCapsule(center, half_height, radius, rotation, color?, life_time?, thickness?)

Parameters

Type	Parameter	Default	Description
Vector	center	Required parameter	Centre de la capsule
float	half_height	Required parameter	La moitié de la hauteur de la capsule
float	radius	Required parameter	Rayon de la capsule
Rotator	rotation	Required parameter	Rotation de la capsule
Color	color?	Color.RED	La couleur à utiliser
float	life_time?	5	Secondes avant que le dessin de débogage ne disparaisse
float	thickness?	0	Epaisseur du trait

---

Moderate

DrawCoordinateSystem

Dessine un système de coordonnées de débogage dans le monde

Debug.DrawCoordinateSystem(location, rotation, size?, life_time?, thickness?)

Parameters

Type	Parameter	Default	Description
Vector	location	Required parameter	Emplacement du monde
Rotator	rotation	Required parameter	Rotation du monde
float	size?	100	Taille du dessin
float	life_time?	5	Secondes avant que le dessin ne disparaisse
float	thickness?	0	Epaisseur du trait

---

Moderate

DrawCrosshairs

Dessine un réticule de débogage dans le monde

Debug.DrawCrosshairs(location, rotation, size?, color?, life_time?, thickness?)

Parameters

Type	Parameter	Default	Description
Vector	location	Required parameter	Emplacement du monde
Rotator	rotation	Required parameter	Rotation du monde
float	size?	100	Taille du dessin
Color	color?	Color.RED	La couleur à utiliser
float	life_time?	5	Secondes avant que le dessin ne disparaisse
float	thickness?	0	Epaisseur du trait

---

Moderate

DrawCylinder

Dessine un cylindre de débogage dans le monde

Debug.DrawCylinder(start_location, end_location, radius, segments, color?, life_time?, thickness?)

Parameters

Type	Parameter	Default	Description
Vector	start_location	Required parameter	Emplacement de départ du monde
Vector	end_location	Required parameter	Emplacement de la fin du monde
float	radius	Required parameter	Rayon
integer	segments	Required parameter	Nombre de segments utilisés pour le dessiner, plus il y a de segments plus le rendu est lisse
Color	color?	Color.RED	La couleur à utiliser
float	life_time?	5	Secondes avant que le dessin ne disparaisse
float	thickness?	0	Epaisseur du trait

---

Moderate

DrawDirectionalArrow

Dessine une flèche directionnelle de débogage dans le monde

Debug.DrawDirectionalArrow(start_location, end_location, arrow_size?, color?, life_time?, thickness?)

Parameters

Type	Parameter	Default	Description
Vector	start_location	Required parameter	Emplacement de départ du monde
Vector	end_location	Required parameter	Emplacement de la fin du monde
float	arrow_size?	100	Size of the arrow head
Color	color?	Color.RED	La couleur à utiliser
float	life_time?	5	Secondes avant que le dessin ne disparaisse
float	thickness?	0	Epaisseur du trait

---

Moderate

DrawLine

Dessine une ligne de débogage dans le monde

Debug.DrawLine(start_position, end_position, color?, life_time?, thickness?)

Parameters

Type	Parameter	Default	Description
Vector	start_position	Required parameter	Emplacement de départ du monde
Vector	end_position	Required parameter	Emplacement de la fin du monde
Color	color?	Color.RED	La couleur à utiliser
float	life_time?	5	Secondes avant que le dessin ne disparaisse
float	thickness?	0	Epaisseur du trait

---

Moderate

DrawPoint

Dessine un point de débogage dans le monde

Debug.DrawPoint(start_position, color?, life_time?, size?)

Parameters

Type	Parameter	Default	Description
Vector	start_position	Required parameter	Emplacement de départ du monde
Color	color?	Color.RED	La couleur à utiliser
float	life_time?	5	Secondes avant que le dessin ne disparaisse
float	size?	10	Taille du dessin

---

Moderate

DrawSphere

Dessine une sphère de débogage dans le monde

Debug.DrawSphere(start_location, radius, segments, color?, life_time?, thickness?)

Parameters

Type	Parameter	Default	Description
Vector	start_location	Required parameter	Emplacement de départ du monde
float	radius	Required parameter	Rayon
integer	segments	Required parameter	Nombre de segments utilisés pour le dessiner, plus il y a de segments plus le rendu est lisse
Color	color?	Color.RED	La couleur à utiliser
float	life_time?	5	Secondes avant que le dessin ne disparaisse
float	thickness?	0	Epaisseur du trait

---

Moderate

DrawString

Dessine une chaîne de texte de débogage dans le monde

Debug.DrawString(location, text, color?, life_time?, draw_shadow?, font_scale?)

Parameters

Type	Parameter	Default	Description
Vector	location	Required parameter	Emplacement du monde
string	text	Required parameter	The text to draw
Color	color?	Color.RED	La couleur à utiliser
float	life_time?	5	Secondes avant que le dessin ne disparaisse
boolean	draw_shadow?	false	Dessiner ou non une ombre derrière le texte
float	font_scale?	1	Taille du texte

---

Optimal

IsProfilerConnected

Returns if a Tracy profiler is connected right now. Useful for skipping debugging logic

local ret = Debug.IsProfilerConnected()

Returns

Type	Description
boolean	If Tracy is connected

---

Optimal

ProfileMessage

Marks an event with a text in the Tracy timeline.

The text is prefixed with '[package]'. Does nothing while Tracy is not connected.

Debug.ProfileMessage(text)

Parameters

Type	Parameter	Default	Description
string	text	Required parameter	Text of the event

---

Optimal

ProfilePlot

Records a value in a graph in Tracy.

The graph is named '[package] name'. Use fixed names: each different name stays stored until the game or server closes, up to 256 names in total. Does nothing while Tracy is not connected.

Debug.ProfilePlot(name, value)

Parameters

Type	Parameter	Default	Description
string	name	Required parameter	Name of the graph
number	value	Required parameter	Value to record

---

Optimal

ProfileZone

Runs a function and measures it as a zone in Tracy and in the native profiling.

The zone is named '[package] name' and always closes when the function returns.

Use fixed names: each different name stays stored until the game or server closes, up to 256 names in total.

Debug.ProfileZone(name, callback)

Parameters

Type	Parameter	Default	Description
string	name	Required parameter	Name of the zone
function	callback	Required parameter	Function to run and measure

🚀 Événements

This class doesn't have own events.