Class DeliveryRegistry

Namespace

S1API.Deliveries

Assembly

S1API.dll

Discovers active deliveries and immutable delivery-history snapshots.

public static class DeliveryRegistry

Inheritance

object

DeliveryRegistry

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

This API intentionally does not create, mutate, or complete deliveries. Those operations are server-authoritative native flows and are not exposed until they can be represented safely.

Methods

GetAll()

Gets an immutable snapshot of all active deliveries.

public static IReadOnlyList<Delivery> GetAll()

Returns

IReadOnlyList<Delivery>

GetById(string)

Finds an active delivery by its unique identifier.

public static Delivery? GetById(string id)

Parameters

id string

The delivery identifier to find.

Returns

Delivery

The delivery wrapper, or null when no active delivery matches.

GetForShop(Shop)

Gets an immutable snapshot of active deliveries placed with a shop.

public static IReadOnlyList<Delivery> GetForShop(Shop shop)

Parameters

shop Shop

The wrapped shop whose deliveries should be returned.

Returns

IReadOnlyList<Delivery>

Exceptions

ArgumentNullException

Thrown when shop is null.

GetForShop(string)

Gets an immutable snapshot of active deliveries placed with a shop name.

public static IReadOnlyList<Delivery> GetForShop(string shopName)

Parameters

shopName string

The stable native shop name stored on delivery records.

Returns

IReadOnlyList<Delivery>

GetHistory()

Gets an immutable snapshot of the delivery receipts visible in the in-game order history.

public static IReadOnlyList<DeliveryReceipt> GetHistory()

Returns

IReadOnlyList<DeliveryReceipt>

Events

Completed

Raised after a delivery's native status becomes Completed.

public static event Action<Delivery>? Completed

Event Type

Action<Delivery>

Created

Raised after an active delivery is received by the game.

public static event Action<Delivery>? Created

Event Type

Action<Delivery>

StatusChanged

Raised after an active delivery changes lifecycle state. The second and third callback values are the previous and current states.

public static event Action<Delivery, DeliveryStatus, DeliveryStatus>? StatusChanged

Event Type

Action<Delivery, DeliveryStatus, DeliveryStatus>