unreal.DrawDebugLibrary

class unreal.DrawDebugLibrary(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

A blueprint library of additional debug draw functions that unifies drawing between different debug drawing interfaces. Also includes a number of helper functions and other convenience functions that are useful for debug drawing such as functions for recording histories.

General parameter structure for these functions is:

Required Inputs, Style, bDepthTest, Settings

C++ Source:

• Plugin: DrawDebugLibrary

• Module: DrawDebugLibrary

• File: DrawDebugLibrary.h

classmethod add_to_float_history_array(out_values, new_value=0.000000, max_history_num=60) → Array[float]

Convenience function that adds a float to the end of an array, popping values from the front once the max is reached

Parameters:

• out_values (Array[float])

• new_value (float)

• max_history_num (int32)

Returns:

out_values (Array[float]):

Return type:

Array[float]

classmethod add_to_vector_history_array(out_values, new_value=[0.000000, 0.000000, 0.000000], max_history_num=60) → Array[Vector]

Convenience function that adds a vector to the end of an array, popping values from the front once the max is reached

Parameters:

• out_values (Array[Vector])

• new_value (Vector)

• max_history_num (int32)

Returns:

out_values (Array[Vector]):

Return type:

Array[Vector]

classmethod draw_debug_angle(drawer, location, rotation, angle=0.000000, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, line_length=10.000000, angle_radius=5.000000, segments=17) → None

Debug Draw an angle

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• angle (float)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• line_length (float)

• angle_radius (float)

• segments (int32)

classmethod draw_debug_arc(drawer, location, rotation, angle=360.000000, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, radius=10.000000, segments=17) → None

Debug Draw an arc around the XY axis

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• angle (float)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• radius (float)

• segments (int32)

classmethod draw_debug_arrow(drawer, start_location, end_location, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, settings=[False, False, 5.000000, DrawDebugArrowHead.SIMPLE, True, False, 5.000000, DrawDebugArrowHead.SIMPLE]) → None

Debug Draw an arrow

Parameters:

• drawer (DebugDrawer)

• start_location (Vector)

• end_location (Vector)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• settings (DrawDebugArrowSettings)

classmethod draw_debug_bone(drawer, location, rotation, color=[0.000000, 0.000000, 0.025000, 1.000000], depth_test=True, radius=5.000000, segments=10, draw_transform=False) → None

Debug Draw a bone

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• color (LinearColor)

• depth_test (bool)

• radius (float)

• segments (int32)

• draw_transform (bool)

classmethod draw_debug_bone_link(drawer, child_location, parent_location, parent_rotation, color=[0.000000, 0.000000, 0.025000, 1.000000], depth_test=True, radius=5.000000) → None

Debug Draw a link between a child and parent bone

Parameters:

• drawer (DebugDrawer)

• child_location (Vector)

• parent_location (Vector)

• parent_rotation (Rotator)

• color (LinearColor)

• depth_test (bool)

• radius (float)

classmethod draw_debug_box(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, half_extents=[10.000000, 10.000000, 10.000000]) → None

Debug Draw an oriented box

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• half_extents (Vector)

classmethod draw_debug_camera(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, scale=10.000000, fov_degees=30.000000) → None

Debug draw a camera shape

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• scale (float)

• fov_degees (float)

classmethod draw_debug_capsule(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, radius=10.000000, half_length=10.000000, segments=8) → None

Debug Draw a capsule

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• radius (float)

• half_length (float)

• segments (int32)

classmethod draw_debug_capsule_line(drawer, start_location, end_location, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, radius=10.000000, segments=8) → None

Debug Draw a capsule using the start and end location

Parameters:

• drawer (DebugDrawer)

• start_location (Vector)

• end_location (Vector)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• radius (float)

• segments (int32)

classmethod draw_debug_catmull_rom_spline(drawer, points, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, monotonic=False, segments=15) → None

Debug Draw a catmull rom spline

Parameters:

• drawer (DebugDrawer)

• points (Array[Vector])

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• monotonic (bool)

• segments (int32)

classmethod draw_debug_catmull_rom_spline_end(drawer, v0, v1, v2, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, monotonic=False, segments=15) → None

Debug Draw the end section of a catmull rom spline

Parameters:

• drawer (DebugDrawer)

• v0 (Vector)

• v1 (Vector)

• v2 (Vector)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• monotonic (bool)

• segments (int32)

classmethod draw_debug_catmull_rom_spline_section(drawer, v0, v1, v2, v3, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, monotonic=False, segments=15) → None

Debug Draw a full segment of a catmull rom spline

Parameters:

• drawer (DebugDrawer)

• v0 (Vector)

• v1 (Vector)

• v2 (Vector)

• v3 (Vector)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• monotonic (bool)

• segments (int32)

classmethod draw_debug_catmull_rom_spline_start(drawer, v0, v1, v2, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, monotonic=False, segments=15) → None

Debug Draw the start section of a catmull rom spline

Parameters:

• drawer (DebugDrawer)

• v0 (Vector)

• v1 (Vector)

• v2 (Vector)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• monotonic (bool)

• segments (int32)

classmethod draw_debug_chair(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, settings=[40.000000, 40.000000, 40.000000, 10.000000]) → None

Debug draw a basic chair shape

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• settings (DrawDebugChairSettings)

classmethod draw_debug_circle(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, radius=10.000000, segments=17) → None

Debug Draw an circle around the XY axis

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• radius (float)

• segments (int32)

classmethod draw_debug_circle_arrow(drawer, location, rotation, angle, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, radius=10.000000, length=20.000000, arrow_settings=[False, False, 5.000000, DrawDebugArrowHead.SIMPLE, True, False, 5.000000, DrawDebugArrowHead.SIMPLE]) → None

Debug Draw an arrow coming off a circle at a given angle

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• angle (float)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• radius (float)

• length (float)

• arrow_settings (DrawDebugArrowSettings)

classmethod draw_debug_circle_outline(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, inner_radius=10.000000, outer_radius=15.000000, segments=17) → None

Debug Draw the outline of a circle (two circles) around the XY axis

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• inner_radius (float)

• outer_radius (float)

• segments (int32)

classmethod draw_debug_circle_tick(drawer, location, rotation, angle, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, radius=10.000000, length=2.500000, inside=True) → None

Debug Draw an tick on a circle at a given angle

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• angle (float)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• radius (float)

• length (float)

• inside (bool)

classmethod draw_debug_circle_ticks(drawer, location, rotation, angles, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, radius=10.000000, length=5.000000, inside=True) → None

Debug Draw ticks on a circle at the given angles

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• angles (Array[float])

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• radius (float)

• length (float)

• inside (bool)

classmethod draw_debug_cone(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, length=20.000000, radius=10.000000, segments=9) → None

Debug Draw a cone

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• length (float)

• radius (float)

• segments (int32)

classmethod draw_debug_cross_locator(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, radius=10.000000) → None

Debug Draw an axis-aligned cross rotated by 45 degrees

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• radius (float)

classmethod draw_debug_decagon(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, radius=10.000000) → None

Debug Draw a decagon on the XY axis

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• radius (float)

classmethod draw_debug_diamond(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, radius=10.000000) → None

Debug Draw a diamond on the XY axis

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• radius (float)

classmethod draw_debug_direction(drawer, location, direction=[1.000000, 0.000000, 0.000000], line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, draw_arrow_length=100.000000, arrow_head_scale=1.000000) → None

Debug Draw an arrow at the given location facing in the given direction

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• direction (Vector)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• draw_arrow_length (float)

• arrow_head_scale (float)

classmethod draw_debug_door(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, settings=[100.000000, 200.000000, 5.000000, 90.000000, 20.000000, 3.000000, 2.000000, True, True, True, True, 40.000000]) → None

Debug draw a basic door shape

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• settings (DrawDebugDoorSettings)

classmethod draw_debug_event(drawer, time_until_event_known, time_until_event, location, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, size=20.000000) → None

Debug draw a phase-representation of an event at a location

Parameters:

• drawer (DebugDrawer)

• time_until_event_known (bool)

• time_until_event (float)

• location (Vector)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• size (float)

classmethod draw_debug_flat_arrow(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, length=20.000000, width=20.000000) → None

Draws a flat 2d arrow motif

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• length (float)

• width (float)

classmethod draw_debug_frustum(drawer, frustum_to_world, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True) → None

Debug Draw a Frustum

Parameters:

• drawer (DebugDrawer)

• frustum_to_world (Matrix)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

classmethod draw_debug_graph(drawer, location, rotation, xvalues, yvalues, xmin=0.000000, xmax=1.000000, ymin=0.000000, ymax=1.000000, xaxis_length=100.000000, yaxis_length=100.000000, text_line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], axes_line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], plot_line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, axes_settings=['', [10.000000, True, 1.000000, 1.000000, 1.000000, 0.000000], '', '', [10.000000, True, 1.000000, 1.000000, 1.000000, 0.000000]]) → None

