This wiki is archived and useful information is being migrated to the main bzflag.org website

Editing Bz BasePlayerRecord

Jump to: navigation, search

Warning: The database has been locked for maintenance, so you will not be able to save your edits right now. You may wish to copy and paste your text into a text file and save it for later.

The administrator who locked it offered this explanation: Archived wiki

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 11: Line 11:
 
; int playerID : The player ID for the player.
 
; int playerID : The player ID for the player.
 
; [[bz_ApiString]] callsign : The username/callsign for the player.
 
; [[bz_ApiString]] callsign : The username/callsign for the player.
 +
; [[bz_ApiString]] email : The e-mail string provided by the user
 
; [[bz_eTeamType]] team : The team the player is currently on.
 
; [[bz_eTeamType]] team : The team the player is currently on.
 
; float lastUpdateTime : The server time of the last player update
 
; float lastUpdateTime : The server time of the last player update
 
; [[bz_PlayerUpdateState]] lastKnownState : The state record that was last sent
 
; [[bz_PlayerUpdateState]] lastKnownState : The state record that was last sent
; [[bz_PlayerUpdateState]] currentState (not in 2.4) : The predicted state at the current time, representing where the server and all remote users show the player at.
+
; [[bz_PlayerUpdateState]] currentState : The predicted state at the current time, representing where the server and all remote users show the player at.
 
; [[bz_ApiString]] ipAddress : The Internet Protocol v4 address of the connected client
 
; [[bz_ApiString]] ipAddress : The Internet Protocol v4 address of the connected client
; [[bz_ApiString]] currentFlag : The flag code of the flag to give to the player. The [[Flag_Reference_in_Plugins|flag code format]] is a string that looks like "FLag (+FL)" Where letters that make up the flag abbreviation is capitalized. So for example, Narrow is Narrow and Wings is WinGs. The content in parenthesis include a + sign if the flag is a good flag or a - sign if the flag is a bad flag followed by the symbol of the flag. If no flag is being held, this parameter is simply an empty string. The actual values outputted by this member can also be clarified on the 5th & 6th pages of the "Help" section in-game.
+
; [[bz_ApiString]] currentFlag : The flag code of the flag to give to the player. The flag code format is a string that looks like "FLag (+FL)" Where letters that make up the flag abbreviation is capitalized. So for example, Narrow is Narrow and Wings is WinGs. The content in parenthesis include a + sign if the flag is a good flag or a - sign if the flag is a bad flag followed by the symbol of the flag. If no flag is being held, this parameter is simply an empty string.
 
; [[bz_APIStringList]] flagHistory : A list of strings representing the names of all the flags the player has held, in order from newest to oldest.
 
; [[bz_APIStringList]] flagHistory : A list of strings representing the names of all the flags the player has held, in order from newest to oldest.
 
; bool spawned : True if the user has spawned and is playing.
 
; bool spawned : True if the user has spawned and is playing.
Line 31: Line 32:
 
; int wins : The number of kills the user has had.
 
; int wins : The number of kills the user has had.
 
; int losses : The number of deaths the user has had
 
; int losses : The number of deaths the user has had
; int teamKills : The number of team mates the user has killed.
+
; int teamkills : The number of team mates the user has killed.
  
 
==Methods==
 
==Methods==
Line 58: Line 59:
 
==Uses==
 
==Uses==
 
This class is returned by a number of API functions and events. This class is used any time player specific data is requested.
 
This class is returned by a number of API functions and events. This class is used any time player specific data is requested.
 
==Removed Fields==
 
The email field was removed with version 2.4 since it was removed from the game and changed to "motto"
 

Please note that all contributions to BZFlagWiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see BZFlagWiki:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel | Editing help (opens in new window)

Templates used on this page: