public class CreateSFSGameSettings extends CreateRoomSettings
CreateRoomSettings.RoomExtensionSettings
Constructor and Description |
---|
CreateSFSGameSettings() |
Modifier and Type | Method and Description |
---|---|
int |
getInvitationExpiryTime()
The maximum amount of time for an invited Player to accept/refuse an invitation.
|
ISFSObject |
getInvitationParams()
Get optional SFSObject containing custom invitation parameters.
|
java.util.List<User> |
getInvitedPlayers()
For private games only:
A list of players invited to play in the Game.
|
int |
getMinPlayersToStartGame()
Get the minimum number of players required to start the Game
|
MatchExpression |
getPlayerMatchExpression()
A match expression to filter Players willing to join the Game.
|
java.util.List<Room> |
getSearchableRooms()
A list of Rooms where to search for more players to invite in a private Game.
|
MatchExpression |
getSpectatorMatchExpression()
A match expression to filter Spectators willing to join the Game.
|
boolean |
isGamePublic()
Check if the Game is public.
|
boolean |
isLeaveLastJoinedRoom()
Check if the Player should be removed from its previous Room after he joins the Game
|
boolean |
isNotifyGameStartedViaRoomVariable()
Turn on the notification of the Game state (started, not-started) by the way of a reserved global Room Variable.
|
static CreateSFSGameSettings |
newFromRoomSettings(CreateRoomSettings rSettings) |
void |
setGamePublic(boolean isGamePublic) |
void |
setInvitationExpiryTime(int invitationExpiryTime)
The maximum amount of time for an invited Player to accept/refuse an invitation.
|
void |
setInvitationParams(ISFSObject invitationParams)
Set the custom invitation parameters.
|
void |
setInvitedPlayers(java.util.List<User> invitedPlayers)
Set a list of people invited to play a private Game
|
void |
setLeaveLastJoinedRoom(boolean leaveLastJoinedRoom) |
void |
setMinPlayersToStartGame(int minPlayersToStartGame) |
void |
setNotifyGameStartedViaRoomVariable(boolean notifyGameStartedWithRoomVariable) |
void |
setPlayerMatchExpression(MatchExpression playerMatchExpression)
A match expression to filter Players willing to join the Game.
|
void |
setSearchableRooms(java.util.List<Room> searchableRooms)
Provide a list of Rooms (e.g. all the Rooms from a specific Group in the Zone) that the system will use to search more players to join in
a private Game.
|
void |
setSpectatorMatchExpression(MatchExpression spectatorMatchExpression)
A match expression to filter Spectators willing to join the Game.
|
java.lang.String |
toString() |
allowOwnerOnlyInvitation, getAutoRemoveMode, getCustomPlayerIdGeneratorClass, getExtension, getGroupId, getMaxSpectators, getMaxUsers, getMaxVariablesAllowed, getName, getPassword, getRoomProperties, getRoomSettings, getRoomVariables, isDynamic, isGame, isHidden, isUseWordsFilter, setAllowOwnerOnlyInvitation, setAutoRemoveMode, setCustomPlayerIdGeneratorClass, setDynamic, setExtension, setGame, setGroupId, setHidden, setMaxSpectators, setMaxUsers, setMaxVariablesAllowed, setName, setPassword, setRoomProperties, setRoomSettings, setRoomVariables, setUseWordsFilter
public static CreateSFSGameSettings newFromRoomSettings(CreateRoomSettings rSettings)
public boolean isGamePublic()
public void setGamePublic(boolean isGamePublic)
public int getMinPlayersToStartGame()
public void setMinPlayersToStartGame(int minPlayersToStartGame)
public java.util.List<User> getInvitedPlayers()
public void setInvitedPlayers(java.util.List<User> invitedPlayers)
invitedPlayers
- the list of invited playerspublic java.util.List<Room> getSearchableRooms()
getPlayerMatchExpression()
public void setSearchableRooms(java.util.List<Room> searchableRooms)
searchableRooms
- the list of Roomspublic boolean isLeaveLastJoinedRoom()
public void setLeaveLastJoinedRoom(boolean leaveLastJoinedRoom)
public MatchExpression getPlayerMatchExpression()
MatchExpression
public void setPlayerMatchExpression(MatchExpression playerMatchExpression)
playerMatchExpression
- the match expressionMatchExpression
public MatchExpression getSpectatorMatchExpression()
MatchExpression
public void setSpectatorMatchExpression(MatchExpression spectatorMatchExpression)
spectatorMatchExpression
- the match expressionMatchExpression
public int getInvitationExpiryTime()
SFSInvitation
public void setInvitationExpiryTime(int invitationExpiryTime)
invitationExpiryTime
- the expiration time, expressed in secondsSFSInvitation
public boolean isNotifyGameStartedViaRoomVariable()
ReservedRoomVariables.RV_GAME_STARTED
public void setNotifyGameStartedViaRoomVariable(boolean notifyGameStartedWithRoomVariable)
public ISFSObject getInvitationParams()
public void setInvitationParams(ISFSObject invitationParams)
invitationParams
- public java.lang.String toString()
toString
in class CreateRoomSettings