Debug Draw a simple graph.

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• xvalues (Array[float])

• yvalues (Array[float])

• xmin (float)

• xmax (float)

• ymin (float)

• ymax (float)

• xaxis_length (float)

• yaxis_length (float)

• text_line_style (DrawDebugLineStyle)

• axes_line_style (DrawDebugLineStyle)

• plot_line_style (DrawDebugLineStyle)

• depth_test (bool)

• axes_settings (DrawDebugGraphAxesSettings)

classmethod draw_debug_graph_axes(drawer, location, rotation, xaxis_length=100.000000, yaxis_length=100.000000, text_line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], axes_line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, axes_settings=['', [10.000000, True, 1.000000, 1.000000, 1.000000, 0.000000], '', '', [10.000000, True, 1.000000, 1.000000, 1.000000, 0.000000]]) → None

Debug Draw a simple graph axes.

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• xaxis_length (float)

• yaxis_length (float)

• text_line_style (DrawDebugLineStyle)

• axes_line_style (DrawDebugLineStyle)

• depth_test (bool)

• axes_settings (DrawDebugGraphAxesSettings)

classmethod draw_debug_graph_legend(drawer, location, rotation, legend_colors, legend_labels, xaxis_length=100.000000, yaxis_length=100.000000, text_line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], icon_line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], icon_size=2.500000, depth_test=True, legend_settings=[10.000000, True, 1.000000, 1.000000, 1.000000, 0.000000]) → None

