A B C D E F G H I J K L M N O P Q R S T U V
All Classes All Packages
All Classes All Packages
All Classes All Packages
G
- GameServerConnectionRequired - Static variable in class sfs2x.client.requests.BaseRequest
- GenericMessage - Static variable in class sfs2x.client.requests.BaseRequest
-
*Private*
- getAllowNameChange() - Method in class sfs2x.client.requests.RoomPermissions
-
Indicates whether changing the Room name after its creation is allowed or not.
- getAllowPasswordStateChange() - Method in class sfs2x.client.requests.RoomPermissions
-
Indicates whether changing (or removing) the Room password after its creation is allowed or not.
- getAllowPublicMessages() - Method in class sfs2x.client.requests.RoomPermissions
-
Indicates whether users inside the Room are allowed to send public messages or not.
- getAllowResizing() - Method in class sfs2x.client.requests.RoomPermissions
-
Indicates whether the Room capacity can be changed after its creation or not.
- getAllowUserCountChange() - Method in class sfs2x.client.requests.RoomEvents
-
Indicates whether or not the userCountChange event should be dispatched whenever the users (or players+spectators) count changes in the Room.
- getAllowUserEnter() - Method in class sfs2x.client.requests.RoomEvents
-
Indicates whether the userEnterRoom event should be dispatched whenever a user joins the Room or not.
- getAllowUserExit() - Method in class sfs2x.client.requests.RoomEvents
-
Indicates whether the userExitRoom event should be dispatched whenever a user leaves the Room or not.
- getAllowUserVariablesUpdate() - Method in class sfs2x.client.requests.RoomEvents
-
Indicates whether or not the userVariablesUpdate event should be dispatched whenever a user in the Room updates his User Variables.
- getAOIEntryPoint() - Method in interface sfs2x.client.entities.IMMOItem
-
Returns the entry point within the User's AOI where this object "appeared" with the last PROXIMITY_LIST_UPDATE event.
- getAOIEntryPoint() - Method in class sfs2x.client.entities.MMOItem
-
Returns the entry point within the User's AOI where this object "appeared" with the last PROXIMITY_LIST_UPDATE event.
- getAOIEntryPoint() - Method in class sfs2x.client.entities.SFSUser
- getAOIEntryPoint() - Method in interface sfs2x.client.entities.User
-
Returns the entry point within the User's AOI where this client "appeared" with the last PROXIMITY_LIST_UPDATE event.
- getArguments() - Method in class sfs2x.client.core.BaseEvent
-
Returns a Map<String, Object> containing the parameters of the event.
- getBboxHost() - Method in class sfs2x.client.util.ConfigData
-
Specifies the IP address or host name of the BlueBox.
- getBboxPollingRate() - Method in class sfs2x.client.util.ConfigData
-
Specifies the BlueBox polling speed.
- getBoolValue() - Method in class sfs2x.client.entities.variables.BaseVariable
-
Get the value of the variable as Boolean
- getBoolValue() - Method in interface sfs2x.client.entities.variables.Variable
-
Get the value of the variable as Boolean
- getBuddyById(int) - Method in interface sfs2x.client.entities.managers.IBuddyManager
-
Retrieves a Buddy object from its id property.
- getBuddyById(int) - Method in class sfs2x.client.entities.managers.SFSBuddyManager
- getBuddyByName(String) - Method in interface sfs2x.client.entities.managers.IBuddyManager
-
Retrieves a Buddy object from its name property.
- getBuddyByName(String) - Method in class sfs2x.client.entities.managers.SFSBuddyManager
- getBuddyByNickName(String) - Method in interface sfs2x.client.entities.managers.IBuddyManager
-
Retrieves a Buddy object from its nickName property (if set).
- getBuddyByNickName(String) - Method in class sfs2x.client.entities.managers.SFSBuddyManager
- getBuddyList() - Method in interface sfs2x.client.entities.managers.IBuddyManager
-
Returns a list of Buddy objects representing all the buddies in the user's buddies list.
- getBuddyList() - Method in class sfs2x.client.entities.managers.SFSBuddyManager
- getBuddyManager() - Method in interface sfs2x.client.ISmartFox
- getBuddyManager() - Method in class sfs2x.client.SmartFox
-
Returns a reference to the Buddy Manager.
- getBuddyStates() - Method in interface sfs2x.client.entities.managers.IBuddyManager
-
Returns a list of strings representing the available custom buddy states.
- getBuddyStates() - Method in class sfs2x.client.entities.managers.SFSBuddyManager
- getCapacity() - Method in interface sfs2x.client.entities.Room
-
Returns the maximum amount of users, including spectators, that can be contained in this Room.
- getCapacity() - Method in class sfs2x.client.entities.SFSRoom
- getClassName() - Method in class sfs2x.client.requests.RoomExtension
-
Returns the fully qualified name of the main class of the Extension.
- getCompressionThreshold() - Method in class sfs2x.client.SmartFox
-
Returns the current compression threshold.
- getCondition() - Method in class sfs2x.client.entities.match.MatchExpression
-
Returns the matching criteria used during values comparison.
- getConfig() - Method in interface sfs2x.client.ISmartFox
- getConfig() - Method in class sfs2x.client.SmartFox
-
Returns the client configuration details.
- getConnectionMode() - Method in class sfs2x.client.SmartFox
-
Returns the current connection mode after a connection has been successfully established.
- getCurrentIp() - Method in class sfs2x.client.SmartFox
-
Returns the IP address of the SmartFoxServer 2X instance to which the client is connected.
- getCurrentPort() - Method in class sfs2x.client.SmartFox
-
Returns the TCP port of the SmartFoxServer 2X instance to which the client is connected.
- getCurrentZone() - Method in class sfs2x.client.SmartFox
-
Returns the Zone currently in use, if the user is already logged in.
- getDefaultAOI() - Method in class sfs2x.client.entities.MMORoom
-
Returns the default Area of Interest (AoI) of this MMORoom.
- getDefaultAOI() - Method in class sfs2x.client.requests.mmo.MMORoomSettings
-
Defines the Area of Interest (AoI) for the MMORoom.
- getDispatcher() - Method in interface sfs2x.client.ISmartFox
- getDispatcher() - Method in class sfs2x.client.SmartFox
-
* API internal usage only *
- getDoubleValue() - Method in class sfs2x.client.entities.variables.BaseVariable
-
Get the value of the variable as Double
- getDoubleValue() - Method in interface sfs2x.client.entities.variables.Variable
-
Get the value of the variable as Double
- getErrorMessage(short, Object[]) - Static method in class sfs2x.client.util.SFSErrorCodes
-
* API internal usage only *
- getEvents() - Method in class sfs2x.client.requests.RoomSettings
-
Defines the flags indicating which events related to the Room are dispatched by the SmartFox client.
- getExtension() - Method in class sfs2x.client.requests.RoomSettings
-
Defines the Extension that must be attached to the Room on the server-side, and its settings.
- getGroupId() - Method in interface sfs2x.client.entities.Room
-
Returns the Room Group name.
- getGroupId() - Method in class sfs2x.client.entities.SFSRoom
- getGroupId() - Method in class sfs2x.client.requests.RoomSettings
-
Defines the id of the Group to which the Room should belong.
- getHigherLimit() - Method in class sfs2x.client.requests.mmo.MapLimits
-
Obtain the higher coordinate limit
- getHigherMapLimit() - Method in class sfs2x.client.entities.MMORoom
-
Returns the higher coordinates limit of the virtual environment represented by the MMORoom along the X,Y,Z axes.
- getHost() - Method in class sfs2x.client.util.ConfigData
-
Specifies the IP address or host name of the SmartFoxServer 2X instance to connect to (TCP connection).
- getHttpPort() - Method in class sfs2x.client.util.ConfigData
-
Specifies the port for generic HTTP communication.
- getHttpsPort() - Method in class sfs2x.client.util.ConfigData
-
Specifies the port for HTTPS communication.
- getHttpUploadURI() - Method in class sfs2x.client.SmartFox
-
Returns the HTTP URI that can be used to upload files to, using regular HTTP POST.
- getId() - Method in interface sfs2x.client.entities.Buddy
-
Indicates the id of this buddy.
- getId() - Method in interface sfs2x.client.entities.IMMOItem
-
The unique ID of this item
- getId() - Method in interface sfs2x.client.entities.invitation.Invitation
-
Indicates the id of this invitation.
- getId() - Method in class sfs2x.client.entities.invitation.SFSInvitation
- getId() - Method in enum sfs2x.client.entities.match.LogicOperator
-
Returns the id of the current LogicOperator instance.
- getId() - Method in class sfs2x.client.entities.MMOItem
-
The unique ID of this item
- getId() - Method in interface sfs2x.client.entities.Room
-
Indicates the id of this Room.
- getId() - Method in class sfs2x.client.entities.SFSBuddy
- getId() - Method in class sfs2x.client.entities.SFSRoom
- getId() - Method in class sfs2x.client.entities.SFSUser
- getId() - Method in interface sfs2x.client.entities.User
-
Indicates the id of this user.
- getId() - Method in class sfs2x.client.requests.BaseRequest
- getId() - Method in class sfs2x.client.requests.RoomExtension
-
Returns the name of the Extension to be attached to the Room.
- getIntValue() - Method in class sfs2x.client.entities.variables.BaseVariable
-
Get the value of the variable as Integer
- getIntValue() - Method in interface sfs2x.client.entities.variables.Variable
-
Get the value of the variable as Integer
- getInvitationExpiryTime() - Method in class sfs2x.client.requests.cluster.ClusterRoomSettings
-
In private games, defines the number of seconds that the users invited to join the game have to reply to the invitation.
- getInvitationExpiryTime() - Method in class sfs2x.client.requests.game.SFSGameSettings
-
In private games, defines the number of seconds that the users invited to join the game have to reply to the invitation.
- getInvitationParams() - Method in class sfs2x.client.requests.cluster.ClusterRoomSettings
-
In private games, defines an optional object containing additional custom parameters to be sent together with the invitation.
- getInvitationParams() - Method in class sfs2x.client.requests.game.SFSGameSettings
-
In private games, defines an optional object containing additional custom parameters to be sent together with the invitation.
- getInvitedPlayers() - Method in class sfs2x.client.requests.cluster.ClusterRoomSettings
-
In private games, defines a list of User objects representing players to be invited to join the game.
- getInvitedPlayers() - Method in class sfs2x.client.requests.game.SFSGameSettings
-
In private games, defines a list of User objects representing players to be invited to join the game.
- getInvitee() - Method in interface sfs2x.client.entities.invitation.Invitation
-
Returns the User object corresponding to the user who received the invitation.
- getInvitee() - Method in class sfs2x.client.entities.invitation.SFSInvitation
- getInviter() - Method in interface sfs2x.client.entities.invitation.Invitation
-
Returns the User object corresponding to the user who sent the invitation.
- getInviter() - Method in class sfs2x.client.entities.invitation.SFSInvitation
- getJoinedRooms() - Method in interface sfs2x.client.entities.managers.IRoomManager
-
Returns a list of Rooms currently joined by the client.
- getJoinedRooms() - Method in class sfs2x.client.entities.managers.SFSRoomManager
- getJoinedRooms() - Method in interface sfs2x.client.ISmartFox
- getJoinedRooms() - Method in class sfs2x.client.SmartFox
-
Returns a list of Room objects representing the Rooms currently joined by the client.
- getLagMonitor() - Method in interface sfs2x.client.ISmartFox
- getLagMonitor() - Method in class sfs2x.client.SmartFox
-
* API internal usage only *
- getLastJoinedRoom() - Method in interface sfs2x.client.ISmartFox
- getLastJoinedRoom() - Method in class sfs2x.client.SmartFox
-
Returns the object representing the last Room joined by the client, if any.
- getLeaveLastJoinedRoom() - Method in class sfs2x.client.requests.game.SFSGameSettings
-
In private games, indicates whether the players must leave the previous Room when joining the game or not.
- getLogger() - Method in interface sfs2x.client.ISmartFox
- getLogger() - Method in class sfs2x.client.SmartFox
-
Returns a reference to the internal Logger instance used by SmartFoxServer 2X.
- getLogicOp() - Method in class sfs2x.client.entities.match.MatchExpression
-
In case of concatenated expressions, returns the current logical operator.
- getLowerLimit() - Method in class sfs2x.client.requests.mmo.MapLimits
-
Obtain the lower coordinate limit
- getLowerMapLimit() - Method in class sfs2x.client.entities.MMORoom
-
Returns the lower coordinates limit of the virtual environment represented by the MMORoom along the X,Y,Z axes.
- getMapLimits() - Method in class sfs2x.client.requests.mmo.MMORoomSettings
-
Defines the limits of the virtual environment represented by the MMORoom.
- getMaxMessageSize() - Method in class sfs2x.client.SmartFox
-
Returns the maximum size of messages allowed by the server.
- getMaxSpectators() - Method in interface sfs2x.client.entities.Room
-
Returns the maximum number of spectators allowed in this Room (Game Rooms only).
- getMaxSpectators() - Method in class sfs2x.client.entities.SFSRoom
- getMaxSpectators() - Method in class sfs2x.client.requests.RoomSettings
-
Defines the maximum number of spectators allowed in the Room (only for Game Rooms).
- getMaxUsers() - Method in interface sfs2x.client.entities.Room
-
Returns the maximum number of users allowed in this Room.
- getMaxUsers() - Method in class sfs2x.client.entities.SFSRoom
- getMaxUsers() - Method in class sfs2x.client.requests.RoomSettings
-
Defines the maximum number of users allowed in the Room.
- getMaxVariables() - Method in class sfs2x.client.requests.RoomSettings
-
Defines the maximum number of Room Variables allowed for the Room.
- getMessage() - Method in class sfs2x.client.requests.BaseRequest
- getMinPlayersToStartGame() - Method in class sfs2x.client.requests.cluster.ClusterRoomSettings
-
Defines the minimum number of players required to start the game.
- getMinPlayersToStartGame() - Method in class sfs2x.client.requests.game.SFSGameSettings
-
Defines the minimum number of players required to start the game.
- getMMOItem(int) - Method in class sfs2x.client.entities.MMORoom
-
Retrieves an MMOItem object from its id property.
- getMMOItems() - Method in class sfs2x.client.entities.MMORoom
-
Retrieves all MMOItem object in the MMORoom that fall within the current user's Area of Interest.
- getMode() - Method in class sfs2x.client.requests.MessageRecipientMode
-
Returns the selected recipient mode.
- getMyNickName() - Method in interface sfs2x.client.entities.managers.IBuddyManager
-
Returns the current user's nickname (if set).
- getMyNickName() - Method in class sfs2x.client.entities.managers.SFSBuddyManager
- getMyOnlineState() - Method in interface sfs2x.client.entities.managers.IBuddyManager
-
Returns the current user's online/offline state.
- getMyOnlineState() - Method in class sfs2x.client.entities.managers.SFSBuddyManager
- getMySelf() - Method in interface sfs2x.client.ISmartFox
- getMySelf() - Method in class sfs2x.client.SmartFox
-
Returns the User object representing the client when connected to a SmartFoxServer 2X instance.
- getMyState() - Method in interface sfs2x.client.entities.managers.IBuddyManager
-
Returns the current user's custom state (if set).
- getMyState() - Method in class sfs2x.client.entities.managers.SFSBuddyManager
- getMyVariable(String) - Method in interface sfs2x.client.entities.managers.IBuddyManager
-
Retrieves a Buddy Variable from its name.
- getMyVariable(String) - Method in class sfs2x.client.entities.managers.SFSBuddyManager
- getMyVariables() - Method in interface sfs2x.client.entities.managers.IBuddyManager
-
Returns all the Buddy Variables associated with the current user.
- getMyVariables() - Method in class sfs2x.client.entities.managers.SFSBuddyManager
- getName() - Method in interface sfs2x.client.entities.Buddy
-
Indicates the name of this buddy.
- getName() - Method in interface sfs2x.client.entities.Room
-
Indicates the name of this Room.
- getName() - Method in class sfs2x.client.entities.SFSBuddy
- getName() - Method in class sfs2x.client.entities.SFSRoom
- getName() - Method in class sfs2x.client.entities.SFSUser
- getName() - Method in interface sfs2x.client.entities.User
-
Indicates the name of this user.
- getName() - Method in class sfs2x.client.entities.variables.BaseVariable
-
Return the name of the variable
- getName() - Method in interface sfs2x.client.entities.variables.Variable
-
Return the name of the variable
- getName() - Method in class sfs2x.client.requests.RoomSettings
-
Defines the name of the Room.
- getNext() - Method in class sfs2x.client.entities.match.MatchExpression
-
Returns the next matching expression concatenated to the current one.
- getNickName() - Method in interface sfs2x.client.entities.Buddy
-
Returns the nickname of this buddy.
- getNickName() - Method in class sfs2x.client.entities.SFSBuddy
- getNodeId() - Method in interface sfs2x.client.ISmartFox
- getNodeId() - Method in class sfs2x.client.SmartFox
-
* Cluster only *
- getNotifyGameStarted() - Method in class sfs2x.client.requests.cluster.ClusterRoomSettings
-
Indicates if a game state change must be notified when the minimum number of players is reached.
- getNotifyGameStarted() - Method in class sfs2x.client.requests.game.SFSGameSettings
-
Indicates if a game state change must be notified when the minimum number of players is reached.
- getOfflineBuddies() - Method in interface sfs2x.client.entities.managers.IBuddyManager
-
Returns a list of Buddy objects representing all the offline buddies in the user's buddies list.
- getOfflineBuddies() - Method in class sfs2x.client.entities.managers.SFSBuddyManager
- getOfflineVariables() - Method in interface sfs2x.client.entities.Buddy
-
Retrieves the list of persistent Buddy Variables of this buddy.
- getOfflineVariables() - Method in class sfs2x.client.entities.SFSBuddy
- getOnlineBuddies() - Method in interface sfs2x.client.entities.managers.IBuddyManager
-
Returns a list of Buddy objects representing all the online buddies in the user's buddies list.
- getOnlineBuddies() - Method in class sfs2x.client.entities.managers.SFSBuddyManager
- getOnlineVariables() - Method in interface sfs2x.client.entities.Buddy
-
Retrieves the list of non-persistent Buddy Variables of this buddy.
- getOnlineVariables() - Method in class sfs2x.client.entities.SFSBuddy
- getOwnerZone() - Method in interface sfs2x.client.entities.managers.IRoomManager
-
* API internal usage only *
- getOwnerZone() - Method in class sfs2x.client.entities.managers.SFSRoomManager
- getParams() - Method in interface sfs2x.client.entities.invitation.Invitation
-
Returns an instance of SFSObject containing a custom set of parameters.
- getParams() - Method in class sfs2x.client.entities.invitation.SFSInvitation
- getPassword() - Method in class sfs2x.client.requests.RoomSettings
-
Defines the password of the Room.
- getPermissions() - Method in class sfs2x.client.requests.RoomSettings
-
Defines the flags indicating which operations are permitted on the Room.
- getPlayerId() - Method in class sfs2x.client.entities.SFSUser
- getPlayerId() - Method in interface sfs2x.client.entities.User
-
Returns the id of this user as a player in a Game Room.
- getPlayerId(Room) - Method in class sfs2x.client.entities.SFSUser
- getPlayerId(Room) - Method in interface sfs2x.client.entities.User
-
Returns the playerId value of this user in the passed Room.
- getPlayerList() - Method in interface sfs2x.client.entities.Room
-
Returns a list of User objects representing the players currently inside this Room (Game Rooms only).
- getPlayerList() - Method in class sfs2x.client.entities.SFSRoom
- getPlayerMatchExpression() - Method in class sfs2x.client.requests.game.SFSGameSettings
-
Defines the game matching expression to be used to filters players.
- getPort() - Method in class sfs2x.client.util.ConfigData
-
Specifies the TCP port of the SmartFoxServer 2X instance to connect to (TCP connection).
- getPrivilegeId() - Method in class sfs2x.client.entities.SFSUser
- getPrivilegeId() - Method in interface sfs2x.client.entities.User
-
Returns the id which identifies the privilege level of this user.
- getProperties() - Method in interface sfs2x.client.entities.Room
-
Defines a generic utility object that can be used to store custom Room data.
- getProperties() - Method in class sfs2x.client.entities.SFSRoom
- getProperties() - Method in class sfs2x.client.entities.SFSUser
- getProperties() - Method in interface sfs2x.client.entities.User
-
Defines a generic utility object that can be used to store custom User data.
- getPropertiesFile() - Method in class sfs2x.client.requests.RoomExtension
-
Defines the name of an optional properties file that should be loaded on the server-side during the Extension initialization.
- getProximityListUpdateMillis() - Method in class sfs2x.client.requests.mmo.MMORoomSettings
-
Configures the speed at which the SFSEvent.PROXIMITY_LIST_UPDATE event is sent by the server.
- getReason(int) - Static method in class sfs2x.client.util.ClientDisconnectionReason
-
* API internal usage only *
- getReconnectionSeconds() - Method in class sfs2x.client.SmartFox
-
* API internal usage only *
- getRoomById(int) - Method in interface sfs2x.client.entities.managers.IRoomManager
-
Retrieves a Room object from its id.
- getRoomById(int) - Method in class sfs2x.client.entities.managers.SFSRoomManager
- getRoomById(int) - Method in class sfs2x.client.SmartFox
-
Retrieves a Room object from its id.
- getRoomByName(String) - Method in interface sfs2x.client.entities.managers.IRoomManager
-
Retrieves a Room object from its name.
- getRoomByName(String) - Method in class sfs2x.client.entities.managers.SFSRoomManager
- getRoomByName(String) - Method in class sfs2x.client.SmartFox
-
Retrieves a Room object from its name.
- getRoomCount() - Method in interface sfs2x.client.entities.managers.IRoomManager
-
Returns the current number of Rooms in the Rooms list.
- getRoomCount() - Method in class sfs2x.client.entities.managers.SFSRoomManager
- getRoomGroups() - Method in interface sfs2x.client.entities.managers.IRoomManager
-
Returns the names of Room Groups currently subscribed by the client.
- getRoomGroups() - Method in class sfs2x.client.entities.managers.SFSRoomManager
- getRoomId() - Method in class sfs2x.client.requests.cluster.ClusterTarget
- getRoomList() - Method in interface sfs2x.client.entities.managers.IRoomManager
-
Returns a list of Rooms currently "known" by the client.
- getRoomList() - Method in class sfs2x.client.entities.managers.SFSRoomManager
- getRoomList() - Method in class sfs2x.client.SmartFox
-
Returns a list of Room objects representing the Rooms currently "watched" by the client.
- GetRoomList - Static variable in class sfs2x.client.requests.BaseRequest
-
*Private*
- getRoomListFromGroup(String) - Method in interface sfs2x.client.entities.managers.IRoomManager
-
Retrieves the list of Rooms which are part of the specified Room Group.
- getRoomListFromGroup(String) - Method in class sfs2x.client.entities.managers.SFSRoomManager
- getRoomListFromGroup(String) - Method in class sfs2x.client.SmartFox
-
Retrieves the list of Rooms which are part of the specified Room Group.
- getRoomManager() - Method in interface sfs2x.client.entities.Room
-
Returns a reference to the Room Manager which manages this Room.
- getRoomManager() - Method in class sfs2x.client.entities.SFSRoom
- getRoomManager() - Method in interface sfs2x.client.ISmartFox
- getRoomManager() - Method in class sfs2x.client.SmartFox
-
Returns a reference to the Room Manager.
- getSearchableRooms() - Method in class sfs2x.client.requests.game.SFSGameSettings
-
In private games, defines a list of Groups names where to search players to invite.
- getSecondsForAnswer() - Method in interface sfs2x.client.entities.invitation.Invitation
-
Returns the number of seconds available to the invitee to reply to the invitation, after which the invitation expires.
- getSecondsForAnswer() - Method in class sfs2x.client.entities.invitation.SFSInvitation
- getServerId() - Method in class sfs2x.client.requests.cluster.ClusterTarget
- getSessionToken() - Method in interface sfs2x.client.ISmartFox
- getSessionToken() - Method in class sfs2x.client.SmartFox
-
Returns the unique session token.
- getSFSArrayValue() - Method in class sfs2x.client.entities.variables.BaseVariable
-
Get the value of the variable as SFSArray
- getSFSArrayValue() - Method in interface sfs2x.client.entities.variables.Variable
-
Get the value of the variable as SFSArray
- getSFSObjectValue() - Method in class sfs2x.client.entities.variables.BaseVariable
-
Get the value of the variable as SFSObject
- getSFSObjectValue() - Method in interface sfs2x.client.entities.variables.Variable
-
Get the value of the variable as SFSObject
- getSmartFox() - Method in interface sfs2x.client.entities.managers.IRoomManager
-
* API internal usage only *
- getSmartFox() - Method in interface sfs2x.client.entities.managers.IUserManager
-
* API internal usage only *
- getSmartFox() - Method in class sfs2x.client.entities.managers.SFSRoomManager
- getSmartFox() - Method in class sfs2x.client.entities.managers.SFSUserManager
- getSocketEngine() - Method in interface sfs2x.client.ISmartFox
- getSocketEngine() - Method in class sfs2x.client.SmartFox
-
* API internal usage only *
- getSpectatorCount() - Method in interface sfs2x.client.entities.Room
-
Returns the current number of spectators in this Room (Game Rooms only).
- getSpectatorCount() - Method in class sfs2x.client.entities.SFSRoom
- getSpectatorList() - Method in interface sfs2x.client.entities.Room
-
Returns a list of User objects representing the spectators currently inside this Room (Game Rooms only).
- getSpectatorList() - Method in class sfs2x.client.entities.SFSRoom
- getSpectatorMatchExpression() - Method in class sfs2x.client.requests.game.SFSGameSettings
-
Defines the game matching expression to be used to filters spectators.
- getState() - Method in interface sfs2x.client.entities.Buddy
-
Returns the custom state of this buddy.
- getState() - Method in class sfs2x.client.entities.SFSBuddy
- getStringValue() - Method in class sfs2x.client.entities.variables.BaseVariable
-
Get the value of the variable as String
- getStringValue() - Method in interface sfs2x.client.entities.variables.Variable
-
Get the value of the variable as String
- getSymbol() - Method in enum sfs2x.client.entities.match.BoolMatch
- getSymbol() - Method in interface sfs2x.client.entities.match.IMatcher
-
Returns the condition symbol of this matcher.
- getSymbol() - Method in enum sfs2x.client.entities.match.NumberMatch
- getSymbol() - Method in enum sfs2x.client.entities.match.StringMatch
- getTarget() - Method in class sfs2x.client.core.BaseEvent
-
* API internal usage only *
- getTarget() - Method in class sfs2x.client.requests.MessageRecipientMode
-
Returns the moderator/administrator message target, according to the selected recipient mode.
- getTargetController() - Method in class sfs2x.client.requests.BaseRequest
- getType() - Method in class sfs2x.client.core.BaseEvent
-
Returns the type of the event.
- getType() - Method in enum sfs2x.client.entities.match.BoolMatch
- getType() - Method in interface sfs2x.client.entities.match.IMatcher
-
Returns the type id of this matcher.
- getType() - Method in enum sfs2x.client.entities.match.NumberMatch
- getType() - Method in enum sfs2x.client.entities.match.StringMatch
- getType() - Method in class sfs2x.client.entities.variables.BaseVariable
-
Return the data type of the variable
- getType() - Method in interface sfs2x.client.entities.variables.Variable
-
Return the data type of the variable
- getUdpHost() - Method in class sfs2x.client.util.ConfigData
-
Specifies the IP address of the SmartFoxServer 2X instance to connect to (UDP connection).
- getUdpPort() - Method in class sfs2x.client.util.ConfigData
-
Specifies the UDP port of the SmartFoxServer 2X instance to connect to (UDP connection).
- getUserById(int) - Method in interface sfs2x.client.entities.managers.IUserManager
-
Retrieves a User object from its id property.
- getUserById(int) - Method in class sfs2x.client.entities.managers.SFSUserManager
- getUserById(int) - Method in interface sfs2x.client.entities.Room
-
Retrieves a User object from its id property.
- getUserById(int) - Method in class sfs2x.client.entities.SFSRoom
- getUserByName(String) - Method in interface sfs2x.client.entities.managers.IUserManager
-
Retrieves a User object from its name property.
- getUserByName(String) - Method in class sfs2x.client.entities.managers.SFSUserManager
- getUserByName(String) - Method in interface sfs2x.client.entities.Room
-
Retrieves a User object from its name property.
- getUserByName(String) - Method in class sfs2x.client.entities.SFSRoom
- getUserCount() - Method in interface sfs2x.client.entities.managers.IUserManager
-
Returns the total number of users in the local users list.
- getUserCount() - Method in class sfs2x.client.entities.managers.SFSUserManager
- getUserCount() - Method in interface sfs2x.client.entities.Room
-
Returns the current number of users in this Room.
- getUserCount() - Method in class sfs2x.client.entities.SFSRoom
- getUserList() - Method in interface sfs2x.client.entities.managers.IUserManager
-
Get the whole list of users inside the Rooms joined by the client.
- getUserList() - Method in class sfs2x.client.entities.managers.SFSUserManager
- getUserList() - Method in interface sfs2x.client.entities.Room
-
Returns a list of User objects representing all the users currently inside this Room.
- getUserList() - Method in class sfs2x.client.entities.SFSRoom
- getUserManager() - Method in class sfs2x.client.entities.SFSUser
- getUserManager() - Method in interface sfs2x.client.entities.User
-
Returns a reference to the User Manager which manages this user.
- getUserManager() - Method in interface sfs2x.client.ISmartFox
- getUserManager() - Method in class sfs2x.client.SmartFox
-
Returns a reference to the User Manager.
- getUserMaxLimboSeconds() - Method in class sfs2x.client.requests.mmo.MMORoomSettings
-
Defines the time limit before a user without a physical position set inside the MMORoom is kicked from the Room.
- getUserRooms(User) - Method in interface sfs2x.client.entities.managers.IRoomManager
-
Retrieves a list of Rooms joined by the specified user.
- getUserRooms(User) - Method in class sfs2x.client.entities.managers.SFSRoomManager
- getUseUDP() - Method in class sfs2x.client.requests.ExtensionRequest
-
* API internal usage only *
- getValue() - Method in class sfs2x.client.entities.match.MatchExpression
-
Returns the value against which the variable or property corresponding to varName is compared.
- getValue() - Method in class sfs2x.client.entities.variables.BaseVariable
-
Get the value of the variable as Object
- getValue() - Method in interface sfs2x.client.entities.variables.Variable
-
Get the value of the variable as Object
- getVariable(String) - Method in interface sfs2x.client.entities.Buddy
-
Retrieves a Buddy Variable from its name.
- getVariable(String) - Method in interface sfs2x.client.entities.IMMOItem
-
Retrieves a User Variable from its name.
- getVariable(String) - Method in class sfs2x.client.entities.MMOItem
-
Retrieves a User Variable from its name.
- getVariable(String) - Method in interface sfs2x.client.entities.Room
-
Retrieves a Room Variable from its name.
- getVariable(String) - Method in class sfs2x.client.entities.SFSBuddy
- getVariable(String) - Method in class sfs2x.client.entities.SFSRoom
- getVariable(String) - Method in class sfs2x.client.entities.SFSUser
- getVariable(String) - Method in interface sfs2x.client.entities.User
-
Retrieves a User Variable from its name.
- getVariables() - Method in interface sfs2x.client.entities.Buddy
-
Returns a list of BuddyVariable objects associated with the buddy.
- getVariables() - Method in interface sfs2x.client.entities.IMMOItem
-
Retrieves all the Variables of this Item
- getVariables() - Method in class sfs2x.client.entities.MMOItem
-
Retrieves all the Variables of this Item
- getVariables() - Method in interface sfs2x.client.entities.Room
-
Retrieves all the Room Variables of this Room.
- getVariables() - Method in class sfs2x.client.entities.SFSBuddy
- getVariables() - Method in class sfs2x.client.entities.SFSRoom
- getVariables() - Method in class sfs2x.client.entities.SFSUser
- getVariables() - Method in interface sfs2x.client.entities.User
-
Retrieves all the User Variables of this user.
- getVariables() - Method in class sfs2x.client.requests.RoomSettings
-
Defines a list of RooomVariable objects to be attached to the Room.
- getVarName() - Method in class sfs2x.client.entities.match.MatchExpression
-
Returns the name of the variable or property against which the comparison is made.
- getVersion() - Method in class sfs2x.client.SmartFox
-
Returns the current version of the SmartFoxServer 2X Java Client API.
- getZone() - Method in class sfs2x.client.util.ConfigData
-
Specifies the Zone of the SmartFoxServer 2X instance to join.
- GoOnline - Static variable in class sfs2x.client.requests.BaseRequest
-
*Private*
- GoOnlineRequest - Class in sfs2x.client.requests.buddylist
-
Toggles the current user's online/offline state as buddy in other users' buddies lists.
- GoOnlineRequest(boolean) - Constructor for class sfs2x.client.requests.buddylist.GoOnlineRequest
-
Creates a new GoOnlineRequest instance.
- GREATER_THAN - sfs2x.client.entities.match.NumberMatch
-
An instance of NumberMatch representing the following condition: number1 > number2.
- GREATER_THAN_OR_EQUAL_TO - sfs2x.client.entities.match.NumberMatch
-
An instance of NumberMatch representing the following condition: number1 >= number2.
- GROUP_ID - Static variable in class sfs2x.client.entities.match.RoomProperties
-
The name of the Group to which the Room belongs.
- GUEST - Static variable in class sfs2x.client.entities.UserPrivileges
-
The Guest user is usually the lowest level in the privilege profiles scale.
All Classes All Packages