Bz ePlayerJoinEvent: Difference between revisions

Latest revision as of 22:39, 9 November 2025

Redirect to:

@@ 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_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_ePlayerJoinEvent
-  |-
-  |playerID
-  |int
-  |The player ID that is joining
-  |-
-  |record
-  |[[bz_BasePlayerRecord]] *
-  |The player record for the joining player
-  |-
-  |reason
-  |[[bz_ApiString]]
-  |The reason for the event, unused for join events
-  |-
-  |eventTime
-  |double
-  |Time of event.
-  |}
-==Uses==
-This event is a notification-only event, none of the data returned can be changed.