updated documentation
This commit is contained in:
walterhiggins
parent
8106fac4d1
commit
c10c469b12
171
docs/api.md
171
docs/api.md
|
|
@ -123,6 +123,48 @@ To create a black structure 4 blocks wide, 9 blocks tall and 1 block long...
|
|||
|
||||
|
||||
|
||||
Drone.box0() method
|
||||
===================
|
||||
Another convenience method - this one creates 4 walls with no floor or ceiling.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
* block - the block id - e.g. 6 for an oak sapling or '6:2' for a birch sapling.
|
||||
Alternatively you can use any one of the `blocks` values e.g. `blocks.sapling.birch`
|
||||
* width (optional - default 1) - the width of the structure
|
||||
* height (optional - default 1) - the height of the structure
|
||||
* length (optional - default 1) - the length of the structure - how far
|
||||
away (depth of field) from the drone the structure will extend.
|
||||
|
||||
Example
|
||||
-------
|
||||
To create a stone building with the insided hollowed out 7 wide by 3 tall by 6 long...
|
||||
|
||||
box0( blocks.stone, 7, 3, 6);
|
||||
|
||||
|
||||
|
||||
Drone.boxa() method
|
||||
===================
|
||||
Construct a cuboid using an array of blocks.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
* blocks - An array of blocks - each block in the array will be placed in turn.
|
||||
* width
|
||||
* height
|
||||
* length
|
||||
|
||||
Example
|
||||
-------
|
||||
Construct a rainbow-colored road 100 blocks long...
|
||||
|
||||
var rainbowColors = [blocks.wool.red, blocks.wool.orange, blocks.wool.yellow, blocks.wool.lime,
|
||||
blocks.wool.lightblue, blocks.wool.blue, blocks.wool.purple];
|
||||
boxa(rainbowColors,5,1,98);
|
||||
|
||||
|
||||
|
||||
Drone Movement
|
||||
==============
|
||||
Drones can move freely in minecraft's 3-D world. You control the
|
||||
|
|
@ -156,7 +198,6 @@ e.g. building a road, skyscraper or forest you should set a
|
|||
check-point before doing so if you want your drone to return to its
|
||||
current location.
|
||||
|
||||
|
||||
A 'start' checkpoint is automatically created when the Drone is first created.
|
||||
|
||||
Markers are created and returned to using the followng two methods...
|
||||
|
|
@ -183,40 +224,6 @@ Example
|
|||
//
|
||||
drone.move('town-square');
|
||||
|
||||
Drone.box0() method
|
||||
===================
|
||||
Another convenience method - this one creates 4 walls with no floor or ceiling.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
* block - the block id - e.g. 6 for an oak sapling or '6:2' for a birch sapling.
|
||||
Alternatively you can use any one of the `blocks` values e.g. `blocks.sapling.birch`
|
||||
* width (optional - default 1) - the width of the structure
|
||||
* height (optional - default 1) - the height of the structure
|
||||
* length (optional - default 1) - the length of the structure - how far
|
||||
away (depth of field) from the drone the structure will extend.
|
||||
|
||||
Drone.boxa() method
|
||||
===================
|
||||
Construct a cuboid using an array of blocks.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
* blocks - An array of blocks - each block in the array will be placed in turn.
|
||||
* width
|
||||
* height
|
||||
* length
|
||||
|
||||
Example
|
||||
-------
|
||||
Construct a rainbow-colored road 100 blocks long...
|
||||
|
||||
var rainbowColors = [blocks.wool.red, blocks.wool.orange, blocks.wool.yellow, blocks.wool.lime,
|
||||
blocks.wool.lightblue, blocks.wool.blue, blocks.wool.purple];
|
||||
boxa(rainbowColors,5,1,98);
|
||||
|
||||
|
||||
|
||||
Drone.prism() method
|
||||
====================
|
||||
Creates a prism. This is useful for roofs on houses.
|
||||
|
|
@ -262,6 +269,14 @@ Example
|
|||
Drone.cylinder0() method
|
||||
========================
|
||||
A version of cylinder that hollows out the middle.
|
||||
|
||||
Example
|
||||
-------
|
||||
|
||||
cylinder0(blocks.iron, 7, 1);
|
||||
|
||||
|
||||
|
||||
Drone.arc() method
|
||||
==================
|
||||
The arc() method can be used to create 1 or more 90 degree arcs in the horizontal or vertical planes.
|
||||
|
|
@ -290,6 +305,22 @@ arc() takes a single parameter - an object with the following named properties..
|
|||
circle to draw. If the quadrants property is absent then all 4
|
||||
quadrants are drawn.
|
||||
|
||||
Examples
|
||||
--------
|
||||
To draw a 1/4 circle (top right quadrant only) with a radius of 10 and stroke width of 2 blocks ...
|
||||
|
||||
arc({blockType: blocks.iron,
|
||||
meta: 0,
|
||||
radius: 10,
|
||||
strokeWidth: 2
|
||||
quadrants: { topright: true },
|
||||
orientation: 'vertical',
|
||||
stack: 1,
|
||||
fill: false
|
||||
});
|
||||
|
||||
|
||||
|
||||
[bres]: http://en.wikipedia.org/wiki/Midpoint_circle_algorithm
|
||||
[dv]: http://www.minecraftwiki.net/wiki/Data_values
|
||||
Drone.door() method
|
||||
|
|
@ -300,6 +331,19 @@ Parameters
|
|||
----------
|
||||
* doorType (optional - default wood) - If a parameter is provided then the door is Iron.
|
||||
|
||||
Example
|
||||
-------
|
||||
To create a wooden door at the crosshairs/drone's location...
|
||||
|
||||
var drone = new Drone();
|
||||
drone.door();
|
||||
|
||||
To create an iron door...
|
||||
|
||||
drone.door( blocks.door_iron );
|
||||
|
||||
|
||||
|
||||
Drone.door2() method
|
||||
====================
|
||||
Create double doors (left and right side)
|
||||
|
|
@ -308,6 +352,14 @@ Parameters
|
|||
----------
|
||||
* doorType (optional - default wood) - If a parameter is provided then the door is Iron.
|
||||
|
||||
Example
|
||||
-------
|
||||
To create double-doors at the cross-hairs/drone's location...
|
||||
|
||||
drone.door2();
|
||||
|
||||
|
||||
|
||||
Drone.sign() method
|
||||
===================
|
||||
Signs must use block 63 (stand-alone signs) or 68 (signs on walls)
|
||||
|
|
@ -323,9 +375,13 @@ To create a free-standing sign...
|
|||
|
||||
drone.sign(["Hello","World"],63);
|
||||
|
||||
|
||||
|
||||
... to create a wall mounted sign...
|
||||
|
||||
drone.sign(["Message","Goes","Here"], 68);
|
||||
drone.sign(["Welcome","to","Scriptopia"], 68);
|
||||
|
||||
|
||||
|
||||
Drone Trees methods
|
||||
===================
|
||||
|
|
@ -335,8 +391,41 @@ Drone Trees methods
|
|||
* birch()
|
||||
* jungle()
|
||||
|
||||
Example
|
||||
-------
|
||||
To create 4 trees in a row, point the cross-hairs at the ground then type `/js ` and ...
|
||||
|
||||
up().oak().right(8).spruce().right(8).birch().right(8).jungle();
|
||||
|
||||
Trees won't always generate unless the conditions are right. You
|
||||
should use the tree methods when the drone is directly above the
|
||||
ground. Trees will usually grow if the drone's current location is
|
||||
occupied by Air and is directly above an area of grass (That is why
|
||||
the `up()` method is called first).
|
||||
|
||||
|
||||
|
||||
|
||||
None of the tree methods require parameters. Tree methods will only be successful
|
||||
if the tree is placed on grass in a setting where trees can grow.
|
||||
Drone.garden() method
|
||||
=====================
|
||||
places random flowers and long grass (similar to the effect of placing bonemeal on grass)
|
||||
|
||||
Parameters
|
||||
----------
|
||||
|
||||
* width - the width of the garden
|
||||
* length - how far from the drone the garden extends
|
||||
|
||||
Example
|
||||
-------
|
||||
To create a garden 10 blocks wide by 5 blocks long...
|
||||
|
||||
garden(10,5);
|
||||
|
||||
|
||||
|
||||
Drone.rand() method
|
||||
===================
|
||||
rand takes either an array (if each blockid has the same chance of occurring)
|
||||
|
|
@ -354,16 +443,6 @@ to place random blocks stone has a 50% chance of being picked,
|
|||
|
||||
regular stone has a 50% chance, mossy stone has a 30% chance and cracked stone has just a 20% chance of being picked.
|
||||
|
||||
Drone.garden() method
|
||||
=====================
|
||||
places random flowers and long grass (similar to the effect of placing bonemeal on grass)
|
||||
|
||||
Parameters
|
||||
----------
|
||||
|
||||
* width - the width of the garden
|
||||
* length - how far from the drone the garden extends
|
||||
|
||||
Copy & Paste using Drone
|
||||
========================
|
||||
A drone can be used to copy and paste areas of the game world.
|
||||
|
|
|
|||
Reference in a new issue