Difference between revisions of "Bz eGetPlayerInfoEvent"

From BZFlagWiki
Jump to: navigation, search
(Data: sigonasr2 found out ipAddress does not work.)
Line 27: Line 27:
 
   |ipAddress
 
   |ipAddress
 
   |[[bz_ApiString]]
 
   |[[bz_ApiString]]
   |The IPv4 address for the player.
+
   |The IPv4 address for the player. (Defunctional in Version 2.4. Get the player record ipAddress member instead.)
 
   |-
 
   |-
 
   |team
 
   |team
Line 49: Line 49:
 
   |The local server time of the event.
 
   |The local server time of the event.
 
   |}
 
   |}
 +
 
==Uses==
 
==Uses==
 
This is a modification event. The state members can be changed ( admin, verified, and registered ). Changes to these values only change the data sent to the remote user, they do not change any internal permission states or access permissions. This event is only to allow plug-ins to overide the logic used for the display of the various scoreboard symbols.
 
This is a modification event. The state members can be changed ( admin, verified, and registered ). Changes to these values only change the data sent to the remote user, they do not change any internal permission states or access permissions. This event is only to allow plug-ins to overide the logic used for the display of the various scoreboard symbols.

Revision as of 23:10, 28 September 2011

BZFS API Documentation This page contains part of the BZFS API documentation for use by Plug-ins on the BZFS server.

BZFS Event. This page documents a BZFS event that is called by the game server to notify plug-ins of various actions and state changes in the game world.


Overview

The bz_eGetPlayerInfoEvent is an API event that is called each time the server sends out a player info update message to a remote player.

Data

bz_eGetPlayerInfoEvent returns the bz_GetPlayerInfoEventData_V1 data class.

name type value description
eventType bz_eEventType bz_eGetPlayerInfoEvent
playerID int The playerID the record refers too.
callsign bz_ApiString The callsign for the player.
ipAddress bz_ApiString The IPv4 address for the player. (Defunctional in Version 2.4. Get the player record ipAddress member instead.)
team bz_eTeamType The team the player is current only.
admin bool The admin permision state of the player, indicating if they will be displayed with an '@' symbol in the scoreboard.
verified bool The authentication state of the player, indicating if they will be displayed with an '+' symbol in the scoreboard.
registered bool The state of the player's username. This value is true if the username is registered. If the user is not veriried, but registered then they will be displayed with an '-' symbol in the scoreboard.
eventTime double The local server time of the event.

Uses

This is a modification event. The state members can be changed ( admin, verified, and registered ). Changes to these values only change the data sent to the remote user, they do not change any internal permission states or access permissions. This event is only to allow plug-ins to overide the logic used for the display of the various scoreboard symbols.