Package sfs3.client.requests.game

Class CreateSFSGameRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.game.CreateSFSGameRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class CreateSFSGameRequest
extends BaseRequest

Creates a new public or private game, including player matching criteria, invitations settings and more.

A game is created through the instantiation of a SFSGame on the server-side, a specialized Room type that provides advanced features during the creation phase of a game. Specific game-configuration settings are passed by means of the SFSGameSettings class.

If the creation is successful, a roomAdd event is dispatched to all the users who subscribed the Group to which the Room is associated, including the game creator. Otherwise, a roomCreationError event is returned to the creator's client.

Also, if the settings passed in the SFSGameSettings object cause invitations to join the game to be sent, an invitation event is dispatched to all the recipient clients.

Check the SmartFoxServer 3 documentation for a more in-depth overview of the GAME API.

See Also:

• SFSGameSettings
• SFSEvent.ROOM_ADD
• SFSEvent.ROOM_CREATION_ERROR
• SFSEvent.INVITATION

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_INVITATION_EXPIRY
static final String	KEY_INVITATION_PARAMS
static final String	KEY_INVITED_PLAYERS
static final String	KEY_IS_PUBLIC
static final String	KEY_LEAVE_ROOM
static final String	KEY_MIN_PLAYERS
static final String	KEY_NOTIFY_GAME_STARTED
static final String	KEY_PLAYER_MATCH_EXP
static final String	KEY_SEARCHABLE_ROOMS
static final String	KEY_SPECTATOR_MATCH_EXP

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
CreateSFSGameRequest(SFSGameSettings settings)	Creates a new CreateSFSGameRequest 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_IS_PUBLIC

public static final String KEY_IS_PUBLIC

See Also:

• Constant Field Values

Internal

KEY_MIN_PLAYERS

public static final String KEY_MIN_PLAYERS

See Also:

• Constant Field Values

Internal

KEY_INVITED_PLAYERS

public static final String KEY_INVITED_PLAYERS

See Also:

• Constant Field Values

Internal

KEY_SEARCHABLE_ROOMS

public static final String KEY_SEARCHABLE_ROOMS

See Also:

• Constant Field Values

Internal

KEY_PLAYER_MATCH_EXP

public static final String KEY_PLAYER_MATCH_EXP

See Also:

• Constant Field Values

Internal

KEY_SPECTATOR_MATCH_EXP

public static final String KEY_SPECTATOR_MATCH_EXP

See Also:

• Constant Field Values

Internal

KEY_INVITATION_EXPIRY

public static final String KEY_INVITATION_EXPIRY

See Also:

• Constant Field Values

Internal

KEY_LEAVE_ROOM

public static final String KEY_LEAVE_ROOM

See Also:

• Constant Field Values

Internal

KEY_NOTIFY_GAME_STARTED

public static final String KEY_NOTIFY_GAME_STARTED

See Also:

• Constant Field Values

Internal

KEY_INVITATION_PARAMS

public static final String KEY_INVITATION_PARAMS

See Also:

• Constant Field Values

Internal

Constructor Details

CreateSFSGameRequest

public CreateSFSGameRequest(SFSGameSettings settings)

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

Parameters:

settings - An object containing the SFSGame configuration settings.

See Also:

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

Method Details

validate

public void validate(ISmartFox sfs)
              throws SFSValidationException

Throws:

SFSValidationException

Internal

execute

public void execute(ISmartFox sfs)

Internal