|
|
| Line 1: |
Line 1: |
| {{BZFS_API_Doc}}
| | #REDIRECT [[Category:BZFS API Docs]] |
| {{BZFS_API_Events}}
| |
| | |
| ==Overview==
| |
| The '''bz_eAllowPlayer''' is an API event that is called each time a player connects to the server. This event is called after all internal allow/deny logic.
| |
| | |
| ==Data==
| |
| '''bz_eAllowPlayer''' returns the '''bz_AllowPlayerEventData_V1''' data class.
| |
| | |
| {| border="1" cellpadding="20" cellspacing="0"
| |
| !name
| |
| !type
| |
| !value description
| |
| |-
| |
| |eventType
| |
| |[[Event(API)|bz_eEventType]]
| |
| |bz_eAllowPlayer
| |
| |-
| |
| |playerID
| |
| |int
| |
| |This value is the player ID for the joining player.
| |
| |-
| |
| |callsign
| |
| |[[bz_ApiString]]
| |
| |This value is the callsign for the player.
| |
| |-
| |
| |ipAddress
| |
| |[[bz_ApiString]]
| |
| |This value is the IPv4 address of the player.
| |
| |-
| |
| |reason
| |
| |[[bz_ApiString]]
| |
| |This value is the reason for any denials of admittance, it will be reported back to the player.
| |
| |-
| |
| |allow
| |
| |bool
| |
| |This value is the current allow/deny state for the join. Plug-ins wishing to overide the server allow/deny logic can change this value.
| |
| |-
| |
| |eventTime
| |
| |double
| |
| |This value is the local server time of the event.
| |
| |}
| |
| ==Uses==
| |
| This is a modification event, plug-ins may override the allow/deny logic choice themselves. This is the primary hook for plug-ins that wish to implement custom ban list systems.
| |