diff options
author | Julian Laubstein <julianlaubstein@yahoo.de> | 2015-08-11 22:48:55 +0200 |
---|---|---|
committer | Julian Laubstein <julianlaubstein@yahoo.de> | 2015-08-11 22:48:55 +0200 |
commit | 0958e167e89d2b3289c01905ebb8897e6bc86c43 (patch) | |
tree | 482062f5cdc11520ff0d0496e419524be01f1299 /MCServer/Plugins/APIDump/Hooks | |
parent | Merge pull request #2423 from cuberite/JsonCppCheck (diff) | |
download | cuberite-0958e167e89d2b3289c01905ebb8897e6bc86c43.tar cuberite-0958e167e89d2b3289c01905ebb8897e6bc86c43.tar.gz cuberite-0958e167e89d2b3289c01905ebb8897e6bc86c43.tar.bz2 cuberite-0958e167e89d2b3289c01905ebb8897e6bc86c43.tar.lz cuberite-0958e167e89d2b3289c01905ebb8897e6bc86c43.tar.xz cuberite-0958e167e89d2b3289c01905ebb8897e6bc86c43.tar.zst cuberite-0958e167e89d2b3289c01905ebb8897e6bc86c43.zip |
Diffstat (limited to '')
24 files changed, 38 insertions, 38 deletions
diff --git a/MCServer/Plugins/APIDump/Hooks/OnBlockSpread.lua b/MCServer/Plugins/APIDump/Hooks/OnBlockSpread.lua index ed0b5f46f..7da796d4d 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnBlockSpread.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnBlockSpread.lua @@ -29,7 +29,7 @@ return }, Returns = [[ If the function returns false or no value, the next plugin's callback is called, and finally - MCServer will process the spread. If the function + Cuberite will process the spread. If the function returns true, no other callback is called for this event and the spread will not occur. ]], }, -- HOOK_BLOCK_SPREAD diff --git a/MCServer/Plugins/APIDump/Hooks/OnChunkGenerated.lua b/MCServer/Plugins/APIDump/Hooks/OnChunkGenerated.lua index b10dc36f5..64bfdad5c 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnChunkGenerated.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnChunkGenerated.lua @@ -21,10 +21,10 @@ return { Name = "ChunkDesc", Type = "{{cChunkDesc}}", Notes = "Generated chunk data. Plugins may still modify the chunk data contained." }, }, Returns = [[ - If the plugin returns false or no value, MCServer will call other plugins' callbacks for this event. + If the plugin returns false or no value, Cuberite will call other plugins' callbacks for this event. If a plugin returns true, no other callback is called for this event.</p> <p> - In either case, MCServer will then store the data from ChunkDesc as the chunk's contents in the world. + In either case, Cuberite will then store the data from ChunkDesc as the chunk's contents in the world. ]], CodeExamples = { @@ -34,7 +34,7 @@ return Code = [[ function OnChunkGenerated(a_World, a_ChunkX, a_ChunkZ, a_ChunkDesc) -- Generate a psaudorandom value that is always the same for the same X/Z pair, but is otherwise random enough: - -- This is actually similar to how MCServer does its noise functions + -- This is actually similar to how Cuberite does its noise functions local PseudoRandom = (a_ChunkX * 57 + a_ChunkZ) * 57 + 19785486 PseudoRandom = PseudoRandom * 8192 + PseudoRandom; PseudoRandom = ((PseudoRandom * (PseudoRandom * PseudoRandom * 15731 + 789221) + 1376312589) % 0x7fffffff; diff --git a/MCServer/Plugins/APIDump/Hooks/OnChunkUnloading.lua b/MCServer/Plugins/APIDump/Hooks/OnChunkUnloading.lua index cd79e2a13..4ba995075 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnChunkUnloading.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnChunkUnloading.lua @@ -5,8 +5,8 @@ return CalledWhen = " A chunk is about to be unloaded from the memory. Plugins may refuse the unload.", DefaultFnName = "OnChunkUnloading", -- also used as pagename Desc = [[ - MCServer calls this function when a chunk is about to be unloaded from the memory. A plugin may - force MCServer to keep the chunk in memory by returning true.</p> + Cuberite calls this function when a chunk is about to be unloaded from the memory. A plugin may + force Cuberite to keep the chunk in memory by returning true.</p> <p> FIXME: The return value should be used only for event propagation stopping, not for the actual decision whether to unload. diff --git a/MCServer/Plugins/APIDump/Hooks/OnCollectingPickup.lua b/MCServer/Plugins/APIDump/Hooks/OnCollectingPickup.lua index 0a56df2c9..2a451da92 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnCollectingPickup.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnCollectingPickup.lua @@ -20,7 +20,7 @@ return { Name = "Pickup", Type = "{{cPickup}}", Notes = "The pickup being collected" }, }, Returns = [[ - If the function returns false or no value, MCServer calls other plugins' callbacks and finally the + If the function returns false or no value, Cuberite calls other plugins' callbacks and finally the pickup is collected. If the function returns true, no other plugins are called for this event and the pickup is not collected. ]], diff --git a/MCServer/Plugins/APIDump/Hooks/OnCraftingNoRecipe.lua b/MCServer/Plugins/APIDump/Hooks/OnCraftingNoRecipe.lua index 5137bbb25..7cd86b8b8 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnCraftingNoRecipe.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnCraftingNoRecipe.lua @@ -6,7 +6,7 @@ return DefaultFnName = "OnCraftingNoRecipe", -- also used as pagename Desc = [[ This callback is called when a player places items in their {{cCraftingGrid|crafting grid}} and - MCServer cannot find a built-in {{cCraftingRecipe|recipe}} for the combination. Plugins may provide + Cuberite cannot find a built-in {{cCraftingRecipe|recipe}} for the combination. Plugins may provide a recipe for the ingredients given. ]], Params = @@ -17,7 +17,7 @@ return }, Returns = [[ If the function returns false or no value, no recipe will be used. If the function returns true, no - other plugin will have their callback called for this event and MCServer will use the crafting + other plugin will have their callback called for this event and Cuberite will use the crafting recipe in Recipe.</p> <p> FIXME: To allow plugins give suggestions and overwrite other plugins' suggestions, we should change diff --git a/MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua b/MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua index 204cb63d2..ae872a3ad 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua @@ -26,7 +26,7 @@ return { Name = "Reason", Type = "string", Notes = "The reason that the client has sent in the disconnect packet" }, }, Returns = [[ - If the function returns false or no value, MCServer calls other plugins' callbacks for this event. + If the function returns false or no value, Cuberite calls other plugins' callbacks for this event. If the function returns true, no other plugins are called for this event. In either case, the client is disconnected. ]], diff --git a/MCServer/Plugins/APIDump/Hooks/OnEntityAddEffect.lua b/MCServer/Plugins/APIDump/Hooks/OnEntityAddEffect.lua index 1d1658a6f..155abc41b 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnEntityAddEffect.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnEntityAddEffect.lua @@ -22,7 +22,7 @@ return }, Returns = [[ If the plugin returns true, the effect will not be added and none of the remaining hook handlers will - be called. If the plugin returns false, MCServer calls all the remaining hook handlers and finally + be called. If the plugin returns false, Cuberite calls all the remaining hook handlers and finally the effect is added to the entity. ]], }, -- HOOK_EXECUTE_COMMAND diff --git a/MCServer/Plugins/APIDump/Hooks/OnExecuteCommand.lua b/MCServer/Plugins/APIDump/Hooks/OnExecuteCommand.lua index db7eb97d1..4aa31bbd6 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnExecuteCommand.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnExecuteCommand.lua @@ -27,7 +27,7 @@ return { Name = "EntireCommand", Type = "string", Notes = "The entire command as a single string" }, }, Returns = [[ - If the plugin returns false, MCServer calls all the remaining hook handlers and finally the command + If the plugin returns false, Cuberite calls all the remaining hook handlers and finally the command will be executed. If the plugin returns true, the none of the remaining hook handlers will be called. In this case the plugin can return a second value, specifying whether what the command result should be set to, one of the {{cPluginManager#CommandResult|CommandResult}} constants. If not diff --git a/MCServer/Plugins/APIDump/Hooks/OnExploding.lua b/MCServer/Plugins/APIDump/Hooks/OnExploding.lua index 729f2e162..e21b41be0 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnExploding.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnExploding.lua @@ -39,7 +39,7 @@ return }, Returns = [[ If the function returns false or no value, the next plugin's callback is called, and finally - MCServer will process the explosion - destroy blocks and push + hurt entities. If the function + Cuberite will process the explosion - destroy blocks and push + hurt entities. If the function returns true, no other callback is called for this event and the explosion will not occur. ]], }, -- HOOK_EXPLODING diff --git a/MCServer/Plugins/APIDump/Hooks/OnKilling.lua b/MCServer/Plugins/APIDump/Hooks/OnKilling.lua index d2339e60b..6bfd75fb6 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnKilling.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnKilling.lua @@ -16,7 +16,7 @@ return { Name = "TDI", Type = "{{TakeDamageInfo}}", Notes = "The damage type, cause and effects." }, }, Returns = [[ - If the function returns false or no value, MCServer calls other plugins with this event. If the + If the function returns false or no value, Cuberite calls other plugins with this event. If the function returns true, no other plugin is called for this event.</p> <p> In either case, the victim's health is then re-checked and if it is greater than zero, the victim is diff --git a/MCServer/Plugins/APIDump/Hooks/OnLogin.lua b/MCServer/Plugins/APIDump/Hooks/OnLogin.lua index 6859f9d11..f71c3ade4 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnLogin.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnLogin.lua @@ -19,7 +19,7 @@ return }, Returns = [[ If the function returns true, no other plugins are called for this event and the client is kicked. - If the function returns false or no value, MCServer calls other plugins' callbacks and finally + If the function returns false or no value, Cuberite calls other plugins' callbacks and finally sends an authentication request for the client's username to the auth server. If the auth server is disabled in the server settings, the player object is immediately created. ]], diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerLeftClick.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerLeftClick.lua index 1d9585c55..3d4c07950 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnPlayerLeftClick.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerLeftClick.lua @@ -5,15 +5,15 @@ return CalledWhen = "A left-click packet is received from the client. Plugin may override / refuse.", DefaultFnName = "OnPlayerLeftClick", -- also used as pagename Desc = [[ - This hook is called when MCServer receives a left-click packet from the {{cClientHandle|client}}. It + This hook is called when Cuberite receives a left-click packet from the {{cClientHandle|client}}. It is called before any processing whatsoever is performed on the packet, meaning that hacked / malicious clients may be trigerring this event very often and with unchecked parameters. Therefore plugin authors are advised to use extreme caution with this callback.</p> <p> - Plugins may refuse the default processing for the packet, causing MCServer to behave as if the + Plugins may refuse the default processing for the packet, causing Cuberite to behave as if the packet has never arrived. This may, however, create inconsistencies in the client - the client may think that they broke a block, while the server didn't process the breaking, etc. For this reason, - if a plugin refuses the processing, MCServer sends the block specified in the packet back to the + if a plugin refuses the processing, Cuberite sends the block specified in the packet back to the client (as if placed anew), if the status code specified a block-break action. For other actions, plugins must rectify the situation on their own.</p> <p> @@ -31,11 +31,11 @@ return { Name = "Action", Type = "number", Notes = "Action to be performed on the block (\"status\" in the protocol docs)" }, }, Returns = [[ - If the function returns false or no value, MCServer calls other plugins' callbacks and finally sends + If the function returns false or no value, Cuberite calls other plugins' callbacks and finally sends the packet for further processing.</p> <p> If the function returns true, no other plugins are called, processing is halted. If the action was a - block dig, MCServer sends the block specified in the coords back to the client. The packet is + block dig, Cuberite sends the block specified in the coords back to the client. The packet is dropped. ]], }, -- HOOK_PLAYER_LEFT_CLICK diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerPlacedBlock.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerPlacedBlock.lua index 6445a76b4..74d4c19e3 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnPlayerPlacedBlock.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerPlacedBlock.lua @@ -28,7 +28,7 @@ return { Name = "BlockMeta", Type = "NIBBLETYPE", Notes = "The block meta of the block" }, }, Returns = [[ - If this function returns false or no value, MCServer calls other plugins with the same event. If + If this function returns false or no value, Cuberite calls other plugins with the same event. If this function returns true, no other plugin is called for this event. ]], }, -- HOOK_PLAYER_PLACED_BLOCK diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerPlacingBlock.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerPlacingBlock.lua index 4241a09aa..b78acc327 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnPlayerPlacingBlock.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerPlacingBlock.lua @@ -10,7 +10,7 @@ return at all.</p> <p> Note that the client already expects that the block has been placed. For that reason, if a plugin - refuses the placement, MCServer sends the old block at the provided coords to the client.</p> + refuses the placement, Cuberite sends the old block at the provided coords to the client.</p> <p> Use the {{cPlayer}}:GetWorld() function to get the world to which the block belongs.</p> <p> @@ -31,9 +31,9 @@ return { Name = "BlockMeta", Type = "NIBBLETYPE", Notes = "The block meta of the block" }, }, Returns = [[ - If this function returns false or no value, MCServer calls other plugins with the same event and + If this function returns false or no value, Cuberite calls other plugins with the same event and finally places the block and removes the corresponding item from player's inventory. If this - function returns true, no other plugin is called for this event, MCServer sends the old block at + function returns true, no other plugin is called for this event, Cuberite sends the old block at the specified coords to the client and drops the packet. ]], }, -- HOOK_PLAYER_PLACING_BLOCK diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerRightClick.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerRightClick.lua index de9b3662c..e1b95197d 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnPlayerRightClick.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerRightClick.lua @@ -5,12 +5,12 @@ return CalledWhen = "A right-click packet is received from the client. Plugin may override / refuse.", DefaultFnName = "OnPlayerRightClick", -- also used as pagename Desc = [[ - This hook is called when MCServer receives a right-click packet from the {{cClientHandle|client}}. It + This hook is called when Cuberite receives a right-click packet from the {{cClientHandle|client}}. It is called before any processing whatsoever is performed on the packet, meaning that hacked / malicious clients may be trigerring this event very often and with unchecked parameters. Therefore plugin authors are advised to use extreme caution with this callback.</p> <p> - Plugins may refuse the default processing for the packet, causing MCServer to behave as if the + Plugins may refuse the default processing for the packet, causing Cuberite to behave as if the packet has never arrived. This may, however, create inconsistencies in the client - the client may think that they placed a block, while the server didn't process the placing, etc. ]], @@ -26,7 +26,7 @@ return { Name = "CursorZ", Type = "number", Notes = "Z-coord of the mouse crosshair on the block" }, }, Returns = [[ - If the function returns false or no value, MCServer calls other plugins' callbacks and finally sends + If the function returns false or no value, Cuberite calls other plugins' callbacks and finally sends the packet for further processing.</p> <p> If the function returns true, no other plugins are called, processing is halted. diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerRightClickingEntity.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerRightClickingEntity.lua index 796622307..b271cf058 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnPlayerRightClickingEntity.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerRightClickingEntity.lua @@ -14,7 +14,7 @@ return { Name = "Entity", Type = "{{cEntity}} descendant", Notes = "The entity that has been right-clicked" }, }, Returns = [[ - If the functino returns false or no value, MCServer calls other plugins' callbacks and finally does + If the functino returns false or no value, Cuberite calls other plugins' callbacks and finally does the default processing for the right-click. If the function returns true, no other callbacks are called and the default processing is skipped. ]], diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerShooting.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerShooting.lua index aefae2c2f..7315ede7a 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnPlayerShooting.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerShooting.lua @@ -20,7 +20,7 @@ return }, Returns = [[ If the function returns false or no value, the next plugin's callback is called, and finally - MCServer creates the projectile. If the functino returns true, no other callback is called and no + Cuberite creates the projectile. If the functino returns true, no other callback is called and no projectile is created. ]], }, -- HOOK_PLAYER_SHOOTING diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerTossingItem.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerTossingItem.lua index 82d5bb390..d3daf850b 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnPlayerTossingItem.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerTossingItem.lua @@ -20,7 +20,7 @@ return If the function returns false or no value, other plugins' callbacks are called and finally MCServer creates the pickup for the item and tosses it, using {{cPlayer}}:TossHeldItem, {{cPlayer}}:TossEquippedItem, or {{cPlayer}}:TossPickup. If the function returns true, no other callbacks are called for this event - and MCServer doesn't toss the item. + and Cuberite doesn't toss the item. ]], }, -- HOOK_PLAYER_TOSSING_ITEM } diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerUsedBlock.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerUsedBlock.lua index 9a0e036b9..babd70fcc 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnPlayerUsedBlock.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerUsedBlock.lua @@ -6,7 +6,7 @@ return DefaultFnName = "OnPlayerUsedBlock", -- also used as pagename Desc = [[ This hook is called after a {{cPlayer|player}} has right-clicked a block that can be used, such as a - {{cChestEntity|chest}} or a lever. It is called after MCServer processes the usage (sends the UI + {{cChestEntity|chest}} or a lever. It is called after Cuberite processes the usage (sends the UI handling packets / toggles redstone). Note that for UI-related blocks, the player is most likely still using the UI. This is a notification-only event.</p> <p> diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerUsedItem.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerUsedItem.lua index 998058c35..6089928e2 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnPlayerUsedItem.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerUsedItem.lua @@ -7,7 +7,7 @@ return Desc = [[ This hook is called after a {{cPlayer|player}} has right-clicked a block with an {{cItem|item}} that can be used (is not placeable, is not food and clicked block is not use-able), such as a bucket or a - hoe. It is called after MCServer processes the usage (places fluid / turns dirt to farmland). + hoe. It is called after Cuberite processes the usage (places fluid / turns dirt to farmland). This is an information-only hook, there is no way to cancel the event anymore.</p> <p> Note that the block coords given in this callback are for the (solid) block that is being clicked, diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerUsingBlock.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerUsingBlock.lua index 8acc84b5f..48cb78af3 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnPlayerUsingBlock.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerUsingBlock.lua @@ -6,7 +6,7 @@ return DefaultFnName = "OnPlayerUsingBlock", -- also used as pagename Desc = [[ This hook is called when a {{cPlayer|player}} has right-clicked a block that can be used, such as a - {{cChestEntity|chest}} or a lever. It is called before MCServer processes the usage (sends the UI + {{cChestEntity|chest}} or a lever. It is called before Cuberite processes the usage (sends the UI handling packets / toggles redstone). Plugins may refuse the interaction by returning true.</p> <p> Note that the block coords given in this callback are for the (solid) block that is being clicked, diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerUsingItem.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerUsingItem.lua index 09674606d..3434acd54 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnPlayerUsingItem.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerUsingItem.lua @@ -7,7 +7,7 @@ return Desc = [[ This hook is called when a {{cPlayer|player}} has right-clicked a block with an {{cItem|item}} that can be used (is not placeable, is not food and clicked block is not use-able), such as a bucket or a - hoe. It is called before MCServer processes the usage (places fluid / turns dirt to farmland). + hoe. It is called before Cuberite processes the usage (places fluid / turns dirt to farmland). Plugins may refuse the interaction by returning true.</p> <p> Note that the block coords given in this callback are for the (solid) block that is being clicked, diff --git a/MCServer/Plugins/APIDump/Hooks/OnPostCrafting.lua b/MCServer/Plugins/APIDump/Hooks/OnPostCrafting.lua index 8af78ba62..26a450750 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnPostCrafting.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnPostCrafting.lua @@ -20,11 +20,11 @@ return { { Name = "Player", Type = "{{cPlayer}}", Notes = "The player who has changed their crafting grid contents" }, { Name = "Grid", Type = "{{cCraftingGrid}}", Notes = "The new crafting grid contents" }, - { Name = "Recipe", Type = "{{cCraftingRecipe}}", Notes = "The recipe that MCServer has decided to use (can be tweaked by plugins)" }, + { Name = "Recipe", Type = "{{cCraftingRecipe}}", Notes = "The recipe that Cuberite has decided to use (can be tweaked by plugins)" }, }, Returns = [[ If the function returns false or no value, other plugins' callbacks are called. If the function - returns true, no other callbacks are called for this event. In either case, MCServer uses the value + returns true, no other callbacks are called for this event. In either case, Cuberite uses the value of Recipe as the recipe to be presented to the player. ]], }, -- HOOK_POST_CRAFTING diff --git a/MCServer/Plugins/APIDump/Hooks/OnPreCrafting.lua b/MCServer/Plugins/APIDump/Hooks/OnPreCrafting.lua index b404e0e73..5a5347310 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnPreCrafting.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnPreCrafting.lua @@ -19,13 +19,13 @@ return { { Name = "Player", Type = "{{cPlayer}}", Notes = "The player who has changed their crafting grid contents" }, { Name = "Grid", Type = "{{cCraftingGrid}}", Notes = "The new crafting grid contents" }, - { Name = "Recipe", Type = "{{cCraftingRecipe}}", Notes = "The recipe that MCServer will use. Modify this object to change the recipe" }, + { Name = "Recipe", Type = "{{cCraftingRecipe}}", Notes = "The recipe that Cuberite will use. Modify this object to change the recipe" }, }, Returns = [[ If the function returns false or no value, other plugins' callbacks are called and then MCServer searches the built-in recipes. The Recipe output parameter is ignored in this case.</p> <p> - If the function returns true, no other callbacks are called for this event and MCServer uses the + If the function returns true, no other callbacks are called for this event and Cuberite uses the recipe stored in the Recipe output parameter. ]], }, -- HOOK_PRE_CRAFTING |