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 ePlayerUpdateEvent: Difference between revisions
Jump to navigation
Jump to search
→Data: Data class was wrong. |
m Clarified documentation on the two state variables |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 21: | Line 21: | ||
|ID of the player that sent the update | |ID of the player that sent the update | ||
|- | |- | ||
| | |state | ||
| | |[[bz_PlayerUpdateState]] | ||
|The | |The new state the tank is currently in | ||
|- | |- | ||
| | |lastState | ||
| | |[[bz_PlayerUpdateState]] | ||
|The | |The previous state the tank was in. The change in states can be used to see what the update was (e.g. a tank is no longer falling) | ||
|- | |- | ||
| | |stateTime | ||
| | |double | ||
|The | |The time the state was updated | ||
|- | |- | ||
| | |eventTime | ||
|double | |double | ||
|The | |The server time at which the event occurred (in seconds). | ||
|} | |} | ||
Latest revision as of 04:57, 6 September 2014
| 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
The bz_ePlayerUpdateEvent is an API event that is called each time a player sends an update to the server.
Data
bz_ePlayerUpdateEvent returns the bz_PlayerUpdateEventData_V1 data class.
| name | type | value description |
|---|---|---|
| eventType | bz_eEventType | bz_ePlayerUpdateEvent |
| playerID | int | ID of the player that sent the update |
| state | bz_PlayerUpdateState | The new state the tank is currently in |
| lastState | bz_PlayerUpdateState | The previous state the tank was in. The change in states can be used to see what the update was (e.g. a tank is no longer falling) |
| stateTime | double | The time the state was updated |
| eventTime | double | The server time at which the event occurred (in seconds). |