Pardon our dust! Docs for Yarn Spinner for Unity 3.2 and Yarn Spinner for Godot C# are on docs.yarnspinner.dev (the old docs site). Docs for Yarn Spinner for Unity 3.3 (pre-release, out ASAP), Yarn Spinner for Godot GDScript and Yarn Spinner for Unreal Engine (work in progress) are on /docs/ (the new docs site).

MarkupPalette

Represents a collection of marker names and colours.
public sealed class MarkupPalette : ScriptableObject

Inherits from ScriptableObject

This is intended to be used with the LinePresenter, and also be a sample of using the markup system.

#Nested Types

  • Contains information describing the formatting style of text within a named marker.
  • Represents a marker itself including it's offsets (if needed)

#Fields

#BasicMarkers

A list containing all the color markers defined in this palette.
public List<BasicMarker> BasicMarkers = new List<BasicMarker>();

Type List

#CustomMarkers

public List<CustomMarker> CustomMarkers = new List<CustomMarker>();

Type List

#Methods

#ColorForMarker(string, Color)

Determines the colour for a particular marker inside this palette.
public bool ColorForMarker(string Marker, out Color colour)

Parameters

  • Markerstring
    The marker you want to get a colour for.
  • colourColor
    The colour of the marker, or Color.black if it doesn't exist in the MarkupPalette.

Returns Boolean: true if the marker exists within this palette; false otherwise.

#PaletteForMarker(string, CustomMarker)

Returns the named palette
public bool PaletteForMarker(string markerName, out CustomMarker palette)

Parameters

Returns Boolean: True if the palette was found, false otherwise

Generated from Yarn Spinner for Unity 3.3.