Bz BasePlayerRecord - Revision history

Brad: /* Data */

2012-10-16T00:35:57Z

Data

← Older revision		Revision as of 00:35, 16 October 2012
Line 14:		Line 14:
	; 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 : The predicted state at the current time, representing where the server and all remote users show the player at.		; [[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_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 ~~(not in 2.4)~~ : 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_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_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.

Brad: /* Data */

2012-10-16T00:35:35Z

Data

← Older revision		Revision as of 00:35, 16 October 2012
Line 16:		Line 16:
	; [[bz_PlayerUpdateState]] currentState : 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 (not in 2.4) : 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_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.

85.210.194.116: proper case for teamKills

2012-10-09T17:48:13Z

proper case for teamKills

← Older revision		Revision as of 17:48, 9 October 2012
Line 31:		Line 31:
	; 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==

Joevano: Fix link to internal page reference style, remove hard coding to http://wiki.bzflag.org

2012-06-20T23:54:24Z

Fix link to internal page reference style, remove hard coding to http://wiki.bzflag.org

← Older revision		Revision as of 23:54, 20 June 2012
Line 16:		Line 16:
	; [[bz_PlayerUpdateState]] currentState : 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 [~~http://wiki.bzflag.org/~~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_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_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.

Allejo: Added reference to list of flag codes

2012-06-17T02:48:56Z

Added reference to list of flag codes

← Older revision		Revision as of 02:48, 17 June 2012
Line 16:		Line 16:
	; [[bz_PlayerUpdateState]] currentState : 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 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 [http://wiki.bzflag.org/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_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.

JeffM2501: note what happened to the email

2011-10-15T03:45:36Z

note what happened to the email

← Older revision		Revision as of 03:45, 15 October 2011
Line 58:		Line 58:
	==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"

70.190.212.232: /* Data */ The email data member is not available at this time. It may be put back once it is available. (Nowhere does it say it's included in future versions.)

2011-10-15T03:23:29Z

Data: The email data member is not available at this time. It may be put back once it is available. (Nowhere does it say it's included in future versions.)

← Older revision		Revision as of 03:23, 15 October 2011
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

70.190.212.232: /* Data */ Forgot the 6th page with the bad flags.

2011-08-25T06:30:32Z

Data: Forgot the 6th page with the bad flags.

← Older revision		Revision as of 06:30, 25 August 2011
Line 17:		Line 17:
	; [[bz_PlayerUpdateState]] currentState : 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 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 ~~page~~ 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. The actual values outputted by this member can also be clarified on the 5th & 6th pages of the "Help" section in-game.
	; [[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.

70.190.212.232: Clarify where you can find the values to currentFlag. Maybe a wiki page later for this. (Editor: sigonasr2 - Too lazy to login.)

2011-08-25T06:29:49Z

Clarify where you can find the values to currentFlag. Maybe a wiki page later for this. (Editor: sigonasr2 - Too lazy to login.)

← Older revision		Revision as of 06:29, 25 August 2011
Line 17:		Line 17:
	; [[bz_PlayerUpdateState]] currentState : 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 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_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. The actual values outputted by this member can also be clarified on the 5th page of the "Help" section in-game.
	; [[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.

68.0.162.159: /* Data */ currentFlag has a + or - sign determined by the flag type.

2011-07-14T05:33:06Z

Data: currentFlag has a + or - sign determined by the flag type.

← Older revision		Revision as of 05:33, 14 July 2011
Line 17:		Line 17:
	; [[bz_PlayerUpdateState]] currentState : 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 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 followed by the symbol of the flag. If no flag is being held, this parameter is simply an empty string.		; [[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.