GODPAPER | All Packages | All Classes | Index | Frames No Frames |
PlayerIoPlugin

Package | com.godpaper.as3.plugins.playerIO
Class | public class PlayerIoPlugin
Inheritance | PlayerIoPlugin Object
Implements | com.godpaper.as3.plugins.IPlug

PlayerIoPlugin.as class.

See also

http://playerio.com/documentation/gettingstarted/flashcombopackage
http://playerio.com/documentation/reference/actionscript3

Public Properties

| Property | Defined By
--- | --- | ---
|  | connection : Connection | PlayerIoPlugin
|  | data : IPlugData [read-only] | PlayerIoPlugin
|  | roomID : String | PlayerIoPlugin
|  | signal_game_reset : Signal | PlayerIoPlugin
|  | signal_game_tie : Signal | PlayerIoPlugin
|  | signal_hoster_joined : Signal | PlayerIoPlugin
|  | signal_piece_placed : Signal | PlayerIoPlugin
|  | signal_player_win : Signal | PlayerIoPlugin
|  | signal_room_refreshed : Signal | PlayerIoPlugin
|  | signal_user_joined : Signal | PlayerIoPlugin

Public Methods

| Method | Defined By
--- | --- | ---
|  | PlayerIoPlugin(gameID:String, boardID:String) | PlayerIoPlugin
|  | createJoinRoom(name:String):void | PlayerIoPlugin
|  | createRoom(name:String, peerID:String, roleIndex:int = 0):void | PlayerIoPlugin
|  | initialization():void | PlayerIoPlugin
|  | joinRoom(id:String, peerID:String, roleIndex:int = 0):void | PlayerIoPlugin
|  | refreshRoomList():void | PlayerIoPlugin
|  | saveData(value:Object):Boolean | PlayerIoPlugin
|  | showData():Boolean | PlayerIoPlugin
|  | showLeaderboard(value:Object):Boolean | PlayerIoPlugin
|  | showLoginWidget():Boolean | PlayerIoPlugin
|  | showStore():Boolean | PlayerIoPlugin
|  | submitData(value:Object):Boolean | PlayerIoPlugin

Property Detail

connection | property

`public var connection:Connection`

data | property |

`data:IPlugData` [read-only]

Implementation
`public function get data():IPlugData`

roomID | property |

`public var roomID:String`

signal_game_reset | property |

`public var signal_game_reset:Signal`

signal_game_tie | property |

`public var signal_game_tie:Signal`

signal_hoster_joined | property |

`public var signal_hoster_joined:Signal`

signal_piece_placed | property |

`public var signal_piece_placed:Signal`

signal_player_win | property |

`public var signal_player_win:Signal`

signal_room_refreshed | property |

`public var signal_room_refreshed:Signal`

signal_user_joined | property |

`public var signal_user_joined:Signal`

Constructor Detail

PlayerIoPlugin | () | Constructor

`public function PlayerIoPlugin(gameID:String, boardID:String)`

Parameters

| `gameID:String`
| `boardID:String`

Method Detail

createJoinRoom | () | method

`public function createJoinRoom(name:String):void`

Parameters

| `name:String`

createRoom | () | method |

`public function createRoom(name:String, peerID:String, roleIndex:int = 0):void`

Parameters

| `name:String`
| `peerID:String`
| `roleIndex:int` (default = `0`)``

initialization | () | method |

`public function initialization():void`

joinRoom | () | method |

`public function joinRoom(id:String, peerID:String, roleIndex:int = 0):void`

Parameters

| `id:String`
| `peerID:String`
| `roleIndex:int` (default = `0`)``

refreshRoomList | () | method |

`public function refreshRoomList():void`

saveData | () | method |

`public function saveData(value:Object):Boolean`

Parameters

| `value:Object`

Returns

| `Boolean`

showData | () | method |

`public function showData():Boolean`

Returns

| `Boolean`

showLeaderboard | () | method |

`public function showLeaderboard(value:Object):Boolean`

Parameters

| `value:Object`

Returns

| `Boolean`

showLoginWidget | () | method |

`public function showLoginWidget():Boolean`

Returns

| `Boolean`

showStore | () | method |

`public function showStore():Boolean`

Returns

| `Boolean`

submitData | () | method |

`public function submitData(value:Object):Boolean`

Parameters

| `value:Object`

Returns

| `Boolean`

Thu Jan 16 2014, 01:11 PM +08:00