Class MessagePart

Namespace

Archipelago.MultiClient.Net.MessageLog.Parts

Assembly

Archipelago.MultiClient.Net.dll

Part of a LogMessage that contains information on how to display the piece of text

public class MessagePart

Inheritance

object

MessagePart

Derived

EntranceMessagePart

HintStatusMessagePart

ItemMessagePart

LocationMessagePart

PlayerMessagePart

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Color

The color corresponding to PaletteColor in the built-in dark palette.

public Color Color { get; }

Property Value

Color

IsBackgroundColor

Whether this message part's color is intended to represent a background color

public bool IsBackgroundColor { get; }

Property Value

bool

PaletteColor

The specified color for this message part, or null if not specified.

public PaletteColor? PaletteColor { get; protected set; }

Property Value

PaletteColor?

Text

The text to display

public string Text { get; }

Property Value

string

Type

The type of message part

public MessagePartType Type { get; }

Property Value

MessagePartType

Methods

GetColor<T>(Palette<T>)

Gets the color corresponding to PaletteColor in the specified palette.

public T GetColor<T>(Palette<T> palette)

Parameters

palette Palette<T>

The palette to retrieve the color from

Returns

T

Type Parameters

T

ToString()

The text to display of this message part

public override string ToString()

Returns

string