Package sfs2x.client.requests.game

Class SFSGameSettings

  • public class SFSGameSettings
extends RoomSettings

    The SFSGameSettings class is a container for the settings required to create a Game Room using the CreateSFSGameRequest request.

    On the server-side, a Game Room is represented by the SFSGame Java class which extends the Room class providing new advanced features such as player matching, game invitations, public and private games, quick game joining etc. On the client side Game Rooms are available as a regular Rooms, with their isGame property set to true.

    See Also:
    CreateSFSGameRequest, Room

    • Constructor Detail

      • SFSGameSettings

        public SFSGameSettings​(java.lang.String name)
        Creates a new SFSGameSettings instance. The instance must be passed to the CreateSFSGameRequest class constructor.
        Parameters:
        name - The name of the Game Room to be created.
        See Also:
        CreateSFSGameRequest

    • Method Detail

      • isPublic

        public boolean isPublic()
        Indicates whether the game is public or private.

        A public game can be joined by any player whose User Variables match the playerMatchExpression assigned to the Game Room. A private game can be joined by users invited by the game creator by means of invitedPlayers list.

        The default value is true.

        See Also:
        getPlayerMatchExpression(), getInvitedPlayers()

      • getMinPlayersToStartGame

        public int getMinPlayersToStartGame()
        Defines the minimum number of players required to start the game. If the notifyGameStarted property is set to true, when this number is reached, the game start is notified.

        The default value is 2.

        See Also:
        getNotifyGameStarted()

      • getInvitedPlayers

        public java.util.List<?> getInvitedPlayers()
        In private games, defines a list of User objects representing players to be invited to join the game.

        If the invitations are less than the minimum number of players required to start the game (see the minPlayersToStartGame property), the server will send additional invitations automatically, searching users in the Room Groups specified in the searchableRooms list and filtering them by means of the object passed to the playerMatchExpression property.

        The game matching criteria contained in the playerMatchExpression property do not apply to the users specified in this list.

        The default value is null.

        See Also:
        minPlayersToStartGame, searchableRooms, playerMatchExpression, User

      • getSearchableRooms

        public java.util.List<java.lang.String> getSearchableRooms()
        In private games, defines a list of Groups names where to search players to invite.

        If the users invited to join the game (specified through the invitedPlayers property) are less than the minimum number of players required to start the game (see the minPlayersToStartGame property), the server will invite others automatically, searching them in Rooms belonging to the Groups specified in this list and filtering them by means of the object passed to the playerMatchExpression property.

        The default value is null.

        See Also:
        getInvitedPlayers(), getMinPlayersToStartGame(), getPlayerMatchExpression()

      • getInvitationExpiryTime

        public int getInvitationExpiryTime()
        In private games, defines the number of seconds that the users invited to join the game have to reply to the invitation. The suggested range is 10 to 40 seconds.

        The default value is 15.

      • getLeaveLastJoinedRoom

        public boolean getLeaveLastJoinedRoom()
        In private games, indicates whether the players must leave the previous Room when joining the game or not.

        This setting applies to private games only because users join the Game Room automatically when they accept the invitation to play, while public games require a JoinRoomRequest request to be sent, where this behavior can be determined manually.

        The default value is true.

      • getNotifyGameStarted

        public boolean getNotifyGameStarted()
        Indicates if a game state change must be notified when the minimum number of players is reached.

        If this setting is true, the game state (started or stopped) is handled by means of the reserved Room Variable represented by the ReservedRoomVariables.RV_GAME_STARTED constant. Listening to the roomVariablesUpdate event for this variable allows clients to be notified when the game can start due to minimum number of players being reached.

        As the used Room Variable is created as global (see the SFSRoomVariable class description), its update is broadcast outside the Room too: this can be used on the client-side, for example, to show the game state in a list of available games.

        The default value is false.

        See Also:
        ReservedRoomVariables.RV_GAME_STARTED, SFSEvent.ROOM_VARIABLES_UPDATE, SFSRoomVariable

      • getPlayerMatchExpression

        public MatchExpression getPlayerMatchExpression()
        Defines the game matching expression to be used to filters players.

        Filtering is applied when:

        1. users try to join a public Game Room as players (their User Variables must match the matching criteria);
        2. the server selects additional users to be invited to join a private game (see the searchableRooms property).

        Filtering is not applied to users invited by the creator to join a private game (see the invitedPlayers property).

        The default value is null.

        See Also:
        getSearchableRooms(), getInvitedPlayers(), getSpectatorMatchExpression()

      • getSpectatorMatchExpression

        public MatchExpression getSpectatorMatchExpression()
        Defines the game matching expression to be used to filters spectators.

        Filtering is applied when users try to join a public Game Room as spectators (their User Variables must match the matching criteria).

        The default value is null.

        See Also:
        getPlayerMatchExpression()

      • getInvitationParams

        public com.smartfoxserver.v2.entities.data.ISFSObject getInvitationParams()
        In private games, defines an optional object containing additional custom parameters to be sent together with the invitation.

        This object must be an instance of SFSObject. Possible custom parameters to be transferred to the invitees are a message for the recipient, the game details (title, type...), the inviter details, etc.

        The default value is null.

        See Also:
        SFSObject

      • setPublic

        public void setPublic​(boolean isPublic)
        See Also:
        isPublic()

      • setMinPlayersToStartGame

        public void setMinPlayersToStartGame​(int minPlayersToStartGame)
        See Also:
        getMinPlayersToStartGame()

      • setInvitedPlayers

        public void setInvitedPlayers​(java.util.List<?> invitedPlayers)
        See Also:
        getInvitedPlayers()

      • setSearchableRooms

        public void setSearchableRooms​(java.util.List<java.lang.String> searchableRooms)
        See Also:
        getSearchableRooms()

      • setInvitationExpiryTime

        public void setInvitationExpiryTime​(int invitationExpiryTime)
        See Also:
        getInvitationExpiryTime()

      • setLeaveLastJoinedRoom

        public void setLeaveLastJoinedRoom​(boolean leaveLastJoinedRoom)
        See Also:
        getLeaveLastJoinedRoom()

      • setNotifyGameStarted

        public void setNotifyGameStarted​(boolean notifyGameStarted)
        See Also:
        getNotifyGameStarted()

      • setInvitationParams

        public void setInvitationParams​(com.smartfoxserver.v2.entities.data.ISFSObject invitationParams)
        See Also:
        getInvitationParams()