unreal.VisualLoggerLibrary

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

Bases: BlueprintFunctionLibrary

Visual Logger Kismet Library

C++ Source:

• Module: Engine

• File: VisualLoggerKismetLibrary.h

classmethod enable_recording(enabled) → None

Enable Recording

Parameters:

enabled (bool) –

classmethod log_arrow(world_context_object, segment_start, segment_end, text, object_color=[0.000000, 0.000000, 1.000000, 1.000000], category_name='VisLogBP', add_to_message_log=False) → None

Logs arrow - recording for Visual Logs has to be enabled to record this data

Parameters:

• world_context_object (Object) –

• segment_start (Vector) –

• segment_end (Vector) –

• text (str) –

• object_color (LinearColor) –

• category_name (Name) –

• add_to_message_log (bool) –

classmethod log_box(world_context_object, box_shape, text, object_color=[0.000000, 0.000000, 1.000000, 1.000000], log_category='VisLogBP', add_to_message_log=False, wireframe=False) → None

Logs box shape - recording for Visual Logs has to be enabled to record this data

Parameters:

• world_context_object (Object) –

• box_shape (Box) –

• text (str) –

• object_color (LinearColor) –

• log_category (Name) –

• add_to_message_log (bool) –

• wireframe (bool) –

classmethod log_capsule(world_context_object, base, half_height, radius, rotation, text, object_color=[0.000000, 0.000000, 1.000000, 1.000000], log_category='VisLogBP', add_to_message_log=False, wireframe=False) → None

Logs capsule shape - recording for Visual Logs has to be enabled to record this data

Parameters:

• world_context_object (Object) –

• base (Vector) –

• half_height (float) –

• radius (float) –

• rotation (Quat) –

• text (str) –

• object_color (LinearColor) –

• log_category (Name) –

• add_to_message_log (bool) –

• wireframe (bool) –

classmethod log_circle(world_context_object, center, up_axis, radius, text, object_color=[0.000000, 0.000000, 1.000000, 1.000000], thickness=0.000000, category_name='VisLogBP', add_to_message_log=False) → None

Logs circle - recording for Visual Logs has to be enabled to record this data

Parameters:

• world_context_object (Object) –

• center (Vector) –

• up_axis (Vector) –

• radius (float) –

• text (str) –

• object_color (LinearColor) –

• thickness (float) –

• category_name (Name) –

• add_to_message_log (bool) –

classmethod log_cone(world_context_object, origin, direction, length, angle, text, object_color=[0.000000, 0.000000, 1.000000, 1.000000], log_category='VisLogBP', add_to_message_log=False, wireframe=False) → None

Logs cone shape - recording for Visual Logs has to be enabled to record this data

Parameters:

• world_context_object (Object) –

• origin (Vector) –

• direction (Vector) –

• length (float) –

• angle (float) –

• text (str) –

• object_color (LinearColor) –

• log_category (Name) –

• add_to_message_log (bool) –

• wireframe (bool) –

classmethod log_cylinder(world_context_object, start, end, radius, text, object_color=[0.000000, 0.000000, 1.000000, 1.000000], log_category='VisLogBP', add_to_message_log=False, wireframe=False) → None

Logs cylinder shape - recording for Visual Logs has to be enabled to record this data

Parameters:

• world_context_object (Object) –

• start (Vector) –

• end (Vector) –

• radius (float) –

• text (str) –

• object_color (LinearColor) –

• log_category (Name) –

• add_to_message_log (bool) –

• wireframe (bool) –

classmethod log_location(world_context_object, location, text, object_color=[0.000000, 0.000000, 1.000000, 1.000000], radius=10.000000, log_category='VisLogBP', add_to_message_log=False) → None

Logs location as sphere with given radius - recording for Visual Logs has to be enabled to record this data

Parameters:

• world_context_object (Object) –

• location (Vector) –

• text (str) –

• object_color (LinearColor) –

• radius (float) –

• log_category (Name) –

• add_to_message_log (bool) –

classmethod log_oriented_box(world_context_object, box_shape, transform, text, object_color=[0.000000, 0.000000, 1.000000, 1.000000], log_category='VisLogBP', add_to_message_log=False, wireframe=False) → None

Logs oriented box shape - recording for Visual Logs has to be enabled to record this data

Parameters:

• world_context_object (Object) –

• box_shape (Box) –

• transform (Transform) –

• text (str) –

• object_color (LinearColor) –

• log_category (Name) –

• add_to_message_log (bool) –

• wireframe (bool) –

classmethod log_segment(world_context_object, segment_start, segment_end, text, object_color=[0.000000, 0.000000, 1.000000, 1.000000], thickness=0.000000, category_name='VisLogBP', add_to_message_log=False) → None

Logs segment - recording for Visual Logs has to be enabled to record this data

Parameters:

• world_context_object (Object) –

• segment_start (Vector) –

• segment_end (Vector) –

• text (str) –

• object_color (LinearColor) –

• thickness (float) –

• category_name (Name) –

• add_to_message_log (bool) –

classmethod log_sphere(world_context_object, center, radius, text, object_color=[0.000000, 0.000000, 1.000000, 1.000000], log_category='VisLogBP', add_to_message_log=False, wireframe=False) → None

Logs sphere shape - recording for Visual Logs has to be enabled to record this data

Parameters:

• world_context_object (Object) –

• center (Vector) –

• radius (float) –

• text (str) –

• object_color (LinearColor) –

• log_category (Name) –

• add_to_message_log (bool) –

• wireframe (bool) –

classmethod log_text(world_context_object, text, log_category='VisLogBP', add_to_message_log=False) → None

Logs simple text string with Visual Logger - recording for Visual Logs has to be enabled to record this data

Parameters:

• world_context_object (Object) –

• text (str) –

• log_category (Name) –

• add_to_message_log (bool) –

classmethod redirect_vislog(source_owner, destination_owner) → None

Makes SourceOwner log to DestinationOwner’s vislog

Parameters:

• source_owner (Object) –

• destination_owner (Object) –