unreal.TraceUtilLibrary

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

Bases: BlueprintFunctionLibrary

Trace Util Library

C++ Source:

• Plugin: TraceUtilities

• Module: TraceUtilities

• File: TraceUtilLibrary.h

classmethod get_all_channels() → Array[str]

Get All Channels

Return type:

Array[str]

classmethod get_enabled_channels() → Array[str]

Get Enabled Channels

Return type:

Array[str]

classmethod is_channel_enabled(channel_name) → bool

Is Channel Enabled

Parameters:

channel_name (str)

Return type:

bool

classmethod is_tracing() → bool

Is Tracing

Return type:

bool

classmethod pause_tracing() → bool

Pause Tracing

Return type:

bool

classmethod resume_tracing() → bool

Resume Tracing

Return type:

bool

classmethod start_trace_send_to(target, channels) → bool

Start Trace Send To

Parameters:

• target (str)

• channels (Array[str])

Return type:

bool

classmethod start_trace_to_file(file_name, channels) → bool

Start Trace to File

Parameters:

• file_name (str)

• channels (Array[str])

Return type:

bool

classmethod stop_tracing() → bool

Stop Tracing

Return type:

bool

classmethod toggle_channel(channel_name, enabled) → bool

Toggle Channel

Parameters:

• channel_name (str)

• enabled (bool)

Return type:

bool

classmethod trace_bookmark(name) → None

Traces a bookmark with specified name.

Parameters:

name (str)

classmethod trace_mark_region_end(name) → None

Traces an end event for a region with specified name.

Parameters:

name (str)

classmethod trace_mark_region_start(name) → None

Traces a begin event for a region with specified name.

Parameters:

name (str)

classmethod trace_screenshot(name, show_ui) → None

Triggers an Unreal Insights screenshot

Parameters:

• name (str)

• show_ui (bool)