|
|
| Line 1: |
Line 1: |
| {{BZFS_API_Doc}}
| | #REDIRECT [[Category:BZFS API Docs]] |
| {{BZFS_API_Events}}
| |
| | |
| ==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.
| |
| | |
| {| border="1" cellpadding="20" cellspacing="0"
| |
| !name
| |
| !type
| |
| !value description
| |
| |-
| |
| |eventType
| |
| |[[Event(API)|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. (not set in 2.4.0, fixed in 2.4.1.)
| |
| |-
| |
| |team
| |
| |[[bz_eTeamType]]
| |
| |The team the player is current only.
| |
| |-
| |
| |admin
| |
| |bool
| |
| |The admin permission 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 verified, 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.
| |