Skip to content

USMCompilerLog¶

Module: SMSystem

#include <SMNodeInstance.h>

Inherits from UObject

Description¶

class USMCompilerLog;

The compiler log is only valid during the compile process of a state machine blueprint.

Public Functions¶

Name
void Log(ESMCompilerLogType Severity, const FString & Message)
images/classes/SMCompilerLog/img/nd_img_Log.png
void LogProperty(FName PropertyName, const USMNodeInstance * NodeInstance, const FString & Message, ESMCompilerLogType Severity, bool bHighlight =false, bool bSilent =false, int32 ArrayIndex =-1)
images/classes/SMCompilerLog/img/nd_img_LogProperty.png

Public Attributes¶

Name
FOnCompilerLogSignature OnCompilerLogEvent
FOnCompilerLogPropertySignature OnCompilerLogPropertyEvent

Public Functions Documentation¶

function Log¶

void Log(
    ESMCompilerLogType Severity,
    const FString & Message
)

images/classes/SMCompilerLog/img/nd_img_Log.png

Output a message to the compiler log.

Parameters:

Severity
The log level to use.
Message
The text to output to the log.

Note:

Development Only.

function LogProperty¶

void LogProperty(
    FName PropertyName,
    const USMNodeInstance * NodeInstance,
    const FString & Message,
    ESMCompilerLogType Severity,
    bool bHighlight =false,
    bool bSilent =false,
    int32 ArrayIndex =-1
)

images/classes/SMCompilerLog/img/nd_img_LogProperty.png

Output a message to an exposed property on a node.

Parameters:

PropertyName
The name of the property to output to.
NodeInstance
The node instance the property belongs to. Most likely 'this' or 'self'. Automatically set when called in blueprints.
Message
The text to output to the log.
Severity
The log level to use.
bHighlight
Whether the property should be highlighted in addition to an info icon.
bSilent
When true the main compiler log won't be written to, allowing the blueprint to compile even when the severity is an error.
ArrayIndex
The index of the element if an array. Leave at -1 to include all elements in the array.

Note:

Development Only.

Public Attributes Documentation¶

variable OnCompilerLogEvent¶

FOnCompilerLogSignature OnCompilerLogEvent;

variable OnCompilerLogPropertyEvent¶

FOnCompilerLogPropertySignature OnCompilerLogPropertyEvent;