Debug Draw a simple graph legend.

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• legend_colors (Array[LinearColor])

• legend_labels (Array[str])

• xaxis_length (float)

• yaxis_length (float)

• text_line_style (DrawDebugLineStyle)

• icon_line_style (DrawDebugLineStyle)

• icon_size (float)

• depth_test (bool)

• legend_settings (DrawDebugStringSettings)

classmethod draw_debug_graph_line(drawer, location, rotation, xvalues, yvalues, xmin=0.000000, xmax=1.000000, ymin=0.000000, ymax=1.000000, xaxis_length=100.000000, yaxis_length=100.000000, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True) → None

Debug Draw a line on a simple graph.

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• xvalues (Array[float])

• yvalues (Array[float])

• xmin (float)

• xmax (float)

• ymin (float)

• ymax (float)

• xaxis_length (float)

• yaxis_length (float)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

classmethod draw_debug_ground_target_arrow(drawer, location, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, length=100.000000, arrow_head_size=20.000000, radius=10.000000, segments=17) → None

Draws an arrow pointing down at the location surrounded by a circle

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• length (float)

• arrow_head_size (float)

• radius (float)

• segments (int32)

classmethod draw_debug_heptagon(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, radius=10.000000) → None

Debug Draw a heptagon on the XY axis

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• radius (float)

classmethod draw_debug_hexagon(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, radius=10.000000) → None

Debug Draw a hexagon on the XY axis

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• radius (float)

classmethod draw_debug_line(drawer, start_location, end_location, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True) → None

