Represents a command made from DM code. More...

Inheritance diagram for Tgstation.Server.Host.Components.Chat.Commands.CustomCommand:

[legend]

Collaboration diagram for Tgstation.Server.Host.Components.Chat.Commands.CustomCommand:

[legend]

Public Member Functions

CustomCommand (string name, string helpText, bool adminOnly)

Initializes a new instance of the CustomCommand class.

void SetHandler (ICustomCommandHandler handler)

Set a new handler .

ValueTask< MessageContent > Invoke (string arguments, ChatUser user, CancellationToken cancellationToken)

Invoke the ICommand.

Parameters

arguments	The text after Name with leading whitespace trimmed.
user	The ChatUser who invoked the command.
cancellationToken	The CancellationToken for the operation.

Returns: A ValueTask<TResult> resulting in a MessageContent to send to the invoker.

Properties
string	Name `[get]`
	The text to invoke the command. May not be "?" or "help" (case-insensitive).

string	HelpText `[get]`
	The help text to display when queires are made about the command.

bool	AdminOnly `[get]`
	If the command should only be available to ChatUsers who's ChatUser.Channel has ChannelRepresentation.IsAdminChannel set.

Properties inherited from Tgstation.Server.Host.Components.Chat.Commands.ICommand

Private Attributes
ICustomCommandHandler?	handler
	The ICustomCommandHandler for the CustomCommand.

Detailed Description

Represents a command made from DM code.

Definition at line 12 of file CustomCommand.cs.

Constructor & Destructor Documentation

◆ CustomCommand()

Tgstation.Server.Host.Components.Chat.Commands.CustomCommand.CustomCommand	(	string	name,
		string	helpText,
		bool	adminOnly
	)

Initializes a new instance of the CustomCommand class.

Parameters

name	The value of Name.
helpText	The value of HelpText.
adminOnly	The value of AdminOnly.

Definition at line 34 of file CustomCommand.cs.

        {
            Name = name ?? throw new ArgumentNullException(nameof(name));
            HelpText = helpText ?? throw new ArgumentNullException(nameof(helpText));
            AdminOnly = adminOnly;
        }

References Tgstation.Server.Host.Components.Chat.Commands.CustomCommand.AdminOnly, Tgstation.Server.Host.Components.Chat.Commands.CustomCommand.HelpText, and Tgstation.Server.Host.Components.Chat.Commands.CustomCommand.Name.

Member Function Documentation

◆ Invoke()

ValueTask< MessageContent > Tgstation.Server.Host.Components.Chat.Commands.CustomCommand.Invoke	(	string	arguments,
		ChatUser	user,
		CancellationToken	cancellationToken
	)

Invoke the ICommand.

Parameters

arguments	The text after Name with leading whitespace trimmed.
user	The ChatUser who invoked the command.
cancellationToken	The CancellationToken for the operation.

Returns: A ValueTask<TResult> resulting in a MessageContent to send to the invoker.

Implements Tgstation.Server.Host.Components.Chat.Commands.ICommand.

Definition at line 53 of file CustomCommand.cs.

        {
            if (handler == null)
                throw new InvalidOperationException("SetHandler() has not been called!");
            return handler.HandleChatCommand(Name, arguments, user, cancellationToken);
        }

References Tgstation.Server.Host.Components.Chat.ICustomCommandHandler.HandleChatCommand(), Tgstation.Server.Host.Components.Chat.Commands.CustomCommand.handler, and Tgstation.Server.Host.Components.Chat.Commands.CustomCommand.Name.

Here is the call graph for this function:

◆ SetHandler()

void Tgstation.Server.Host.Components.Chat.Commands.CustomCommand.SetHandler ( ICustomCommandHandler handler )

Set a new handler .

Parameters

handler The value of handler.

Definition at line 45 of file CustomCommand.cs.

        {
            if (this.handler != null)
                throw new InvalidOperationException("SetHandler() already called!");
            this.handler = handler ?? throw new ArgumentNullException(nameof(handler));
        }