Package sfs3.client.requests

Class RoomSettings

java.lang.Object
sfs3.client.requests.RoomSettings
Direct Known Subclasses:
MMORoomSettings, SFSGameSettings
public class RoomSettings extends Object
The RoomSettings class is a container for the settings required to create a Room using the CreateRoomRequest request.
See Also:

  • Constructor Details

    • RoomSettings

      public RoomSettings(String name)
      Creates a new RoomSettings instance. The instance must be passed to the CreateRoomRequest class constructor.
      Parameters:
      name - The name of the Room to be created.
      See Also:

  • Method Details

    • getName

      public String getName()
      Defines the name of the Room.

    • setName

      public void setName(String name)
      See Also:

    • getPassword

      public String getPassword()
      Defines the password of the Room. If the password is set to an empty string, the Room won't be password protected.

      The default value is an empty string.

    • setPassword

      public void setPassword(String password)
      See Also:

    • isGame

      public boolean isGame()
      Indicates whether the Room is a Game Room or not.

      The default value is false

    • setGame

      public RoomSettings setGame(boolean game)
      See Also:
      • isGame

    • getMaxUsers

      public int getMaxUsers()
      Defines the maximum number of users allowed in the Room. In case of Game Rooms, this is the maximum number of players.

      The default value is 10

      See Also:

    • setMaxUsers

      public RoomSettings setMaxUsers(int maxUsers)
      See Also:

    • getMaxVariables

      public int getMaxVariables()
      Defines the maximum number of Room Variables allowed for the Room.

      The default value is 5

    • setMaxVariables

      public RoomSettings setMaxVariables(int maxVariables)
      See Also:

    • getMaxSpectators

      public int getMaxSpectators()
      Defines the maximum number of spectators allowed in the Room (only for Game Rooms).

      The default value is 0

      See Also:

    • setMaxSpectators

      public RoomSettings setMaxSpectators(int maxSpectators)
      See Also:

    • getVariables

      public List<RoomVariable> getVariables()
      Defines a list of RooomVariable objects to be attached to the Room.

      The default value is null

      See Also:

    • setVariables

      public RoomSettings setVariables(List<RoomVariable> variables)
      See Also:

    • getPermissions

      public RoomPermissions getPermissions()
      Defines the flags indicating which operations are permitted on the Room.

      Permissions include: name and password change, maximum users change and public messaging. If set to null, the permissions configured on the server-side are used (see the SmartFoxServer 3 Administration Tool documentation).

      The default value is null

    • setPermissions

      public RoomSettings setPermissions(RoomPermissions permissions)
      See Also:

    • getEvents

      public RoomEvents getEvents()
      Defines the flags indicating which events related to the Room are dispatched by the SmartFox client.

      Room events include: users entering or leaving the room, user count change and user variables update. If set to null, the events configured on the server-side are used (see the SmartFoxServer 3 Administration Tool documentation).

      The default value is null

    • setEvents

      public RoomSettings setEvents(RoomEvents events)
      See Also:

    • getExtension

      public RoomExtension getExtension()
      Defines the Extension that must be attached to the Room on the server-side, and its settings.

    • setExtension

      public RoomSettings setExtension(RoomExtension extension)
      See Also:

    • getGroupId

      public String getGroupId()
      Defines the id of the Group to which the Room should belong. If the Group doesn't exist yet, a new one is created before assigning the Room to it.

      The default value is default

      See Also:

    • setGroupId

      public RoomSettings setGroupId(String groupId)
      See Also:

    • allowOwnerOnlyInvitation

      public boolean allowOwnerOnlyInvitation()
      Specifies if the Room allows "Join Room" Invitations sent by any User or just by its owner

      Default = true (only the creator is allowed to send invitations)

      Since:
      1.7.0
      See Also:

    • setAllowOwnerOnlyInvitation

      public RoomSettings setAllowOwnerOnlyInvitation(boolean value)
      Specifies if the Room allows "Join Room" Invitations sent by any User or just by its owner

      Default = true (only the creator is allowed to send invitations)

      Since:
      1.7.0
      See Also: