ActionScript3 Reference
Class Multiplayer
Namespace: playerio
Language: ActionScript 3
Provides access to the Multiplayer services provided by Player.IO.
Properties | |||
|---|---|---|---|
| public |
If defined the system will connect to a local development server instead of a live server. |
||
Methods | |||
| public |
Creates or joins a room of the specified server type. |
||
| public |
Creates a room of the specified server type. |
||
| public |
Joins an already existing room |
||
| public |
List all room instances of a specific server type |
||
Multiplayer.developmentServer
| public |
|
If defined the system will connect to a local development server instead of a live server.
Example
The following example connects to a development server running on localhost on port 8184
Multiplayer.createJoinRoom
| public |
|
Creates or joins a room of the specified server type.
Arguments
| roomId:String | |
| The id of the room, if set to null the room is assigned a random id | |
| roomType:String | |
| The type of room we should start | |
| visible:Boolean | |
| If the room should be returned when doing a listRooms request | |
| roomData:Object | |
| Init data, this init data can be read on by server: {Name:"MyRoom", Level:3} | |
| joinData:Object | |
| User join data, this join data can be read by the server: {Name:"Chris", Type:"Sniper"} | |
| callback:Function (Default = null) | |
| Method executed when the createJoinRoom call executed successfully: function(connection:Connection):void{...} | |
| errorHandler:Function (Default = null) | |
| Method executed if the createJoinRoom request failed: function(error:PlayerIOError):void{...} |
Multiplayer.createRoom
| public |
|
Creates a room of the specified server type.
Arguments
| roomId:String | |
| The id of the room, if set to null the room is assigned a random id | |
| roomType:String | |
| The type of room we should start | |
| visible:Boolean | |
| If the room should be returned when doing a listRooms request | |
| roomData:Object | |
| Init data, this init data can be read by server: {Name:"MyRoom", Level:3} | |
| callback:Function (Default = null) | |
| Method executed when the createRoom call executed successfully, returns the id of the created room: function(roomId:String):void{...} | |
| errorHandler:Function (Default = null) | |
| Method executed if the joinRoom request failed: function(error:PlayerIOError):void{...} |
Multiplayer.joinRoom
| public |
|
Joins an already existing room
Arguments
| roomId:String | |
| The id of the room we wish to join | |
| joinData:Object | |
| User join data, this join data can be read by the server: {Name:"Chris", Type:"Sniper"} | |
| callback:Function (Default = null) | |
| Method executed when the joinRoom call executed successfully: function(connection:Connection):void{...} | |
| errorHandler:Function (Default = null) | |
| Method executed if the joinRoom request failed: function(error:PlayerIOError):void{...} |
Multiplayer.listRooms
| public |
|
List all room instances of a specific server type
Arguments
| roomType:String | |
| The type of room we should list | |
| searchCriteria:Object | |
| Compares the properties of the parsed object to properties on the roomData object and returns only perfect matches. Passing the object {level:"3"} returns only rooms which have level defined as 3 on the roomData object. To use search criteria you must first define what properties are searchable under the Multiplayer menu option for your game. | |
| resultLimit:int | |
| How many room instances should we load from the server | |
| resultOffset:int | |
| At what offset should we list from | |
| callback:Function (Default = null) | |
| Method executed when the listRooms call executed successfully: function(rooms:Array<RoomInfo>):void{...} | |
| errorHandler:Function (Default = null) | |
| Method executed if the listRooms request failed: function(error:PlayerIOError):void{...} |