Debug Draw a line

Parameters:

• drawer (DebugDrawer)

• start_location (Vector)

• end_location (Vector)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

classmethod draw_debug_line_style_color(line_style) → LinearColor

Get the color from a line style

Parameters:

line_style (DrawDebugLineStyle)

Return type:

LinearColor

classmethod draw_debug_line_style_from_point_style(point_style) → DrawDebugLineStyle

Get a line style from a point style

Parameters:

point_style (DrawDebugPointStyle)

Return type:

DrawDebugLineStyle

classmethod draw_debug_line_style_with_color(line_style, color=[1.000000, 0.000000, 1.000000, 1.000000]) → DrawDebugLineStyle

Get a line style with the color changed

Parameters:

• line_style (DrawDebugLineStyle)

• color (LinearColor)

Return type:

DrawDebugLineStyle

classmethod draw_debug_line_style_with_color_no_opacity(line_style, color=[1.000000, 0.000000, 1.000000, 1.000000]) → DrawDebugLineStyle

Get a line style with the color (excluding the opacity) changed

Parameters:

• line_style (DrawDebugLineStyle)

• color (LinearColor)

Return type:

DrawDebugLineStyle

classmethod draw_debug_line_style_with_thickness(line_style, thickness=0.000000) → DrawDebugLineStyle

Get a line style with the thickness changed

Parameters:

• line_style (DrawDebugLineStyle)

• thickness (float)

Return type:

DrawDebugLineStyle

classmethod draw_debug_line_style_with_type(line_style, line_type=DrawDebugLineType.SOLID) → DrawDebugLineStyle

Get a line style with the type changed

Parameters:

• line_style (DrawDebugLineStyle)

• line_type (DrawDebugLineType)

Return type:

DrawDebugLineStyle

classmethod draw_debug_lines(drawer, start_locations, end_locations, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True) → None

Debug Draw lines. These should be preferred over DrawDebugLine where possible as it will batch drawing when required such as when using the visual logger.

Parameters:

• drawer (DebugDrawer)

• start_locations (Array[Vector])

• end_locations (Array[Vector])

• line_style (DrawDebugLineStyle)

• depth_test (bool)

classmethod draw_debug_location(drawer, location, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, draw_radius=10.000000, segments=8) → None

Debug Draw a sphere at the given location

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• draw_radius (float)

• segments (int32)

classmethod draw_debug_locations(drawer, locations, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, draw_radius=10.000000, segments=8) → None

Debug Draw spheres at the given locations

Parameters:

• drawer (DebugDrawer)

• locations (Array[Vector])

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• draw_radius (float)

• segments (int32)

classmethod draw_debug_locator(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, radius=10.000000) → None

Debug Draw an axis-aligned cross

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• radius (float)

classmethod draw_debug_mover_orientation(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, forward_vector=[1.000000, 0.000000, 0.000000], scale=30.000000) → None

Draws a flat 2d motif representing mover position and rotation

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• forward_vector (Vector)

• scale (float)

classmethod draw_debug_name(drawer, name, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, settings=[10.000000, True, 1.000000, 1.000000, 1.000000, 0.000000]) → None

Debug Draw a name

Parameters:

• drawer (DebugDrawer)

• name (Name)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• settings (DrawDebugStringSettings)

classmethod draw_debug_name_dimensions(name, settings=[10.000000, True, 1.000000, 1.000000, 1.000000, 0.000000]) → Vector

Get the dimensions of a draw debug name. Useful for aligning or centering text.

Parameters:

• name (Name)

• settings (DrawDebugStringSettings)

Return type:

Vector

classmethod draw_debug_nonagon(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, radius=10.000000) → None

Debug Draw a nonagon on the XY axis

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• radius (float)

classmethod draw_debug_octagon(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, radius=10.000000) → None

Debug Draw a octagon on the XY axis

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• radius (float)

