|
|
| (5 intermediate revisions by 3 users not shown) |
| Line 1: |
Line 1: |
| {{BZFS_API_Doc}}
| | #REDIRECT [[Category:BZFS API Docs]] |
| {{BZFS_API_Events}}
| |
| {{API_Docs_that_need_work}}
| |
| | |
| ==Overview==
| |
| The '''bz_eGetPlayerInfoEvent''' is an API event that is called to tell plugins about a new user and find out their permissions. A plugin can use this to modify the state of being administrator, being verified and being registered of every user.
| |
| | |
| ==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 identification number of the player
| |
| |-
| |
| |callsign
| |
| |[[bz_ApiString]]
| |
| |The callsign of the player
| |
| |-
| |
| |ipAddress
| |
| |[[bz_ApiString]]
| |
| |The IP address of the player
| |
| |-
| |
| |team
| |
| |[[bz_eTeamType]]
| |
| |The team the player belongs to
| |
| |-
| |
| |admin
| |
| |bool
| |
| |This flag is set to true if the player is an administrator.
| |
| |-
| |
| |verified
| |
| |bool
| |
| |True if the user has authenticated with the login system. Comparable to a user having a "+" in the scoreboard.
| |
| |-
| |
| |registered
| |
| |bool
| |
| |This flag is set to true if the player is registered with the server, as opposed to being verified with the global login system (see the verified flag).
| |
| |-
| |
| |eventTime
| |
| |double
| |
| |The time of the event
| |
| |}
| |
| ==Uses==
| |
| Some data in this event can be modified, namely the following flags: admin, verified, registered. A plugin can, for example, let every other user be an admin.
| |
| | |
| [[Category:BZFS_API_Docs]] | |
| [[Category:BZFS_API_Events]]
| |