Multiuser Lingo Dictionary > Multiuser Lingo Dictionary > checkNetMessages |  |

checkNetMessages

Syntax

    gMultiuserInstance.checkNetMessages({numberOfMessages})

Description

Multiuser Server Lingo command; forces a check for any incoming messages and calls the callback handlers specified by `setNetMessageHandler()`. It is necessary only when the movie itself does not allow the normal idle time in which the Xtra would check for incoming messages automatically. The optional parameter defaults to 1 and specifies the maximum number of messages to process. Setting this number to a high value can cause performance problems, since this function does not return until the waiting messages have been processed.

This function is useful in movies that sit in one frame with a `go to the frame` loop, for example. It should not be called from a message handler specified by the `setNetMessageHandler()` command, or by any handler called by a message handler (including `beginSprite`, `enterFrame`, and so on) that can be executed as the result of a `go to frame n` statement.

Example

This statement tells the Multiuser Xtra to check for incoming messages, with a maximum of four messages:

    errCode = gMultiuserInstance.checkNetMessages(4)

See also

`setNetMessageHandler`