This wiki is archived and useful information is being migrated to the main bzflag.org website

bz ePlayerScoreChanged

From BZFlagWiki
Revision as of 19:22, 15 October 2011 by Sigonasr2 (Talk | contribs) (Created Documentation for this API Event.)

(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

The bz_ePlayerScoreChanged is an API event that is called when a player's score changes.

Data

bz_ePlayerScoreChanged returns the bz_PlayerScoreChangeEventData_V1 data class.

name type value description
eventType bz_eEventType bz_ePlayerScoreChanged
playerID int Player that has had a change of score.
element bz_eScoreElement The type of score that is being changed.
thisValue int The new amount of element score the playerID has.
lastValue int The old amount of element score the playerID had.
time double Time local server time for the event.

Uses

Can be used to record and report scores. Note that the difference between thisValue and lastValue can vary by more than 1 if a user for example, teamkills or kills with a Genocide shot.