classmethod draw_debug_oriented_arrow(drawer, location, rotation, length=100.000000, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, settings=[False, False, 5.000000, DrawDebugArrowHead.SIMPLE, True, False, 5.000000, DrawDebugArrowHead.SIMPLE]) → None

Debug Draw an arrow with an orientation

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• length (float)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• settings (DrawDebugArrowSettings)

classmethod draw_debug_pentagon(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, radius=10.000000) → None

Debug Draw a pentagon on the XY axis

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• radius (float)

classmethod draw_debug_point(drawer, location, point_style=[0.000000, [1.000000, 0.000000, 1.000000, 1.000000]], depth_test=True) → None

Debug Draw a point

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• point_style (DrawDebugPointStyle)

• depth_test (bool)

classmethod draw_debug_point_style_color(point_style) → LinearColor

Get the color from a point style

Parameters:

point_style (DrawDebugPointStyle)

Return type:

LinearColor

classmethod draw_debug_point_style_from_line_style(line_style) → DrawDebugPointStyle

Get a point style from a line style

Parameters:

line_style (DrawDebugLineStyle)

Return type:

DrawDebugPointStyle

classmethod draw_debug_points(drawer, locations, point_style=[0.000000, [1.000000, 0.000000, 1.000000, 1.000000]], depth_test=True) → None

Debug Draw points. These should be preferred over DrawDebugPoint where possible as it will batch drawing when required such as when using the visual logger.

Parameters:

• drawer (DebugDrawer)

• locations (Array[Vector])

• point_style (DrawDebugPointStyle)

• depth_test (bool)

classmethod draw_debug_pose(drawer, bone_locations, bone_linear_velocities, relative_transform=[[0.000000, 0.000000, 0.000000], [-0.000000, 0.000000, 0.000000], [1.000000, 1.000000, 1.000000]], line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, draw_velocity_line_scale=1.000000) → None

Debug Draw a pose made up of bone locations and velocities

Parameters:

• drawer (DebugDrawer)

• bone_locations (Array[Vector])

• bone_linear_velocities (Array[Vector])

• relative_transform (Transform)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• draw_velocity_line_scale (float)

classmethod draw_debug_regular_polygon(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, radius=10.000000, sides=11) → None

Debug Draw a flat regular polygon on the XY axis

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• radius (float)

• sides (int32)

classmethod draw_debug_rotation(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, draw_radius=10.000000) → None

Draws a rotation

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• draw_radius (float)

classmethod draw_debug_simple_sphere(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, radius=10.000000, segments=13) → None

Debug Draw a simple sphere made up of three circles one of each axis

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• radius (float)

• segments (int32)

classmethod draw_debug_skeleton_from_skinned_mesh_component(drawer, skinned_mesh_component, color=[0.000000, 0.000000, 0.025000, 1.000000], depth_test=False, settings=[False, 1.000000, 10, False, True, [1.000000, 0.000000, 0.000000, 1.000000]]) → None

Draws a skeleton from a skinned mesh component

Parameters:

• drawer (DebugDrawer)

• skinned_mesh_component (SkinnedMeshComponent)

• color (LinearColor)

• depth_test (bool)

• settings (DrawDebugSkeletonSettings)

classmethod draw_debug_sphere(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, radius=10.000000, segments=8) → None

Debug Draw a sphere

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• radius (float)

• segments (int32)

classmethod draw_debug_square(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, half_length=10.000000) → None

Debug Draw a square on the XY axis

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• half_length (float)

classmethod draw_debug_square_base_pyramid(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, length=20.000000, width=20.000000) → None

Debug Draw a square base pyramid

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• length (float)

• width (float)

classmethod draw_debug_string(drawer, string, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, settings=[10.000000, True, 1.000000, 1.000000, 1.000000, 0.000000]) → None

Debug Draw a string. Will only render ASCII characters.

Parameters:

• drawer (DebugDrawer)

• string (str)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• settings (DrawDebugStringSettings)

classmethod draw_debug_string_dimensions(string, settings=[10.000000, True, 1.000000, 1.000000, 1.000000, 0.000000]) → Vector

