Class BanCommand

Ban a player.

Remarks

the /ban command.

Hierarchy (View Summary)

Command
- BanCommand

Index

Constructors

Properties

aliases? description id permission?

Accessors

Methods

Constructors

constructor

new BanCommand(): BanCommand
Returns BanCommand
Overrides Command.constructor
- Defined in packages/prismarine/src/command/vanilla/BanCommand.ts:13

Properties

`Optional`aliases

aliases?: string[]

The command's aliases.

description

description: string

The command's description.

id

id: string

The command's id in a [namespace]:[id] format.

`Optional`permission

permission?: string

The command's permission.

Accessors

name

get name(): string
Returns string
Inherited from Command.name
- Defined in packages/prismarine/src/command/Command.ts:16

Methods

register

register(dispatcher: CommandDispatcher<any>): Promise<void>
Register the command.
Parameters
- dispatcher: CommandDispatcher<any>
Returns Promise<void>
Overrides Command.register
- Defined in packages/prismarine/src/command/vanilla/BanCommand.ts:21

usage

usage(dispatcher: CommandDispatcher<any>): string
Parameters
- dispatcher: CommandDispatcher<any>
Returns string
Inherited from Command.usage
- Defined in packages/prismarine/src/command/Command.ts:47