Table of Contents

Struct PluginEquipmentCommandResult

Namespace
AcDream.Plugin.Abstractions
Assembly
AcDream.Plugin.Abstractions.dll

The outcome of one equip request, with an optional explanation.

public readonly record struct PluginEquipmentCommandResult : IEquatable<PluginEquipmentCommandResult>
Implements
Inherited Members

Constructors

PluginEquipmentCommandResult(PluginEquipmentCommandStatus, string?)

The outcome of one equip request, with an optional explanation.

public PluginEquipmentCommandResult(PluginEquipmentCommandStatus Status, string? Notice = null)

Parameters

Status PluginEquipmentCommandStatus

What the client did with the request.

Notice string

A short human-readable reason, when there is one.

Properties

Accepted

True when the item is now on its way to the requested slot, or was already there.

public bool Accepted { get; }

Property Value

bool

Notice

A short human-readable reason, when there is one.

public string? Notice { get; init; }

Property Value

string

Status

What the client did with the request.

public PluginEquipmentCommandStatus Status { get; init; }

Property Value

PluginEquipmentCommandStatus