| Excerpt |
|---|
Extend the "Time to Live" of a conversation. |
Syntax
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
chat.extend(player, ttl); |
Parameters
| 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 |
Return Values
| 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 |
| <conversation><cdo> | Conversation Descriptor Object | An object describing the conversation with the following properties:
The same object is used throughout a game session (does not survive the save/load cycle) so you can use it to store custom properties relating to conversations. Just remember to re-initialise any properties whenever a conversation startsIf the conversation was extended successfully, it's CDO will be returned. | 0.1 |
Example
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
// conversation with player 4 will be extended for 15 seconds from current time chat.extend(4); |
| Div | ||
|---|---|---|
| ||
The conversation cannot be extended if the CDO associated with the player has a missing or invalid Conversation Handler Function. |
| Div | ||||||
|---|---|---|---|---|---|---|
| ||||||
Availability
Requires:
|
| Div | ||||
|---|---|---|---|---|
| ||||
ContentsJump to:
|
| Div | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Chat APITopics:
|