Class Multiplayer

Object
   |
   +--Multiplayer

class Multiplayer

This is the core object of the multiplayer interface. Typically, this interface is used by constructing a new object, registering a listener to hear when the login is complete, and calling the login() function.

A typical instance might look like this:

Field Detail

game

Game game

This object holds the status of the current game. It will be null until after the user is successfully logged in.

username

String username

The username seen by the server and other users. The value is "null" prior to a successful login. Note that the final username may differ from the requested username. This is to ensure that usernames are unique. Your code should never assume that the username it requested during login is the same username it will receive after the login is complete.

Multiplayer

Multiplayer()

Create a new multiplayer session.

addEventListener

void addEventListener(<String> type, <Function> handler, <boolean> capture)

Registers an event listener for a given event.

Supported Events:
login - Login success or failure.
transfer - Fired when the player is moved to a different room.
gamestart - The game in the current Stadium has started.
gamereset - The game in the current Stadium has ended.
messagearrive - The server has sent a message to this client.
disconnect - Client has been disconnected from the server.

Parameters:
type - The name of the event to listen for.
handler - The function to call when the event is fired.
capture - Reserved. Always pass false for this parameter.

checkMessages

void checkMessages()

This function must be called on a regular basis for messages to be processed. In Flash programs, it can be placed in an onEnterFrame() loop. In Javascript programs, it can be called from a function registered with setInterval() or setTimeout().

dispatchEvent

void dispatchEvent(<Event> event)

Fires an event off to all registered listeners. The type of the event is taken from the event object.

Parameters:
event -

isWii

boolean isWii()

Used to detect if we are running on the Nintendo Wii or not.

Returns:
True if the browser is on the Wii, False otherwise.

login

void login(<String> username, <String> gamename)

This object will not establish a connection to the server until this function is called. You must provide this function with both the desired username and the game that you wish to connect to.

Note that the server may change the username to ensure unique identities. So you should check the returned username rather than remembering what you pass to this function.

Parameters:
username - The username you wish to use.
gamename - The game to connect to.

See:
- username
- addEventListener()

removeEventListener

void removeEventListener(<String> type, <Function> handler, <boolean> capture)

Removes a previously registered event handler.

Parameters:
type - The name of the event listened for.
handler - The function to call when the event is fired.
capture - Reserved. Always pass false for this paramter.

See:
- addEventListener()

toString

String toString()

Returns "[Object Multiplayer]" to help distinguish the type of the object.