Desc="(<b>OBSOLETE</b>) This class is no longer useful in the API and will be removed as soon as all core plugins are migrated away from it. The {{cPlugin}} class serves as the main plugin instance's interface.",
Notes="Informs the plugin manager that it should call the specified function when the specified hook event occurs. If a function is not specified, a default global function name is looked up, based on the hook type",
Notes="Binds an in-game command with the specified callback function, permission and help string. By common convention, providing an empty string for HelpString will hide the command from the /help display. Returns true if successful, logs to console and returns no value on error. The callback uses the following signature: <pre class=\"prettyprint lang-lua\">function(Split, {{cPlayer|Player}})</pre> The Split parameter contains an array-table of the words that the player has sent, Player is the {{cPlayer}} object representing the player who sent the command. If the callback returns true, the command is assumed to have executed successfully; in all other cases the server sends a warning to the player that the command is unknown (this is so that subcommands can be implemented).",
Notes="Binds an in-game command with the specified callback function, permission and help string. By common convention, providing an empty string for HelpString will hide the command from the /help display. Returns true if successful, logs to console and returns no value on error. The callback uses the following signature: <pre class=\"prettyprint lang-lua\">function(Split, {{cPlayer|Player}})</pre> The Split parameter contains an array-table of the words that the player has sent, Player is the {{cPlayer}} object representing the player who sent the command. If the callback returns true, the command is assumed to have executed successfully; in all other cases the server sends a warning to the player that the command is unknown (this is so that subcommands can be implemented).",
Notes="Binds a console command with the specified callback function and help string. By common convention, providing an empty string for HelpString will hide the command from the \"help\" console command. Returns true if successful, logs to console and returns no value on error. The callback uses the following signature: <pre class=\"prettyprint lang-lua\">function(Split)</pre> The Split parameter contains an array-table of the words that the admin has typed. If the callback returns true, the command is assumed to have executed successfully; in all other cases the server issues a warning to the console that the command is unknown (this is so that subcommands can be implemented).",
},
{
Params=
{
{
Name="Command",
Type="string",
},
{
Name="Callback",
Type="function",
},
{
Name="HelpString",
Type="string",
},
},
Returns=
{
{
Type="boolean",
IsOptional=true,
},
},
Notes="Binds a console command with the specified callback function and help string. By common convention, providing an empty string for HelpString will hide the command from the \"help\" console command. Returns true if successful, logs to console and returns no value on error. The callback uses the following signature: <pre class=\"prettyprint lang-lua\">function(Split)</pre> The Split parameter contains an array-table of the words that the admin has typed. If the callback returns true, the command is assumed to have executed successfully; in all other cases the server issues a warning to the console that the command is unknown (this is so that subcommands can be implemented).",
},
},
CallPlugin=
{
IsStatic=true,
Params=
{
{
Name="PluginName",
Type="string",
},
{
Name="FunctionName",
Type="string",
},
{
Name="FunctionArgs...",
Type="...",
IsOptional=true,
},
},
Returns=
{
{
Name="FunctionRets",
Type="...",
IsOptional=true,
},
},
Notes="Calls the specified function in the specified plugin, passing all the given arguments to it. If it succeeds, it returns all the values returned by that function. If it fails, returns no value at all. Note that only strings, numbers, bools, nils, API classes and simple tables can be used for parameters and return values; functions cannot be copied across plugins.",
},
DoWithPlugin=
{
IsStatic=true,
Params=
{
{
Name="PluginName",
Type="string",
},
{
Name="CallbackFn",
Type="function",
},
},
Returns=
{
{
Type="boolean",
},
},
Notes="Calls the CallbackFn for the specified plugin, if found. A plugin can be found even if it is currently unloaded, disabled or errored, the callback should check the plugin status. If the plugin is not found, this function returns false, otherwise it returns the bool value that the callback has returned. The CallbackFn has the following signature: <pre class=\"prettyprint lang-lua\">function ({{cPlugin|Plugin}})</pre>",
},
ExecuteCommand=
{
Params=
{
{
Name="Player",
Type="cPlayer",
},
{
Name="CommandStr",
Type="string",
},
},
Returns=
{
{
Name="CommandResult",
Type="cPluginManager#CommandResult",
},
},
Notes="Executes the command as if given by the specified Player. Checks permissions.",
},
ExecuteConsoleCommand=
{
Params=
{
{
Name="CommandStr",
Type="string",
},
},
Returns=
{
{
Type="boolean",
},
{
Type="string",
},
},
Notes="Executes the console command as if given by the admin on the console. If the command is successfully executed, returns true and the text that would be output to the console normally. On error it returns false and an error message.",
},
FindPlugins=
{
Notes="<b>OBSOLETE</b>, use RefreshPluginList() instead",
},
ForceExecuteCommand=
{
Params=
{
{
Name="Player",
Type="cPlayer",
},
{
Name="CommandStr",
Type="string",
},
},
Returns=
{
{
Name="CommandResult",
Type="cPluginManager#CommandResult",
},
},
Notes="Same as ExecuteCommand, but doesn't check permissions",
},
ForEachCommand=
{
Params=
{
{
Name="CallbackFn",
Type="function",
},
},
Returns=
{
{
Type="boolean",
},
},
Notes="Calls the CallbackFn function for each command that has been bound using BindCommand(). The CallbackFn has the following signature: <pre class=\"prettyprint lang-lua\">function(Command, Permission, HelpString)</pre> If the callback returns true, the enumeration is aborted and this API function returns false; if it returns false or no value, the enumeration continues with the next command, and the API function returns true.",
},
ForEachConsoleCommand=
{
Params=
{
{
Name="CallbackFn",
Type="function",
},
},
Returns=
{
{
Type="boolean",
},
},
Notes="Calls the CallbackFn function for each command that has been bound using BindConsoleCommand(). The CallbackFn has the following signature: <pre class=\"prettyprint lang-lua\">function (Command, HelpString)</pre> If the callback returns true, the enumeration is aborted and this API function returns false; if it returns false or no value, the enumeration continues with the next command, and the API function returns true.",
Notes="Calls the CallbackFn function for each plugin that is currently discovered by Cuberite (including disabled, unloaded and errrored plugins). The CallbackFn has the following signature: <pre class=\"prettyprint lang-lua\">function ({{cPlugin|Plugin}})</pre> If the callback returns true, the enumeration is aborted and this API function returns false; if it returns false or no value, the enumeration continues with the next command, and the API function returns true.",
Notes="Calls the CallbackFn function for each plugin that is currently discovered by Cuberite (including disabled, unloaded and errrored plugins). The CallbackFn has the following signature: <pre class=\"prettyprint lang-lua\">function ({{cPlugin|Plugin}})</pre> If the callback returns true, the enumeration is aborted and this API function returns false; if it returns false or no value, the enumeration continues with the next command, and the API function returns true.",
Notes="Returns the single instance of the plugin manager",
},
GetAllPlugins=
{
Returns=
{
{
Type="table",
},
},
Notes="Returns a table (dictionary) of all plugins, [name => value], where value is a valid {{cPlugin}} if the plugin is loaded, or the bool value false if the plugin is not loaded.",
},
GetCommandPermission=
{
Params=
{
{
Name="Command",
Type="string",
},
},
Returns=
{
{
Name="Permission",
Type="string",
},
},
Notes="Returns the permission needed for executing the specified command",
},
GetCurrentPlugin=
{
Returns=
{
{
Type="cPlugin",
},
},
Notes="Returns the {{cPlugin}} object for the calling plugin. This is the same object that the Initialize function receives as the argument.",
},
GetNumLoadedPlugins=
{
Returns=
{
{
Type="number",
},
},
Notes="Returns the number of loaded plugins (psLoaded only)",
},
GetNumPlugins=
{
Returns=
{
{
Type="number",
},
},
Notes="Returns the number of plugins, including the disabled, errored, unloaded and not-found ones",
},
GetPlugin=
{
Params=
{
{
Name="PluginName",
Type="string",
},
},
Returns=
{
{
Type="cPlugin",
},
},
Notes="(<b>DEPRECATED, UNSAFE</b>) Returns a plugin handle of the specified plugin, or nil if such plugin is not loaded. Note thatdue to multithreading the handle is not guaranteed to be safe for use when stored - a single-plugin reload may have been triggered in the mean time for the requested plugin.",
},
GetPluginFolderName=
{
Params=
{
{
Name="PluginName",
Type="string",
},
},
Returns=
{
{
Type="string",
},
},
Notes="Returns the name of the folder from which the plugin was loaded (without the \"Plugins\" part). Used as a plugin's display name.",
},
GetPluginsPath=
{
IsStatic=true,
Returns=
{
{
Type="string",
},
},
Notes="Returns the path where the individual plugin folders are located. Doesn't include the path separator at the end of the returned string.",
},
IsCommandBound=
{
Params=
{
{
Name="Command",
Type="string",
},
},
Returns=
{
{
Type="boolean",
},
},
Notes="Returns true if in-game Command is already bound (by any plugin)",
},
IsConsoleCommandBound=
{
Params=
{
{
Name="Command",
Type="string",
},
},
Returns=
{
{
Type="boolean",
},
},
Notes="Returns true if console Command is already bound (by any plugin)",
},
IsPluginLoaded=
{
Params=
{
{
Name="PluginName",
Type="string",
},
},
Notes="Returns true if the specified plugin is loaded.",
},
LoadPlugin=
{
Params=
{
{
Name="PluginFolder",
Type="string",
},
},
Notes="(<b>DEPRECATED</b>) Loads a plugin from the specified folder. NOTE: Loading plugins may be an unsafe operation and may result in a deadlock or a crash. This API is deprecated and might be removed.",
},
LogStackTrace=
{
IsStatic=true,
Notes="Logs a current stack trace of the Lua engine to the server console log. Same format as is used when the plugin fails.",
},
RefreshPluginList=
{
Notes="Refreshes the list of plugins to include all folders inside the Plugins folder (potentially new disabled plugins)",
},
ReloadPlugins=
{
Notes="Reloads all active plugins",
},
UnloadPlugin=
{
Params=
{
{
Name="PluginName",
Type="string",
},
},
Notes="Queues the specified plugin to be unloaded. To avoid deadlocks, the unloading happens in the main tick thread asynchronously.",
Notes="When a plugin stopped the command using the OnExecuteCommand hook",
},
crError=
{
Notes="When the command handler for the given command results in an error",
},
crExecuted=
{
Notes="When the command is successfully executed.",
},
crNoPermission=
{
Notes="When the player doesn't have permission to execute the given command.",
},
crUnknownCommand=
{
Notes="When the given command doesn't exist.",
},
HOOK_BLOCK_SPREAD=
{
Notes="Called when a block spreads based on world conditions",
},
HOOK_BLOCK_TO_PICKUPS=
{
Notes="Called when a block has been dug and is being converted to pickups. The server has provided the default pickups and the plugins may modify them.",
Notes="Called when a client sends a chat message that is not a command. The plugin may modify the chat message",
},
HOOK_CHUNK_AVAILABLE=
{
Notes="Called when a chunk is loaded or generated and becomes available in the {{cWorld|world}}.",
},
HOOK_CHUNK_GENERATED=
{
Notes="Called after a chunk is generated. A plugin may do last modifications on the generated chunk before it is handed of to the {{cWorld|world}}.",
},
HOOK_CHUNK_GENERATING=
{
Notes="Called before a chunk is generated. A plugin may override some parts of the generation algorithm.",
},
HOOK_CHUNK_UNLOADED=
{
Notes="Called after a chunk has been unloaded from a {{cWorld|world}}.",
},
HOOK_CHUNK_UNLOADING=
{
Notes="Called before a chunk is unloaded from a {{cWorld|world}}. The chunk has already been saved.",
},
HOOK_COLLECTING_PICKUP=
{
Notes="Called when a player is about to collect a pickup.",
},
HOOK_CRAFTING_NO_RECIPE=
{
Notes="Called when a player has items in the crafting slots and the server cannot locate any recipe. Plugin may provide a recipe.",
},
HOOK_DISCONNECT=
{
Notes="Called after the player has disconnected.",
},
HOOK_ENTITY_ADD_EFFECT=
{
Notes="Called when an effect is being added to an {{cEntity|entity}}. Plugin may refuse the effect.",
},
HOOK_ENTITY_CHANGED_WORLD=
{
Notes="Called after a entity has changed the world.",
},
HOOK_ENTITY_CHANGING_WORLD=
{
Notes="Called before a entity has changed the world. Plugin may disallow a entity to change the world.",
},
HOOK_ENTITY_TELEPORT=
{
Notes="Called when an {{cEntity|entity}} is being teleported. Plugin may refuse the teleportation.",
},
HOOK_EXECUTE_COMMAND=
{
Notes="Called when a client sends a chat message that is recognized as a command, before handing that command to the regular command handler. A plugin may stop the command from being handled. This hook is called even when the player doesn't have permissions for the command.",
},
HOOK_EXPLODED=
{
Notes="Called after an explosion has been processed in a {{cWorld|world}}.",
},
HOOK_EXPLODING=
{
Notes="Called before an explosion is processed in a {{cWorld|world}}. A plugin may alter the explosion parameters or cancel the explosion altogether.",
},
HOOK_HANDSHAKE=
{
Notes="Called when a Handshake packet is received from a client.",
},
HOOK_HOPPER_PULLING_ITEM=
{
Notes="Called when a hopper is pulling an item from the container above it.",
},
HOOK_HOPPER_PUSHING_ITEM=
{
Notes="Called when a hopper is pushing an item into the container it is aimed at.",
},
HOOK_KILLED=
{
Notes="Called when an entity has been killed.",
},
HOOK_KILLING=
{
Notes="Called when an entity has just been killed. A plugin may resurrect the entity by setting its health to above zero.",
},
HOOK_LOGIN=
{
Notes="Called when a Login packet is sent to the client, before the client is queued for authentication.",
Notes="Called when the player has just placed a block",
},
HOOK_PLAYER_PLACING_BLOCK=
{
Notes="Called when the player is about to place a block. A plugin may cancel the event.",
},
HOOK_PLAYER_RIGHT_CLICK=
{
Notes="Called when the client sends the RightClick packet.",
},
HOOK_PLAYER_RIGHT_CLICKING_ENTITY=
{
Notes="Called when the client sends the UseEntity packet.",
},
HOOK_PLAYER_SHOOTING=
{
Notes="Called when the player releases the mouse button to fire their bow.",
},
HOOK_PLAYER_SPAWNED=
{
Notes="Called after the player entity has been created. The entity is fully initialized and is spawning in the {{cWorld|world}}.",
},
HOOK_PLAYER_TOSSING_ITEM=
{
Notes="Called when the player is tossing the held item (keypress Q)",
},
HOOK_PLAYER_USED_BLOCK=
{
Notes="Called after the player has right-clicked a block",
},
HOOK_PLAYER_USED_ITEM=
{
Notes="Called after the player has right-clicked with a usable item in their hand.",
},
HOOK_PLAYER_USING_BLOCK=
{
Notes="Called when the player is about to use (right-click) a block",
},
HOOK_PLAYER_USING_ITEM=
{
Notes="Called when the player is about to right-click with a usable item in their hand.",
},
HOOK_PLUGIN_MESSAGE=
{
Notes="Called when a PluginMessage packet is received from a client.",
},
HOOK_PLUGINS_LOADED=
{
Notes="Called after all plugins have loaded.",
},
HOOK_POST_CRAFTING=
{
Notes="Called after a valid recipe has been chosen for the current contents of the crafting grid. Plugins may modify the recipe.",
},
HOOK_PRE_CRAFTING=
{
Notes="Called before a recipe is searched for the current contents of the crafting grid. Plugins may provide a recipe and cancel the built-in search.",
},
HOOK_PROJECTILE_HIT_BLOCK=
{
Notes="Called when a {{cProjectileEntity|projectile}} hits a block.",
},
HOOK_PROJECTILE_HIT_ENTITY=
{
Notes="Called when a {{cProjectileEntity|projectile}} hits an {{cEntity|entity}}.",
},
HOOK_SERVER_PING=
{
Notes="Called when a client pings the server from the server list. Plugins may change the favicon, server description, players online and maximum players values.",
},
HOOK_SPAWNED_ENTITY=
{
Notes="Called after an entity is spawned in a {{cWorld|world}}. The entity is already part of the world.",
},
HOOK_SPAWNED_MONSTER=
{
Notes="Called after a mob is spawned in a {{cWorld|world}}. The mob is already part of the world.",
},
HOOK_SPAWNING_ENTITY=
{
Notes="Called just before an entity is spawned in a {{cWorld|world}}.",
},
HOOK_SPAWNING_MONSTER=
{
Notes="Called just before a mob is spawned in a {{cWorld|world}}.",
},
HOOK_TAKE_DAMAGE=
{
Notes="Called when an entity is taking any kind of damage. Plugins may modify the damage value, effects, source or cancel the damage.",
},
HOOK_TICK=
{
Notes="Called when the main server thread ticks - 20 times a second.",
},
HOOK_UPDATED_SIGN=
{
Notes="Called after a {{cSignEntity|sign}} text has been updated, either by a player or by any external means.",
},
HOOK_UPDATING_SIGN=
{
Notes="Called before a {{cSignEntity|sign}} text is updated, either by a player or by any external means.",
},
HOOK_WEATHER_CHANGED=
{
Notes="Called after the weather has changed.",
},
HOOK_WEATHER_CHANGING=
{
Notes="Called just before the weather changes",
},
HOOK_WORLD_STARTED=
{
Notes="Called when a world has been started.",
},
HOOK_WORLD_TICK=
{
Notes="Called in each world's tick thread when the game logic is about to tick (20 times a second).",
},
psDisabled=
{
Notes="The plugin is not enabled in settings.ini",
},
psError=
{
Notes="The plugin is enabled in settings.ini, but it has run into an error while loading. Use {{cPlugin}}:GetLoadError() to identify the error.",
},
psLoaded=
{
Notes="The plugin is enabled and loaded.",
},
psNotFound=
{
Notes="The plugin has been loaded, but is no longer present on disk.",
},
psUnloaded=
{
Notes="The plugin is enabled in settings.ini, but it has been unloaded (by a command).",
