This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz ePlayerJoinEvent"
From BZFlagWiki
(→Data) |
(→Uses: hyphenated compound adjective) |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 7: | Line 7: | ||
==Data== | ==Data== | ||
'''bz_ePlayerJoinEvent''' returns the '''bz_PlayerJoinPartEventData_V1''' data class. | '''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" | {| border="1" cellpadding="20" cellspacing="0" | ||
!name | !name | ||
!type | !type | ||
| − | !value | + | !value description |
|- | |- | ||
|eventType | |eventType | ||
|[[Event(API)|bz_eEventType]] | |[[Event(API)|bz_eEventType]] | ||
| − | | | + | |bz_ePlayerJoinEvent |
|- | |- | ||
|playerID | |playerID | ||
|int | |int | ||
| − | |The player that | + | |The player ID that is joining |
|- | |- | ||
|record | |record | ||
| Line 26: | Line 27: | ||
|- | |- | ||
|reason | |reason | ||
| − | | | + | |[[bz_ApiString]] |
| − | | | + | |The reason for the event, unused for join events |
|- | |- | ||
|eventTime | |eventTime | ||
| Line 35: | Line 36: | ||
==Uses== | ==Uses== | ||
| − | This event is a notification only event, none of the data returned can be changed. | + | This event is a notification-only event, none of the data returned can be changed. |
| − | + | ||
| − | + | ||
| − | + | ||
Latest revision as of 23:30, 27 January 2013
| BZFS API Documentation This page contains part of the BZFS API documentation for use by Plug-ins on the BZFS server. |
BZFS Event. This page documents a BZFS event that is called by the game server to notify plug-ins of various actions and state changes in the game world.
Overview[edit]
The bz_ePlayerJoinEvent is an API event that is called each time a player joins the game.
Data[edit]
bz_ePlayerJoinEvent returns the bz_PlayerJoinPartEventData_V1 data class. The event data record is shared between both join and part events.
| name | type | value description |
|---|---|---|
| eventType | 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[edit]
This event is a notification-only event, none of the data returned can be changed.
