This AI is still in early stages of development.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Current »

Each player is assigned a Conversation Descriptor Object that defines the current state of their chat conversation...

 

Properties

ParameterTypeNotesAPI Version
idNumber

The player ID this object is associated with.

1.0
expiresNumber

The real-world universal time, expressed in milliseconds since 1st Jan 1970, at which this conversation will expire.

You can quickly determine if a conversation is active for a given player using the chat.isActive() function.

1.0
fnConversation Handler Function

The function that will handle messages in a conversation.

You can change this at any time if you want to use a different handler for conversations with that player.

1.0
messageString

The most recent message from the player, even if it was not processed by Chat API.

In your handler functions, this will always be the message that the handler receives (but as a single string instead of an array of words).

1.0
<other>Variant

You can store any number of other properties on the object, for example to track previous conversations or commands, etc.

The properties only last for the current session and will not be persisted in savegames.

1.0

Example

Get conversation descriptor object for player 4
var p4conv = chat.get(4); // get player 4's conversation object
 
if (now < p4conv.timeout) {
  // conversation still active
}
 
if chat.isActive(4) {
  // conversation still active
}
 
// set a different function to handle this conversation
p4conv.fn = someNewHandlerFn;
 
// add custom "foo" property with value "bar".
p4conv.foo = "bar";
Availability BETA

Requires:

Contents

Jump to:

Chat API

Topics:

 

  • No labels