Package sfs3.client.requests.game

Class QuickJoinGameRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.game.QuickJoinGameRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class QuickJoinGameRequest
extends BaseRequest

Quickly joins the current user in a public game.

By providing a matching expression and a list of Rooms or Groups, SmartFoxServer can search for a matching public Game Room and immediately join the user into that Room as a player.

If a game could be found and joined, the roomJoin event is dispatched to the requester's client.

See Also:

• SFSEvent.ROOM_JOIN
• MatchExpression
• JoinRoomRequest

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_GROUP_LIST
static final String	KEY_MATCH_EXPRESSION
static final String	KEY_ROOM_LIST
static final String	KEY_ROOM_TO_LEAVE

Fields inherited from class sfs3.client.requests.BaseRequest

AddBuddy, AdminMessage, AutoJoin, BanUser, BanUsersFromRoom, BlockBuddy, CallExtension, ChangeRoomCapacity, ChangeRoomName, ChangeRoomPassword, ClusterInviteUsers, ClusterJoinOrCreate, CreateRoom, CreateSFSGame, FindRooms, FindUsers, GameServerConnectionRequired, GenericMessage, GetRoomList, GoOnline, Handshake, InitBuddyList, InvitationReply, InviteUser, JoinRoom, JoinRoomInvite, KEY_ERROR_CODE, KEY_ERROR_PARAMS, KickUser, LeaveRoom, Login, Logout, ManualDisconnection, ModeratorMessage, ObjectMessage, PingPong, PlayerToSpectator, PrivateMessage, PublicMessage, QuickJoinGame, QuickJoinOrCreateRoom, RemoveBuddy, SetBuddyVariables, SetRoomVariables, SetUserPosition, SetUserVariables, sfso, SpectatorToPlayer, SubscribeRoomGroup, targetController, UdpInit, UnsubscribeRoomGroup

Constructor Summary

Constructors

Constructor	Description
QuickJoinGameRequest(MatchExpression matchExpression, List<?> whereToSearch)
QuickJoinGameRequest(MatchExpression matchExpression, List<?> whereToSearch, Room roomToLeave)	Creates a new QuickJoinGameRequest instance.

Method Summary

Modifier and Type	Method	Description
void	execute(ISmartFox sfs)
void	validate(ISmartFox sfs)

Methods inherited from class sfs3.client.requests.BaseRequest

getId, getRequest, getTargetController, getTransportType, setId, setTargetController, setTransportType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

KEY_ROOM_LIST

public static final String KEY_ROOM_LIST

See Also:

• Constant Field Values

Internal

KEY_GROUP_LIST

public static final String KEY_GROUP_LIST

See Also:

• Constant Field Values

Internal

KEY_ROOM_TO_LEAVE

public static final String KEY_ROOM_TO_LEAVE

See Also:

• Constant Field Values

Internal

KEY_MATCH_EXPRESSION

public static final String KEY_MATCH_EXPRESSION

See Also:

• Constant Field Values

Internal

Constructor Details

QuickJoinGameRequest

public QuickJoinGameRequest(MatchExpression matchExpression,
 List<?> whereToSearch,
 Room roomToLeave)

Creates a new QuickJoinGameRequest instance. The instance must be passed to the SmartFox.send() method for the request to be performed.

Parameters:

matchExpression - A matching expression that the system will use to search a Game Room where to join the current user.

whereToSearch - An array of Room objects or an array of Group names to which the matching expression should be applied. The maximum number of elements that this array can contain is 32.

roomToLeave - A Room object representing the Room that the user should leave when joining the game.

See Also:

• SmartFox.send(sfs3.client.requests.IClientRequest)
• Room

QuickJoinGameRequest

public QuickJoinGameRequest(MatchExpression matchExpression,
 List<?> whereToSearch)

See Also:

• QuickJoinGameRequest(MatchExpression, List, Room)

Method Details

validate

public void validate(ISmartFox sfs)
              throws SFSValidationException

Throws:

SFSValidationException

Internal

execute

public void execute(ISmartFox sfs)

Internal