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_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) → 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) –

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:
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

Log Segment

Parameters:
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: