This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz eUnknownSlashCommand"
From BZFlagWiki
(time to eventTime) |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 3: | Line 3: | ||
==Overview== | ==Overview== | ||
| − | The '''bz_eUnknownSlashCommand''' is an API event that is called | + | The '''bz_eUnknownSlashCommand''' is an API event that is called when the [[BZFS]] server does not have an installed handler for a specific [[Slash_Commands|slash command]]. |
==Data== | ==Data== | ||
| − | '''bz_eUnknownSlashCommand''' returns the ''' | + | '''bz_eUnknownSlashCommand''' returns the '''bz_UnknownSlashCommandEventData_V1''' data class. |
{| border="1" cellpadding="20" cellspacing="0" | {| border="1" cellpadding="20" cellspacing="0" | ||
| Line 23: | Line 23: | ||
|handled | |handled | ||
|bool | |bool | ||
| − | | | + | |The current state representing if the command has been handled by a previous plug-in. Plug-ins that handle the command should set this value to true to communicate it's state to other plug-ins that have yet to process. |
|- | |- | ||
|message | |message | ||
| − | | | + | |[[bz_ApiString]] |
| − | |The slash command | + | |The full text of the chat message for the slash command, containing the command and all associated parameters. |
|- | |- | ||
| − | | | + | |eventTime |
|double | |double | ||
| − | |The time at which the | + | |The server time at which the event occurred (in seconds). |
|} | |} | ||
==Uses== | ==Uses== | ||
| − | This event | + | This event should not be used by plug-ins to implement custom slash commands. This event is in the process of being deprectated and should be replaced with uses of [[bz_registerCustomSlashCommand]]. |
[[Category:BZFS_API_Docs]] | [[Category:BZFS_API_Docs]] | ||
[[Category:BZFS_API_Events]] | [[Category:BZFS_API_Events]] | ||
Latest revision as of 07:57, 1 May 2014
| 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[edit]
The bz_eUnknownSlashCommand is an API event that is called when the BZFS server does not have an installed handler for a specific slash command.
Data[edit]
bz_eUnknownSlashCommand returns the bz_UnknownSlashCommandEventData_V1 data class.
| name | type | value description |
|---|---|---|
| eventType | bz_eEventType | bz_eUnknownSlashCommandEvent |
| from | int | The player who sent the slash command |
| handled | bool | The current state representing if the command has been handled by a previous plug-in. Plug-ins that handle the command should set this value to true to communicate it's state to other plug-ins that have yet to process. |
| message | bz_ApiString | The full text of the chat message for the slash command, containing the command and all associated parameters. |
| eventTime | double | The server time at which the event occurred (in seconds). |
Uses[edit]
This event should not be used by plug-ins to implement custom slash commands. This event is in the process of being deprectated and should be replaced with uses of bz_registerCustomSlashCommand.
