|
|
| (3 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| '''BZFS API Documentation''' This page contains part of the [[BZFS_API|BZFS API]] documentation for use by [[Plug-ins|Plug-ins]] on the [[BZFS|BZFS]] server.
| | #REDIRECT [[Category:BZFS API Docs]] |
| | |
| | |
| '''BZFS Event.''' This page documents a [[BZFS|BZFS]] [[Event(API)|event]] that is called by the game server to notify [[Plug-ins|plug-ins]] of various actions and state changes in the game world.
| |
| | |
| ==Overview==
| |
| The '''bz_eServerMsgEvent''' is an API event that is called each time the server sends a message.
| |
| | |
| ==Data==
| |
| '''bz_eServerMsgEvent''' returns the '''bz_eServerMsgEvent_V1''' data class.
| |
| | |
| {| border="1" cellpadding="20" cellspacing="0"
| |
| !name
| |
| !type
| |
| !value description
| |
| |-
| |
| |eventType
| |
| |[[Event(API)|bz_eEventType]]
| |
| |bz_eServerMsgEvent
| |
| |-
| |
| |to
| |
| |int
| |
| |ID of the player receiving the message
| |
| |-
| |
| |team
| |
| |[[bz_eTeamType]]
| |
| |The team/group receiving the message
| |
| |-
| |
| |message
| |
| |[[Bz_APIString|bzApiString]]
| |
| |The message text
| |
| |-
| |
| |time
| |
| |double
| |
| |Time local server time for the event.
| |
| |}
| |