CommandHandle

What a plugin exposes per command, city.commands.place: its name, plugin.key, and what it declared. sendCommand sends it, one system’s answers names it and readCommands reads it.

Extends

• CommandDeclaration<Fields, Reason, Returns, ActsThrough, EndsWithLevel, Predicted>

Type Parameters

Type Parameter	Default type
Fields extends CommandFields	CommandFields
Reason extends string	string
Returns extends ReturnFields | undefined	ReturnFields | undefined
ActsThrough extends boolean	boolean
EndsWithLevel extends boolean	boolean
Key extends string	string
Predicted extends boolean	boolean

Properties

Property	Modifier	Type	Description
[commandHandleBrand]?	readonly	true	-
burst	readonly	number	-
endsWithLevel?	readonly	EndsWithLevel	Whether its lifetime is Level: what its refusals’ type reads, kept as a flag so a declaration’s type names no enum member.
entity	readonly	ActsThrough	-
fields	readonly	Fields	-
key	readonly	Key	Its key under its plugin’s commands, which a merged read’s command.key names.
keys	readonly	readonly KeyCode[]	The keys and touch button that send it.
lateTicks	readonly	number	How late a predicted command may reach the room and still run.
lifetime	readonly	CommandLifetime	-
name	readonly	string	plugin.key, as the dump, the devtools and the wire name it.
perSecond	readonly	number	-
plugin	readonly	string	-
predicted	readonly	Predicted	-
refusals	readonly	readonly Reason[]	-
returns	readonly	Returns	-
timeoutSeconds	readonly	number	-
touch?	readonly	TouchControl	-