Uses of Interface
com.smartfoxserver.v2.entities.Room
-
-
Uses of Room in com.smartfoxserver.v2.api
Methods in com.smartfoxserver.v2.api that return Room Modifier and Type Method Description RoomISFSGameApi. createGame(Zone zone, CreateSFSGameSettings settings, User owner)Create an SFSGame Room and automatically update the clients and fire a server eventRoomISFSGameApi. createGame(Zone zone, CreateSFSGameSettings settings, User owner, boolean fireClientEvent, boolean fireServerEvent)Create an SFSGame Room.RoomSFSGameApi. createGame(Zone zone, CreateSFSGameSettings settings, User owner)Create an SFSGame Room and automatically update the clients and fire a server eventRoomSFSGameApi. createGame(Zone zone, CreateSFSGameSettings settings, User owner, boolean fireClientEvent, boolean fireServerEvent)Create an SFSGame Room.RoomISFSApi. createRoom(Zone zone, CreateRoomSettings settings, User owner)Create a new RoomRoomISFSApi. createRoom(Zone zone, CreateRoomSettings settings, User owner, boolean joinIt, Room roomToLeave)Create a new RoomRoomISFSApi. createRoom(Zone zone, CreateRoomSettings settings, User owner, boolean joinIt, Room roomToLeave, boolean fireClientEvent, boolean fireServerEvent)RoomSFSApi. createRoom(Zone zone, CreateRoomSettings params, User owner)Create a new RoomRoomSFSApi. createRoom(Zone zone, CreateRoomSettings params, User owner, boolean joinIt, Room roomToLeave)Create a new RoomRoomSFSApi. createRoom(Zone zone, CreateRoomSettings params, User owner, boolean joinIt, Room roomToLeave, boolean fireClientEvent, boolean fireServerEvent)RoomISFSGameApi. quickJoinGame(User player, MatchExpression expression, Zone zone, java.lang.String groupId)Quick join a User in an SFSGame.RoomISFSGameApi. quickJoinGame(User player, MatchExpression expression, Zone zone, java.lang.String groupId, Room roomToLeave)Quick join a User in an SFSGame.RoomISFSGameApi. quickJoinGame(User player, MatchExpression expression, java.util.Collection<Room> searchableRooms, Room roomToLeave)Quick join a User in an SFSGame.RoomSFSGameApi. quickJoinGame(User player, MatchExpression expression, Zone zone, java.lang.String groupId)Quick join a User in an SFSGame.RoomSFSGameApi. quickJoinGame(User player, MatchExpression expression, Zone zone, java.lang.String groupId, Room roomToLeave)Quick join a User in an SFSGame.RoomSFSGameApi. quickJoinGame(User player, MatchExpression expression, java.util.Collection<Room> searchableRooms, Room roomToLeave)Quick join a User in an SFSGame.Methods in com.smartfoxserver.v2.api that return types with arguments of type Room Modifier and Type Method Description java.util.List<Room>ISFSApi. findRooms(java.util.Collection<Room> roomList, MatchExpression expression, int limit)Find one or more Room(s) in the specified collection of Users.java.util.List<Room>SFSApi. findRooms(java.util.Collection<Room> roomList, MatchExpression expression, int limit)Find one or more Room(s) in the specified collection of Users.Methods in com.smartfoxserver.v2.api with parameters of type Room Modifier and Type Method Description voidISFSApi. changeRoomCapacity(User owner, Room targetRoom, int maxUsers, int maxSpectators)Changes the capacity (max number of Users and Spectators) in the Room.voidSFSApi. changeRoomCapacity(User owner, Room targetRoom, int maxUsers, int maxSpectators)Changes the capacity (max number of Users and Spectators) in the Room.voidISFSApi. changeRoomName(User owner, Room targetRoom, java.lang.String newName)Rename a Room.voidSFSApi. changeRoomName(User owner, Room targetRoom, java.lang.String newName)Rename a Room.voidISFSApi. changeRoomPassword(User owner, Room targetRoom, java.lang.String newPassword)Changes the Room password and the Room password-state.voidSFSApi. changeRoomPassword(User owner, Room targetRoom, java.lang.String newPassword)Changes the Room password and the Room password-state.RoomISFSApi. createRoom(Zone zone, CreateRoomSettings settings, User owner, boolean joinIt, Room roomToLeave)Create a new RoomRoomISFSApi. createRoom(Zone zone, CreateRoomSettings settings, User owner, boolean joinIt, Room roomToLeave, boolean fireClientEvent, boolean fireServerEvent)RoomSFSApi. createRoom(Zone zone, CreateRoomSettings params, User owner, boolean joinIt, Room roomToLeave)Create a new RoomRoomSFSApi. createRoom(Zone zone, CreateRoomSettings params, User owner, boolean joinIt, Room roomToLeave, boolean fireClientEvent, boolean fireServerEvent)voidISFSApi. emptyRoom(Room targetRoom)Removes all Users from the target Room.voidISFSApi. emptyRoom(Room targetRoom, boolean deactivateRoom)Removes all Users from the target Room.voidISFSApi. emptyRoom(Room targetRoom, boolean deactivateRoom, boolean fireClientEvent, boolean fireServerEvent)Removes all Users from the target Room.voidSFSApi. emptyRoom(Room targetRoom)Removes all Users from the target Room.voidSFSApi. emptyRoom(Room targetRoom, boolean deactivateRoom)Removes all Users from the target Room.voidSFSApi. emptyRoom(Room targetRoom, boolean deactivateRoom, boolean fireClientEvent, boolean fireServerEvent)Removes all Users from the target Room.voidISFSApi. joinRoom(User user, Room room)Join the user in a room.
This is the quickest way to join a User in non password-protected Room.voidISFSApi. joinRoom(User user, Room roomToJoin, java.lang.String password, boolean asSpectator, Room roomToLeave)Join the user in a room.
A client update and server side event will be also firedvoidISFSApi. joinRoom(User user, Room roomToJoin, java.lang.String password, boolean asSpectator, Room roomToLeave, boolean fireClientEvent, boolean fireServerEvent)Join the user in a room.voidSFSApi. joinRoom(User user, Room room)Join the user in a room.
This is the quickest way to join a User in non password-protected Room.voidSFSApi. joinRoom(User user, Room roomToJoin, java.lang.String password, boolean asSpectator, Room roomToLeave)Join the user in a room.
A client update and server side event will be also firedvoidSFSApi. joinRoom(User user, Room roomToJoin, java.lang.String password, boolean asSpectator, Room roomToLeave, boolean fireClientEvent, boolean fireServerEvent)Join the user in a room.voidISFSApi. leaveRoom(User user, Room room)Makes a user leave a room that he has joinedvoidISFSApi. leaveRoom(User user, Room room, boolean fireClientEvent, boolean fireServerEvent)Removes a User from a previously joined RoomvoidSFSApi. leaveRoom(User user, Room room)Makes a user leave a room that he has joinedvoidSFSApi. leaveRoom(User user, Room room, boolean fireClientEvent, boolean fireServerEvent)Removes a User from a previously joined RoomvoidISFSApi. playerToSpectator(User user, Room targetRoom, boolean fireClientEvent, boolean fireServerEvent)Turns a player in a Game Room to a spectator.voidSFSApi. playerToSpectator(User user, Room targetRoom, boolean fireClientEvent, boolean fireServerEvent)RoomISFSGameApi. quickJoinGame(User player, MatchExpression expression, Zone zone, java.lang.String groupId, Room roomToLeave)Quick join a User in an SFSGame.RoomISFSGameApi. quickJoinGame(User player, MatchExpression expression, java.util.Collection<Room> searchableRooms, Room roomToLeave)Quick join a User in an SFSGame.RoomSFSGameApi. quickJoinGame(User player, MatchExpression expression, Zone zone, java.lang.String groupId, Room roomToLeave)Quick join a User in an SFSGame.RoomSFSGameApi. quickJoinGame(User player, MatchExpression expression, java.util.Collection<Room> searchableRooms, Room roomToLeave)Quick join a User in an SFSGame.voidISFSApi. quickJoinOrCreateRoom(User user, MatchExpression expression, java.util.Collection<java.lang.String> groupList, CreateRoomSettings settings, Room roomToLeave)Searches for a Room that matches the provided MatchExpression and joins the User in the first occurrence found.voidSFSApi. quickJoinOrCreateRoom(User user, MatchExpression expression, java.util.Collection<java.lang.String> groupList, CreateRoomSettings settings, Room roomToLeave)Searches for a Room that matches the provided MatchExpression and joins the User in the first occurrence found.voidISFSApi. removeRoom(Room room)Removes a Room from its ZonevoidISFSApi. removeRoom(Room room, boolean fireClientEvent, boolean fireServerEvent)Removes a Room from its ZonevoidSFSApi. removeRoom(Room room)Removes a Room from its ZonevoidSFSApi. removeRoom(Room room, boolean fireClientEvent, boolean fireServerEvent)Removes a Room from its ZonevoidISFSApi. sendExtensionResponse(java.lang.String cmdName, ISFSObject params, User recipient, Room room, boolean useUDP)voidISFSApi. sendExtensionResponse(java.lang.String cmdName, ISFSObject params, java.util.List<User> recipients, Room room, boolean useUDP)voidSFSApi. sendExtensionResponse(java.lang.String cmdName, ISFSObject params, User recipient, Room room, boolean useUDP)voidSFSApi. sendExtensionResponse(java.lang.String cmdName, ISFSObject params, java.util.List<User> recipients, Room room, boolean useUDP)voidISFSGameApi. sendJoinRoomInvitation(Room target, User inviter, java.util.List<User> invitees, int expirySeconds)Invites Users / Players in an existing Room.voidISFSGameApi. sendJoinRoomInvitation(Room target, User inviter, java.util.List<User> invitees, int expirySeconds, boolean asSpect, boolean leaveLastJoinedRoom)Invites Users / Players in an existing Room.voidISFSGameApi. sendJoinRoomInvitation(Room target, User inviter, java.util.List<User> invitees, int expirySeconds, boolean asSpect, boolean leaveLastJoinedRoom, ISFSObject params)Invites Users / Players in an existing Room.voidSFSGameApi. sendJoinRoomInvitation(Room target, User inviter, java.util.List<User> invitees, int expirySeconds)Invites Users / Players in an existing Room.voidSFSGameApi. sendJoinRoomInvitation(Room target, User inviter, java.util.List<User> invitees, int expirySeconds, boolean asSpect, boolean leaveLastJoinedRoom)Invites Users / Players in an existing Room.voidSFSGameApi. sendJoinRoomInvitation(Room target, User inviter, java.util.List<User> invitees, int expirySeconds, boolean asSpect, boolean leaveLastJoinedRoom, ISFSObject params)Invites Users / Players in an existing Room.voidISFSApi. sendObjectMessage(Room targetRoom, User sender, ISFSObject message, java.util.Collection<User> recipients)Send an Object message.voidISFSMMOApi. sendObjectMessage(Room targetRoom, User sender, ISFSObject message, Vec3D aoi)Send an Object message based on a custom SFSObject that can contain any data.voidSFSApi. sendObjectMessage(Room targetRoom, User sender, ISFSObject message, java.util.Collection<User> recipients)Send an Object message.voidSFSMMOApi. sendObjectMessage(Room targetRoom, User sender, ISFSObject message, Vec3D aoi)Send an Object message based on a custom SFSObject that can contain any data.voidISFSApi. sendPublicMessage(Room targetRoom, User sender, java.lang.String message, ISFSObject params)Sends a public chat message.voidISFSMMOApi. sendPublicMessage(Room targetRoom, User sender, java.lang.String message, ISFSObject params, Vec3D aoi)Sends a public chat message.voidSFSApi. sendPublicMessage(Room targetRoom, User sender, java.lang.String message, ISFSObject params)Sends a public chat message.voidSFSMMOApi. sendPublicMessage(Room targetRoom, User sender, java.lang.String message, ISFSObject params, Vec3D aoi)Sends a public chat message.voidISFSMMOApi. setMMOItemPosition(BaseMMOItem item, Vec3D pos, Room targetRoom)Set or update an MMOItem inside an MMORoomvoidSFSMMOApi. setMMOItemPosition(BaseMMOItem item, Vec3D pos, Room targetRoom)Set or update an MMOItem inside an MMORoomvoidISFSApi. setRoomVariables(User user, Room targetRoom, java.util.List<RoomVariable> variables)Set Room Variables.voidISFSApi. setRoomVariables(User user, Room targetRoom, java.util.List<RoomVariable> variables, boolean fireClientEvent, boolean fireServerEvent, boolean overrideOwnership)Set Room Variables.voidSFSApi. setRoomVariables(User user, Room targetRoom, java.util.List<RoomVariable> variables)Set Room Variables.voidSFSApi. setRoomVariables(User user, Room targetRoom, java.util.List<RoomVariable> variables, boolean fireClientEvent, boolean fireServerEvent, boolean overrideOwnership)Set Room Variables.voidISFSMMOApi. setUserPosition(User user, Vec3D pos, Room targetRoom)Set the new User position inside an MMORoomvoidSFSMMOApi. setUserPosition(User user, Vec3D pos, Room targetRoom)Set the new User position inside an MMORoomvoidISFSApi. spectatorToPlayer(User user, Room targetRoom, boolean fireClientEvent, boolean fireServerEvent)Turns a spectator in a Game Room to a Player.voidSFSApi. spectatorToPlayer(User user, Room targetRoom, boolean fireClientEvent, boolean fireServerEvent)Method parameters in com.smartfoxserver.v2.api with type arguments of type Room Modifier and Type Method Description java.util.List<Room>ISFSApi. findRooms(java.util.Collection<Room> roomList, MatchExpression expression, int limit)Find one or more Room(s) in the specified collection of Users.java.util.List<Room>SFSApi. findRooms(java.util.Collection<Room> roomList, MatchExpression expression, int limit)Find one or more Room(s) in the specified collection of Users.RoomISFSGameApi. quickJoinGame(User player, MatchExpression expression, java.util.Collection<Room> searchableRooms, Room roomToLeave)Quick join a User in an SFSGame.RoomSFSGameApi. quickJoinGame(User player, MatchExpression expression, java.util.Collection<Room> searchableRooms, Room roomToLeave)Quick join a User in an SFSGame. -
Uses of Room in com.smartfoxserver.v2.entities
Classes in com.smartfoxserver.v2.entities that implement Room Modifier and Type Class Description classSFSRoomOverviewMethods in com.smartfoxserver.v2.entities that return Room Modifier and Type Method Description RoomDefaultRoomFactory. createNewRoom(CreateRoomSettings settings)RoomIRoomFactory. createNewRoom(CreateRoomSettings settings)RoomSFSZone. createRoom(CreateRoomSettings params)Use theSFSApi.createRoom(Zone, CreateRoomSettings, User)method insteadRoomSFSZone. createRoom(CreateRoomSettings params, User user)Use theSFSApi.createRoom(Zone, CreateRoomSettings, User)method insteadRoomZone. createRoom(CreateRoomSettings params)RoomZone. createRoom(CreateRoomSettings params, User user)RoomSFSUser. getLastJoinedRoom()RoomUser. getLastJoinedRoom()A reference to the last Room that was joined by this UserRoomSFSZone. getRoomById(int id)Get a Room from its unique IDRoomZone. getRoomById(int id)Get a Room from its unique IDRoomSFSZone. getRoomByName(java.lang.String name)Get a Room from its nameRoomZone. getRoomByName(java.lang.String name)Get a Room from its nameMethods in com.smartfoxserver.v2.entities that return types with arguments of type Room Modifier and Type Method Description java.util.List<Room>SFSUser. getCreatedRooms()java.util.List<Room>User. getCreatedRooms()Get a list of Rooms created by this Userjava.util.List<Room>SFSUser. getJoinedRooms()java.util.List<Room>User. getJoinedRooms()A list of Rooms currently joined by the Userjava.util.Map<Room,java.lang.Integer>SFSUser. getPlayerIds()java.util.Map<Room,java.lang.Integer>User. getPlayerIds()Get a map of playerId(s) per Room
This method can be used when a player is currently engaged in multiple games at the same timejava.util.List<Room>SFSZone. getRoomList()Get the list of Rooms in the Zonejava.util.List<Room>Zone. getRoomList()Get the list of Rooms in the Zonejava.util.List<Room>SFSZone. getRoomListFromGroup(java.lang.String groupId)Get the list of Rooms from a specific Groupjava.util.List<Room>Zone. getRoomListFromGroup(java.lang.String groupId)Get the list of Rooms from a specific Groupjava.util.List<Room>SFSZone. getRoomListFromGroupList(java.util.Collection<java.lang.String> groups)java.util.List<Room>Zone. getRoomListFromGroupList(java.util.Collection<java.lang.String> groups)Obtain a Room list generated by merging all Rooms from the provided group namesMethods in com.smartfoxserver.v2.entities with parameters of type Room Modifier and Type Method Description voidSFSUser. addCreatedRoom(Room room)voidUser. addCreatedRoom(Room room)voidSFSUser. addJoinedRoom(Room room)voidUser. addJoinedRoom(Room room)voidSFSUser. addPersistentRoomVarReference(Room target)voidUser. addPersistentRoomVarReference(Room target)voidSFSZone. addRoom(Room room)voidZone. addRoom(Room room)INTERNALvoidSFSZone. changeRoomCapacity(Room room, int newMaxUsers, int newMaxSpect)voidZone. changeRoomCapacity(Room room, int newMaxUsers, int maxMaxSpect)INTERNALvoidSFSZone. changeRoomName(Room room, java.lang.String newName)voidZone. changeRoomName(Room room, java.lang.String newName)INTERNALvoidSFSZone. changeRoomPasswordState(Room room, java.lang.String password)voidZone. changeRoomPasswordState(Room room, java.lang.String password)INTERNALvoidSFSZone. checkAndRemove(Room room)voidZone. checkAndRemove(Room room)intSFSUser. getPlayerId(Room room)intUser. getPlayerId(Room room)Get the playerId for the User in a specific RoombooleanSFSUser. isJoinedInRoom(Room room)booleanUser. isJoinedInRoom(Room room)Check if a User is joined in a RoombooleanSFSUser. isPlayer(Room room)booleanUser. isPlayer(Room room)Check if the User is Player in a specific RoombooleanSFSUser. isSpectator(Room room)booleanUser. isSpectator(Room room)Check if the User is Spectator in a specific RoomvoidSFSUser. removeCreatedRoom(Room room)voidUser. removeCreatedRoom(Room room)voidSFSUser. removeJoinedRoom(Room room)voidUser. removeJoinedRoom(Room room)voidSFSZone. removeRoom(Room room)voidZone. removeRoom(Room room)INTERNALvoidSFSZone. removeUserFromRoom(User user, Room room)voidZone. removeUserFromRoom(User user, Room room)INTERNALvoidSFSUser. setPlayerId(int id, Room room)voidUser. setPlayerId(int id, Room room)ISFSArraySFSUser. toSFSArray(Room room)ISFSArrayUser. toSFSArray(Room room) -
Uses of Room in com.smartfoxserver.v2.entities.match
Methods in com.smartfoxserver.v2.entities.match that return types with arguments of type Room Modifier and Type Method Description java.util.List<Room>MatchingUtils. matchRooms(java.util.Collection<Room> roomList, MatchExpression conditions)java.util.List<Room>MatchingUtils. matchRooms(java.util.Collection<Room> roomList, MatchExpression conditions, int limit)Methods in com.smartfoxserver.v2.entities.match with parameters of type Room Modifier and Type Method Description booleanMatchingUtils. matchRoom(Room room, MatchExpression conditions)Method parameters in com.smartfoxserver.v2.entities.match with type arguments of type Room Modifier and Type Method Description java.util.List<Room>MatchingUtils. matchRooms(java.util.Collection<Room> roomList, MatchExpression conditions)java.util.List<Room>MatchingUtils. matchRooms(java.util.Collection<Room> roomList, MatchExpression conditions, int limit) -
Uses of Room in com.smartfoxserver.v2.extensions
Methods in com.smartfoxserver.v2.extensions that return Room Modifier and Type Method Description RoomBaseSFSExtension. getParentRoom()Return the parent Room of the Extension.RoomISFSExtension. getParentRoom()Return the parent Room of the Extension.Methods in com.smartfoxserver.v2.extensions with parameters of type Room Modifier and Type Method Description voidBaseSFSExtension. setParentRoom(Room room)voidISFSExtension. setParentRoom(Room room) -
Uses of Room in com.smartfoxserver.v2.game
Classes in com.smartfoxserver.v2.game that implement Room Modifier and Type Class Description classSFSGameIntroductionMethods in com.smartfoxserver.v2.game that return Room Modifier and Type Method Description protected RoomBaseGameInvitationCallback. getGame()Get the GameMethods in com.smartfoxserver.v2.game that return types with arguments of type Room Modifier and Type Method Description java.util.List<Room>CreateSFSGameSettings. getSearchableRooms()A list of Rooms where to search for more players to invite in a private Game.
The players will be matched against the Player Match Expression providedMethod parameters in com.smartfoxserver.v2.game with type arguments of type Room Modifier and Type Method Description voidCreateSFSGameSettings. 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.Constructors in com.smartfoxserver.v2.game with parameters of type Room Constructor Description BaseGameInvitationCallback(Room game, boolean leaveLastJoinedRoom)Create a new Callback object keeping track of the Game RoomJoinRoomInvitationCallback(Room targetRoom)SFSGameInvitationCallback(Room game, int invitedPlayersCount, boolean leaveLastJoinedRoom) -
Uses of Room in com.smartfoxserver.v2.mmo
Classes in com.smartfoxserver.v2.mmo that implement Room Modifier and Type Class Description classMMORoomOverview -
Uses of Room in com.smartfoxserver.v2.persistence.room
Methods in com.smartfoxserver.v2.persistence.room with parameters of type Room Modifier and Type Method Description voidIRoomStorage. saveRoom(Room theRoom)Save a Room and its state -
Uses of Room in com.smartfoxserver.v2.util
Methods in com.smartfoxserver.v2.util that return Room Modifier and Type Method Description RoomDefaultPlayerIdGenerator. getParentRoom()RoomIPlayerIdGenerator. getParentRoom()Get a reference to the parent RoomMethods in com.smartfoxserver.v2.util with parameters of type Room Modifier and Type Method Description voidDefaultPlayerIdGenerator. setParentRoom(Room room)voidIPlayerIdGenerator. setParentRoom(Room room)
-