Modifier and Type | Method and Description |
---|---|
Room |
ISFSGameApi.createGame(Zone zone,
CreateSFSGameSettings settings,
User owner)
Create an SFSGame Room and automatically update the clients and fire a server event
|
Room |
SFSGameApi.createGame(Zone zone,
CreateSFSGameSettings settings,
User owner)
Create an SFSGame Room and automatically update the clients and fire a server event
|
Room |
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,
boolean fireClientEvent,
boolean fireServerEvent)
Create an SFSGame Room.
|
Room |
SFSApi.createRoom(Zone zone,
CreateRoomSettings params,
User owner)
Create a new Room
|
Room |
ISFSApi.createRoom(Zone zone,
CreateRoomSettings settings,
User owner)
Create a new Room
|
Room |
SFSApi.createRoom(Zone zone,
CreateRoomSettings params,
User owner,
boolean joinIt,
Room roomToLeave)
Create a new Room
|
Room |
ISFSApi.createRoom(Zone zone,
CreateRoomSettings settings,
User owner,
boolean joinIt,
Room roomToLeave)
Create a new Room
|
Room |
SFSApi.createRoom(Zone zone,
CreateRoomSettings params,
User owner,
boolean joinIt,
Room roomToLeave,
boolean fireClientEvent,
boolean fireServerEvent) |
Room |
ISFSApi.createRoom(Zone zone,
CreateRoomSettings settings,
User owner,
boolean joinIt,
Room roomToLeave,
boolean fireClientEvent,
boolean fireServerEvent) |
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.
|
Room |
ISFSGameApi.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)
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 |
SFSGameApi.quickJoinGame(User player,
MatchExpression expression,
Zone zone,
java.lang.String groupId,
Room roomToLeave)
Quick join a User in an SFSGame.
|
Modifier and Type | Method and Description |
---|---|
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.
|
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.
|
Modifier and Type | Method and Description |
---|---|
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.changeRoomCapacity(User owner,
Room targetRoom,
int maxUsers,
int maxSpectators)
Changes the capacity (max number of Users and Spectators) in the Room.
|
void |
SFSApi.changeRoomName(User owner,
Room targetRoom,
java.lang.String newName)
Rename a Room.
|
void |
ISFSApi.changeRoomName(User owner,
Room targetRoom,
java.lang.String newName)
Rename a Room.
|
void |
SFSApi.changeRoomPassword(User owner,
Room targetRoom,
java.lang.String newPassword)
Changes the Room password and the Room password-state.
|
void |
ISFSApi.changeRoomPassword(User owner,
Room targetRoom,
java.lang.String newPassword)
Changes the Room password and the Room password-state.
|
Room |
SFSApi.createRoom(Zone zone,
CreateRoomSettings params,
User owner,
boolean joinIt,
Room roomToLeave)
Create a new Room
|
Room |
ISFSApi.createRoom(Zone zone,
CreateRoomSettings settings,
User owner,
boolean joinIt,
Room roomToLeave)
Create a new Room
|
Room |
SFSApi.createRoom(Zone zone,
CreateRoomSettings params,
User owner,
boolean joinIt,
Room roomToLeave,
boolean fireClientEvent,
boolean fireServerEvent) |
Room |
ISFSApi.createRoom(Zone zone,
CreateRoomSettings settings,
User owner,
boolean joinIt,
Room roomToLeave,
boolean fireClientEvent,
boolean fireServerEvent) |
void |
SFSApi.joinRoom(User user,
Room room)
Join the user in a room.
|
void |
ISFSApi.joinRoom(User user,
Room room)
Join the user in a room.
|
void |
SFSApi.joinRoom(User user,
Room roomToJoin,
java.lang.String password,
boolean asSpectator,
Room roomToLeave)
Join the user in a room.
|
void |
ISFSApi.joinRoom(User user,
Room roomToJoin,
java.lang.String password,
boolean asSpectator,
Room roomToLeave)
Join the user in a room.
|
void |
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.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.leaveRoom(User user,
Room room)
Makes a user leave a room that he has joined
|
void |
ISFSApi.leaveRoom(User user,
Room room)
Makes a user leave a room that he has joined
|
void |
SFSApi.leaveRoom(User user,
Room room,
boolean fireClientEvent,
boolean fireServerEvent)
Removes a User from a previously joined Room
|
void |
ISFSApi.leaveRoom(User user,
Room room,
boolean fireClientEvent,
boolean fireServerEvent)
Removes a User from a previously joined Room
|
void |
SFSApi.playerToSpectator(User user,
Room targetRoom,
boolean fireClientEvent,
boolean fireServerEvent) |
void |
ISFSApi.playerToSpectator(User user,
Room targetRoom,
boolean fireClientEvent,
boolean fireServerEvent)
Turns a player in a Game Room to a spectator.
|
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.
|
Room |
ISFSGameApi.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,
Zone zone,
java.lang.String groupId,
Room roomToLeave)
Quick join a User in an SFSGame.
|
void |
SFSApi.removeRoom(Room room)
Removes a Room from its Zone
|
void |
ISFSApi.removeRoom(Room room)
Removes a Room from its Zone
|
void |
SFSApi.removeRoom(Room room,
boolean fireClientEvent,
boolean fireServerEvent)
Removes a Room from its Zone
|
void |
ISFSApi.removeRoom(Room room,
boolean fireClientEvent,
boolean fireServerEvent)
Removes a Room from its Zone
|
void |
SFSApi.sendExtensionResponse(java.lang.String cmdName,
ISFSObject params,
java.util.List<User> recipients,
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 |
ISFSApi.sendExtensionResponse(java.lang.String cmdName,
ISFSObject params,
User recipient,
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 |
SFSGameApi.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 |
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 |
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,
boolean asSpect,
boolean leaveLastJoinedRoom,
ISFSObject params)
Invites Users / Players in an existing Room.
|
void |
SFSApi.sendObjectMessage(Room targetRoom,
User sender,
ISFSObject message,
java.util.Collection<User> recipients)
Send an Object message.
|
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 |
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 |
SFSApi.sendPublicMessage(Room targetRoom,
User sender,
java.lang.String message,
ISFSObject params)
Sends a public chat message.
|
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 |
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 MMORoom
|
void |
SFSMMOApi.setMMOItemPosition(BaseMMOItem item,
Vec3D pos,
Room targetRoom)
Set or update an MMOItem inside an MMORoom
|
void |
SFSApi.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)
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 |
ISFSApi.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 MMORoom
|
void |
SFSMMOApi.setUserPosition(User user,
Vec3D pos,
Room targetRoom)
Set the new User position inside an MMORoom
|
void |
SFSApi.spectatorToPlayer(User user,
Room targetRoom,
boolean fireClientEvent,
boolean fireServerEvent) |
void |
ISFSApi.spectatorToPlayer(User user,
Room targetRoom,
boolean fireClientEvent,
boolean fireServerEvent)
Turns a spectator in a Game Room to a Player.
|
Modifier and Type | Method and Description |
---|---|
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.
|
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.
|
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.
|
Modifier and Type | Class and Description |
---|---|
class |
SFSRoom
Overview
The Room object is the main tool to organize and group Users in the application.
|
Modifier and Type | Method and Description |
---|---|
Room |
IRoomFactory.createNewRoom(CreateRoomSettings settings) |
Room |
DefaultRoomFactory.createNewRoom(CreateRoomSettings settings) |
Room |
Zone.createRoom(CreateRoomSettings params) |
Room |
SFSZone.createRoom(CreateRoomSettings params)
Use the
SFSApi.createRoom(Zone, CreateRoomSettings, User) method instead |
Room |
Zone.createRoom(CreateRoomSettings params,
User user) |
Room |
SFSZone.createRoom(CreateRoomSettings params,
User user)
Use the
SFSApi.createRoom(Zone, CreateRoomSettings, User) method instead |
Room |
User.getLastJoinedRoom()
A reference to the last Room that was joined by this User
|
Room |
SFSUser.getLastJoinedRoom() |
Room |
Zone.getRoomById(int id)
Get a Room from its unique ID
|
Room |
SFSZone.getRoomById(int id)
Get a Room from its unique ID
|
Room |
Zone.getRoomByName(java.lang.String name)
Get a Room from its name
|
Room |
SFSZone.getRoomByName(java.lang.String name)
Get a Room from its name
|
Modifier and Type | Method and Description |
---|---|
java.util.List<Room> |
User.getCreatedRooms()
Get a list of Rooms created by this User
|
java.util.List<Room> |
SFSUser.getCreatedRooms() |
java.util.List<Room> |
User.getJoinedRooms()
A list of Rooms currently joined by the User
|
java.util.List<Room> |
SFSUser.getJoinedRooms() |
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 time |
java.util.Map<Room,java.lang.Integer> |
SFSUser.getPlayerIds() |
java.util.List<Room> |
Zone.getRoomList()
Get the list of Rooms in the Zone
|
java.util.List<Room> |
SFSZone.getRoomList()
Get the list of Rooms in the Zone
|
java.util.List<Room> |
Zone.getRoomListFromGroup(java.lang.String groupId)
Get the list of Rooms from a specific Group
|
java.util.List<Room> |
SFSZone.getRoomListFromGroup(java.lang.String groupId)
Get the list of Rooms from a specific Group
|
Modifier and Type | Method and Description |
---|---|
void |
User.addCreatedRoom(Room room) |
void |
SFSUser.addCreatedRoom(Room room) |
void |
User.addJoinedRoom(Room room) |
void |
SFSUser.addJoinedRoom(Room room) |
void |
User.addPersistentRoomVarReference(Room target) |
void |
SFSUser.addPersistentRoomVarReference(Room target) |
void |
Zone.addRoom(Room room)
INTERNAL
Instead use
SFSApi.createRoom(Zone, CreateRoomSettings, User) |
void |
SFSZone.addRoom(Room room) |
void |
Zone.changeRoomCapacity(Room room,
int newMaxUsers,
int maxMaxSpect)
INTERNAL
Instead use
SFSApi.changeRoomCapacity(User, Room, int, int) |
void |
SFSZone.changeRoomCapacity(Room room,
int newMaxUsers,
int newMaxSpect)
|
void |
Zone.changeRoomName(Room room,
java.lang.String newName)
INTERNAL
Instead use
SFSApi.changeRoomName(User, Room, String) |
void |
SFSZone.changeRoomName(Room room,
java.lang.String newName)
|
void |
Zone.changeRoomPasswordState(Room room,
java.lang.String password)
INTERNAL
Instead use
SFSApi.changeRoomPassword(User, Room, String) |
void |
SFSZone.changeRoomPasswordState(Room room,
java.lang.String password)
|
void |
Zone.checkAndRemove(Room room) |
void |
SFSZone.checkAndRemove(Room room) |
int |
User.getPlayerId(Room room)
Get the playerId for the User in a specific Room
|
int |
SFSUser.getPlayerId(Room room) |
boolean |
User.isJoinedInRoom(Room room)
Check if a User is joined in a Room
|
boolean |
SFSUser.isJoinedInRoom(Room room) |
boolean |
User.isPlayer(Room room)
Check if the User is Player in a specific Room
|
boolean |
SFSUser.isPlayer(Room room) |
boolean |
User.isSpectator(Room room)
Check if the User is Spectator in a specific Room
|
boolean |
SFSUser.isSpectator(Room room) |
void |
User.removeCreatedRoom(Room room) |
void |
SFSUser.removeCreatedRoom(Room room) |
void |
User.removeJoinedRoom(Room room) |
void |
SFSUser.removeJoinedRoom(Room room) |
void |
Zone.removeRoom(Room room)
INTERNAL
Instead use
SFSApi.removeRoom(Room) |
void |
SFSZone.removeRoom(Room room)
|
void |
Zone.removeUserFromRoom(User user,
Room room)
INTERNAL
Instead use
SFSApi.leaveRoom(User, Room) |
void |
SFSZone.removeUserFromRoom(User user,
Room room)
|
void |
User.setPlayerId(int id,
Room room) |
void |
SFSUser.setPlayerId(int id,
Room room) |
ISFSArray |
User.toSFSArray(Room room) |
ISFSArray |
SFSUser.toSFSArray(Room room) |
Modifier and Type | Method and 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) |
Modifier and Type | Method and Description |
---|---|
boolean |
MatchingUtils.matchRoom(Room room,
MatchExpression conditions) |
Modifier and Type | Method and 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) |
Modifier and Type | Method and Description |
---|---|
Room |
ISFSExtension.getParentRoom()
Return the parent Room of the Extension.
|
Room |
BaseSFSExtension.getParentRoom()
Return the parent Room of the Extension.
|
Modifier and Type | Method and Description |
---|---|
void |
ISFSExtension.setParentRoom(Room room) |
void |
BaseSFSExtension.setParentRoom(Room room) |
Modifier and Type | Class and Description |
---|---|
class |
SFSGame
Introduction
The SFSGame class is part of the SFS2X Game API which allow advanced Game tools for setting up matches, invite and challenge
users, quick jump into a game, matching users based on custom criteria and more...
|
Modifier and Type | Method and Description |
---|---|
protected Room |
BaseGameInvitationCallback.getGame()
Get the Game
|
Modifier and Type | Method and Description |
---|---|
java.util.List<Room> |
CreateSFSGameSettings.getSearchableRooms()
A list of Rooms where to search for more players to invite in a private Game.
|
Modifier and Type | Method and 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.
|
Constructor and Description |
---|
BaseGameInvitationCallback(Room game,
boolean leaveLastJoinedRoom)
Create a new Callback object keeping track of the Game Room
|
JoinRoomInvitationCallback(Room targetRoom) |
SFSGameInvitationCallback(Room game,
int invitedPlayersCount,
boolean leaveLastJoinedRoom) |
Modifier and Type | Class and Description |
---|---|
class |
MMORoom
Overview
The MMORoom extends the functionalities of a regular Room by adding an Area Of Interest (AOI) to determine the range of the
events that should be received by Users.
|
Modifier and Type | Method and Description |
---|---|
void |
IRoomStorage.saveRoom(Room theRoom)
Save a Room and its state
|
Modifier and Type | Method and Description |
---|---|
Room |
DefaultPlayerIdGenerator.getParentRoom() |
Room |
IPlayerIdGenerator.getParentRoom()
Get a reference to the parent Room
|
Modifier and Type | Method and Description |
---|---|
void |
DefaultPlayerIdGenerator.setParentRoom(Room room) |
void |
IPlayerIdGenerator.setParentRoom(Room room) |