Constant Field Values

Contents

• com.smartfoxserver.*

com.smartfoxserver.*

com.smartfoxserver.bitswarm.sessions.Session

Modifier and Type	Constant Field	Value
public static final String	BB_REMOTE_IP	"bbRemoteIP"
public static final String	BBCLIENT	"bbClient"
public static final String	DATA_BUFFER	"session_data_buffer"
public static final String	ENCRYPTION_ENABLED	"session_encryption_enabled"
public static final String	NO_IP	"NO_IP"
public static final String	PACKET_READ_STATE	"read_state"
public static final String	PROTOCOL	"session_protocol"
public static final String	WS_CHANNEL	"wsChannel"
public static final String	WS_REMOTE_IP	"wsRemoteIP"

com.smartfoxserver.buddylist.ReservedBuddyVariables

Modifier and Type	Constant Field	Value
public static final String	BV_NICKNAME	"$__BV_NICKNAME__"
public static final String	BV_ONLINE	"$__BV_ONLINE__"
public static final String	BV_STATE	"$__BV_STATE__"

com.smartfoxserver.buddylist.SFSBuddyVariable

Modifier and Type	Constant Field	Value
public static final String	OFFLINE_PREFIX	"$"

com.smartfoxserver.components.signup.SignUpAssistantComponent

Modifier and Type	Constant Field	Value
public static final String	COMMAND_PREFIX	"$SignUp"

com.smartfoxserver.controllers.system.BanUser

Modifier and Type	Constant Field	Value
public static final String	KEY_BAN_DURATION_HOURS	"dh"
public static final String	KEY_BAN_MODE	"b"
public static final String	KEY_DELAY	"d"
public static final String	KEY_MESSAGE	"m"
public static final String	KEY_USER_ID	"u"

com.smartfoxserver.controllers.system.BanUsersFromRoom

Modifier and Type	Constant Field	Value
public static final String	KEY_INTERVAL	"i"
public static final String	KEY_MESSAGE	"m"
public static final String	KEY_ROOM	"r"
public static final String	KEY_TIME_UNIT	"t"
public static final String	KEY_USERS	"u"

com.smartfoxserver.controllers.system.ChangeRoomCapacity

Modifier and Type	Constant Field	Value
public static final String	KEY_MAX_SPECT	"s"
public static final String	KEY_MAX_USERS	"u"
public static final String	KEY_ROOM	"r"

com.smartfoxserver.controllers.system.ChangeRoomName

Modifier and Type	Constant Field	Value
public static final String	KEY_NAME	"n"
public static final String	KEY_ROOM	"r"

com.smartfoxserver.controllers.system.ChangeRoomPassword

Modifier and Type	Constant Field	Value
public static final String	KEY_PASS	"p"
public static final String	KEY_ROOM	"r"

com.smartfoxserver.controllers.system.CreateRoom

Modifier and Type	Constant Field	Value
public static final String	KEY_ALLOW_AUDIO_STREAMING	"aas"
public static final String	KEY_ALLOW_JOIN_INVITATION_BY_OWNER	"aji"
public static final String	KEY_AUTO_JOIN	"aj"
public static final String	KEY_EVENTS	"ev"
public static final String	KEY_EXTCLASS	"xc"
public static final String	KEY_EXTID	"xn"
public static final String	KEY_EXTPROP	"xp"
public static final String	KEY_GROUP_ID	"g"
public static final String	KEY_ISGAME	"ig"
public static final String	KEY_MAXSPECTATORS	"ms"
public static final String	KEY_MAXUSERS	"mu"
public static final String	KEY_MAXVARS	"mv"
public static final String	KEY_MMO_DEFAULT_AOI	"maoi"
public static final String	KEY_MMO_MAP_HIGH_LIMIT	"mlhm"
public static final String	KEY_MMO_MAP_LOW_LIMIT	"mllm"
public static final String	KEY_MMO_PROXIMITY_UPDATE_MILLIS	"mpum"
public static final String	KEY_MMO_SEND_ENTRY_POINT	"msep"
public static final String	KEY_MMO_USER_MAX_LIMBO_SECONDS	"muls"
public static final String	KEY_NAME	"n"
public static final String	KEY_PASSWORD	"p"
public static final String	KEY_PERMISSIONS	"pm"
public static final String	KEY_ROOM	"r"
public static final String	KEY_ROOM_TO_LEAVE	"rl"
public static final String	KEY_ROOMVARS	"rv"

