Class ColorUtils

Namespace

Archipelago.MultiClient.Net.Colors

Assembly

Archipelago.MultiClient.Net.dll

Static utilities for getting the appropriate palette color from various protocol-provided information

public static class ColorUtils

Inheritance

object

ColorUtils

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Fields

ActivePlayerColor

The color to be used to represent the currently connected player

public const PaletteColor ActivePlayerColor = Magenta

Field Value

PaletteColor

NonActivePlayerColor

The color to be used to represent any player other the currently connected player

public const PaletteColor NonActivePlayerColor = Yellow

Field Value

PaletteColor

Methods

GetColor(HintStatus)

Gets the palette color corresponding to a HintStatus.

public static PaletteColor? GetColor(HintStatus status)

Parameters

status HintStatus

Returns

PaletteColor?

The corresponding palette color, or null if not specified

GetColor(ItemFlags)

Gets the palette color corresponding to an ItemFlags.

public static PaletteColor? GetColor(ItemFlags flags)

Parameters

flags ItemFlags

Returns

PaletteColor?

The corresponding palette color, or null if not specified

GetColor(JsonMessagePartColor)

Gets the palette color corresponding to a JsonMessagePartColor.

public static PaletteColor? GetColor(JsonMessagePartColor color)

Parameters

color JsonMessagePartColor

Returns

PaletteColor?

The corresponding palette color, or null if not specified

GetColor(PlayerInfo, IConnectionInfoProvider)

Gets the palette color corresponding to a PlayerInfo.

public static PaletteColor? GetColor(PlayerInfo player, IConnectionInfoProvider connectionInfo)

Parameters

player PlayerInfo

connectionInfo IConnectionInfoProvider

Returns

PaletteColor?

The corresponding palette color, or null if not specified

GetColor(Hint)

Gets the palette color corresponding to a Hint's status.

public static PaletteColor? GetColor(Hint hint)

Parameters

hint Hint

Returns

PaletteColor?

The corresponding palette color, or null if not specified

GetColor(ItemInfo)

Gets the palette color corresponding to an ItemInfo's flags.

public static PaletteColor? GetColor(ItemInfo item)

Parameters

item ItemInfo

Returns

PaletteColor?

The corresponding palette color, or null if not specified