#Class: Command

Defined in: sapi/runtime/command.ts:139

游戏内原生自定义指令的声明表与触发器。

#Accessors

#list

#Get Signature

get static list(): Record<string, CommandEntry>;

Defined in: sapi/runtime/command.ts:141

已注册指令表（名称 → 条目）。

#Returns

Record<string, CommandEntry>

#Set Signature

set static list(value: Record<string, CommandEntry>): void;

Defined in: sapi/runtime/command.ts:144

#Parameters

#Returns

void

#deductCost

#Get Signature

get static deductCost(): 
  | ((player: Player, amount: number, commandName: string) => Promise<boolean>)
  | null;

Defined in: sapi/runtime/command.ts:148

费用扣减回调；由 Economy 模块在启动时注入。

#Returns

| ((player: Player, amount: number, commandName: string) => Promise<boolean>) | null

#Set Signature

set static deductCost(value: 
  | ((player: Player, amount: number, commandName: string) => Promise<boolean>)
  | null): void;

Defined in: sapi/runtime/command.ts:151

#Parameters

#Returns

void

#Constructors

#Constructor

new Command(): Command;

#Returns

Command

#Methods

#register()

static register(
   name: string, 
   permission: string | number, 
   callback: (player: Player | undefined, ...args: unknown[]) => any, 
   description?: string, 
   moduleId?: string, 
   cost?: CommandCost, 
   options?: CommandOptions): boolean;

Defined in: sapi/runtime/command.ts:167

声明一条游戏内原生自定义指令。

#Parameters

#Returns

boolean

注册成功始终返回 true。

#unregister()

static unregister(name: string): boolean;

Defined in: sapi/runtime/command.ts:196

注销指定的指令。

#Parameters

#Returns

boolean

若指令存在且成功删除返回 true，否则返回 false。

#unregisterByModule()

static unregisterByModule(moduleId: string): number;

Defined in: sapi/runtime/command.ts:211

按模块 id 批量注销该模块名下的所有指令。

#Parameters

#Returns

number

实际被注销的指令条数。

#has()

static has(name: string): boolean;

Defined in: sapi/runtime/command.ts:228

判断指定指令是否已注册。

#Parameters

#Returns

boolean

#names()

static names(): string[];

Defined in: sapi/runtime/command.ts:233

获取所有已注册指令的名称列表。

#Returns

string[]

#entries()

static entries(): {
  name: string;
  permission: string | number;
  description: string;
  moduleId?: string;
  aliases?: string[];
}[];

Defined in: sapi/runtime/command.ts:238

获取已注册指令的只读快照列表（沙箱装载清单及管理界面使用）。

#Returns

{ name: string; permission: string | number; description: string; moduleId?: string; aliases?: string[]; }[]

#getModuleId()

static getModuleId(name: string): string | undefined;

Defined in: sapi/runtime/command.ts:262

获取指定指令所属的模块 id。

#Parameters

#Returns

string | undefined

若指定了所属模块则返回其 id，否则返回 undefined。

#trigger()

static trigger(
   player: Player | undefined, 
   message: string, ...
   args: unknown[]): void;

Defined in: sapi/runtime/command.ts:286

触发指令执行流程：依次校验模块守卫、权限与费用后执行回调。

#Parameters

#Returns

void

#registerHelpCommand()

static registerHelpCommand(): void;

Defined in: sapi/runtime/command.ts:325

注册内置 /c:help 指令，列出当前玩家有权限的指令。

#Returns

void

#nativeName()

static nativeName(name: string): string;

Defined in: sapi/runtime/command.ts:367

生成统一的原生命令名：所有命令均公开为 c:name。

#Parameters

#Returns

string

#registerNativeCommands()

static registerNativeCommands(registry: CustomCommandRegistry): void;

Defined in: sapi/runtime/command.ts:372

在 startup early-execution 阶段把全部声明提交给原生命令注册表。

#Parameters

#Returns

void