Ebnzo / command

Add ingame chat commands to your mod.

Cli Command

Fork of command allowing for commands to be typed into cli.

Usage

Custom chat commands may be preceded by /! or entered into the /proxy chat channel (overrides Private Channel 8 by default). To pass strings containing spaces as arguments, enclose them in quotes ("" or ''). To enclude quotes or backslashes in arguments, precede them with a backslash \.

Examples

/!mymod

/!mymod dostuff

/!mymod 123 456 'Hello ponies!'

/!mymod "This is a string containing 'quotes', \"similar quotes\", and \\backslashes."

Developers

To use Command in your module, first require it in your mod's initializer using mod.require.command (or destructuring shorthand).

Examples

module.exports = function MyMod(mod) {
	const {command} = mod.require

	command.add('mymod', (x, y, z) => {
		command.message('Parameters: ' + [x, y, z].join(', '))
	})
}

Sub-Commands:

module.exports = function SubCommandTest(mod) {
	const {command} = mod.require

	command.add('test', {
		$default(cmd) { command.message(`Unknown command "${cmd}".`) },
		$none() { command.message('Usage: test [echo|hello]') },
		echo(...args) {
			if(args[0] === undefined) command.message('Usage: test echo [msg]')
			else command.message(args.join(' '))
		},
		hello: {
			$default() { command.message('Usage: test hello [blue|red]') },
			blue() { command.message('<font color="#5555ff">Hello ponies!</font>') },
			red() { command.message('<font color="#ff5555">Hello ponies!</font>') }
		}
	})
}

Command

Methods

add(command, callback[, context])

Adds one or more command hooks. All commands must be unique and are case insensitive.

command may be a string or an array of strings.

callback may be a function or an object. Callback receives a variable number of input string arguments. If an object is provided, the object's keys are registered as sub-commands which may in turn be either a callback or another object. Two special keys are usable for sub-commands:

• $none called if there were no arguments.
• $default called with sub-command name as the first argument if no other hook was matched.

context optional this to pass to callbacks. Default is unspecified.

remove(command)

Removes one or more command hooks.

command may be a string or an array of strings.

message(msg)

Sends a message in the [Proxy] channel. May contain HTML.

exec(str)

Executes a raw command string. If str is an array then it will be interpreted as arguments instead.

Returns true on command found, false otherwise. May throw an exception if the callback contains an error.