Packagecom.electrotank.electroserver4.message.request
Classpublic class JoinGameRequest
InheritanceJoinGameRequest Inheritance com.electrotank.electroserver4.message.request.RequestImpl

This request allows you to join a specific game managed by the Game Manager by specifying a game type and game id.



Public Methods
 MethodDefined by
  
Creates a new instance of the JoinGameRequest class.
JoinGameRequest
  
getGameId():Number
The id of the game you want to join.
JoinGameRequest
  
getGameType():String
The type of game you want to join.
JoinGameRequest
  
getPassword():String
The password being used to join the game.
JoinGameRequest
  
JoinGameRequest
  
setGameId(gameId:Number):void
Sets the id of the game you want to join.
JoinGameRequest
  
setGameType(gameType:String):void
The type of game you want to join.
JoinGameRequest
  
setPassword(password:String):void
If a password is needed to join this game, specify it here.
JoinGameRequest
  
JoinGameRequest
Constructor detail
JoinGameRequest()constructor
public function JoinGameRequest()

Creates a new instance of the JoinGameRequest class.

Method detail
getGameId()method
public function getGameId():Number

The id of the game you want to join.

Returns
Number — The id of the game you want to join.
getGameType()method 
public function getGameType():String

The type of game you want to join.

Returns
String — The type of game you want to join.
getPassword()method 
public function getPassword():String

The password being used to join the game.

Returns
String — The passowd being used to join the game.
getRealMessage()method 
public override function getRealMessage():Message

Returns
Message
setGameId()method 
public function setGameId(gameId:Number):void

Sets the id of the game you want to join.

Parameters
gameId:Number — The id of the game you want to join.
setGameType()method 
public function setGameType(gameType:String):void

The type of game you want to join. Game type is something that is registered on the server that defined the game, liked Chess.

Parameters
gameType:String — The type of game you want to join.
setPassword()method 
public function setPassword(password:String):void

If a password is needed to join this game, specify it here.

Parameters
password:String — The password needed to join the game, if any.
validate()method 
public override function validate():ValidationResponse

Returns
ValidationResponse