This AI is still in early stages of development.
chat.isActive()
Determine conversation state for a specific player.
Syntax
chat.isActive(player);
Parameters
| Parameter | Type | Mandatory | Notes | Chat Ver |
|---|---|---|---|---|
| player | Number |  | The ID of the player to check. | 0.1 |
Return Values
| Value | Type | Notes | Chat Ver |
|---|---|---|---|
| <error> | Error | Parameters specified were invalid (see error message for details). | 0.1 |
true | Boolean | Yes, we have an active conversation with this player. | 1.0 |
false | Boolean | No, we don't currently have an active conversation with the player. | 1.0 |
Example
Start a conversation with player 4
chat.start(3, myConvHandlerFn, 10000); chat.isActive(3); // true chat.stop(3); chat.isActive(3); // false chat.extend(3, 10000); // give them another 10 seconds chat.isActive(3); // true
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.