com.smartfoxserver.controllers.system.FindRooms

Modifier and Type	Constant Field	Value
public static final String	KEY_EXPRESSION	"e"
public static final String	KEY_FILTERED_ROOMS	"fr"
public static final String	KEY_GROUP	"g"
public static final String	KEY_LIMIT	"l"

com.smartfoxserver.controllers.system.FindUsers

Modifier and Type	Constant Field	Value
public static final String	KEY_EXPRESSION	"e"
public static final String	KEY_FILTERED_USERS	"fu"
public static final String	KEY_GROUP	"g"
public static final String	KEY_LIMIT	"l"
public static final String	KEY_ROOM	"r"

com.smartfoxserver.controllers.system.GenericMessage

Modifier and Type	Constant Field	Value
public static final String	KEY_AOI	"aoi"
public static final String	KEY_MESSAGE	"m"
public static final String	KEY_MESSAGE_TYPE	"t"
public static final String	KEY_RECIPIENT	"rc"
public static final String	KEY_RECIPIENT_MODE	"rm"
public static final String	KEY_ROOM_ID	"r"
public static final String	KEY_SENDER_DATA	"sd"
public static final String	KEY_USER_ID	"u"
public static final String	KEY_XTRA_PARAMS	"p"

com.smartfoxserver.controllers.system.Handshake

Modifier and Type	Constant Field	Value
public static final String	KEY_ADMIN_PWD_HASHED	"aph"
public static final String	KEY_API	"api"
public static final String	KEY_AUDIO_STREAMING_ENABLED	"ase"
public static final String	KEY_BIN_FLAG	"bin"
public static final String	KEY_CLIENT_TYPE	"cl"
public static final String	KEY_COMPRESSION_THRESHOLD	"ct"
public static final String	KEY_MAX_MESSAGE_SIZE	"ms"
public static final String	KEY_RECONNECTION_TOKEN	"rt"
public static final String	KEY_TOKEN	"tk"

com.smartfoxserver.controllers.system.JoinRoom

Modifier and Type	Constant Field	Value
public static final String	KEY_AS_SPECTATOR	"sp"
public static final String	KEY_PASS	"p"
public static final String	KEY_ROOM	"r"
public static final String	KEY_ROOM_ID	"i"
public static final String	KEY_ROOM_NAME	"n"
public static final String	KEY_ROOM_TO_LEAVE	"rl"
public static final String	KEY_USER_LIST	"ul"

com.smartfoxserver.controllers.system.KickUser

Modifier and Type	Constant Field	Value
public static final String	KEY_DELAY	"d"
public static final String	KEY_MESSAGE	"m"
public static final String	KEY_USER_ID	"u"

com.smartfoxserver.controllers.system.LeaveRoom

Modifier and Type	Constant Field	Value
public static final String	KEY_ROOM_ID	"r"

com.smartfoxserver.controllers.system.Login

Modifier and Type	Constant Field	Value
public static final String	KEY_ID	"id"
public static final String	KEY_PARAMS	"p"
public static final String	KEY_PASSWORD	"pw"
public static final String	KEY_PRIVILEGE_ID	"pi"
public static final String	KEY_RECONNECTION_SECONDS	"rs"
public static final String	KEY_ROOMLIST	"rl"
public static final String	KEY_USERNAME	"un"
public static final String	KEY_ZONENAME	"zn"

com.smartfoxserver.controllers.system.Logout

Modifier and Type	Constant Field	Value
public static final String	KEY_ZONE_NAME	"zn"

com.smartfoxserver.controllers.system.PlayerToSpectator

Modifier and Type	Constant Field	Value
public static final String	KEY_ROOM	"r"
public static final String	KEY_USER_ID	"u"

com.smartfoxserver.controllers.system.QuickJoinOrCreateRoom

