chat.extend()

Extend the "Time to Live" of a conversation.

Syntax

chat.extend(player, ttl);

Parameter

Type

Mandatory

Notes

Chat Ver

player

Number

The ID of the player whose conversation will be extended.

0.1

ttl

Number

Time To Live (TTL) specified in milliseconds.

Default: 15000

0.1

Value	Type	Notes	Chat Ver
<error>	Error	Parameters specified were invalid (see error message for details) or the Conversation Handler Function for the player is missing or invalid.	0.1
<cdo>	Conversation Descriptor Object	If the conversation was extended successfully, it's CDO will be returned.	0.1

Extend conversation with player 4

// conversation with player 4 will be extended for 15 seconds from current time
chat.extend(4);

The conversation cannot be extended if the CDO associated with the player has a missing or invalid Conversation Handler Function.

Requires:

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.