Struct WaypointTravelOptions

Namespace

FishMMO.Shared

Assembly

FishMMO.Shared.dll

Options a caller passes to TryTravel(IPlayerCharacter, IWaypoint, in WaypointTravelOptions, out WaypointTravelRefusalReason). The server's map request uses the defaults; a designer's TeleportToWaypointAction may relax them.

public readonly struct WaypointTravelOptions

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

WaypointTravelOptions(bool, bool, bool)

public WaypointTravelOptions(bool requireUnlocked, bool evaluateConditions, bool allowInCombat)

Parameters

requireUnlocked bool

evaluateConditions bool

allowInCombat bool

Fields

AllowInCombat

Permit travel while flagged in combat. Off for anything a player initiates.

public readonly bool AllowInCombat

Field Value

bool

Default

The rules a player's own map request is held to.

public static readonly WaypointTravelOptions Default

Field Value

WaypointTravelOptions

EvaluateConditions

Refuse unless the waypoint's authored travel conditions pass.

public readonly bool EvaluateConditions

Field Value

bool

RequireUnlocked

Refuse unless the traveller has discovered the waypoint.

public readonly bool RequireUnlocked

Field Value

bool