Modifier and Type	Constant Field	Value
protected static final String	KEY_GROUP_LIST	"gl"
protected static final String	KEY_MATCH_EXPRESSION	"me"
protected static final String	KEY_ROOM_SETTINGS	"rs"
protected static final String	KEY_ROOM_TO_LEAVE	"tl"

com.smartfoxserver.controllers.system.SetMMOItemVariables

Modifier and Type	Constant Field	Value
public static final String	KEY_ITEM_ID	"i"
public static final String	KEY_ROOM_ID	"r"
public static final String	KEY_VAR_LIST	"v"

com.smartfoxserver.controllers.system.SetRoomVariables

Modifier and Type	Constant Field	Value
public static final String	KEY_VAR_LIST	"vl"
public static final String	KEY_VAR_ROOM	"r"

com.smartfoxserver.controllers.system.SetUserPosition

Modifier and Type	Constant Field	Value
public static final String	KEY_MINUS_ITEM_LIST	"n"
public static final String	KEY_MINUS_USER_LIST	"m"
public static final String	KEY_PLUS_ITEM_LIST	"q"
public static final String	KEY_PLUS_USER_LIST	"p"
public static final String	KEY_ROOM_ID	"r"
public static final String	KEY_VEC3D	"v"

com.smartfoxserver.controllers.system.SetUserVariables

Modifier and Type	Constant Field	Value
public static final String	KEY_USER	"u"
public static final String	KEY_VAR_LIST	"vl"

com.smartfoxserver.controllers.system.SpectatorToPlayer

Modifier and Type	Constant Field	Value
public static final String	KEY_PLAYER_ID	"p"
public static final String	KEY_ROOM	"r"
public static final String	KEY_USER_ID	"u"

com.smartfoxserver.controllers.system.SubscribeRoomGroup

Modifier and Type	Constant Field	Value
public static final String	KEY_GROUP_ID	"g"
public static final String	KEY_ROOM_LIST	"rl"

com.smartfoxserver.controllers.system.UnsubscribeRoomGroup

Modifier and Type	Constant Field	Value
public static final String	KEY_GROUP_ID	"g"

com.smartfoxserver.controllers.system.buddylist.AddBuddy

Modifier and Type	Constant Field	Value
public static final String	KEY_BUDDY_NAME	"bn"

com.smartfoxserver.controllers.system.buddylist.BlockBuddy

Modifier and Type	Constant Field	Value
public static final String	KEY_BUDDY	"bd"
public static final String	KEY_BUDDY_BLOCK_STATE	"bs"
public static final String	KEY_BUDDY_NAME	"bn"

com.smartfoxserver.controllers.system.buddylist.GoOnline

Modifier and Type	Constant Field	Value
public static final String	KEY_BUDDY_ID	"bi"
public static final String	KEY_BUDDY_NAME	"bn"
public static final String	KEY_ONLINE	"o"

com.smartfoxserver.controllers.system.buddylist.InitBuddyList

Modifier and Type	Constant Field	Value
public static final String	KEY_BUDDY_LIST	"bl"
public static final String	KEY_BUDDY_STATES	"bs"
public static final String	KEY_MY_VARS	"mv"

com.smartfoxserver.controllers.system.buddylist.RemoveBuddy

Modifier and Type	Constant Field	Value
public static final String	KEY_BUDDY_NAME	"bn"

com.smartfoxserver.controllers.system.buddylist.SetBuddyVariables

Modifier and Type	Constant Field	Value
public static final String	KEY_BUDDY_NAME	"bn"
public static final String	KEY_BUDDY_VARS	"bv"

com.smartfoxserver.controllers.system.game.CreateSFSGame

Modifier and Type	Constant Field	Value
public static final String	KEY_INVITATION_EXPIRY	"gie"
public static final String	KEY_INVITATION_PARAMS	"ip"
public static final String	KEY_INVITED_PLAYERS	"ginp"
public static final String	KEY_IS_PUBLIC	"gip"
public static final String	KEY_LEAVE_ROOM	"glr"
public static final String	KEY_MIN_PLAYERS	"gmp"
public static final String	KEY_NOTIFY_GAME_STARTED	"gns"
public static final String	KEY_PLAYER_MATCH_EXP	"gpme"
public static final String	KEY_SEARCHABLE_ROOMS	"gsr"
public static final String	KEY_SPECTATOR_MATCH_EXP	"gsme"

