This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz eLuaDataEvent"
From BZFlagWiki
(→eLuaDataEvent) |
(forgot bz_) |
||
Line 3: | Line 3: | ||
==Overview== | ==Overview== | ||
− | The '''eLuaDataEvent''' is an API event that is called each time a BZDB variable is changed. | + | The ''bz_'eLuaDataEvent''' is an API event that is called each time a BZDB variable is changed. |
==Data== | ==Data== | ||
− | ''' | + | '''bz_eLuaDataEvent''' returns the '''bz_LuaDataEventData_V1''' data class. |
{| border="1" cellpadding="20" cellspacing="0" | {| border="1" cellpadding="20" cellspacing="0" | ||
Line 14: | Line 14: | ||
|eventType | |eventType | ||
|[[Event(API)|bz_eEventType]] | |[[Event(API)|bz_eEventType]] | ||
− | | | + | |bz_eLuaDataEvent |
|- | |- | ||
|srcPlayerID | |srcPlayerID |
Revision as of 18:31, 25 September 2010
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_'eLuaDataEvent' is an API event that is called each time a BZDB variable is changed.
Data
bz_eLuaDataEvent returns the bz_LuaDataEventData_V1 data class.
name | type | value description |
---|---|---|
eventType | bz_eEventType | bz_eLuaDataEvent |
srcPlayerID | int | ID of the player sending the data |
dstPlayerID | int | ID of the player receiving the data |
srcScriptID | int | ID of the sending script |
dstScriptID | int | ID of the receiving script |
status | int | Status of the data |
data | const char* | The data being sent |
doNotSend | bool | Whether or not to send the data |
Usagae
All data retured is only for notification purposes except for doNotSend.