Table of Contents

Interface IWaypoint

Namespace
FishMMO.Shared.Core
Assembly
FishMMO.Shared.dll

A discoverable fast-travel point. Interacting with one unlocks it for the character; once unlocked it can be travelled to from the world map.

public interface IWaypoint : IInteractable, ISceneObject
Inherited Members

Remarks

Identity is the pair (SceneName, WaypointIndex). The index is authored on the component and must be unique within its scene; it is the bit position the character's unlock record stores, which is why it is a small integer and not a name or a GUID — see WaypointUnlockMask.

Properties

ArrivalPoint

Where a travelling character lands. Falls back to the waypoint's own transform.

Transform ArrivalPoint { get; }

Property Value

Transform

Description

Optional description shown in the map's waypoint panel.

string Description { get; }

Property Value

string

OnTravelTriggers

Triggers invoked server-side after a character arrives here by fast travel.

List<Trigger> OnTravelTriggers { get; }

Property Value

List<Trigger>

SceneName

The name of the scene this waypoint stands in.

string SceneName { get; }

Property Value

string

TravelConditions

Designer-authored conditions a character must meet to travel here. Evaluated on the server against the traveller. Null or empty means no conditions.

List<BaseCondition> TravelConditions { get; }

Property Value

List<BaseCondition>

WaypointIndex

The authored index of this waypoint within its scene, from 0.

int WaypointIndex { get; }

Property Value

int

WaypointName

The player-facing name shown on the map.

string WaypointName { get; }

Property Value

string