Package sfs2x.client.requests

Class RoomEvents

  • public class RoomEvents
extends java.lang.Object
    The RoomEvents class contains a specific subset of the RoomSettings required to create a Room. It defines which events related to the Room will be fired by the SmartFox client.
    See Also:
    RoomSettings.getEvents(), CreateRoomRequest

    • Constructor Summary

      Constructors 
      Constructor Description
      RoomEvents()
      Creates a new RoomEvents instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean getAllowUserCountChange()
      Indicates whether or not the userCountChange event should be dispatched whenever the users (or players+spectators) count changes in the Room.
      boolean getAllowUserEnter()
      Indicates whether the userEnterRoom event should be dispatched whenever a user joins the Room or not.
      boolean getAllowUserExit()
      Indicates whether the userExitRoom event should be dispatched whenever a user leaves the Room or not.
      boolean getAllowUserVariablesUpdate()
      Indicates whether or not the userVariablesUpdate event should be dispatched whenever a user in the Room updates his User Variables.
      void setAllowUserCountChange​(boolean allowUserCountChange)  
      void setAllowUserEnter​(boolean allowUserEnter)  
      void setAllowUserExit​(boolean allowUserExit)  
      void setAllowUserVariablesUpdate​(boolean allowUserVariablesUpdate)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • RoomEvents

        public RoomEvents()
        Creates a new RoomEvents instance. The RoomSettings.events property must be set to this instance during Room creation.
        See Also:
        RoomSettings.getEvents()

    • Method Detail

      • getAllowUserEnter

        public boolean getAllowUserEnter()
        Indicates whether the userEnterRoom event should be dispatched whenever a user joins the Room or not.

        The default value is false

        See Also:
        SFSEvent.USER_ENTER_ROOM

      • setAllowUserEnter

        public void setAllowUserEnter​(boolean allowUserEnter)
        See Also:
        getAllowUserEnter()

      • getAllowUserExit

        public boolean getAllowUserExit()
        Indicates whether the userExitRoom event should be dispatched whenever a user leaves the Room or not.

        The default value is false

        See Also:
        SFSEvent.USER_EXIT_ROOM

      • setAllowUserExit

        public void setAllowUserExit​(boolean allowUserExit)
        See Also:
        getAllowUserExit()

      • getAllowUserCountChange

        public boolean getAllowUserCountChange()
        Indicates whether or not the userCountChange event should be dispatched whenever the users (or players+spectators) count changes in the Room.

        The default value is false

        See Also:
        SFSEvent.USER_COUNT_CHANGE

      • setAllowUserCountChange

        public void setAllowUserCountChange​(boolean allowUserCountChange)
        See Also:
        getAllowUserCountChange()

      • getAllowUserVariablesUpdate

        public boolean getAllowUserVariablesUpdate()
        Indicates whether or not the userVariablesUpdate event should be dispatched whenever a user in the Room updates his User Variables.

        The default value is false

        See Also:
        SFSEvent.USER_VARIABLES_UPDATE

      • setAllowUserVariablesUpdate

        public void setAllowUserVariablesUpdate​(boolean allowUserVariablesUpdate)
        See Also:
        getAllowUserVariablesUpdate()