|
|
| Line 1: |
Line 1: |
| {{BZFS_API_Doc}}
| | #REDIRECT [[Category:BZFS API Docs]] |
| {{BZFS_API_Events}}
| |
| | |
| ==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.
| |
| | |
| {| border="1" cellpadding="20" cellspacing="0"
| |
| !name
| |
| !type
| |
| !value description
| |
| |-
| |
| |eventType
| |
| |[[Event(API)|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.
| |