Skip to content
Valentin Plyasinov edited this page Jul 6, 2024 · 7 revisions

Blueprint Message Log Plugin

Welcome to the BlueprintMessageLogPlugin wiki! Check navigation on right side.

Overview

Blueprint Message Log Plugin provides integration between Blueprints and Message Log API allowing creation of interactive logging messages in Blueprints.

Each Message is a sequence of one or more Tokens that contain various payloads (text, link, image, slot) and bound to a logging Category.

These messages displayed in a dedicated panel that can be opened from Window > Developer Tool > Message Log menu.

Message Log C++ details can be found here.

Message Object

Message constructed with Create Log Message or Create Simple Log Message functions.

Returned Object represents a single message prototype that can be filled with tokens or slots.

Message Token

Tokens constructed with a wide range of Make*Token factory functions. Each constructed token can be added to a message object with AddToken or AddTokens call or via additional pins of Create Log Message.

Displaying Messages

After message object is constructed and filled with tokens it has to be printed to log. This is done with Show and ShowAndPrint functions.

Show simply sends constructed message to a Message Log, while ShowAndPrint has additional AddOnScreenDebugMessage call to display it in viewport.

Slots

Slots is an advanced tool to create templated messages. By utilizing AddNamedSlot user able to add a slot for a token that can be filled in=place without needing to reconstruct whole message.

Example:

  • Create a message object with slots and tokens to act as a template
  • Use same object or Duplicate message object, set tokens at vacant slots.
  • Print message
Clone this wiki locally