mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-12-12 11:10:29 +00:00
Code Issues Releases Wiki Activity

Clarify the turtle.place docs a little

Browse Source 
Closes #714
This commit is contained in:
Jonathan Coates 2021-02-20 20:19:22 +00:00
parent 1825f67eee
commit eb722a74cd
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/main/java/dan200/computercraft/shared/turtle/apis/TurtleAPI.java
View File

@ -182,6 +182,10 @@ public class TurtleAPI implements ILuaAPI
/** /**
* Place a block or item into the world in front of the turtle. * 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. * @param args Arguments to place.
* @return The turtle command result. * @return The turtle command result.
* @cc.tparam [opt] string text When placing a sign, set its contents to this text. * @cc.tparam [opt] string text When placing a sign, set its contents to this text.
@ -202,6 +206,7 @@ public class TurtleAPI implements ILuaAPI
* @cc.tparam [opt] string text When placing a sign, set its contents to this text. * @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 boolean Whether the block could be placed.
* @cc.treturn string|nil The reason the block was not placed. * @cc.treturn string|nil The reason the block was not placed.
* @see #place For more information about placing items.
*/ */
@LuaFunction @LuaFunction
public final MethodResult placeUp( IArguments args ) public final MethodResult placeUp( IArguments args )
@ -217,6 +222,7 @@ public class TurtleAPI implements ILuaAPI
* @cc.tparam [opt] string text When placing a sign, set its contents to this text. * @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 boolean Whether the block could be placed.
* @cc.treturn string|nil The reason the block was not placed. * @cc.treturn string|nil The reason the block was not placed.
* @see #place For more information about placing items.
*/ */
@LuaFunction @LuaFunction
public final MethodResult placeDown( IArguments args ) public final MethodResult placeDown( IArguments args )