Class MapMarker

Namespace

FishMMO.Shared

Assembly

FishMMO.Shared.dll

Makes an object appear on the minimap and the world map. Attach to any prefab — a character, an NPC, a gathering node, a door — that players should be able to find.

public class MapMarker : MonoBehaviour

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

MapMarker

Inherited Members

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.didStart

MonoBehaviour.didAwake

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.GetComponentIndex()

Component.CompareTag(string)

Component.CompareTag(TagHandle)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.transformHandle

Component.gameObject

Component.tag

Object.GetEntityId()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectsByType(Type)

Object.FindObjectsByType(Type, FindObjectsInactive)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsByType<T>()

Object.FindObjectsByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Remarks

What replaced what. This supersedes the old MinimapIcon, which spawned a child SpriteRenderer onto a dedicated "Minimap" layer at a fixed world height of 999 so that an overhead camera would photograph it. That approach could not do most of what a map needs — a sprite in a render texture has no label, no tooltip, cannot be clamped to the edge of the frame when its object is off screen, and scales with the map's zoom instead of staying legible. Worse, it made map visibility a property of a Unity layer: anything on that layer was on the map, whether or not the player was supposed to know where it was, and the only way to hide one thing from one player was to move a GameObject between layers at runtime.

What this does instead. The component is data and a registration; it spawns nothing and renders nothing. The client's map panels read MapMarkerRegistry, apply Visibility against the local player's relationship to this object, and draw the survivors as UI elements. Every marker is therefore filtered by a rule the map subsystem owns, and gains labels, tooltips, edge clamping and zoom-independent sizing for free.

Server builds. Registration is compiled out under UNITY_SERVER. The component still exists there so shared prefabs deserialise identically on both sides — stripping the type would make every prefab that carries one log a missing-script warning on the server — but it holds no state and does no work.

Fields

ClampToEdge

Whether the marker is pinned to the edge of the frame, pointing at its object, when the object is outside the current view.

[Tooltip("Pin the marker to the frame edge, pointing at the object, when it is off the map view.")]
public bool ClampToEdge

Field Value

bool

Icon

Icon drawn for this marker. Falls back to the type's default when null.

[Tooltip("Icon drawn for this marker. Uses the type's default icon when empty.")]
public Sprite Icon

Field Value

Sprite

IconSize

Size of the icon in UI points at the map's base scale.

[Tooltip("Size of the icon in UI points at the map's base scale.")]
public float IconSize

Field Value

float

Label

Text drawn beside the icon. Empty means no label.

[Tooltip("Static text drawn beside the icon. Leave empty for no label.")]
public string Label

Field Value

string

Remarks

Never used for a character's name. Names come from the character itself and are suppressed for anything the detection rule covers — a name attached to a throttled position would hand a modified client the one piece of information the throttling exists to withhold.

MarkerAnchor

Where the marker is drawn. Defaults to this transform.

[Tooltip("Optional transform the marker is drawn at. Uses this object when empty.")]
public Transform MarkerAnchor

Field Value

Transform

Remarks

Overridable so a marker on a large object can sit at its entrance rather than at its pivot, which for a building is usually its corner.

Priority

Draw priority when markers overlap. Higher wins; ties fall back to the type ordinal.

[Tooltip("Draw priority when markers overlap. Higher draws on top.")]
public int Priority

Field Value

int

ShowOnMinimap

Whether the marker is drawn on the minimap.

[Tooltip("Draw this marker on the minimap.")]
public bool ShowOnMinimap

Field Value

bool

ShowOnWorldMap

Whether the marker is drawn on the world map.

[Tooltip("Draw this marker on the world map.")]
public bool ShowOnWorldMap

Field Value

bool

Tint

Tint multiplied into the icon.

[Tooltip("Tint multiplied into the icon.")]
public Color Tint

Field Value

Color

Type

What this marker represents.

[Tooltip("What this marker represents. Drives the default icon, draw order and filter row.")]
public MapMarkerType Type

Field Value

MapMarkerType

Visibility

The rule deciding whether the local player may see this marker.

[Tooltip("Rule deciding whether the local player may see this marker.")]
public MapMarkerVisibility Visibility

Field Value

MapMarkerVisibility

Remarks

Left at Always for world fixtures. A prefab that can be a player character should use Detection: the runtime promotes it to full fidelity for party and guild members by itself, so authoring the strict rule costs nothing and a prefab that is never revisited stays safe.

Properties

Character

The character this marker belongs to, when it is on one. Null for world fixtures.

public ICharacter Character { get; }

Property Value

ICharacter

Remarks

Resolved once, on enable, and used by the client to work out the live relationship between the local player and this object. Cached rather than looked up per frame because GetComponent against an interface walks every component on the GameObject, and the map refreshes this for every marker in view.

FacingDegrees

The direction the marker's icon faces, in degrees clockwise from world north.

public float FacingDegrees { get; }

Property Value

float

Position

The world position the marker is drawn at.

public Vector3 Position { get; }

Property Value

Vector3