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 Room
ISFSGameApi. createGame(Zone zone, CreateSFSGameSettings settings, User owner)
Create an SFSGame Room and automatically update the clients and fire a server eventRoom
ISFSGameApi. createGame(Zone zone, CreateSFSGameSettings settings, User owner, boolean fireClientEvent, boolean fireServerEvent)
Create an SFSGame Room.Room
SFSGameApi. createGame(Zone zone, CreateSFSGameSettings settings, User owner)
Create an SFSGame Room and automatically update the clients and fire a server eventRoom
SFSGameApi. createGame(Zone zone, CreateSFSGameSettings settings, User owner, boolean fireClientEvent, boolean fireServerEvent)
Create an SFSGame Room.Room
ISFSApi. createRoom(Zone zone, CreateRoomSettings settings, User owner)
Create a new RoomRoom
ISFSApi. createRoom(Zone zone, CreateRoomSettings settings, User owner, boolean joinIt, Room roomToLeave)
Create a new RoomRoom
ISFSApi. createRoom(Zone zone, CreateRoomSettings settings, User owner, boolean joinIt, Room roomToLeave, boolean fireClientEvent, boolean fireServerEvent)
Room
SFSApi. createRoom(Zone zone, CreateRoomSettings params, User owner)
Create a new RoomRoom
SFSApi. createRoom(Zone zone, CreateRoomSettings params, User owner, boolean joinIt, Room roomToLeave)
Create a new RoomRoom
SFSApi. createRoom(Zone zone, CreateRoomSettings params, User owner, boolean joinIt, Room roomToLeave, boolean fireClientEvent, boolean fireServerEvent)
Room
ISFSGameApi. quickJoinGame(User player, MatchExpression expression, Zone zone, java.lang.String groupId)
Quick join a User in an SFSGame.Room
ISFSGameApi. quickJoinGame(User player, MatchExpression expression, Zone zone, java.lang.String groupId, Room roomToLeave)
Quick join a User in an SFSGame.Room
ISFSGameApi. quickJoinGame(User player, MatchExpression expression, java.util.Collection<Room> searchableRooms, Room roomToLeave)
Quick join a User in an SFSGame.Room
SFSGameApi. quickJoinGame(User player, MatchExpression expression, Zone zone, java.lang.String groupId)
Quick join a User in an SFSGame.Room
SFSGameApi. quickJoinGame(User player, MatchExpression expression, Zone zone, java.lang.String groupId, Room roomToLeave)
Quick join a User in an SFSGame.Room
SFSGameApi. 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 void
ISFSApi. changeRoomCapacity(User owner, Room targetRoom, int maxUsers, int maxSpectators)
Changes the capacity (max number of Users and Spectators) in the Room.void
SFSApi. changeRoomCapacity(User owner, Room targetRoom, int maxUsers, int maxSpectators)
Changes the capacity (max number of Users and Spectators) in the Room.void
ISFSApi. changeRoomName(User owner, Room targetRoom, java.lang.String newName)
Rename a Room.void
SFSApi. changeRoomName(User owner, Room targetRoom, java.lang.String newName)
Rename a Room.void
ISFSApi. changeRoomPassword(User owner, Room targetRoom, java.lang.String newPassword)
Changes the Room password and the Room password-state.void
SFSApi. changeRoomPassword(User owner, Room targetRoom, java.lang.String newPassword)
Changes the Room password and the Room password-state.Room
ISFSApi. createRoom(Zone zone, CreateRoomSettings settings, User owner, boolean joinIt, Room roomToLeave)
Create a new RoomRoom
ISFSApi. createRoom(Zone zone, CreateRoomSettings settings, User owner, boolean joinIt, Room roomToLeave, boolean fireClientEvent, boolean fireServerEvent)
Room
SFSApi. createRoom(Zone zone, CreateRoomSettings params, User owner, boolean joinIt, Room roomToLeave)
Create a new RoomRoom
SFSApi. createRoom(Zone zone, CreateRoomSettings params, User owner, boolean joinIt, Room roomToLeave, boolean fireClientEvent, boolean fireServerEvent)
void
ISFSApi. emptyRoom(Room targetRoom)
Removes all Users from the target Room.void
ISFSApi. emptyRoom(Room targetRoom, boolean deactivateRoom)
Removes all Users from the target Room.void
ISFSApi. emptyRoom(Room targetRoom, boolean deactivateRoom, boolean fireClientEvent, boolean fireServerEvent)
Removes all Users from the target Room.void
SFSApi. emptyRoom(Room targetRoom)
Removes all Users from the target Room.void
SFSApi. emptyRoom(Room targetRoom, boolean deactivateRoom)
Removes all Users from the target Room.void
SFSApi. emptyRoom(Room targetRoom, boolean deactivateRoom, boolean fireClientEvent, boolean fireServerEvent)
Removes all Users from the target Room.void
ISFSApi. 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.void
ISFSApi. 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 firedvoid
ISFSApi. joinRoom(User user, Room roomToJoin, java.lang.String password, boolean asSpectator, Room roomToLeave, boolean fireClientEvent, boolean fireServerEvent)
Join the user in a room.void
SFSApi. 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.void
SFSApi. 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 firedvoid
SFSApi. joinRoom(User user, Room roomToJoin, java.lang.String password, boolean asSpectator, Room roomToLeave, boolean fireClientEvent, boolean fireServerEvent)
Join the user in a room.void
ISFSApi. leaveRoom(User user, Room room)
Makes a user leave a room that he has joinedvoid
ISFSApi. leaveRoom(User user, Room room, boolean fireClientEvent, boolean fireServerEvent)
Removes a User from a previously joined Roomvoid
SFSApi. leaveRoom(User user, Room room)
Makes a user leave a room that he has joinedvoid
SFSApi. leaveRoom(User user, Room room, boolean fireClientEvent, boolean fireServerEvent)
Removes a User from a previously joined Roomvoid
ISFSApi. playerToSpectator(User user, Room targetRoom, boolean fireClientEvent, boolean fireServerEvent)
Turns a player in a Game Room to a spectator.void
SFSApi. playerToSpectator(User user, Room targetRoom, boolean fireClientEvent, boolean fireServerEvent)
Room
ISFSGameApi. quickJoinGame(User player, MatchExpression expression, Zone zone, java.lang.String groupId, Room roomToLeave)
Quick join a User in an SFSGame.Room
ISFSGameApi. quickJoinGame(User player, MatchExpression expression, java.util.Collection<Room> searchableRooms, Room roomToLeave)
Quick join a User in an SFSGame.Room
SFSGameApi. quickJoinGame(User player, MatchExpression expression, Zone zone, java.lang.String groupId, Room roomToLeave)
Quick join a User in an SFSGame.Room
SFSGameApi. quickJoinGame(User player, MatchExpression expression, java.util.Collection<Room> searchableRooms, Room roomToLeave)
Quick join a User in an SFSGame.void
ISFSApi. 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.void
SFSApi. 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.void
ISFSApi. removeRoom(Room room)
Removes a Room from its Zonevoid
ISFSApi. removeRoom(Room room, boolean fireClientEvent, boolean fireServerEvent)
Removes a Room from its Zonevoid
SFSApi. removeRoom(Room room)
Removes a Room from its Zonevoid
SFSApi. removeRoom(Room room, boolean fireClientEvent, boolean fireServerEvent)
Removes a Room from its Zonevoid
ISFSApi. sendExtensionResponse(java.lang.String cmdName, ISFSObject params, User recipient, Room room, boolean useUDP)
void
ISFSApi. sendExtensionResponse(java.lang.String cmdName, ISFSObject params, java.util.List<User> recipients, Room room, boolean useUDP)
void
SFSApi. sendExtensionResponse(java.lang.String cmdName, ISFSObject params, User recipient, Room room, boolean useUDP)
void
SFSApi. sendExtensionResponse(java.lang.String cmdName, ISFSObject params, java.util.List<User> recipients, Room room, boolean useUDP)
void
ISFSGameApi. sendJoinRoomInvitation(Room target, User inviter, java.util.List<User> invitees, int expirySeconds)
Invites Users / Players in an existing Room.void
ISFSGameApi. sendJoinRoomInvitation(Room target, User inviter, java.util.List<User> invitees, int expirySeconds, boolean asSpect, boolean leaveLastJoinedRoom)
Invites Users / Players in an existing Room.void
ISFSGameApi. 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.void
SFSGameApi. sendJoinRoomInvitation(Room target, User inviter, java.util.List<User> invitees, int expirySeconds)
Invites Users / Players in an existing Room.void
SFSGameApi. sendJoinRoomInvitation(Room target, User inviter, java.util.List<User> invitees, int expirySeconds, boolean asSpect, boolean leaveLastJoinedRoom)
Invites Users / Players in an existing Room.void
SFSGameApi. 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.void
ISFSApi. sendObjectMessage(Room targetRoom, User sender, ISFSObject message, java.util.Collection<User> recipients)
Send an Object message.void
ISFSMMOApi. sendObjectMessage(Room targetRoom, User sender, ISFSObject message, Vec3D aoi)
Send an Object message based on a custom SFSObject that can contain any data.void
SFSApi. sendObjectMessage(Room targetRoom, User sender, ISFSObject message, java.util.Collection<User> recipients)
Send an Object message.void
SFSMMOApi. sendObjectMessage(Room targetRoom, User sender, ISFSObject message, Vec3D aoi)
Send an Object message based on a custom SFSObject that can contain any data.void
ISFSApi. sendPublicMessage(Room targetRoom, User sender, java.lang.String message, ISFSObject params)
Sends a public chat message.void
ISFSMMOApi. sendPublicMessage(Room targetRoom, User sender, java.lang.String message, ISFSObject params, Vec3D aoi)
Sends a public chat message.void
SFSApi. sendPublicMessage(Room targetRoom, User sender, java.lang.String message, ISFSObject params)
Sends a public chat message.void
SFSMMOApi. sendPublicMessage(Room targetRoom, User sender, java.lang.String message, ISFSObject params, Vec3D aoi)
Sends a public chat message.void
ISFSMMOApi. setMMOItemPosition(BaseMMOItem item, Vec3D pos, Room targetRoom)
Set or update an MMOItem inside an MMORoomvoid
SFSMMOApi. setMMOItemPosition(BaseMMOItem item, Vec3D pos, Room targetRoom)
Set or update an MMOItem inside an MMORoomvoid
ISFSApi. setRoomVariables(User user, Room targetRoom, java.util.List<RoomVariable> variables)
Set Room Variables.void
ISFSApi. setRoomVariables(User user, Room targetRoom, java.util.List<RoomVariable> variables, boolean fireClientEvent, boolean fireServerEvent, boolean overrideOwnership)
Set Room Variables.void
SFSApi. setRoomVariables(User user, Room targetRoom, java.util.List<RoomVariable> variables)
Set Room Variables.void
SFSApi. setRoomVariables(User user, Room targetRoom, java.util.List<RoomVariable> variables, boolean fireClientEvent, boolean fireServerEvent, boolean overrideOwnership)
Set Room Variables.void
ISFSMMOApi. setUserPosition(User user, Vec3D pos, Room targetRoom)
Set the new User position inside an MMORoomvoid
SFSMMOApi. setUserPosition(User user, Vec3D pos, Room targetRoom)
Set the new User position inside an MMORoomvoid
ISFSApi. spectatorToPlayer(User user, Room targetRoom, boolean fireClientEvent, boolean fireServerEvent)
Turns a spectator in a Game Room to a Player.void
SFSApi. 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.Room
ISFSGameApi. quickJoinGame(User player, MatchExpression expression, java.util.Collection<Room> searchableRooms, Room roomToLeave)
Quick join a User in an SFSGame.Room
SFSGameApi. 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 class
SFSRoom
OverviewMethods in com.smartfoxserver.v2.entities that return Room Modifier and Type Method Description Room
DefaultRoomFactory. createNewRoom(CreateRoomSettings settings)
Room
IRoomFactory. createNewRoom(CreateRoomSettings settings)
Room
SFSZone. createRoom(CreateRoomSettings params)
Use theSFSApi.createRoom(Zone, CreateRoomSettings, User)
method insteadRoom
SFSZone. createRoom(CreateRoomSettings params, User user)
Use theSFSApi.createRoom(Zone, CreateRoomSettings, User)
method insteadRoom
Zone. createRoom(CreateRoomSettings params)
Room
Zone. createRoom(CreateRoomSettings params, User user)
Room
SFSUser. getLastJoinedRoom()
Room
User. getLastJoinedRoom()
A reference to the last Room that was joined by this UserRoom
SFSZone. getRoomById(int id)
Get a Room from its unique IDRoom
Zone. getRoomById(int id)
Get a Room from its unique IDRoom
SFSZone. getRoomByName(java.lang.String name)
Get a Room from its nameRoom
Zone. 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 void
SFSUser. addCreatedRoom(Room room)
void
User. addCreatedRoom(Room room)
void
SFSUser. addJoinedRoom(Room room)
void
User. addJoinedRoom(Room room)
void
SFSUser. addPersistentRoomVarReference(Room target)
void
User. addPersistentRoomVarReference(Room target)
void
SFSZone. addRoom(Room room)
void
Zone. addRoom(Room room)
INTERNALvoid
SFSZone. changeRoomCapacity(Room room, int newMaxUsers, int newMaxSpect)
void
Zone. changeRoomCapacity(Room room, int newMaxUsers, int maxMaxSpect)
INTERNALvoid
SFSZone. changeRoomName(Room room, java.lang.String newName)
void
Zone. changeRoomName(Room room, java.lang.String newName)
INTERNALvoid
SFSZone. changeRoomPasswordState(Room room, java.lang.String password)
void
Zone. changeRoomPasswordState(Room room, java.lang.String password)
INTERNALvoid
SFSZone. checkAndRemove(Room room)
void
Zone. checkAndRemove(Room room)
int
SFSUser. getPlayerId(Room room)
int
User. getPlayerId(Room room)
Get the playerId for the User in a specific Roomboolean
SFSUser. isJoinedInRoom(Room room)
boolean
User. isJoinedInRoom(Room room)
Check if a User is joined in a Roomboolean
SFSUser. isPlayer(Room room)
boolean
User. isPlayer(Room room)
Check if the User is Player in a specific Roomboolean
SFSUser. isSpectator(Room room)
boolean
User. isSpectator(Room room)
Check if the User is Spectator in a specific Roomvoid
SFSUser. removeCreatedRoom(Room room)
void
User. removeCreatedRoom(Room room)
void
SFSUser. removeJoinedRoom(Room room)
void
User. removeJoinedRoom(Room room)
void
SFSZone. removeRoom(Room room)
void
Zone. removeRoom(Room room)
INTERNALvoid
SFSZone. removeUserFromRoom(User user, Room room)
void
Zone. removeUserFromRoom(User user, Room room)
INTERNALvoid
SFSUser. setPlayerId(int id, Room room)
void
User. setPlayerId(int id, Room room)
ISFSArray
SFSUser. toSFSArray(Room room)
ISFSArray
User. 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 boolean
MatchingUtils. 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 Room
BaseSFSExtension. getParentRoom()
Return the parent Room of the Extension.Room
ISFSExtension. getParentRoom()
Return the parent Room of the Extension.Methods in com.smartfoxserver.v2.extensions with parameters of type Room Modifier and Type Method Description void
BaseSFSExtension. setParentRoom(Room room)
void
ISFSExtension. 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 class
SFSGame
IntroductionMethods in com.smartfoxserver.v2.game that return Room Modifier and Type Method Description protected Room
BaseGameInvitationCallback. 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 void
CreateSFSGameSettings. 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 class
MMORoom
Overview -
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 void
IRoomStorage. 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 Room
DefaultPlayerIdGenerator. getParentRoom()
Room
IPlayerIdGenerator. getParentRoom()
Get a reference to the parent RoomMethods in com.smartfoxserver.v2.util with parameters of type Room Modifier and Type Method Description void
DefaultPlayerIdGenerator. setParentRoom(Room room)
void
IPlayerIdGenerator. setParentRoom(Room room)
-