This wiki was in read-only mode for many years, but can now be edited again. A lot of information will need to be updated.

Bz ePlayerPartEvent: Difference between revisions

From BZFlagWiki
Jump to navigation Jump to search
Uses: hyphenated compound adjective
Zehra (talk | contribs)
redirect, since events are in official docs
Tag: New redirect
 
Line 1: Line 1:
{{BZFS_API_Doc}}
#REDIRECT [[Category:BZFS API Docs]]
{{BZFS_API_Events}}
 
==Overview==
The '''bz_ePlayerPartEvent''' is an API event that is called each time a player parts (ie, leaves) a game.
 
==Data==
'''bz_ePlayerPartEvent''' returns the '''bz_PlayerJoinPartEventData_V1''' data class.
The event data record is shared between both join and part events.
 
  {| border="1" cellpadding="20" cellspacing="0"
  !name
  !type
  !value description
  |-
  |eventType   
  |[[Event(API)|bz_eEventType]]
  |bz_ePlayerPartEvent
  |-
  |playerID   
  |int
  |The player ID that is leaving.
  |-
  |record
  |[[bz_BasePlayerRecord]] *
  |The player record for the leaving player.
  |-
  |reason
  |[[bz_ApiString]]
  |The reason for the part, such as a kick or a ban.
  |-
  |eventTime
  |double
  |Time of event.
  |}
 
==Uses==
This event is a notification-only event, none of the data returned can be changed.
 
[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Latest revision as of 22:40, 9 November 2025