Class DeliveryLocation

Namespace

S1API.Map

Assembly

S1API.dll

Wrapper for a base-game delivery location.

public sealed class DeliveryLocation

Inheritance

object

DeliveryLocation

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ReflectionUtils.GetValueTupleItems(object)

ReflectionUtils.IsValueTuple(object)

Properties

CustomerStandPoint

Customer standing position.

public Transform CustomerStandPoint { get; }

Property Value

Transform

Description

Human-readable description for UI.

public string Description { get; }

Property Value

string

GUID

GUID string identifier used by the base game.

public string GUID { get; }

Property Value

string

Name

Location display name.

public string Name { get; }

Property Value

string

TeleportPoint

Teleport target point near the location.

public Transform TeleportPoint { get; }

Property Value

Transform

Methods

GetAll()

Returns all known delivery locations (sorted by name).

public static DeliveryLocation[] GetAll()

Returns

DeliveryLocation[]

GetByGuid(string)

Returns a delivery location by GUID string.

public static DeliveryLocation GetByGuid(string guid)

Parameters

guid string

Returns

DeliveryLocation

GetByName(string)

Returns a delivery location by case-insensitive name match.

public static DeliveryLocation GetByName(string name)

Parameters

name string

Returns

DeliveryLocation

Get<T>()

Resolves a delivery location using a typed identifier T. Declare an identifier class annotated with [DeliveryLocations.DeliveryLocationName("...")].

public static DeliveryLocation Get<T>() where T : IDeliveryLocationIdentifier

Returns

DeliveryLocation

Type Parameters

T