This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz ePlayerPartEvent"
From BZFlagWiki
(New page: {{BZFS_API_Doc}} {{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_ePlayerPartEve...) |
(→Uses: hyphenated compound adjective) |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 20: | Line 20: | ||
|playerID | |playerID | ||
|int | |int | ||
| − | |The player ID that is leaving | + | |The player ID that is leaving. |
|- | |- | ||
|record | |record | ||
|[[bz_BasePlayerRecord]] * | |[[bz_BasePlayerRecord]] * | ||
| − | |The player record for the leaving player | + | |The player record for the leaving player. |
|- | |- | ||
|reason | |reason | ||
| − | | | + | |[[bz_ApiString]] |
| − | |The reason for the | + | |The reason for the part, such as a kick or a ban. |
|- | |- | ||
|eventTime | |eventTime | ||
| Line 36: | 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. |
[[Category:BZFS_API_Docs]] | [[Category:BZFS_API_Docs]] | ||
[[Category:BZFS_API_Events]] | [[Category:BZFS_API_Events]] | ||
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_ePlayerPartEvent is an API event that is called each time a player parts (ie, leaves) a game.
Data[edit]
bz_ePlayerPartEvent 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_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[edit]
This event is a notification-only event, none of the data returned can be changed.