com.smartfoxserver.controllers.system.game.InvitationReply

Modifier and Type	Constant Field	Value
public static final String	KEY_INVITATION_ID	"i"
public static final String	KEY_INVITATION_PARAMS	"p"
public static final String	KEY_INVITATION_REPLY	"r"

com.smartfoxserver.controllers.system.game.InviteUser

Modifier and Type	Constant Field	Value
public static final String	KEY_INVITATION_ID	"ii"
public static final String	KEY_INVITED_USERS	"iu"
public static final String	KEY_PARAMS	"p"
public static final String	KEY_REPLY_ID	"ri"
public static final String	KEY_TIME	"t"
public static final String	KEY_USER	"u"
public static final String	KEY_USER_ID	"ui"

com.smartfoxserver.controllers.system.game.JoinRoomInvite

Modifier and Type	Constant Field	Value
protected static final boolean	DEFAULT_AS_SPECT	false
protected static final int	DEFAULT_EXPIRY_SEC	25
public static final String	KEY_AS_SPECT	"as"
public static final String	KEY_EXPIRY_SECONDS	"es"
public static final String	KEY_INVITED_NAMES	"in"
public static final String	KEY_OPTIONAL_PARAMS	"op"
public static final String	KEY_ROOM_ID	"r"

com.smartfoxserver.controllers.system.game.QuickJoinGame

Modifier and Type	Constant Field	Value
public static final String	KEY_GROUP_LIST	"gl"
public static final String	KEY_MATCH_EXPRESSION	"me"
public static final String	KEY_ROOM_LIST	"rl"
public static final String	KEY_ROOM_TO_LEAVE	"tl"

com.smartfoxserver.db.EmbeddedDBService

Modifier and Type	Constant Field	Value
public static final String	SFS3_DB_ALIAS	"sfs"
public static final String	SFS3_DB_PASS	""
public static final String	SFS3_DB_PATH	"data/sfs/sfsData"
public static final String	SFS3_DB_SCHEMA	"SFS3"
public static final String	SFS3_DB_TAB_PERFDATA	"PERF_DATA"
public static final String	SFS3_DB_USER	"SA"

com.smartfoxserver.entities.data.SFSDataSize

Modifier and Type	Constant Field	Value
public static final int	MAX_ARRAY_SIZE	32767
public static final int	MAX_SHORT_STRING_SIZE	255
public static final int	MAX_STRING_SIZE	32767
public static final int	MAX_TEXT_SIZE	2147483647

com.smartfoxserver.entities.match.RoomProperties

Modifier and Type	Constant Field	Value
public static final String	GROUP_ID	"${G}"
public static final String	HAS_FREE_PLAYER_SLOTS	"${HFP}"
public static final String	IS_GAME	"${ISG}"
public static final String	IS_PRIVATE	"${ISP}"
public static final String	IS_TYPE_DEFAULT	"${ISD}"
public static final String	IS_TYPE_MMO	"${ISM}"
public static final String	IS_TYPE_SFSGAME	"${IST}"
public static final String	MAX_SPECTATORS	"${MXS}"
public static final String	MAX_USERS	"${MXU}"
public static final String	NAME	"${N}"
public static final String	SPECTATOR_COUNT	"${SC}"
public static final String	USER_COUNT	"${UC}"

com.smartfoxserver.entities.match.UserProperties

Modifier and Type	Constant Field	Value
public static final String	IS_IN_ANY_ROOM	"${IAR}"
public static final String	IS_NPC	"${ISN}"
public static final String	IS_PLAYER	"${ISP}"
public static final String	IS_SPECTATOR	"${ISS}"
public static final String	NAME	"${N}"
public static final String	PRIVILEGE_ID	"${PRID}"

com.smartfoxserver.entities.variables.ReservedRoomVariables

Modifier and Type	Constant Field	Value
public static final String	RV_GAME_STARTED	"$GS"

com.smartfoxserver.extensions.SFSExtension

Modifier and Type	Constant Field	Value
public static final String	MULTIHANDLER_REQUEST_ID	"__[[REQUEST_ID]]__"