This AI is still in early stages of development.
chat.on()
Define a chat command and it's handler function.
Syntax
chat.on(command, handler);
Parameters
| Parameter | Type | Mandatory | Notes | Chat Ver |
|---|---|---|---|---|
| command | String |  | The chat command to register.
| 0.1 |
| handler | Command Handler Function | | The function that will be called when a user issues the command. | 0.1 |
Must not contain spaces! Return Values
| Value | Type | Notes | Chat Ver |
|---|---|---|---|
| <error> | Error | Parameters specified were invalid (see error message for details). | 0.1 |
| true | Boolean | The command handler was registered successfully. | 0.1 |
Example
chat.on("help", myHelpHandlerFn);
Contents
Jump to:
Chat API
Topics:
- Chat API Diagnostics — The Chat API provides the following diagnostic routines...
- Conversation Descriptor Object — Each player is assigned a Conversation Descriptor Object that defines the current state of their chat conversation...
- Conversation Mode — Quick start guide for making and using conversations...
- chat.isActive() — Determine conversation state for a specific player.
- chat.get() — Get the object associated with a multi-message conversation with a specific player.
- chat.stop() — Stop a conversation with a specific player.
- chat.extend() — Extend the "Time to Live" of the most recent conversation with a player.
- Conversation Handler Functions — How to define a conversation handler function....
- chat.start() — Start a multi-message conversation with a player.
- Command Mode — Quick start guide for creating and using commands...
- Command Handler Functions — How to define a command handler function....
- chat.on() — Define a chat command and it's handler function.