Messages Messages

Action Messages

• AT_DELAY - Executes the message specified as the second argument once the internal clock reaches a particular time computed from the time this was created and the delay (in seconds) specified.

  Parameters:

  • delay (float) - The delay before which this message should not be issued.

  • messageID (unicode) - The message to issue when the time is right.

  • messageData (tuple) - The data for the message, whatever it may be.

• AT_TIME - Executes the message specified as the second+third argument once the internal clock reaches a specified time.

  Parameters:

  • time (float) - The internal clock time before which this message should not be issued.

  • messageID (unicode) - The message to issue when the time is right.

  • messageData (tuple) - The data for the message, whatever it may be.

• DELAY_UNTIL_MESSAGE - Executes the message specified as the second argument once the message specified as the first argument is processed. Only one message is sent when the specified message arrives.

  Parameters:

  • MessageID (unicode) - The message that you are waiting for.

  • messageID (unicode) - The message to issue when the message you are waiting for arrives.

  • messageData (tuple) - The data for the message.

• DELAY_UNTIL_MESSAGE_BATCH - Executes the message specified as the second argument once the message specified as the first argument is processed. All of the messages registered DELAY_UNTIL_MESSAGE_BATCH are sent when the correct message arrives and no nonbatch messages are sent.

  Parameters:

  • MessageID (unicode) - The message that you are waiting for.

  • messageID (unicode) - The message to issue when the message you are waiting for arrives.

  • messageData (tuple) - The data for the message.

• DIALOG_INTERPRETER_ADD - A client sends this message when it wants to receive and handle messages.

  Parameters:

  • client (object) - The message receiver.

• DIALOG_INTERPRETER_REMOVE - A client sends this message when it no longer wants to receive and handle messages. The client should have sent a DIALOG_INTERPRETER_ADD message earlier.

  Parameters:

  • client (object) - The message receiver.

• REFRESH - Causes the message dispatcher to break out of the message dispatch loop and thus forces a scene graph update and frame draw. This default maximum wait time for this message is 1.

• REMOVE_DELAYED_MESSAGE - Removes all delayed messages with the specified message identifier (added with DELAY_UNTIL_MESSAGE) from the message queue.

  Parameters:

  • MessageID (unicode) - The message identifier of the message(s) to be removed.

• CLOSE_CHUNK - Marks the end of a compound message.

  Parameters:

  • ChunkID (unicode) - The name of the chunk. Must correspond to the name in a preceding OPEN_CHUNK message.

• OPEN_CHUNK - Marks the beginning of a compound message.

  Parameters:

  • ChunkID (unicode) - The name of the chunk.