Class WorldCommandBase

Namespace

Shard.Gameplay.Universe.World.Commands

Assembly

Shard.Gameplay.Universe.dll

Command that runs one synchronous body in the invoking Player's current World.

public abstract class WorldCommandBase : AsyncCommandBase, IAsyncCommand, ICommand

Inheritance

object

CommandDefinitionBase

AsyncCommandBase

WorldCommandBase

Implements

IAsyncCommand

ICommand

Inherited Members

CommandDefinitionBase.Name

CommandDefinitionBase.Description

CommandDefinitionBase.Aliases

CommandDefinitionBase.Arguments

CommandDefinitionBase.Usage

CommandDefinitionBase.Permission

CommandDefinitionBase.DefaultPermission

CommandDefinitionBase.WithRequiredArg<T>(string, CommandArgumentParser<T>, string)

CommandDefinitionBase.WithDefaultArg<T>(string, CommandArgumentParser<T>, T, string)

CommandDefinitionBase.WithOptionalArg<T>(string, CommandArgumentParser<T>, string)

CommandDefinitionBase.WithFlagArg(string, params string[])

CommandDefinitionBase.WithFlagArg(string, string, params string[])

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

The Store is borrowed for Execute(CommandContext, World, World) only. Explicit World selection for terminal senders is not supported until command argument processing owns a World resolver.

Constructors

WorldCommandBase(string, string, params string[])

Command that runs one synchronous body in the invoking Player's current World.

protected WorldCommandBase(string name, string description, params string[] aliases)

Parameters

name string

description string

aliases string[]

Remarks

The Store is borrowed for Execute(CommandContext, World, World) only. Explicit World selection for terminal senders is not supported until command argument processing owns a World resolver.

Methods

Execute(CommandContext, World, World)

protected abstract void Execute(CommandContext context, World world, World store)

Parameters

context CommandContext

world World

store World

ExecuteAsync(CommandContext, CancellationToken)

public override sealed ValueTask ExecuteAsync(CommandContext context, CancellationToken cancellationToken)

Parameters

context CommandContext

cancellationToken CancellationToken

Returns

ValueTask