Class MapRegionLabelDetails

Namespace

FishMMO.Shared

Assembly

FishMMO.Shared.dll

A named area drawn as text across the world map, and used to answer "where am I" on the minimap's location readout.

[Serializable]
public class MapRegionLabelDetails

Inheritance

object

MapRegionLabelDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Baked from a MapRegionLabel placed in the scene. Stored in world space, not map space: a re-bake that changes the map texture's resolution or the scene's bounds must not move the labels, and world space is the only coordinate system both the bake and the runtime agree on without a conversion.

Fields

DetailTier

Zoom tier at which the label starts being drawn on the world map, lowest first. Continents at 0, provinces at 1, individual settlements at 2 and beyond.

public int DetailTier

Field Value

int

Name

The player-facing name of the region.

public string Name

Field Value

string

Position

Centre of the region in world space.

public Vector3 Position

Field Value

Vector3

Radius

Horizontal radius of the region in metres. A position within this distance of Position is considered inside the region.

public float Radius

Field Value

float

RequiresDiscovery

Whether the player must have explored this region before its name is shown.

public bool RequiresDiscovery

Field Value

bool

Methods

Contains(Vector3)

Whether a position lies inside this region, ignoring height.

public bool Contains(Vector3 worldPosition)

Parameters

worldPosition Vector3

The position to test.

Returns

bool

True when the position is within Radius horizontally.

Remarks

Height is ignored on purpose. A region is an area on a map, and a player standing on a tower or at the bottom of a ravine inside a valley is still in that valley — testing the full 3D distance would name the region correctly at ground level and then stop naming it as soon as the player climbed anything.