Get the dimensions of a draw debug string. Useful for aligning or centering text.

Parameters:

• string (str)

• settings (DrawDebugStringSettings)

Return type:

Vector

classmethod draw_debug_string_segment_num(string, settings=[10.000000, True, 1.000000, 1.000000, 1.000000, 0.000000]) → int32

Get the number of line segments required to draw debug string.

Parameters:

• string (str)

• settings (DrawDebugStringSettings)

Return type:

int32

classmethod draw_debug_text(drawer, text, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, settings=[10.000000, True, 1.000000, 1.000000, 1.000000, 0.000000]) → None

Debug Draw some text. Will only render ASCII characters.

Parameters:

• drawer (DebugDrawer)

• text (Text)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• settings (DrawDebugStringSettings)

classmethod draw_debug_text_dimensions(text, settings=[10.000000, True, 1.000000, 1.000000, 1.000000, 0.000000]) → Vector

Get the dimensions of a draw debug text. Useful for aligning or centering text.

Parameters:

• text (Text)

• settings (DrawDebugStringSettings)

Return type:

Vector

classmethod draw_debug_trajectory(drawer, locations, directions, relative_transform=[[0.000000, 0.000000, 0.000000], [-0.000000, 0.000000, 0.000000], [1.000000, 1.000000, 1.000000]], line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, draw_arrow_length=100.000000, point_radius=5.000000, arrow_head_scale=1.000000, segments=9, vertical_offset=2.000000) → None

Debug Draw a trajectory of locations and directions

Parameters:

• drawer (DebugDrawer)

• locations (Array[Vector])

• directions (Array[Vector])

• relative_transform (Transform)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• draw_arrow_length (float)

• point_radius (float)

• arrow_head_scale (float)

• segments (int32)

• vertical_offset (float)

classmethod draw_debug_transform(drawer, transform, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, draw_radius=10.000000) → None

Debug Draw a set of axes at the given transform

Parameters:

• drawer (DebugDrawer)

• transform (Transform)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• draw_radius (float)

classmethod draw_debug_transform_trajectory(drawer, transform_trajectory, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, radius=5.000000, vertical_offset=2.000000) → None

Debug Draw a transform trajectory

Parameters:

• drawer (DebugDrawer)

• transform_trajectory (TransformTrajectory)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• radius (float)

• vertical_offset (float)

classmethod draw_debug_triangle(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, radius=10.000000) → None

Debug Draw a triangle on the XY axis

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• radius (float)

classmethod draw_debug_triangular_base_pyramid(drawer, location, rotation, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, length=20.000000, width=20.000000) → None

Debug Draw a triangular base pyramid

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• rotation (Rotator)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• length (float)

• width (float)

classmethod draw_debug_velocities(drawer, locations, velocities, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, draw_velocity_line_scale=1.000000) → None

Debug draw velocities

Parameters:

• drawer (DebugDrawer)

• locations (Array[Vector])

• velocities (Array[Vector])

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• draw_velocity_line_scale (float)

classmethod draw_debug_velocity(drawer, location, velocity, line_style=[DrawDebugLineType.SOLID, 0.000000, [1.000000, 0.000000, 1.000000, 1.000000], 2.500000, 1.000000, 1.000000], depth_test=True, draw_velocity_line_scale=1.000000) → None

Debug Draw a line at the given location scaled by the given velocity

Parameters:

• drawer (DebugDrawer)

• location (Vector)

• velocity (Vector)

• line_style (DrawDebugLineStyle)

• depth_test (bool)

• draw_velocity_line_scale (float)

classmethod get_default_bone_color() → LinearColor

Gets the default debug draw bone color

Return type:

LinearColor

classmethod get_default_bone_radius() → float

Gets the default debug draw bone radius

Return type:

float

classmethod make_debug_drawer(object) → DebugDrawer

Make a debug debugger from the current “Self” object

Parameters:

object (Object)

Return type:

DebugDrawer

classmethod make_draw_debug_line_style_from_color(color=[1.000000, 0.000000, 1.000000, 1.000000]) → DrawDebugLineStyle

