Struct PluginCombatCommandResult
- Namespace
- AcDream.Plugin.Abstractions
- Assembly
- AcDream.Plugin.Abstractions.dll
The outcome of one combat command, with an optional explanation.
public readonly record struct PluginCombatCommandResult : IEquatable<PluginCombatCommandResult>
- Implements
- Inherited Members
Constructors
PluginCombatCommandResult(PluginCombatCommandStatus, string?)
The outcome of one combat command, with an optional explanation.
public PluginCombatCommandResult(PluginCombatCommandStatus Status, string? Notice = null)
Parameters
StatusPluginCombatCommandStatusWhat the client did with the command.
NoticestringA short human-readable reason, when there is one.
Properties
Accepted
True when the command did what it was asked to, counting the cases where there was nothing left to do.
public bool Accepted { get; }
Property Value
Notice
A short human-readable reason, when there is one.
public string? Notice { get; init; }
Property Value
Status
What the client did with the command.
public PluginCombatCommandStatus Status { get; init; }