tgstation-server 6.12.0
The /tg/station 13 server suite
Loading...
Searching...
No Matches
ICommand.cs
Go to the documentation of this file.
1using System.Threading;
2using System.Threading.Tasks;
3
5
7{
11 public interface ICommand
12 {
16 string Name { get; }
17
21 string HelpText { get; }
22
26 bool AdminOnly { get; }
27
35 ValueTask<MessageContent> Invoke(string arguments, ChatUser user, CancellationToken cancellationToken);
36 }
37}
Represents a tgs_chat_user datum.
Definition ChatUser.cs:12
Represents a command that can be invoked by talking to chat bots.
Definition ICommand.cs:12
bool AdminOnly
If the command should only be available to ChatUsers who's ChatUser.Channel has ChannelRepresentation...
Definition ICommand.cs:26
ValueTask< MessageContent > Invoke(string arguments, ChatUser user, CancellationToken cancellationToken)
Invoke the ICommand.
string Name
The text to invoke the command. May not be "?" or "help" (case-insensitive).
Definition ICommand.cs:16
string HelpText
The help text to display when queires are made about the command.
Definition ICommand.cs:21