Make a line style from a color

Parameters:

color (LinearColor)

Return type:

DrawDebugLineStyle

classmethod make_draw_debug_point_style_from_color(color=[1.000000, 0.000000, 1.000000, 1.000000]) → DrawDebugPointStyle

Make a point style from a color

Parameters:

color (LinearColor)

Return type:

DrawDebugPointStyle

classmethod make_linearly_spaced_float_array(start=0.000000, stop=1.000000, num=10) → Array[float]

Convenience function for making an array of linearly spaced float values

Parameters:

• start (float)

• stop (float)

• num (int32)

Returns:

out_values (Array[float]):

Return type:

Array[float]

classmethod make_merged_debug_drawer(debug_drawers) → DebugDrawer

Make a debug drawer by merging multiple other debug drawers of different types

Parameters:

debug_drawers (Array[DebugDrawer])

Return type:

DebugDrawer

classmethod make_null_debug_drawer() → DebugDrawer

Make a null debug drawer which ignores draw commands

Return type:

DebugDrawer

classmethod make_object_debug_drawer(object) → DebugDrawer

Make a debug drawer for a UObject

Parameters:

object (Object)

Return type:

DebugDrawer

classmethod make_visual_logger_debug_drawer(object, category='LogDrawDebugLibrary', verbosity=DrawDebugLogVerbosity.DISPLAY, draw_to_scene=True, draw_to_scene_while_recording=True) → DebugDrawer

Make a debug drawer for the Visual Logger from the current “Self” object

Parameters:

• object (Object)

• category (Name)

• verbosity (DrawDebugLogVerbosity)

• draw_to_scene (bool)

• draw_to_scene_while_recording (bool)

Return type:

DebugDrawer

classmethod make_visual_logger_debug_drawer_from_object(object, category='LogDrawDebugLibrary', verbosity=DrawDebugLogVerbosity.DISPLAY, draw_to_scene=True, draw_to_scene_while_recording=True) → DebugDrawer

Make a debug drawer for the Visual Logger

Parameters:

• object (Object)

• category (Name)

• verbosity (DrawDebugLogVerbosity)

• draw_to_scene (bool)

• draw_to_scene_while_recording (bool)

Return type:

DebugDrawer

classmethod visual_logger_draw_name(drawer, name, location, color=[1.000000, 0.000000, 1.000000, 1.000000]) → None

Debug Draw a name to the visual logger. Will do nothing if not using a VisualLoggerDrawer. Will not display on-screen during recording.

Parameters:

• drawer (DebugDrawer)

• name (Name)

• location (Vector)

• color (LinearColor)

classmethod visual_logger_draw_string(drawer, string, location, color=[1.000000, 0.000000, 1.000000, 1.000000]) → None

Debug Draw a string to the visual logger. Will do nothing if not using a VisualLoggerDrawer. Will not display on-screen during recording.

Parameters:

• drawer (DebugDrawer)

• string (str)

• location (Vector)

• color (LinearColor)

classmethod visual_logger_draw_text(drawer, text, location, color=[1.000000, 0.000000, 1.000000, 1.000000]) → None

Debug Draw some text to the visual logger. Will do nothing if not using a VisualLoggerDrawer. Will not display on-screen during recording.

Parameters:

• drawer (DebugDrawer)

• text (Text)

• location (Vector)

• color (LinearColor)

classmethod visual_logger_log_string(drawer, string, color=[1.000000, 0.000000, 1.000000, 1.000000]) → None

Log a string to the visual logger. Only does anything with a VisualLoggerDebugDrawer.

Parameters:

• drawer (DebugDrawer)

• string (str)

• color (LinearColor)

classmethod visual_logger_log_text(drawer, text, color=[1.000000, 0.000000, 1.000000, 1.000000]) → None

Log some text to the visual logger. Only does anything with a VisualLoggerDebugDrawer.

Parameters:

• drawer (DebugDrawer)

• text (Text)

• color (LinearColor)