(info) This AI is still in early stages of development.

chat.stop()

Owned by Aubergine
Last updated: Nov 11, 2012Version comment
1 min read
Stop a conversation with a specific player.

 

Syntax

chat.stop(player);

Parameters

ParameterTypeMandatoryNotesChat Ver
playerNumber(error)

The ID of the player whose conversation will be extended.

Default: Stop conversations with all players.

0.1

Return Values

ValueTypeNotesChat Ver
<error>ErrorParameters specified were invalid (see error message for details).1.0
trueBooleanAll conversations (with all players) have been stopped.1.0
<cdo>Conversation Descriptor Object

The CDO associated with the player.

1.0

Example

Stop conversation with player 4
// conversation with player 4 will be stopped (immediately expired)
var p4cdo = chat.stop(4);
 
p4cdo.expires; // -1
 
chat.isActive(4); // false
Availability BETA

Requires:

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...

Â