Class PlayerCommandBase

Namespace

Shard.Gameplay.Universe.World.Commands

Assembly

Shard.Gameplay.Universe.dll

Command that runs one synchronous body against the invoking Player's current avatar.

public abstract class PlayerCommandBase : AsyncCommandBase, IAsyncCommand, ICommand

Inheritance

object

CommandDefinitionBase

AsyncCommandBase

PlayerCommandBase

Implements

IAsyncCommand

ICommand

Derived

GameModeCommand

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

Dispatch enters the exact captured World before calling Execute(CommandContext, Player, World, World, Entity). The Store and Entity are borrowed for that call only and must not be retained or used by asynchronous work.

Constructors

PlayerCommandBase(string, string, params string[])

Command that runs one synchronous body against the invoking Player's current avatar.

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

Parameters

name string

description string

aliases string[]

Remarks

Dispatch enters the exact captured World before calling Execute(CommandContext, Player, World, World, Entity). The Store and Entity are borrowed for that call only and must not be retained or used by asynchronous work.

Methods

Execute(CommandContext, Player, World, World, Entity)

protected abstract void Execute(CommandContext context, Player player, World world, World store, Entity avatar)

Parameters

context CommandContext

player Player

world World

store World

avatar Entity

ExecuteAsync(CommandContext, CancellationToken)

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

Parameters

context CommandContext

cancellationToken CancellationToken

Returns

ValueTask