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 eLuaDataEvent: Difference between revisions
Jump to navigation
Jump to search
| (One intermediate revision by the same user not shown) | |||
| Line 3: | Line 3: | ||
==Overview== | ==Overview== | ||
The ''' | 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 15: | ||
|eventType | |eventType | ||
|[[Event(API)|bz_eEventType]] | |[[Event(API)|bz_eEventType]] | ||
| | |bz_eLuaDataEvent | ||
|- | |- | ||
|srcPlayerID | |srcPlayerID | ||
Latest revision as of 18:32, 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.