Modifier and Type | Method and Description |
---|---|
User |
SFSApi.createNPC(java.lang.String userName,
Zone zone,
boolean forceLogin)
Create connection-less NPC (Non-Player Character).
|
User |
ISFSApi.createNPC(java.lang.String userName,
Zone zone,
boolean forceLogin)
Create connection-less NPC (Non-Player Character).
|
User |
SFSApi.getUserById(int userId)
Finds a User from its unique ID
|
User |
ISFSApi.getUserById(int userId)
Finds a User from its unique ID
|
User |
SFSApi.getUserByName(java.lang.String name)
Finds a User from its name
|
User |
ISFSApi.getUserByName(java.lang.String name)
Finds a User from its name
|
User |
SFSApi.getUserBySession(ISession session)
Finds a User from its Session
|
User |
ISFSApi.getUserBySession(ISession session)
Finds a User from its Session
|
User |
SFSApi.login(ISession sender,
java.lang.String name,
java.lang.String pass,
java.lang.String zoneName,
ISFSObject paramsOut)
Logs a client into a Zone, allowing it to become a User
The login process is central to SmartFoxServer because it generates a User object.
|
User |
ISFSApi.login(ISession session,
java.lang.String name,
java.lang.String pass,
java.lang.String zoneName,
ISFSObject params)
Logs a client into a Zone, allowing it to become a User
The login process is central to SmartFoxServer because it generates a User object.
|
User |
SFSApi.login(ISession sender,
java.lang.String name,
java.lang.String pass,
java.lang.String zoneName,
ISFSObject paramsOut,
boolean forceLogout)
Uses additional flag to disconnect previous user with same username
|
User |
ISFSApi.login(ISession session,
java.lang.String name,
java.lang.String pass,
java.lang.String zoneName,
ISFSObject params,
boolean forceLogout)
Uses additional flag to disconnect previous user with same username
|
Modifier and Type | Method and Description |
---|---|
java.util.List<User> |
SFSApi.findUsers(java.util.Collection<User> userList,
MatchExpression expression,
int limit)
Find one or more User(s) in the specified collection of Users.
|
java.util.List<User> |
ISFSApi.findUsers(java.util.Collection<User> userList,
MatchExpression expression,
int limit)
Find one or more User(s) in the specified collection of Users.
|
Modifier and Type | Method and Description |
---|---|
void |
ISFSBuddyApi.addBuddy(User owner,
java.lang.String buddyName,
boolean isTemp,
boolean fireClientEvent,
boolean fireServerEvent)
Adds a new buddy to the BuddyList of the specified User.
|
void |
SFSBuddyApi.addBuddy(User owner,
java.lang.String buddyName,
boolean isTemp,
boolean fireClientEvent,
boolean fireServerEvent)
Adds a new buddy to the BuddyList of the specified User.
|
void |
SFSApi.banUser(User userToBan,
User modUser,
java.lang.String banMessage,
BanMode mode,
int durationMinutes,
int delaySeconds)
Ban a User.
|
void |
ISFSApi.banUser(User userToBan,
User modUser,
java.lang.String banMessage,
BanMode mode,
int durationMinutes,
int delaySeconds)
Ban a User.
|
void |
ISFSBuddyApi.blockBuddy(User owner,
java.lang.String buddyName,
boolean isBlocked,
boolean fireClientEvent,
boolean fireServerEvent)
Block/Unblock a Buddy in the owner's BuddyList
Blocked buddies won't be able to see the owner online status and send him messages or updates
|
void |
SFSBuddyApi.blockBuddy(User owner,
java.lang.String buddyName,
boolean isBlocked,
boolean fireClientEvent,
boolean fireServerEvent)
Block/Unblock a Buddy in the owner's BuddyList
Blocked buddies won't be able to see the owner online status and send him messages or updates
|
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 |
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) |
void |
SFSApi.disconnectUser(User user)
Disconnect a User from the server.
|
void |
ISFSApi.disconnectUser(User user)
Disconnect User abruptly
|
void |
SFSApi.disconnectUser(User user,
IDisconnectionReason reason)
Disconnect a User indicating one specific reason (for example because the User was Idle).
|
void |
ISFSApi.disconnectUser(User user,
IDisconnectionReason reason)
Disconnect a User indicating one specific reason (for example because the User was Idle).
|
void |
ISFSBuddyApi.goOnline(User user,
boolean online,
boolean fireServerEvent)
Activates/De-activates the Buddy ONLINE status of the User.
|
void |
SFSBuddyApi.goOnline(User user,
boolean online,
boolean fireServerEvent)
Activates/De-activates the Buddy ONLINE status of the User.
|
BuddyList |
ISFSBuddyApi.initBuddyList(User user,
boolean fireServerEvent)
Initialize the buddy list for the requested User.
|
BuddyList |
SFSBuddyApi.initBuddyList(User user,
boolean fireServerEvent)
Initialize the buddy list for the requested User.
|
protected void |
SFSBuddyApi.initializeBuddyState(User user) |
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.kickUser(User userToKick,
User modUser,
java.lang.String kickMessage,
int delaySeconds)
Kicks the User out.
|
void |
ISFSApi.kickUser(User userToKick,
User modUser,
java.lang.String kickMessage,
int delaySeconds)
Kicks the User out.
|
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.logout(User user)
Log a User out of the current Zone
|
void |
ISFSApi.logout(User user)
Log a User out of the current Zone
|
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)
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.
|
void |
ISFSBuddyApi.removeBuddy(User owner,
java.lang.String buddyName,
boolean fireClientEvent,
boolean fireServerEvent)
Remove a Buddy from the owner's BuddyList
|
void |
SFSBuddyApi.removeBuddy(User owner,
java.lang.String buddyName,
boolean fireClientEvent,
boolean fireServerEvent)
Remove a Buddy from the owner's BuddyList
|
void |
ISFSGameApi.replyToInvitation(User invitedUser,
int invitationId,
InvitationResponse reply,
ISFSObject params,
boolean fireClientEvent)
Handle the Invitation reply of a User
|
void |
SFSGameApi.replyToInvitation(User invitedUser,
int invitationId,
InvitationResponse reply,
ISFSObject params,
boolean fireClientEvent)
Handle the Invitation reply of a User
|
void |
SFSApi.sendAdminMessage(User sender,
java.lang.String message,
ISFSObject params,
java.util.Collection<ISession> recipients)
Sends a administrator message to a number of Users.
|
void |
ISFSApi.sendAdminMessage(User sender,
java.lang.String message,
ISFSObject params,
java.util.Collection<ISession> recipients)
Sends a administrator message to a number of Users.
|
void |
SFSApi.sendBuddyMessage(User sender,
User recipient,
java.lang.String message,
ISFSObject params) |
void |
ISFSApi.sendBuddyMessage(User sender,
User recipient,
java.lang.String message,
ISFSObject params) |
void |
ISFSBuddyApi.sendBuddyMessage(User sender,
User recipient,
java.lang.String message,
ISFSObject params)
Send a Buddy Message to any Buddy in your list.
|
void |
SFSBuddyApi.sendBuddyMessage(User sender,
User recipient,
java.lang.String message,
ISFSObject params)
Send a Buddy Message to any Buddy in your list.
|
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 |
SFSApi.sendGenericMessage(com.smartfoxserver.v2.api.GenericMessageType type,
User sender,
int targetRoomId,
java.lang.String message,
ISFSObject params,
java.util.Collection<ISession> recipients) |
void |
ISFSApi.sendGenericMessage(com.smartfoxserver.v2.api.GenericMessageType type,
User sender,
int targetRoomId,
java.lang.String message,
ISFSObject params,
java.util.Collection<ISession> recipients) |
void |
ISFSGameApi.sendInvitation(User inviter,
java.util.List<User> invitees,
int expirySeconds,
InvitationCallback callBackHandler,
ISFSObject params)
Send an Invitation to a User.
|
void |
SFSGameApi.sendInvitation(User inviter,
java.util.List<User> invitees,
int expirySeconds,
InvitationCallback callBackHandler,
ISFSObject params)
Send an Invitation to a User.
|
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.sendModeratorMessage(User sender,
java.lang.String message,
ISFSObject params,
java.util.Collection<ISession> recipients)
Sends a moderator message to a number of Users.
|
void |
ISFSApi.sendModeratorMessage(User sender,
java.lang.String message,
ISFSObject params,
java.util.Collection<ISession> recipients)
Sends a moderator message to a number of Users.
|
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.sendPrivateMessage(User sender,
User recipient,
java.lang.String message,
ISFSObject params)
Sends a private chat message.
|
void |
ISFSApi.sendPrivateMessage(User sender,
User recipient,
java.lang.String message,
ISFSObject params)
Sends a private chat message.
|
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 |
ISFSBuddyApi.setBuddyVariables(User owner,
java.util.List<BuddyVariable> buddyVariables,
boolean fireClientEvent,
boolean fireServerEvent)
Set any number of BuddyVariables for the specified owner
|
void |
SFSBuddyApi.setBuddyVariables(User owner,
java.util.List<BuddyVariable> buddyVariables,
boolean fireClientEvent,
boolean fireServerEvent)
Set any number of BuddyVariables for the specified owner
|
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.setUserVariables(User owner,
java.util.List<UserVariable> variables)
Set User Variables.
|
void |
ISFSApi.setUserVariables(User owner,
java.util.List<UserVariable> variables)
Set User Variables.
|
void |
SFSApi.setUserVariables(User owner,
java.util.List<UserVariable> variables,
boolean fireClientEvent,
boolean fireServerEvent)
Set User Variables.
|
void |
ISFSApi.setUserVariables(User owner,
java.util.List<UserVariable> variables,
boolean fireClientEvent,
boolean fireServerEvent)
Set User Variables.
|
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.
|
void |
SFSApi.subscribeRoomGroup(User user,
java.lang.String groupId)
Subscribe User to a Room Group.
|
void |
ISFSApi.subscribeRoomGroup(User user,
java.lang.String groupId)
Subscribe User to a Room Group.
|
void |
SFSApi.unsubscribeRoomGroup(User user,
java.lang.String groupId)
Unsubscribe User to a Room Group.
|
void |
ISFSApi.unsubscribeRoomGroup(User user,
java.lang.String groupId)
Unsubscribe User to a Room Group.
|
Modifier and Type | Method and Description |
---|---|
java.util.List<User> |
SFSApi.findUsers(java.util.Collection<User> userList,
MatchExpression expression,
int limit)
Find one or more User(s) in the specified collection of Users.
|
java.util.List<User> |
ISFSApi.findUsers(java.util.Collection<User> userList,
MatchExpression expression,
int limit)
Find one or more User(s) in the specified collection of Users.
|
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 |
ISFSGameApi.sendInvitation(User inviter,
java.util.List<User> invitees,
int expirySeconds,
InvitationCallback callBackHandler,
ISFSObject params)
Send an Invitation to a User.
|
void |
SFSGameApi.sendInvitation(User inviter,
java.util.List<User> invitees,
int expirySeconds,
InvitationCallback callBackHandler,
ISFSObject params)
Send an Invitation to a User.
|
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.
|
Modifier and Type | Method and Description |
---|---|
User |
SFSBuddyList.getOwner() |
User |
BuddyList.getOwner()
Get the User that owns this BuddyList
|
Modifier and Type | Method and Description |
---|---|
static java.util.List<java.lang.String> |
BuddyUtils.filterNonMutualRecipients(User sender,
java.util.List<java.lang.String> recipientNames) |
Modifier and Type | Method and Description |
---|---|
void |
ISignUpAssistantPlugin.execute(User user,
ISFSObject params,
SignUpConfiguration config)
Handles the execution of the plugin logic
|
java.lang.String[] |
IPasswordManager.generateRandom(User user) |
void |
SignUpAssistantComponent.handleClientRequest(User sender,
ISFSObject params) |
ISFSObject |
LegacyPasswordRecovery.recover(SignUpAssistantComponent suac,
User user,
ISFSObject params) |
ISFSObject |
IPasswordRecovery.recover(SignUpAssistantComponent suac,
User user,
ISFSObject params) |
ISFSObject |
CustomFieldPasswordRecovery.recover(SignUpAssistantComponent suac,
User user,
ISFSObject params) |
Modifier and Type | Method and Description |
---|---|
FilterAction |
ReadOnlyUserVariablesFilter.handleClientRequest(User sender,
ISFSObject params) |
FilterAction |
ISystemFilter.handleClientRequest(User sender,
ISFSObject params)
Handles a client request
|
FilterAction |
SysControllerFilterChain.runRequest(User sender,
ISFSObject params) |
FilterAction |
ISystemFilterChain.runRequest(User sender,
ISFSObject params) |
Modifier and Type | Class and Description |
---|---|
class |
SFSUser
Overview
The User object represents a connected and logged in client in the system.
|
Modifier and Type | Method and Description |
---|---|
User |
Loggable.doLogin(LoginData ld) |
User |
SFSRoom.getOwner()
Get the owner of the Room (the user that created it)
|
User |
Room.getOwner()
Get the owner of the Room (the user that created it)
|
User |
Zone.getUserById(int id)
Get a User from its unique ID
|
User |
SFSZone.getUserById(int id)
Get a User from its unique ID
|
User |
SFSRoom.getUserById(int id) |
User |
Room.getUserById(int id) |
User |
Zone.getUserByName(java.lang.String name)
Get a User from its name
|
User |
SFSZone.getUserByName(java.lang.String name)
Get a User from its name
|
User |
SFSRoom.getUserByName(java.lang.String name) |
User |
Room.getUserByName(java.lang.String name) |
User |
SFSRoom.getUserByPlayerId(int playerId)
Get the User currently having the specified playerId (Game Room only)
|
User |
Room.getUserByPlayerId(int playerId)
Get the User currently having the specified playerId (Game Room only)
|
User |
Zone.getUserBySession(ISession session)
Get a User from its Session object
|
User |
SFSZone.getUserBySession(ISession session)
Get a User from its Session object
|
User |
SFSRoom.getUserBySession(ISession session) |
User |
Room.getUserBySession(ISession session) |
User |
Zone.login(LoginData loginData)
|
User |
SFSZone.login(LoginData loginData)
|
Modifier and Type | Method and Description |
---|---|
java.util.List<User> |
User.getLastProxyList() |
java.util.List<User> |
SFSUser.getLastProxyList() |
java.util.List<User> |
SFSRoom.getPlayersList()
For Game Rooms: get all Players in the Room (same as all User without the Spectators)
|
java.util.List<User> |
Room.getPlayersList()
For Game Rooms: get all Players in the Room (same as all User without the Spectators)
|
java.util.List<User> |
SFSRoom.getSpectatorsList()
For Game Rooms: get all Spectators in the Room (same as all User without the Players)
|
java.util.List<User> |
Room.getSpectatorsList()
For Game Rooms: get all Spectators in the Room (same as all User without the Players)
|
java.util.Collection<User> |
Zone.getUserList()
Get the list of Users logged in the Zone
|
java.util.Collection<User> |
SFSZone.getUserList()
Get the list of Users logged in the Zone
|
java.util.List<User> |
SFSRoom.getUserList()
Get all Users in the Room
|
java.util.List<User> |
Room.getUserList()
Get all Users in the Room
|
java.util.Collection<User> |
Zone.getUsersInGroup(java.lang.String groupId)
Get a list of Users from all Rooms in the provided Room Group
|
java.util.Collection<User> |
SFSZone.getUsersInGroup(java.lang.String groupId)
Get a list of Users from all Rooms in the provided Room Group
|
Modifier and Type | Method and Description |
---|---|
void |
SFSRoom.addUser(User user) |
void |
Room.addUser(User user) |
void |
SFSRoom.addUser(User user,
boolean asSpectator) |
void |
Room.addUser(User user,
boolean asSpectator) |
boolean |
SFSRoom.containsUser(User user)
Checks if the specified User is joined in the Room
|
boolean |
Room.containsUser(User user)
Checks if the specified User is joined in the Room
|
Room |
Zone.createRoom(CreateRoomSettings params,
User user) |
Room |
SFSZone.createRoom(CreateRoomSettings params,
User user)
Use the
SFSApi.createRoom(Zone, CreateRoomSettings, User) method instead |
void |
LoginFinalizer.doFinalize(User user) |
void |
ILoginFinalizer.doFinalize(User user) |
java.util.List<RoomVariable> |
SFSRoom.getVariablesCreatedByUser(User user)
Get a list of Room Variables created by a specific User
|
java.util.List<RoomVariable> |
Room.getVariablesCreatedByUser(User user)
Get a list of Room Variables created by a specific User
|
void |
Zone.removeUser(User user)
INTERNAL
Instead use
SFSApi.disconnectUser(User) |
void |
SFSZone.removeUser(User user)
INTERNAL
Instead use
SFSApi.disconnectUser(User) |
void |
SFSRoom.removeUser(User user) |
void |
Room.removeUser(User user) |
void |
Zone.removeUserFromRoom(User user,
Room room)
INTERNAL
Instead use
SFSApi.leaveRoom(User, Room) |
void |
SFSZone.removeUserFromRoom(User user,
Room room)
|
java.util.List<RoomVariable> |
SFSRoom.removeVariablesCreatedByUser(User user) |
java.util.List<RoomVariable> |
Room.removeVariablesCreatedByUser(User user) |
java.util.List<RoomVariable> |
SFSRoom.removeVariablesCreatedByUser(User user,
boolean isLeaveRoom) |
java.util.List<RoomVariable> |
Room.removeVariablesCreatedByUser(User user,
boolean isLeaveRoom) |
void |
SFSRoom.setOwner(User owner) |
void |
Room.setOwner(User user) |
void |
SFSRoom.switchPlayerToSpectator(User user) |
void |
Room.switchPlayerToSpectator(User user) |
void |
SFSRoom.switchSpectatorToPlayer(User user) |
void |
Room.switchSpectatorToPlayer(User user) |
Modifier and Type | Method and Description |
---|---|
void |
User.setLastProxyList(java.util.List<User> proxyList) |
void |
SFSUser.setLastProxyList(java.util.List<User> proxyList) |
Constructor and Description |
---|
SFSBannedUser(User user,
int durationMinutes,
BanMode mode) |
SFSBannedUser(User user,
int durationMinutes,
BanMode mode,
java.lang.String reason,
java.lang.String adminName) |
Modifier and Type | Field and Description |
---|---|
protected java.util.Map<User,java.util.List<Invitation>> |
SFSInvitationManager.invitationsByOwner |
Modifier and Type | Method and Description |
---|---|
User |
SFSInvitation.getInvitee() |
User |
Invitation.getInvitee()
Get the Invitee, the user that receives the invitation
|
User |
SFSInvitation.getInviter() |
User |
Invitation.getInviter()
Get the Inviter, the user that started this invitation
|
Constructor and Description |
---|
SFSInvitation(User inviter,
User invitee,
int secondsForAnswer) |
SFSInvitation(User inviter,
User invitee,
int secondsForAnswer,
ISFSObject params) |
Modifier and Type | Method and Description |
---|---|
void |
SFSBannedUserManager.banUser(User userToBan,
User modUser,
int durationMinutes,
BanMode mode,
java.lang.String reason,
java.lang.String banMessage,
int delaySeconds) |
void |
SFSBannedUserManager.kickUser(User userToKick,
User modUser,
java.lang.String kickMessage,
int delaySeconds) |
void |
SFSBannedUserManager.kickUser(User userToKick,
User modUser,
java.lang.String kickMessage,
int delaySeconds,
boolean isBan) |
void |
SFSBannedUserManager.sendWarningMessage(User recipient,
User senderMod,
java.lang.String message) |
Modifier and Type | Method and Description |
---|---|
java.util.List<User> |
MatchingUtils.matchUsers(java.util.Collection<User> userList,
MatchExpression conditions) |
java.util.List<User> |
MatchingUtils.matchUsers(java.util.Collection<User> userList,
MatchExpression conditions,
int limit) |
Modifier and Type | Method and Description |
---|---|
boolean |
MatchingUtils.matchUser(User user,
MatchExpression conditions) |
Modifier and Type | Method and Description |
---|---|
java.util.List<User> |
MatchingUtils.matchUsers(java.util.Collection<User> userList,
MatchExpression conditions) |
java.util.List<User> |
MatchingUtils.matchUsers(java.util.Collection<User> userList,
MatchExpression conditions,
int limit) |
Modifier and Type | Method and Description |
---|---|
User |
RoomVariable.getOwner()
Return the User that created the variable.
|
User |
SFSRoomVariable.getOwner()
Return the User that created the variable.
|
Modifier and Type | Method and Description |
---|---|
void |
RoomVariable.setOwner(User user)
Sets the creator of a variable.
|
void |
SFSRoomVariable.setOwner(User user)
Sets the creator of a variable.
|
Modifier and Type | Method and Description |
---|---|
void |
ISFSExtension.handleClientRequest(java.lang.String cmdName,
User sender,
ISFSObject params)
This method is called whenever a client sends a request to this Extension
|
void |
SFSExtension.handleClientRequest(java.lang.String requestId,
User sender,
ISFSObject params)
This method is called whenever a client sends a request to this Extension
|
void |
IClientRequestHandler.handleClientRequest(User sender,
ISFSObject params)
Handle a client request
|
protected void |
BaseServerEventHandler.send(java.lang.String cmdName,
ISFSObject params,
User recipient)
Send a response back to a User
|
protected void |
BaseClientRequestHandler.send(java.lang.String cmdName,
ISFSObject params,
User recipient)
Send a response back to a User
|
void |
ISFSExtension.send(java.lang.String cmdName,
ISFSObject params,
User recipient) |
void |
BaseSFSExtension.send(java.lang.String cmdName,
ISFSObject params,
User recipient) |
protected void |
BaseServerEventHandler.send(java.lang.String cmdName,
ISFSObject params,
User recipient,
boolean useUDP)
Send a response back to a User
|
protected void |
BaseClientRequestHandler.send(java.lang.String cmdName,
ISFSObject params,
User recipient,
boolean useUDP)
Send a response back to a User
|
void |
ISFSExtension.send(java.lang.String cmdName,
ISFSObject params,
User recipient,
boolean useUDP)
Send an extension message/response to a single User
|
void |
BaseSFSExtension.send(java.lang.String cmdName,
ISFSObject params,
User recipient,
boolean useUDP) |
Modifier and Type | Method and Description |
---|---|
protected void |
BaseServerEventHandler.send(java.lang.String cmdName,
ISFSObject params,
java.util.List<User> recipients)
Broadcast a response back to multiple Users
|
protected void |
BaseClientRequestHandler.send(java.lang.String cmdName,
ISFSObject params,
java.util.List<User> recipients)
Broadcast a response back to multiple Users
|
void |
ISFSExtension.send(java.lang.String cmdName,
ISFSObject params,
java.util.List<User> recipients) |
void |
BaseSFSExtension.send(java.lang.String cmdName,
ISFSObject params,
java.util.List<User> recipients) |
protected void |
BaseServerEventHandler.send(java.lang.String cmdName,
ISFSObject params,
java.util.List<User> recipients,
boolean useUDP)
Broadcast a response back to multiple Users
|
protected void |
BaseClientRequestHandler.send(java.lang.String cmdName,
ISFSObject params,
java.util.List<User> recipients,
boolean useUDP)
Broadcast a response back to multiple Users
|
void |
ISFSExtension.send(java.lang.String cmdName,
ISFSObject params,
java.util.List<User> recipients,
boolean useUDP)
Send an extension message/response to a list of recipients
|
void |
BaseSFSExtension.send(java.lang.String cmdName,
ISFSObject params,
java.util.List<User> recipients,
boolean useUDP)
Send an extension message/response to a list of recipients
|
Modifier and Type | Method and Description |
---|---|
FilterAction |
IFilter.handleClientRequest(java.lang.String requestId,
User sender,
ISFSObject params)
Handles a client request
|
FilterAction |
SFSExtensionFilterChain.runRequestInChain(java.lang.String requestId,
User sender,
ISFSObject params) |
FilterAction |
IFilterChain.runRequestInChain(java.lang.String requestId,
User sender,
ISFSObject params) |
Modifier and Type | Method and Description |
---|---|
java.util.List<User> |
CreateSFSGameSettings.getInvitedPlayers()
For private games only:
A list of players invited to play in the Game.
|
Modifier and Type | Method and Description |
---|---|
void |
SFSGame.addUser(User user,
boolean asSpectator) |
void |
SFSGame.removeUser(User user) |
void |
SFSGame.switchPlayerToSpectator(User user) |
void |
SFSGame.switchSpectatorToPlayer(User user) |
Modifier and Type | Method and Description |
---|---|
void |
CreateSFSGameSettings.setInvitedPlayers(java.util.List<User> invitedPlayers)
Set a list of people invited to play a private Game
|
Modifier and Type | Method and Description |
---|---|
User |
MMORoom.getUserByPlayerId(int playerId) |
Modifier and Type | Method and Description |
---|---|
java.util.List<User> |
MMORoom.getPlayersList() |
java.util.List<User> |
MMORoom.getProximityList(User target)
Returns the List of Users falling within the target's AOI
|
java.util.List<User> |
MMORoom.getProximityList(User target,
Vec3D aoi)
Returns the List of Users falling within the a custom AOI around the target
|
java.util.List<User> |
MMORoom.getProximityList(Vec3D position)
Returns the List of Users falling within the AOI of the target position
|
java.util.List<User> |
MMORoom.getProximityList(Vec3D position,
Vec3D aoi)
Returns the List of Users falling within the custom AOI around the target position
|
java.util.List<User> |
MMORoom.PreviousMMORoomState.getProxyList() |
java.util.List<User> |
MMORoom.getSpectatorsList() |
Modifier and Type | Method and Description |
---|---|
void |
MMORoom.addUser(User user,
boolean asSpectator)
private
|
com.smartfoxserver.v2.mmo.P3D |
MMORoom.findUserLocation(User user)
private
|
java.util.List<BaseMMOItem> |
MMORoom.getProximityItems(User target)
Get the list of MMOItems falling within the User's AoI
|
java.util.List<BaseMMOItem> |
MMORoom.getProximityItems(User target,
Vec3D aoi)
Get the list of MMOItems falling within a custom AoI
|
java.util.List<User> |
MMORoom.getProximityList(User target)
Returns the List of Users falling within the target's AOI
|
java.util.List<User> |
MMORoom.getProximityList(User target,
Vec3D aoi)
Returns the List of Users falling within the a custom AOI around the target
|
void |
MMORoom.removeUser(User user)
private
|
void |
MMORoom.updateUser(User user)
private
|
Constructor and Description |
---|
PreviousMMORoomState(int roomId,
java.util.List<User> proxyList) |
Modifier and Type | Method and Description |
---|---|
boolean |
SFSPrivilegeManager.isFlagSet(User user,
SystemPermission permission) |
boolean |
PrivilegeManager.isFlagSet(User user,
SystemPermission permission) |
boolean |
SFSPrivilegeManager.isRequestAllowed(User user,
SystemRequest request) |
boolean |
PrivilegeManager.isRequestAllowed(User user,
SystemRequest request) |
Modifier and Type | Method and Description |
---|---|
static User |
UsersUtil.getServerAdmin() |
static User |
UsersUtil.getServerModerator() |
Modifier and Type | Method and Description |
---|---|
com.smartfoxserver.v2.util.filters.FilteredMessage |
IWordFilter.apply(java.lang.String message,
User user) |
com.smartfoxserver.v2.util.filters.FilteredMessage |
SFSWordFilter.apply(java.lang.String message,
User user)
Applies the filter to a message/string of a User.
|
void |
IFloodFilter.filterRequest(SystemRequest reqType,
User user) |
void |
SFSFloodFilter.filterRequest(SystemRequest reqType,
User user) |
static boolean |
UsersUtil.isAllowedToPerformNewSearch(User user) |
static boolean |
UsersUtil.usersSeeEachOthers(User sender,
User recipient) |