|
|
| (5 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| {{BZFS_API_Doc}}
| | #REDIRECT [[Category:BZFS API Docs]] |
| {{BZFS_API_Events}}
| |
| | |
| ==Overview==
| |
| The '''bz_ePlayerJoinEvent''' is an API event that is called each time a player joins the game.
| |
| | |
| ==Data==
| |
| '''bz_ePlayerJoinEvent''' returns the '''bz_PlayerJoinPartEventData''' data class.
| |
| int playerID;
| |
| bz_eTeamType team;
| |
| | |
| bzApiString callsign;
| |
| bzApiString email;
| |
| bool verified;
| |
| bzApiString globalUser;
| |
| bzApiString ipAddress;
| |
| bzApiString reason;
| |
| | |
| double time;
| |
| {| border="1" cellpadding="20" cellspacing="0"
| |
| !name
| |
| !type
| |
| !value desription
| |
| |-
| |
| |eventType
| |
| |[[Event(API)|bz_eEventType]]
| |
| |bz_eFlagDroppedEvent
| |
| |-
| |
| |playerID
| |
| |int
| |
| |The player that dropped the flag
| |
| |-
| |
| |team
| |
| |bz_eTeamType
| |
| |The team the new player is a member of
| |
| |-
| |
| |callsign
| |
| |bzApiString
| |
| |Callsign of the player
| |
| |-
| |
| |email
| |
| |bzApiString
| |
| |Email string of the player
| |
| |-
| |
| |verified
| |
| |bool
| |
| |This flag is true if a player has identified as a registered user.
| |
| |-
| |
| |globalUser
| |
| |bzApiString
| |
| |Registered username of the player
| |
| |-
| |
| |ipAddress
| |
| |bzApiString
| |
| |IP address of the player
| |
| |-
| |
| |reason
| |
| |bzApiString
| |
| |Not used for join events
| |
| |-
| |
| |time
| |
| |double
| |
| |Time of join
| |
| |}
| |
| | |
| ==Uses==
| |
| This event is a notification only event, none of the data returned can be changed.
| |
| | |
| [[Category:BZFS_API_Docs]] | |
| [[Category:BZFS_API_Events]]
| |