Class ChatCommandEvent
Namespace: Void.Proxy.Api.Events.Commands
Assembly: Void.Proxy.Api.dll
Represents a chat command received from a linked player before it is forwarded to the server.
public record ChatCommandEvent : IScopedEventWithResult<bool>, IScopedEvent, IEventWithResult<bool>, IEvent, IEquatable<ChatCommandEvent>Inheritance
Implements
IScopedEventWithResult<bool>, IScopedEvent, IEventWithResult<bool>, IEvent, IEquatable<ChatCommandEvent>
Inherited Members
object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()
Constructors
ChatCommandEvent(ILink, IPlayer, string, bool)
Represents a chat command received from a linked player before it is forwarded to the server.
public ChatCommandEvent(ILink Link, IPlayer Player, string Command, bool IsSigned)Parameters
Link ILink
The active player-to-server link.
Player IPlayer
The player that submitted the command.
Command string
The command text without the leading command delimiter.
IsSigned bool
true when the received command carries a protocol signature; otherwise, false.
Properties
Command
The command text without the leading command delimiter.
public string Command { get; init; }Property Value
IsSigned
true when the received command carries a protocol signature; otherwise, false.
public bool IsSigned { get; init; }Property Value
Link
The active player-to-server link.
public ILink Link { get; init; }Property Value
Player
The player that submitted the command.
public IPlayer Player { get; init; }Property Value
Result
Gets or sets whether forwarding the command to the destination server is suppressed.
public bool Result { get; set; }