bz ePlayerUpdateEvent

From BZFlagWiki
Revision as of 04:57, 6 September 2014 by Allejo (Talk | contribs) (Clarified documentation on the two state variables)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
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_ePlayerUpdateEvent is an API event that is called each time a player sends an update to the server.

Data[edit]

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).