1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2025-10-23 01:47:38 +00:00

Clarify the turtle.place docs a little

Closes #714
This commit is contained in:
Jonathan Coates
2021-02-20 20:19:22 +00:00
committed by Jummit
parent 7fe3ac9222
commit 5e0ceda7ce

View File

@@ -191,6 +191,10 @@ public class TurtleAPI implements ILuaAPI {
/**
* Place a block or item into the world in front of the turtle.
*
* "Placing" an item allows it to interact with blocks and entities in front of the turtle. For instance, buckets
* can pick up and place down fluids, and wheat can be used to breed cows. However, you cannot use {@link #place} to
* perform arbitrary block interactions, such as clicking buttons or flipping levers.
*
* @param args Arguments to place.
* @return The turtle command result.
* @cc.tparam [opt] string text When placing a sign, set its contents to this text.
@@ -210,6 +214,7 @@ public class TurtleAPI implements ILuaAPI {
* @cc.tparam [opt] string text When placing a sign, set its contents to this text.
* @cc.treturn boolean Whether the block could be placed.
* @cc.treturn string|nil The reason the block was not placed.
* @see #place For more information about placing items.
*/
@LuaFunction
public final MethodResult placeUp(IArguments args) {
@@ -224,6 +229,7 @@ public class TurtleAPI implements ILuaAPI {
* @cc.tparam [opt] string text When placing a sign, set its contents to this text.
* @cc.treturn boolean Whether the block could be placed.
* @cc.treturn string|nil The reason the block was not placed.
* @see #place For more information about placing items.
*/
@LuaFunction
public final MethodResult placeDown(IArguments args) {