Class MapNote

Namespace

FishMMO.Client

Assembly

FishMMO.Client.dll

A marker the player placed on the world map themselves: a title, an optional line of text, a colour, and a place.

public sealed class MapNote

Inheritance

object

MapNote

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Purely local. Notes are stored beside the explored map in the character's own folder and are never sent anywhere — see MapNoteStore for why that is the whole design rather than a first step.

Fields

ColorIndex

Which of the note palette's colours the pin is drawn in.

public int ColorIndex

Field Value

int

ID

Identifier, unique within the scene, used to edit and delete the note.

public long ID

Field Value

long

MaximumTextLength

Longest body accepted, in characters.

public const int MaximumTextLength = 256

Field Value

int

MaximumTitleLength

Longest title accepted, in characters.

public const int MaximumTitleLength = 48

Field Value

int

Position

Where the note sits, in world space. Y is the terrain height at placement.

public Vector3 Position

Field Value

Vector3

ShowOnMinimap

Whether the note is also drawn on the minimap.

public bool ShowOnMinimap

Field Value

bool

Text

The note's body, shown in the tooltip.

public string Text

Field Value

string

Title

The note's title, drawn beside its pin.

public string Title

Field Value

string

Methods

SetContent(string, string)

Trims a title and body to the lengths the store will accept.

public void SetContent(string title, string text)

Parameters

title string

The title to clamp.

text string

The body to clamp.

Remarks

Applied when the note is created and again when it is loaded. A file edited by hand can carry a title of any length, and a note whose title is a megabyte of text would be laid out and drawn every frame the map is open.