arg/scriptcraft
Archived
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone

Browse source
This commit is contained in:
walterhiggins 2015-01-03 20:57:30 +00:00
parent 91defcbb9b
commit 8d8ea69dda
36 changed files with 3050 additions and 2907 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3551
docs/API-Reference.md
View file

File diff suppressed because it is too large Load diff

7
src/docs/js/generateApiDocs.js
View file

@ -116,10 +116,13 @@ store.sort(sorter([
/lib\/require\.js$/,
/lib\/plugin\.js$/,
/lib\/events\.js$/,
/lib\/events\-helper\-canary/,
/lib\/events\-helper\-bukkit/,
/lib\//,
/modules\/drone\/index\.js/,
/modules\/drone\//,
/plugins\/drone\//,
/modules\//,
/drone\.js/,
/drone\//,
/examples\//
]));
//err.println("store=" + JSON.stringify(store));

13
src/main/js/plugins/drone/arc.js → src/main/js/modules/drone/arc.js
View file

@ -41,8 +41,6 @@ stroke width of 2 blocks ...
[dv]: http://www.minecraftwiki.net/wiki/Data_values
***/
var Drone = require('./drone').Drone;
/*
do the bresenham thing
*/
@ -261,8 +259,9 @@ function arcImpl( params ) {
params.drone.move('arc2' );
};
Drone.extend(function arc( params ) {
params.drone = this;
arcImpl(params );
} );
module.exports = function(Drone){
Drone.extend(function arc( params ) {
params.drone = this;
arcImpl( params );
});
};

55
src/main/js/modules/drone/bed.js Normal file
View file

@ -0,0 +1,55 @@
'use strict';
/*global require, Packages, __plugin, module*/
var blocks = require('blocks');
/************************************************************************
### Drone.bed() method
Creates a bed. The foot of the bed will be at the drone's location and
the head of the bed will extend away from the drone.
#### Example
To create a bed at the in-game prompt, look at a block then type:
```javascript
/js bed()
```
Like most Drone methods, this returns the drone so it can be chained like so:
```javascript
this
.fwd(3)
.bed()
.back(3)
```
***/
var bedDirections = {
0:3, // east
1:0, // south
2:1, // west
3:2 // north
};
module.exports = function(Drone){
Drone.extend( function bed(){
this.then(function(){
var foot = this.setBlock(blocks.bed, bedDirections[this.dir], 0,0,0, false);
var head = this.setBlock(blocks.bed, bedDirections[this.dir] + 8, 0,0,1, false);
if (Drone.bountiful){
var prop = require('blockhelper').property;
var BedHalf = Packages.net.canarymod.api.world.blocks.properties.BlockPropertyEnums.BedHalf;
prop(foot)
.set('facing',this.dir)
.set('part', BedHalf.FOOT);
prop(head)
.set('facing',this.dir)
.set('part', BedHalf.HEAD);
}
if (__plugin.canary){
foot.update();
head.update();
}
});
});
};

9
src/main/js/plugins/drone/blocktype.js → src/main/js/modules/drone/blocktype.js
View file

@ -1,4 +1,3 @@
var Drone = require('./drone').Drone;
var blocks = require('blocks');
/************************************************************************
@ -348,10 +347,10 @@ function blocktype( message, fg, bg, immediate ) {
fg = blocks.wool.black;
}
bmfg = this._getBlockIdAndMeta( fg );
bmfg = this.getBlockIdAndMeta( fg );
bmbg = null;
if ( typeof bg != 'undefined' ) {
bmbg = this._getBlockIdAndMeta( bg );
bmbg = this.getBlockIdAndMeta( bg );
}
lines = message.split( '\n' );
lineCount = lines.length;
@ -393,7 +392,9 @@ function blocktype( message, fg, bg, immediate ) {
return this.move( 'blocktext' );
}
Drone.extend(blocktype);
module.exports = function(Drone){
Drone.extend(blocktype);
};

27
src/main/js/plugins/drone/copypaste.js → src/main/js/modules/drone/copypaste.js
View file

@ -1,6 +1,6 @@
'use strict';
/*global require*/
var Drone = require('./drone').Drone;
/*global require, module*/
/************************************************************************
### Copy & Paste using Drone
@ -37,9 +37,11 @@ point) into memory. the copied area can be referenced using the name
.paste('somethingCool' );
***/
function paste( name, immediate )
{
var ccContent = Drone.clipBoard[name];
var clipBoard = {};
function paste( name, immediate ){
var Drone = this.constructor;
var ccContent = clipBoard[name];
if (ccContent == undefined){
console.warn('Nothing called ' + name + ' in clipboard!');
return;
@ -59,6 +61,7 @@ function paste( name, immediate )
newDir,
dir,
a,
c,
len;
//
// need to adjust blocks which face a direction
@ -89,7 +92,7 @@ function paste( name, immediate )
dir = md & 0x3;
a = Drone.PLAYER_STAIRS_FACING;
len = a.length;
for ( var c=0;c < len;c++ ) {
for ( c = 0; c < len; c++ ) {
if ( a[c] == dir ) {
break;
}
@ -109,7 +112,7 @@ function paste( name, immediate )
case 68: // wall sign
a = Drone.PLAYER_SIGN_FACING;
len = a.length;
for ( var c=0;c < len;c++ ) {
for ( c=0; c < len; c++ ) {
if ( a[c] == md ) {
break;
}
@ -136,8 +139,10 @@ function copy( name, w, h, d ) {
} );
} );
} );
Drone.clipBoard[name] = {dir: this.dir, blocks: ccContent};
clipBoard[name] = {dir: this.dir, blocks: ccContent};
}
Drone.clipBoard = {};
Drone.extend( copy );
Drone.extend( paste );
module.exports = function(Drone){
Drone.extend( copy );
Drone.extend( paste );
};

13
src/main/js/plugins/drone/cylinders.js → src/main/js/modules/drone/cylinders.js
View file

@ -32,7 +32,7 @@ To create a hollow cylinder of Iron 7 blocks in radius and 1 block high...
![cylinder0 example](img/cylinder0ex1.png)
***/
var Drone = require('./drone').Drone;
function cylinder0( block,radius,height,exactParams ) {
var arcParams = {
radius: radius,
@ -46,7 +46,7 @@ function cylinder0( block,radius,height,exactParams ) {
arcParams[p] = exactParams[p];
}
}else{
var md = this._getBlockIdAndMeta(block );
var md = this.getBlockIdAndMeta(block );
arcParams.blockType = md[0];
arcParams.meta = md[1];
}
@ -64,12 +64,13 @@ function cylinder( block,radius,height,exactParams ) {
arcParams.blockType = exactParams.blockType;
arcParams.meta = exactParams.meta;
}else{
var md = this._getBlockIdAndMeta(block );
var md = this.getBlockIdAndMeta(block );
arcParams.blockType = md[0];
arcParams.meta = md[1];
}
return this.arc(arcParams );
};
Drone.extend(cylinder0 );
Drone.extend(cylinder );
module.exports = function(Drone){
Drone.extend(cylinder0 );
Drone.extend(cylinder );
};

41
src/main/js/plugins/drone/doors.js → src/main/js/modules/drone/doors.js
View file

@ -1,3 +1,4 @@
/*global module*/
'use strict';
/*************************************************************************
### Drone.door() method
@ -47,8 +48,7 @@ Create double iron doors
***/
var Drone = require('./drone').Drone,
blocks = require('blocks');
var blocks = require('blocks');
/*global require, Packages, __plugin*/
function door( doorMaterial, hinge) {
if ( typeof doorMaterial == 'undefined' ) {
@ -57,6 +57,7 @@ function door( doorMaterial, hinge) {
if (typeof hinge == 'undefined') {
hinge = 'left';
}
var Drone = this.constructor;
this.then(function(){
var lower = this.setBlock(doorMaterial, this.dir, 0, 0, 0, false);
var upper = this.setBlock(doorMaterial, hinge=='left' ? 8 : 9, 0,1,0, false);
@ -77,22 +78,24 @@ function door( doorMaterial, hinge) {
}
});
}
Drone.extend( door );
module.exports = function(Drone){
Drone.extend( door );
Drone.extend( function door_iron( ) {
this.door(blocks.door_iron);
} );
Drone.extend( function door_iron( ) {
this.door(blocks.door_iron);
} );
Drone.extend( function door2( doorMaterial ) {
if ( typeof doorMaterial == 'undefined' ) {
doorMaterial = blocks.door_wood;
}
this
.door( doorMaterial, 'left')
.right()
.door( doorMaterial, 'right')
.left();
} );
Drone.extend( function door2_iron( ) {
this.door2( blocks.door_iron );
} );
Drone.extend( function door2( doorMaterial ) {
if ( typeof doorMaterial == 'undefined' ) {
doorMaterial = blocks.door_wood;
}
this
.door( doorMaterial, 'left')
.right()
.door( doorMaterial, 'right')
.left();
} );
Drone.extend( function door2_iron( ) {
this.door2( blocks.door_iron );
} );
};

21
src/main/js/modules/drone/firework.js Normal file
View file

@ -0,0 +1,21 @@
'use strict';
/*global module, require*/
var fireworks = require('fireworks');
/*************************************************************************
### Drone.firework() method
Launches a firework at the drone's location.
#### Example
To launch a firework:
var drone = new Drone(self);
drone.firework();
***/
module.exports = function(Drone){
Drone.extend( function firework( ) {
fireworks.firework( this.getLocation() );
});
};

7
src/main/js/plugins/drone/garden.js → src/main/js/modules/drone/garden.js
View file

@ -1,3 +1,5 @@
/*global module, require*/
'use strict';
/************************************************************************
### Drone.garden() method
@ -17,7 +19,6 @@ To create a garden 10 blocks wide by 5 blocks long...
![garden example](img/gardenex1.png)
***/
var Drone = require('./drone').Drone;
var blocks = require('blocks');
function garden( width, depth ) {
@ -43,4 +44,6 @@ function garden( width, depth ) {
.rand( dist, width, 1, depth, false /* don't overwrite */ )
.down();
}
Drone.extend(garden);
module.exports = function(Drone){
Drone.extend(garden);
};

909
src/main/js/modules/drone/index.js Normal file
View file

@ -0,0 +1,909 @@
'use strict';
/*global __plugin, require, org, setTimeout, addUnloadHandler, global, Packages, server, module*/
var utils = require('utils'),
blocks = require('blocks'),
THOUSAND = 1000,
MILLION = THOUSAND * THOUSAND;
/*********************************************************************
## Drone Plugin
The Drone is a convenience class for building. It can be used for...
1. Building
2. Copying and Pasting
It uses a fluent interface which means all of the Drone's methods return `this` and can be chained together like so...
var theDrone = new Drone(self);
theDrone.up().left().box(blocks.oak).down().fwd(3).cylinder0(blocks.lava,8);
### Constructing a Drone Object
Drones can be created in any of the following ways...
1. Calling any one of the methods listed below will return a Drone object. For example...
var d = box( blocks.oak )
... creates a 1x1x1 wooden block at the cross-hairs or player's location and returns a Drone object. This might look odd (if you're familiar with Java's Object-dot-method syntax) but all of the Drone class's methods are also global functions that return new Drone objects. This is short-hand for creating drones and is useful for playing around with Drones at the in-game command prompt. It's shorter than typing ...
var d = new Drone(self).box( blocks.oak )
... All of the Drone's methods return `this` so you can chain operations together like this...
var d = box( blocks.oak )
.up()
.box( blocks.oak ,3,1,3)
.down()
.fwd(2)
.box( blocks.oak )
.turn()
.fwd(2)
.box( blocks.oak )
.turn()
.fwd(2)
.box( blocks.oak );
2. Using the following form...
d = new Drone(self)
...will create a new Drone taking the current player as the parameter. If the player's cross-hairs are pointing at a block at the time then, that block's location becomes the drone's starting point. If the cross-hairs are _not_ pointing at a block, then the drone's starting location will be 2 blocks directly in front of the player. TIP: Building always happens right and front of the drone's position...
Plan View:
^
|
|
D---->
For convenience you can use a _corner stone_ to begin building. The corner stone should be located just above ground level. If the cross-hair is point at or into ground level when you create a new Drone() with either a player or location given as a parameter, then building begins at the location the player was looking at or at the location. You can get around this by pointing at a 'corner stone' just above ground level or alternatively use the following statement...
d = new Drone(self).up();
... which will move the drone up one block as soon as it's created.
![corner stone](img/cornerstone1.png)
3. Or by using the following form...
d = new Drone(x,y,z,direction,world);
This will create a new Drone at the location you specified using x, y, z In minecraft, the X axis runs west to east and the Z axis runs north to south. The direction parameter says what direction you want the drone to face: 0 = east, 1 = south, 2 = west, 3 = north. If the direction parameter is omitted, the player's direction is used instead. Both the `direction` and `world` parameters are optional.
4. Create a new Drone based on a Location object...
d = new Drone(location);
This is useful when you want to create a drone at a given `org.bukkit.Location` . The `Location` class is used throughout the bukkit API. For example, if you want to create a drone when a block is broken at the block's location you would do so like this...
events.blockBreak( function( event ) {
var location = event.block.location;
var drone = new Drone(location);
// do more stuff with the drone here...
});
#### Parameters
* Player : If a player reference is given as the sole parameter then the block the player was looking at will be used as the starting point for the drone. If the player was not looking at a block then the player's location will be used as the starting point. If a `Player` object is provided as a paramter then it should be the only parameter.
* location : *NB* If a `Location` object is provided as a parameter, then it should be the only parameter.
* x : The x coordinate of the Drone (x,y,z,direction and world are not needed if either a player or location parameter is provided)
* y : The y coordinate of the Drone
* z : The z coordinate of the Drone
* direction : The direction in which the Drone is facing. Possible values are 0 (east), 1 (south), 2 (west) or 3 (north)
* world : The world in which the drone is created.
### Drone.box() method
the box() method is a convenience method for building things. (For the more performance-oriented method - see cuboid)
#### parameters
* b - 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`
* w (optional - default 1) - the width of the structure
* h (optional - default 1) - the height of the structure
* d (optional - default 1) - the depth of the structure - NB this is not how deep underground the structure lies - this is how far away (depth of field) from the drone the structure will extend.
#### Example
To create a black structure 4 blocks wide, 9 blocks tall and 1 block long...
box(blocks.wool.black, 4, 9, 1);
... or the following code does the same but creates a variable that can be used for further methods...
var drone = new Drone(self);
drone.box(blocks.wool.black, 4, 9, 1);
![box example 1](img/boxex1.png)
### 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);
![example box0](img/box0ex1.png)
### Drone.boxa() method
Construct a cuboid using an array of blocks. As the drone moves first along the width axis, then the height (y axis) then the length, each block is picked from the array and placed.
#### 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,7,1,30);
![boxa example](img/boxaex1.png)
### Chaining
All of the Drone methods return a Drone object, which means methods can be 'chained' together so instead of writing this...
drone = new Drone( self );
drone.fwd( 3 );
drone.left( 2 );
drone.box( blocks.grass ); // create a grass block
drone.up();
drone.box( blocks.grass ); // create another grass block
drone.down();
...you could simply write ...
var drone = new Drone(self).fwd(3).left(2).box(blocks.grass).up().box(blocks.grass).down();
... since each Drone method is also a global function that constructs a drone if none is supplied, you can shorten even further to just...
fwd(3).left(2).box(blocks.grass).up().box(blocks.grass).down()
The Drone object uses a [Fluent Interface][fl] to make ScriptCraft scripts more concise and easier to write and read. Minecraft's in-game command prompt is limited to about 80 characters so chaining drone commands together means more can be done before hitting the command prompt limit. For complex building you should save your commands in a new script file and load it using /js load()
[fl]: http://en.wikipedia.org/wiki/Fluent_interface
### Drone Properties
* x - The Drone's position along the west-east axis (x increases as you move east)
* y - The Drone's position along the vertical axis (y increses as you move up)
* z - The Drone's position along the north-south axis (z increases as you move south)
* dir - The Drone's direction 0 is east, 1 is south , 2 is west and 3 is north.
### Extending Drone
The Drone object can be easily extended - new buidling recipes/blueprints can be added and can become part of a Drone's chain using the *static* method `Drone.extend`.
### Drone.extend() static method
Use this method to add new methods (which also become chainable global functions) to the Drone object.
#### Parameters
* name - The name of the new method e.g. 'pyramid'.
* function - The method body.
Alternatively if you provide just a function as a parameter, then the function name will be used as the new method name. For example the following two approaches are both valid.
#### Example 1 Using name and function as parameters
// submitted by [edonaldson][edonaldson]
Drone.extend('pyramid', function( block,height) {
this.chkpt('pyramid');
for ( var i = height; i > 0; i -= 2) {
this.box(block, i, 1, i).up().right().fwd();
}
return this.move('pyramid');
});
#### Example 2 Using just a named function as a parameter
function pyramid( block,height) {
this.chkpt('pyramid');
for ( var i = height; i > 0; i -= 2) {
this.box(block, i, 1, i).up().right().fwd();
}
return this.move('pyramid');
}
Drone.extend( pyramid );
Once the method is defined (it can be defined in a new pyramid.js file) it can be used like so...
var d = new Drone(self);
d.pyramid(blocks.brick.stone, 12);
... or simply ...
pyramid(blocks.brick.stone, 12);
[edonaldson]: https://github.com/edonaldson
### Drone Constants
#### Drone.PLAYER_STAIRS_FACING
An array which can be used when constructing stairs facing in the Drone's direction...
var d = new Drone(self);
d.box(blocks.stairs.oak + ':' + Drone.PLAYER_STAIRS_FACING[d.dir]);
... will construct a single oak stair block facing the drone.
#### Drone.PLAYER_SIGN_FACING
An array which can be used when placing signs so they face in a given direction. This is used internally by the Drone.sign() method. It should also be used for placing any of the following blocks...
* chest
* ladder
* furnace
* dispenser
By default, chests, dispensers, signs, ladders and furnaces are placed facing towards the drone so to place a chest facing the Drone just use:
drone.box( blocks.chest );
To place a chest facing _away_ from the Drone:
drone.box( blocks.chest + ':' + Drone.PLAYER_SIGN_FACING[(drone.dir + 2) % 4]);
#### Drone.PLAYER_TORCH_FACING
Used when placing torches. By default torches will be placed facing up. If you want to place a torch so that it faces towards the drone:
drone.box( blocks.torch + ':' + Drone.PLAYER_TORCH_FACING[drone.dir]);
If you want to place a torch so it faces _away_ from the drone:
drone.box( blocks.torch + ':' + Drone.PLAYER_TORCH_FACING[(drone.dir + 2) % 4]);
***/
//
// Implementation
// ==============
//
// There is no need to read any further unless you want to understand how the Drone object works.
//
function getDirFromRotation( location ) {
// 0 = east, 1 = south, 2 = west, 3 = north
// 46 to 135 = west
// 136 to 225 = north
// 226 to 315 = east
// 316 to 45 = south
var r;
if (__plugin.canary ) {
r = location.rotation;
}
if (__plugin.bukkit) {
r = location.yaw;
}
// west = -270
// north = -180
// east = -90
// south = 0
r = (r + 360 ) % 360; // east could be 270 or -90
if ( r > 45 && r <= 135 )
return 2; // west
if ( r > 135 && r <= 225 )
return 3; // north
if ( r > 225 && r <= 315 )
return 0; // east
return 1; // south
}
/*
low-level function to place a block in the world - all drone methods which
place blocks ultimately invoke this function.
*/
function putBlock( x, y, z, blockId, metadata, world, dir, update ) {
if ( typeof metadata == 'undefined' ) {
metadata = 0;
}
var block = world.getBlockAt( x, y, z );
if (__plugin.canary) {
var BlockType = Packages.net.canarymod.api.world.blocks.BlockType;
block.type = BlockType.fromId(blockId);
var applyProperties = require('blockhelper').applyProperties;
applyProperties(block, metadata);
if (typeof update === 'undefined'){
update = true;
}
if (update){
block.update();
}
}
if (__plugin.bukkit) {
block.setTypeIdAndData( blockId, metadata, false );
block.data = metadata;
}
return block;
}
/*
Drone constructs a new Drone object
*/
function Drone( x, y, z, dir, world ) {
this.record = false;
var usePlayerCoords = false;
var player = (typeof self !== 'undefined' ? self : null);
var playerPos;
if ( x.location && x.name) {
player = x;
}
playerPos = x.location;
var that = this;
var populateFromLocation = function( loc ) {
that.x = loc.x;
that.y = loc.y;
that.z = loc.z;
that.dir = getDirFromRotation(loc);
that.world = loc.world;
};
var mp = utils.getMousePos( player );
if ( typeof x == 'undefined' || x.location ) {
if ( mp ) {
populateFromLocation( mp );
if ( playerPos ) {
this.dir = getDirFromRotation(playerPos);
}
} else {
// base it on the player's current location
usePlayerCoords = true;
//
// it's possible that drone.js could be loaded by a non-playing op
// (from the server console)
//
if ( !playerPos ) {
return null;
}
populateFromLocation( playerPos );
}
} else {
if ( arguments[0].x && arguments[0].y && arguments[0].z ) {
populateFromLocation( arguments[ 0 ] );
} else {
this.x = x;
this.y = y;
this.z = z;
if ( typeof dir == 'undefined' ) {
this.dir = getDirFromRotation( playerPos);
} else {
this.dir = dir%4;
}
if ( typeof world == 'undefined' ) {
this.world = playerPos.world;
} else {
this.world = world;
}
}
}
if ( usePlayerCoords ) {
this.fwd( 3 );
}
this.chkpt( 'start' );
this.record = true;
this.history = [];
this.player = player;
return this;
}
Drone.getDirFromRotation = getDirFromRotation;
Drone.opsPerSec = 10;
var theQueue = [];
function processQueue(){
var process,
i = 0,
queues = getAllQueues();
for ( ; i < queues.length; i++ ) {
process = queues[i].shift();
if (process){
try {
process();
} catch( e ) {
console.log('Drone build error: ' + e + ' while processing ' + process);
}
}
}
setTimeout( processQueue, 1000 / Drone.opsPerSec );
};
setTimeout( processQueue, 1000 / Drone.opsPerSec );
addUnloadHandler( function() {
var pendingBuildOps = 0;
var allQueues = getAllQueues();
for (var i = 0; i < allQueues.length; i++){
pendingBuildOps += allQueues[i].length;
}
if (pendingBuildOps > 0){
console.warn('There were ' + pendingBuildOps + ' pending build operations which were cancelled');
}
});
//
// add custom methods to the Drone object using this function
//
Drone.extend = function( name, func ) {
if (arguments.length == 1){
func = name;
if ( !func.name ){
throw 'A Drone extension function must have a name!';
}
name = func.name;
}
Drone.prototype[ '_' + name ] = func;
Drone.prototype[ name ] = function( ) {
if ( this.record ) {
this.history.push( [ name, arguments ] );
}
var oldVal = this.record;
this.record = false;
this[ '_' + name ].apply( this, arguments );
this.record = oldVal;
return this;
};
global[name] = function( ) {
var result = new Drone( self );
result[name].apply( result, arguments );
return result;
};
};
/**************************************************************************
### Drone.times() Method
The times() method makes building multiple copies of buildings
easy. It's possible to create rows or grids of buildings without
resorting to `for` or `while` loops.
#### Parameters
* numTimes (optional - default 2) : The number of times you want to repeat the preceding statements.
#### Example
Say you want to do the same thing over and over. You have a couple of options...
* You can use a for loop...
d = new Drone(); for ( var i =0;i < 4; i++) { d.cottage().right(8); }
While this will fit on the in-game prompt, it's awkward. You need to
declare a new Drone object first, then write a for loop to create the
4 cottages. It's also error prone, even the `for` loop is too much
syntax for what should really be simple.
* You can use a while loop...
d = new Drone(); var i=4; while (i--) { d.cottage().right(8); }
... which is slightly shorter but still too much syntax. Each of the
above statements is fine for creating a 1-dimensional array of
structures. But what if you want to create a 2-dimensional or
3-dimensional array of structures? Enter the `times()` method.
The `times()` method lets you repeat commands in a chain any number of
times. So to create 4 cottages in a row you would use the following
statement...
cottage().right(8).times(4);
...which will build a cottage, then move right 8 blocks, then do it
again 4 times over so that at the end you will have 4 cottages in a
row. What's more the `times()` method can be called more than once in
a chain. So if you wanted to create a *grid* of 20 houses ( 4 x 5 ),
you would do so using the following statement...
cottage().right(8).times(4).fwd(8).left(32).times(5);
... breaking it down...
1. The first 3 calls in the chain ( `cottage()`, `right(8)`, `times(4)` ) build a single row of 4 cottages.
2. The last 3 calls in the chain ( `fwd(8)`, `left(32)`, `times(5)` ) move the drone forward 8 then left 32 blocks (4 x 8) to return to the original x coordinate, then everything in the chain is repeated again 5 times so that in the end, we have a grid of 20 cottages, 4 x 5. Normally this would require a nested loop but the `times()` method does away with the need for loops when repeating builds.
Another example: This statement creates a row of trees 2 by 3 ...
oak().right(10).times(2).left(20).fwd(10).times(3)
... You can see the results below.
![times example 1](img/times-trees.png)
***/
Drone.prototype.times = function( numTimes, commands ) {
if ( typeof numTimes == 'undefined' ) {
numTimes = 2;
}
if ( typeof commands == 'undefined' ) {
commands = this.history.concat();
}
this.history = [ [ 'times', [ numTimes + 1, commands ] ] ];
var oldVal = this.record;
this.record = false;
for ( var j = 1; j < numTimes; j++ ) {
for ( var i = 0; i < commands.length; i++) {
var command = commands[i];
var methodName = command[0];
var args = command[1];
this[ methodName ].apply( this, args );
}
}
this.record = oldVal;
return this;
};
Drone.prototype.getBlock = function(){
return this.world.getBlockAt(this.x,this.y,this.z);
};
Drone.prototype.setBlock = function(blockType, data, ow, oh, od, update){
if (typeof ow == 'undefined')
ow = 0;
if (typeof oh == 'undefined')
oh = 0;
if (typeof od == 'undefined')
od = 0;
this
.right(ow)
.up(oh)
.fwd(od);
var result = putBlock(this.x, this.y, this.z, blockType, data, this.world, this.dir, update);
this
.left(ow)
.down(oh)
.back(od);
return result;
};
Drone.prototype.traverseWidth = function(width, callback){
_traverse[this.dir].width(this, width, callback);
};
Drone.prototype.traverseHeight = function(height, callback){
traverseHeight(this, height, callback);
};
Drone.prototype.traverseDepth = function(depth, callback){
_traverse[this.dir].depth(this, depth, callback);
};
//
// building
//
var playerQueues = {};
/*
if the drone has an associated player, then use that player's queue otherwise
use the global queue.
*/
function getQueue( drone ){
if ( drone.player ) {
var playerName = ''+drone.player.name;
var result = playerQueues[playerName];
if (result === undefined){
playerQueues[playerName] = [];
return playerQueues[playerName];
}
return result;
} else {
return theQueue;
}
}
function getAllQueues() {
var result = [ theQueue ];
for (var pq in playerQueues) {
result.push(playerQueues[pq]) ;
}
return result;
}
Drone.prototype.cuboida = function(/* Array */ blocks, w, h, d, overwrite, immediate ) {
//
// wph 20140823 make a copy because don't want to modify array in background
//
var blocksForBuild = blocks.slice();
var len = blocksForBuild.length,
i = 0;
if ( !immediate ) {
for ( ; i < len; i++ ) {
blocksForBuild[i] = this.getBlockIdAndMeta( blocksForBuild[ i ] );
}
var clone = Drone.clone(this);
var impl = this.cuboida.bind(clone, blocksForBuild, w, h, d, overwrite, true);
getQueue(this).push( function cuboida(){ impl(); });
return this;
}
if ( typeof overwrite == 'undefined' ) {
overwrite = true;
}
if ( typeof h == 'undefined' ) {
h = 1;
}
if ( typeof d == 'undefined' ) {
d = 1;
}
if ( typeof w == 'undefined' ) {
w = 1;
}
var bi = 0;
traverseDHW( this, d,h,w, function traverseWidthCallback( ) {
var properBlock = blocksForBuild[ bi % len ];
this.setBlock(properBlock[0], properBlock[1]);
bi++;
});
return this;
};
Drone.MAX_VOLUME = 1 * MILLION;
Drone.MAX_SIDE = 1 * THOUSAND;
var tooBig = function(w, h, d ) {
return ( w * h * d ) >= Drone.MAX_VOLUME ||
( w >= Drone.MAX_SIDE ) ||
( h >= Drone.MAX_SIDE ) ||
( d >= Drone.MAX_SIDE );
};
/*
faster cuboid because blockid, meta and world must be provided
use this method when you need to repeatedly place blocks
*/
Drone.prototype.cuboidX = function( blockType, meta, w, h, d, immediate ) {
if ( typeof h == 'undefined' ) {
h = 1;
}
if ( typeof d == 'undefined' ) {
d = 1;
}
if ( typeof w == 'undefined' ) {
w = 1;
}
if ( tooBig( w, h, d ) ) {
this.sign([
'Build too Big!',
'width:' + w,
'height:' + h,
'depth:' + d
], 68);
console.warn('Build too big! ' + w + ' X ' + h + ' X ' + d);
return this;
}
if ( !immediate ) {
var clone = Drone.clone(this);
var impl = this.cuboidX.bind(clone, blockType, meta, w, h, d, true);
getQueue(this).push(function cuboidX(){ impl(); });
return this;
}
traverseDHW( this, d,h,w, function( ) {
this.setBlock( blockType, meta );
});
return this;
};
/*
deferred execution of a drone method
*/
Drone.prototype.then = function( next ){
getQueue(this).push( next.bind( Drone.clone(this) ) );
};
Drone.prototype.cuboid = function( block, w, h, d, immediate ) {
var bm = this.getBlockIdAndMeta( block );
return this.cuboidX( bm[0], bm[1], w, h, d, immediate);
};
Drone.prototype.cuboid0 = function( block, w, h, d, immediate ) {
var start = 'cuboid0' + w + h + d + immediate;
this
.chkpt( start )
.cuboid( block, w, h, 1, immediate ) // Front wall
.cuboid( block, 1, h, d, immediate ) // Left wall
.right( w - 1 )
.cuboid( block, 1, h, d, immediate ) // Right wall
.left( w - 1 )
.fwd( d - 1 )
.cuboid( block, w, h, 1, immediate ) // Back wall
.move( start );
};
// player dirs: 0 = east, 1 = south, 2 = west, 3 = north
// block dirs: 0 = east, 1 = west, 2 = south , 3 = north
// sign dirs: 5 = east, 3 = south, 4 = west, 2 = north
Drone.PLAYER_STAIRS_FACING = [ 0, 2, 1, 3 ];
// for blocks 68 (wall signs) 65 (ladders) 61,62 (furnaces) 23 (dispenser) and 54 (chest)
Drone.PLAYER_SIGN_FACING = [ 4, 2, 5, 3 ];
Drone.PLAYER_TORCH_FACING = [ 2, 4, 1, 3 ];
Drone.extend('box', Drone.prototype.cuboid );
Drone.extend('box0',Drone.prototype.cuboid0 );
Drone.extend('boxa',Drone.prototype.cuboida );
//
// show the Drone's position and direction
//
Drone.prototype.toString = function( ) {
var dirs = ['east','south','west','north'];
return 'x: ' + this.x + ' y: '+this.y + ' z: ' + this.z + ' dir: ' + this.dir + ' '+dirs[this.dir];
};
Drone.prototype.debug = function( ) {
console.log(this.toString( ) );
return this;
};
function getBlockIdAndMeta( b ) {
var defaultMeta = 0,
i = 0,
bs,
md,
sp;
if (typeof b === 'number' || /^[0-9]+$/.test(b)) {
// wph 20130414 - use sensible defaults for certain blocks e.g. stairs
// should face the drone.
switch (b) {
case blocks.stairs.oak:
case blocks.stairs.cobblestone:
case blocks.stairs.brick:
case blocks.stairs.stone:
case blocks.stairs.nether:
case blocks.stairs.sandstone:
case blocks.stairs.spruce:
case blocks.stairs.jungle:
case blocks.stairs.quartz:
defaultMeta = Drone.PLAYER_STAIRS_FACING[ this.dir % 4 ];
break;
case blocks.sign:
case blocks.ladder:
// bug: furnace, chest, dispenser don't always use the right metadata
case blocks.furnace:
case blocks.furnace_burning:
case blocks.chest:
case blocks.enderchest:
case blocks.dispenser:
defaultMeta = Drone.PLAYER_SIGN_FACING[ this.dir % 4 ];
break;
case blocks.sign_post:
defaultMeta = ( 12 + ( ( this.dir + 2 ) * 4 ) ) % 16;
break;
}
return [ b, defaultMeta ];
}
if ( typeof b === 'string' ) {
bs = b;
sp = bs.indexOf(':' );
if ( sp == -1 ) {
b = parseInt( bs );
return [ b, defaultMeta ];
}
b = parseInt(bs.substring(0,sp ) );
md = parseInt(bs.substring(sp+1,bs.length ) );
return [b,md];
}
if (b.id){
// wph 20141230 we are dealing with an object
var blockInfo = b;
var metadata = {};
for (i in b){
if (i !== 'id')
metadata[i] = b[i];
}
return [b.id, metadata];
}
}
var _traverse = [{},{},{},{}];
// east
function walkWidthEast( drone, n,callback ) {
var s = drone.z, e = s + n;
for ( ; drone.z < e; drone.z++ ) {
callback.call(drone ,drone.z-s );
}
drone.z = s;
}
function walkDepthEast( drone,n,callback ) {
var s = drone.x, e = s+n;
for ( ;drone.x < e;drone.x++ ) {
callback.call(drone, drone.x-s );
}
drone.x = s;
}
function walkWidthSouth( drone,n,callback ) {
var s = drone.x, e = s-n;
for ( ;drone.x > e;drone.x-- ) {
callback.call(drone, s-drone.x );
}
drone.x = s;
}
function walkWidthWest( drone,n,callback ) {
var s = drone.z, e = s-n;
for ( ;drone.z > e;drone.z-- ) {
callback.call(drone, s-drone.z );
}
drone.z = s;
}
_traverse[0].width = walkWidthEast;
_traverse[0].depth = walkDepthEast;
// south
_traverse[1].width = walkWidthSouth;
_traverse[1].depth = walkWidthEast;
// west
_traverse[2].width = walkWidthWest;
_traverse[2].depth = walkWidthSouth;
// north
_traverse[3].width = walkDepthEast;
_traverse[3].depth = walkWidthWest;
function traverseHeight( drone,n,callback ) {
var s = drone.y, e = s + n;
for ( ; drone.y < e; drone.y++ ) {
callback.call(drone, drone.y-s );
}
drone.y = s;
};
function traverseDHW( drone, d,h,w, callback ){
_traverse[drone.dir].depth( drone, d, function traverseDepthCallback( ) {
traverseHeight( this, h, function traverseHeightCallback( ) {
_traverse[this.dir].width( this, w, callback);
});
});
}
Drone.clone = function(origin) {
var result = new Drone(origin.x,origin.y,origin.z, origin.dir, origin.world);
return result;
};
//
// wph 20130130 - make this a method - extensions can use it.
//
Drone.prototype.getBlockIdAndMeta = getBlockIdAndMeta;
Drone.prototype._getBlockIdAndMeta = function(b){
console.warn('_getBlockIdAndMeta is deprecated. Use .getBlockIdAndMeta() instead');
return this.getBlockIdAndMeta(b);
};
Drone.bountiful = __plugin.canary ? parseFloat(server.canaryModVersion) > 1.7 : false;
var droneCoreExts = [
'./arc',
'./bed',
'./blocktype',
'./copypaste',
'./cylinders',
'./doors',
'./firework',
'./garden',
'./ladder',
'./movement',
'./prism',
'./rand',
'./sign',
'./sphere',
'./stairs',
'./trees'
];
utils.foreach(droneCoreExts, function(path){
require(path)(Drone);
});
module.exports = Drone;

7
src/main/js/plugins/drone/ladder.js → src/main/js/modules/drone/ladder.js
View file

@ -1,5 +1,5 @@
'use strict';
var Drone = require('./drone').Drone;
/*global require, module*/
/************************************************************************
### Drone.ladder() method
@ -40,4 +40,7 @@ function ladder( height ){
}
});
}
Drone.extend( ladder );
module.exports = function(Drone){
Drone.extend( ladder );
};

78
src/main/js/plugins/drone/movement.js → src/main/js/modules/drone/movement.js
View file

@ -1,7 +1,5 @@
'use strict';
/*global require,__plugin*/
var Drone = require('./drone').Drone,
bkLocation = org.bukkit.Location;
/*global require,__plugin, module, Packages, org*/
/************************************************************************
### Drone Movement
@ -89,12 +87,18 @@ _movements[3].left = _movements[0].back;
_movements[3].fwd = _movements[0].left;
_movements[3].back = _movements[0].right;
Drone.prototype._checkpoints = {};
Drone.extend(function chkpt( name ) {
function turn( n ) {
if ( typeof n == 'undefined' ) {
n = 1;
}
this.dir += n;
this.dir %=4;
}
function chkpt( name ) {
this._checkpoints[ name ] = { x:this.x, y:this.y, z:this.z, dir:this.dir };
});
Drone.extend(function move( ) {
}
function move( ) {
var Drone = this.constructor;
if ( arguments[0].x && arguments[0].y && arguments[0].z) {
this.x = arguments[0].x;
this.y = arguments[0].y;
@ -122,64 +126,64 @@ Drone.extend(function move( ) {
this.x = arguments[0];
}
}
});
Drone.extend( function turn( n ) {
if ( typeof n == 'undefined' ) {
n = 1;
}
this.dir += n;
this.dir %=4;
} );
Drone.extend( function right( n ) {
}
function right( n ) {
if ( typeof n == 'undefined' ) {
n = 1;
}
_movements[ this.dir ].right( this, n );
});
Drone.extend( function left( n ) {
}
function left( n ) {
if ( typeof n == 'undefined') {
n = 1;
}
_movements[ this.dir ].left( this, n );
});
Drone.extend( function fwd( n ) {
}
function fwd( n ) {
if ( typeof n == 'undefined' ) {
n = 1;
}
_movements[ this.dir ].fwd( this, n );
});
Drone.extend( function back( n ) {
}
function back( n ) {
if ( typeof n == 'undefined' ) {
n = 1;
}
_movements[ this.dir ].back( this, n );
});
Drone.extend( function up( n ) {
}
function up( n ) {
if ( typeof n == 'undefined' ) {
n = 1;
}
this.y+= n;
});
Drone.extend( function down( n ) {
}
function down( n ) {
if ( typeof n == 'undefined' ) {
n = 1;
}
this.y-= n;
});
Drone.prototype.getLocation = function( ) {
}
function getLocation( ) {
if (__plugin.canary) {
var cmLocation = Packages.net.canarymod.api.world.position.Location;
return new cmLocation( this.world, this.x, this.y, this.z, 0, 0);
}
if (__plugin.bukkit) {
var bkLocation = org.bukkit.Location;
return new bkLocation( this.world, this.x, this.y, this.z );
}
}
module.exports = function(Drone){
Drone.prototype._checkpoints = {};
Drone.prototype.getLocation = getLocation;
Drone.extend( chkpt );
Drone.extend( move );
Drone.extend( turn );
Drone.extend( right );
Drone.extend( left );
Drone.extend( fwd );
Drone.extend( back );
Drone.extend( up );
Drone.extend( down );
};

9
src/main/js/plugins/drone/prism.js → src/main/js/modules/drone/prism.js
View file

@ -1,6 +1,5 @@
'use strict';
/*global require*/
var Drone = require('./drone').Drone;
/*global require, module*/
/************************************************************************
### Drone.prism() method
@ -93,5 +92,7 @@ function prism0( block,w,d ) {
.back();
}
}
Drone.extend(prism0);
Drone.extend(prism);
module.exports = function(Drone){
Drone.extend(prism0);
Drone.extend(prism);
};

11
src/main/js/plugins/drone/rand.js → src/main/js/modules/drone/rand.js
View file

@ -1,5 +1,5 @@
'use strict';
/*global require*/
/*global require, module*/
/************************************************************************
### Drone.rand() method
@ -23,7 +23,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.
***/
var Drone = require('./drone').Drone;
//
// standard fisher-yates shuffle algorithm
//
@ -56,11 +55,13 @@ function _rand( blockDistribution ) {
fisherYates(blockDistribution );
return blockDistribution;
}
Drone.extend( function rand( dist, width, height, depth, overwrite ) {
function rand( dist, width, height, depth, overwrite ) {
if ( typeof overwrite == 'undefined' ) {
overwrite = true;
}
var randomized = _rand( dist );
this.boxa( randomized, width, height, depth, overwrite);
} );
}
module.exports = function(Drone){
Drone.extend( rand );
};

15
src/main/js/plugins/drone/sign.js → src/main/js/modules/drone/sign.js
View file

@ -1,7 +1,6 @@
'use strict';
/*global require, echo,__plugin*/
var Drone = require('./drone').Drone,
blocks = require('blocks');
/*global require, echo,__plugin, module*/
var blocks = require('blocks');
/************************************************************************
### Drone.wallsign() method
@ -124,7 +123,7 @@ function sign( message, block ) {
if ( message.constructor != Array ) {
message = [message];
}
var bm = this._getBlockIdAndMeta( block );
var bm = this.getBlockIdAndMeta( block );
block = bm[0];
var meta = bm[1];
if ( block !== blocks.sign_post && block !== blocks.sign ) {
@ -138,6 +137,8 @@ function sign( message, block ) {
putSign( this, message, block, meta);
}
Drone.extend(sign);
Drone.extend(signpost);
Drone.extend(wallsign);
module.exports = function(Drone){
Drone.extend(sign);
Drone.extend(signpost);
Drone.extend(wallsign);
};

40
src/main/js/plugins/drone/sphere.js → src/main/js/modules/drone/sphere.js
View file

@ -1,5 +1,5 @@
var Drone = require('./drone').Drone;
'use strict';
/*global module*/
/************************************************************************
### Drone.sphere() method
@ -22,11 +22,11 @@ Spheres are time-consuming to make. You *can* make large spheres (250 radius) bu
server to be very busy for a couple of minutes while doing so.
***/
Drone.extend( 'sphere', function( block, radius ) {
function sphere( block, radius ) {
var lastRadius = radius,
slices = [ [ radius , 0 ] ],
diameter = radius * 2,
bm = this._getBlockIdAndMeta( block ),
bm = this.getBlockIdAndMeta( block ),
r2 = radius * radius,
i = 0,
newRadius,
@ -83,7 +83,7 @@ Drone.extend( 'sphere', function( block, radius ) {
.down( v );
}
return this.move( 'sphere' );
});
}
/************************************************************************
### Drone.sphere0() method
@ -104,12 +104,12 @@ Spheres are time-consuming to make. You *can* make large spheres (250 radius) bu
server to be very busy for a couple of minutes while doing so.
***/
Drone.extend('sphere0', function(block,radius)
function sphere0(block,radius)
{
var lastRadius = radius,
slices = [ [ radius, 0 ] ],
diameter = radius * 2,
bm = this._getBlockIdAndMeta( block ),
bm = this.getBlockIdAndMeta( block ),
r2 = radius*radius,
i,
newRadius,
@ -185,7 +185,7 @@ Drone.extend('sphere0', function(block,radius)
return this;
});
}
/************************************************************************
### Drone.hemisphere() method
@ -206,11 +206,11 @@ To create a wood 'north' hemisphere with a radius of 7 blocks...
![hemisphere example](img/hemisphereex1.png)
***/
Drone.extend( 'hemisphere', function( block, radius, northSouth ) {
function hemisphere( block, radius, northSouth ) {
var lastRadius = radius,
slices = [ [ radius, 0 ] ],
diameter = radius * 2,
bm = this._getBlockIdAndMeta(block),
bm = this.getBlockIdAndMeta(block),
r2 = radius * radius,
i = 0,
newRadius;
@ -260,7 +260,7 @@ Drone.extend( 'hemisphere', function( block, radius, northSouth ) {
}
}
return this.move( 'hsphere' );
});
}
/************************************************************************
### Drone.hemisphere0() method
@ -281,22 +281,16 @@ To create a glass 'north' hemisphere with a radius of 20 blocks...
![hemisphere example](img/hemisphereex2.png)
***/
Drone.extend( 'hemisphere0', function( block, radius, northSouth ) {
function hemisphere0( block, radius, northSouth ) {
if ( radius > 255 ) {
throw new Error('Hemisphere radius must be less than 256 blocks');
}
/*
return this.hemisphere( block, radius, northSouth)
.fwd().right().up( northSouth == 'north' ? 0 : 1 )
.hemisphere( 0, radius-1, northSouth )
.back().left().down( northSouth == 'north' ? 0 : 1 );
*/
var lastRadius = radius,
slices = [ [ radius, 0 ] ],
diameter = radius * 2,
bm = this._getBlockIdAndMeta(block),
bm = this.getBlockIdAndMeta(block),
r2 = radius * radius,
i = 0,
len,
@ -393,4 +387,10 @@ Drone.extend( 'hemisphere0', function( block, radius, northSouth ) {
}
return this.move( 'hsphere0' );
});
}
module.exports = function(Drone){
Drone.extend( sphere );
Drone.extend( sphere0 );
Drone.extend( hemisphere );
Drone.extend( hemisphere0 );
};

11
src/main/js/plugins/drone/stairs.js → src/main/js/modules/drone/stairs.js
View file

@ -1,3 +1,5 @@
'use strict';
/*global module*/
/**************************************************************************
### Drone.stairs() function
@ -30,8 +32,7 @@ To build an oak staircase 3 blocks wide and 5 blocks tall:
Staircases do not have any blocks beneath them.
***/
var Drone = require('./drone').Drone,
blocks = require('blocks');
var blocks = require('blocks');
/*global require*/
function stairs(blockType, width, height){
if (typeof width === 'undefined')
@ -42,7 +43,7 @@ function stairs(blockType, width, height){
blockType = blocks.stairs.oak;
}
this.then(function(){
var bm = this._getBlockIdAndMeta(blockType);
var bm = this.getBlockIdAndMeta(blockType);
this.chkpt('_stairs');
while (height > 0) {
this.traverseWidth(width, function(){
@ -56,4 +57,6 @@ function stairs(blockType, width, height){
});
}
Drone.extend(stairs);
module.exports = function(Drone){
Drone.extend(stairs);
};

15
src/main/js/plugins/drone/test.js → src/main/js/modules/drone/test.js
View file

@ -1,6 +1,6 @@
var Drone = require('./drone').Drone;
Drone.prototype.testHorizontalStrokeWidth = function(){
'use strict';
/*global module*/
function testHorizontalStrokeWidth(){
this.arc({
blockType: 42,
meta: 0,
@ -9,9 +9,8 @@ Drone.prototype.testHorizontalStrokeWidth = function(){
strokeWidth: 3,
quadrants: {topright:true,topleft:true,bottomleft:true,bottomright:true}
});
};
Drone.prototype.testVerticalStrokeWidth = function(){
}
function testVerticalStrokeWidth(){
this.arc({
blockType: 42,
meta: 0,
@ -20,4 +19,8 @@ Drone.prototype.testVerticalStrokeWidth = function(){
strokeWidth: 3,
quadrants: {topright:true,topleft:true,bottomleft:true,bottomright:true}
});
}
module.exports = function(Drone){
Drone.prototype.testHorizontalStrokeWidth = testHorizontalStrokeWidth;
Drone.prototype.testVerticalStrokeWidth = testVerticalStrokeWidth;
};

9
src/main/js/plugins/drone/trees.js → src/main/js/modules/drone/trees.js
View file

@ -1,5 +1,5 @@
'use strict';
/*global require, __plugin, Packages, org, echo */
/*global require, __plugin, Packages, org, echo, module */
var blocks = require('blocks');
/************************************************************************
### Drone Trees methods
@ -28,7 +28,6 @@ successful if the tree is placed on grass in a setting where trees can
grow.
***/
var Drone = require('./drone').Drone;
function bukkitTreeFactory( k, v ) {
return function( ) {
var block = this.getBlock();
@ -71,7 +70,7 @@ function canaryTreeFactory( k, v ){
}
};
}
function main(){
module.exports = function (Drone){
var trees = {
oak: null,
birch: null,
@ -96,5 +95,5 @@ function main(){
Drone.extend(p, bukkitTreeFactory ( p, trees[p] ) );
}
}
}
main();
};

55
src/main/js/plugins/drone/bed.js
View file

@ -1,55 +0,0 @@
'use strict';
/*global require, Packages, __plugin*/
var Drone = require('./drone').Drone,
blocks = require('blocks');
/************************************************************************
### Drone.bed() method
Creates a bed. The foot of the bed will be at the drone's location and
the head of the bed will extend away from the drone.
#### Example
To create a bed at the in-game prompt, look at a block then type:
```javascript
/js bed()
```
Like most Drone methods, this returns the drone so it can be chained like so:
```javascript
this
.fwd(3)
.bed()
.back(3)
```
***/
var bedDirections = {
0:3, // east
1:0, // south
2:1, // west
3:2 // north
};
function bed(){
this.then(function(){
var foot = this.setBlock(blocks.bed, bedDirections[this.dir], 0,0,0, false);
var head = this.setBlock(blocks.bed, bedDirections[this.dir] + 8, 0,0,1, false);
if (Drone.bountiful){
var prop = require('blockhelper').property;
var BedHalf = Packages.net.canarymod.api.world.blocks.properties.BlockPropertyEnums.BedHalf;
prop(foot)
.set('facing',this.dir)
.set('part', BedHalf.FOOT);
prop(head)
.set('facing',this.dir)
.set('part', BedHalf.HEAD);
}
if (__plugin.canary){
foot.update();
head.update();
}
});
}
Drone.extend( bed );

2
src/main/js/plugins/drone/contrib/castle.js
View file

@ -1,4 +1,4 @@
var Drone = require('../drone').Drone;
var Drone = require('drone');
//
// a castle is just a big wide fort with 4 taller forts at each corner
//

2
src/main/js/plugins/drone/contrib/chessboard.js
View file

@ -1,4 +1,4 @@
var Drone = require('../drone').Drone;
var Drone = require('drone');
var blocks = require('blocks');
/**

2
src/main/js/plugins/drone/contrib/cottage.js
View file

@ -1,4 +1,4 @@
var Drone = require('../drone').Drone;
var Drone = require('drone');
var blocks = require('blocks');
//
// usage:

2
src/main/js/plugins/drone/contrib/dancefloor.js
View file

@ -1,4 +1,4 @@
var Drone = require('../drone').Drone;
var Drone = require('drone');
var blocks = require('blocks');
//
// Create a floor of colored tiles some of which emit light.

2
src/main/js/plugins/drone/contrib/fort.js
View file

@ -1,5 +1,5 @@
'use strict';
var Drone = require('../drone').Drone;
var Drone = require('drone');
var blocks = require('blocks');
//
// constructs a medieval fort

4
src/main/js/plugins/drone/contrib/hangtorch.js
View file

@ -1,6 +1,6 @@
'use strict';
/*global require, __plugin, org*/
var Drone = require('../drone').Drone,
var Drone = require('drone'),
bkMaterial = org.bukkit.Material,
blocks = require('blocks');
@ -21,7 +21,7 @@ function canHang( block ) {
return false;
}
function hangtorch() {
var torch = '50:' + Drone.PLAYER_TORCH_FACING[this.dir];
var torch = blocks.torch + ':' + Drone.PLAYER_TORCH_FACING[this.dir];
var moves = 0;
var block = this.getBlock();

5
src/main/js/plugins/drone/contrib/lcd-clock.js
View file

@ -10,10 +10,7 @@
/js clock.stop24();
... stops the clock...
*/
var Drone = require('../drone').Drone,
blocktype = require('../blocktype'),
blocks = require('blocks');
var blocks = require('blocks');
exports.LCDClock = function(drone, fgColor,bgColor,border) {

121
src/main/js/plugins/drone/contrib/logo.js
View file

@ -1,4 +1,7 @@
var Drone = require('../drone').Drone;
'use strict';
/*global require*/
var Drone = require('drone'),
blocks = require('blocks');
//
// Constructs the JS logo
@ -9,61 +12,77 @@ var Drone = require('../drone').Drone;
// bg
// the material that the square will be made of
//
Drone.extend('logojs', function(fg, bg) {
function logojs(fg, bg) {
// foreground defaults to gray wool
if (typeof fg == "undefined")
fg = '35:7';
fg = blocks.wool.gray;
// background defaults to gold blocks
if (typeof bg == "undefined")
bg = 41;
bg = blocks.gold;
// Draw the sqaure
this.chkpt('logojs-start')
.up()
.box(bg, 100, 100, 1);
this
.chkpt('logojs-start')
.up()
.box(bg, 100, 100, 1);
// Draw the J, starting with the hook
this.right(30).up(13)
.box(fg)
.right().down()
.box(fg, 1, 3, 1)
.right().down()
.box(fg, 1, 5, 1)
.right().down()
.box(fg, 1, 7, 1)
.right()
.box(fg, 1, 8, 1)
.right().down()
.box(fg, 1, 10, 1)
.right()
.box(fg, 1, 9, 1)
.right()
.box(fg, 1, 8, 1)
.right().down()
.box(fg, 2, 8, 1)
.right(2)
.box(fg, 4, 7, 1)
.right(4)
.box(fg, 1, 8, 1)
.right()
.box(fg, 1, 9, 1)
.right().up()
.box(fg, 3, 10, 1)
.right(3).up()
.box(fg, 2, 9, 1)
.right(2).up()
.box(fg, 2, 8, 1)
.right(2).up()
.box(fg, 1, 7, 1)
.right().up()
.box(fg, 1, 6, 1)
.right().up()
.box(fg, 1, 5, 1)
.right().up(2)
.box(fg, 1, 3, 1)
.left(9).up(3)
.box(fg, 10, 31, 1)
this
.right(30)
.up(13)
.box(fg)
.right()
.down()
.box(fg, 1, 3, 1)
.right()
.down()
.box(fg, 1, 5, 1)
.right()
.down()
.box(fg, 1, 7, 1)
.right()
.box(fg, 1, 8, 1)
.right()
.down()
.box(fg, 1, 10, 1)
.right()
.box(fg, 1, 9, 1)
.right()
.box(fg, 1, 8, 1)
.right()
.down()
.box(fg, 2, 8, 1)
.right(2)
.box(fg, 4, 7, 1)
.right(4)
.box(fg, 1, 8, 1)
.right()
.box(fg, 1, 9, 1)
.right()
.up()
.box(fg, 3, 10, 1)
.right(3)
.up()
.box(fg, 2, 9, 1)
.right(2)
.up()
.box(fg, 2, 8, 1)
.right(2)
.up()
.box(fg, 1, 7, 1)
.right()
.up()
.box(fg, 1, 6, 1)
.right()
.up()
.box(fg, 1, 5, 1)
.right()
.up(2)
.box(fg, 1, 3, 1)
.left(9)
.up(3)
.box(fg, 10, 31, 1)
// Draw the S
// It's drawn in three strokes from bottom to top. Look for when
@ -181,7 +200,7 @@ Drone.extend('logojs', function(fg, bg) {
this.move('logojs-start');
return this;
});
}
//
// Makes a cube of JS logos!
// This is a wrapper for logojs() so look at its docs
@ -189,7 +208,7 @@ Drone.extend('logojs', function(fg, bg) {
// Until the drone can rotate on its Z axis we can't
// use logojs() to create top/bottom sides of cube.
//
Drone.extend('logojscube', function(fg, bg) {
function logojscube(fg, bg) {
this.chkpt('jscube-start')
.logojs(fg, bg);
@ -216,4 +235,6 @@ Drone.extend('logojscube', function(fg, bg) {
.logojs(fg, bg);
return this;
});
}
Drone.extend( logojs );
Drone.extend( logojscube );

2
src/main/js/plugins/drone/contrib/mazegen.js
View file

@ -1,6 +1,6 @@
// Maze generation based on http://rosettacode.org/wiki/Maze_generation#JavaScript
var Drone = require('../drone').Drone;
var Drone = require('drone');
// User-facing code starts here
// Example: Try /js maze(5,7)
Drone.extend( function maze( size_x, size_y ) {

8
src/main/js/plugins/drone/contrib/rainbow.js
View file

@ -1,5 +1,7 @@
var Drone = require('../drone').Drone;
var blocks = require('blocks');
'use strict';
/*global require*/
var Drone = require('drone'),
blocks = require('blocks');
/************************************************************************
### Drone.rainbow() method
@ -33,7 +35,7 @@ function rainbow( radius ) {
colors = blocks.rainbow.slice(0);
colors.push(blocks.air);
for ( i = 0; i < colors.length; i++ ) {
bm = this._getBlockIdAndMeta( colors[i] );
bm = this.getBlockIdAndMeta( colors[i] );
this.arc({
blockType: bm[0],
meta: bm[1],

6
src/main/js/plugins/drone/contrib/redstonewire.js
View file

@ -1,5 +1,7 @@
var Drone = require('../drone').Drone;
var blocks = require('blocks');
'use strict';
/*global require*/
var Drone = require('drone'),
blocks = require('blocks');
//
// usage:

6
src/main/js/plugins/drone/contrib/spiral_stairs.js
View file

@ -1,5 +1,7 @@
var Drone = require('../drone').Drone;
var blocks = require('blocks');
'use strict';
/*global require*/
var Drone = require('drone'),
blocks = require('blocks');
/************************************************************************
### Drone.spiral_stairs() method

4
src/main/js/plugins/drone/contrib/temple.js
View file

@ -1,5 +1,5 @@
var Drone = require('../drone').Drone;
var blocks = require('blocks');
var Drone = require('drone'),
blocks = require('blocks');
//
// constructs a mayan temple
//

6
src/main/js/plugins/drone/drone-firework.js
View file

@ -1,6 +0,0 @@
var fireworks = require('fireworks');
var Drone = require('./drone').Drone;
Drone.extend( 'firework', function( ) {
fireworks.firework( this.getLocation() );
});

882
src/main/js/plugins/drone/drone.js
View file

@ -1,882 +1,4 @@
/*global __plugin, require, org, setTimeout, addUnloadHandler, exports, global, Packages, server*/
var utils = require('utils'),
blocks = require('blocks'),
THOUSAND = 1000,
MILLION = THOUSAND * THOUSAND;
/*********************************************************************
## Drone Plugin
The Drone is a convenience class for building. It can be used for...
1. Building
2. Copying and Pasting
It uses a fluent interface which means all of the Drone's methods return `this` and can be chained together like so...
var theDrone = new Drone(self);
theDrone.up().left().box(blocks.oak).down().fwd(3).cylinder0(blocks.lava,8);
### Constructing a Drone Object
Drones can be created in any of the following ways...
1. Calling any one of the methods listed below will return a Drone object. For example...
var d = box( blocks.oak )
... creates a 1x1x1 wooden block at the cross-hairs or player's location and returns a Drone object. This might look odd (if you're familiar with Java's Object-dot-method syntax) but all of the Drone class's methods are also global functions that return new Drone objects. This is short-hand for creating drones and is useful for playing around with Drones at the in-game command prompt. It's shorter than typing ...
var d = new Drone(self).box( blocks.oak )
... All of the Drone's methods return `this` so you can chain operations together like this...
var d = box( blocks.oak )
.up()
.box( blocks.oak ,3,1,3)
.down()
.fwd(2)
.box( blocks.oak )
.turn()
.fwd(2)
.box( blocks.oak )
.turn()
.fwd(2)
.box( blocks.oak );
2. Using the following form...
d = new Drone(self)
...will create a new Drone taking the current player as the parameter. If the player's cross-hairs are pointing at a block at the time then, that block's location becomes the drone's starting point. If the cross-hairs are _not_ pointing at a block, then the drone's starting location will be 2 blocks directly in front of the player. TIP: Building always happens right and front of the drone's position...
Plan View:
^
|
|
D---->
For convenience you can use a _corner stone_ to begin building. The corner stone should be located just above ground level. If the cross-hair is point at or into ground level when you create a new Drone() with either a player or location given as a parameter, then building begins at the location the player was looking at or at the location. You can get around this by pointing at a 'corner stone' just above ground level or alternatively use the following statement...
d = new Drone(self).up();
... which will move the drone up one block as soon as it's created.
![corner stone](img/cornerstone1.png)
3. Or by using the following form...
d = new Drone(x,y,z,direction,world);
This will create a new Drone at the location you specified using x, y, z In minecraft, the X axis runs west to east and the Z axis runs north to south. The direction parameter says what direction you want the drone to face: 0 = east, 1 = south, 2 = west, 3 = north. If the direction parameter is omitted, the player's direction is used instead. Both the `direction` and `world` parameters are optional.
4. Create a new Drone based on a Location object...
d = new Drone(location);
This is useful when you want to create a drone at a given `org.bukkit.Location` . The `Location` class is used throughout the bukkit API. For example, if you want to create a drone when a block is broken at the block's location you would do so like this...
events.blockBreak( function( event ) {
var location = event.block.location;
var drone = new Drone(location);
// do more stuff with the drone here...
});
#### Parameters
* Player : If a player reference is given as the sole parameter then the block the player was looking at will be used as the starting point for the drone. If the player was not looking at a block then the player's location will be used as the starting point. If a `Player` object is provided as a paramter then it should be the only parameter.
* location : *NB* If a `Location` object is provided as a parameter, then it should be the only parameter.
* x : The x coordinate of the Drone (x,y,z,direction and world are not needed if either a player or location parameter is provided)
* y : The y coordinate of the Drone
* z : The z coordinate of the Drone
* direction : The direction in which the Drone is facing. Possible values are 0 (east), 1 (south), 2 (west) or 3 (north)
* world : The world in which the drone is created.
### Drone.box() method
the box() method is a convenience method for building things. (For the more performance-oriented method - see cuboid)
#### parameters
* b - 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`
* w (optional - default 1) - the width of the structure
* h (optional - default 1) - the height of the structure
* d (optional - default 1) - the depth of the structure - NB this is not how deep underground the structure lies - this is how far away (depth of field) from the drone the structure will extend.
#### Example
To create a black structure 4 blocks wide, 9 blocks tall and 1 block long...
box(blocks.wool.black, 4, 9, 1);
... or the following code does the same but creates a variable that can be used for further methods...
var drone = new Drone(self);
drone.box(blocks.wool.black, 4, 9, 1);
![box example 1](img/boxex1.png)
### 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);
![example box0](img/box0ex1.png)
### Drone.boxa() method
Construct a cuboid using an array of blocks. As the drone moves first along the width axis, then the height (y axis) then the length, each block is picked from the array and placed.
#### 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,7,1,30);
![boxa example](img/boxaex1.png)
### Chaining
All of the Drone methods return a Drone object, which means methods can be 'chained' together so instead of writing this...
drone = new Drone( self );
drone.fwd( 3 );
drone.left( 2 );
drone.box( blocks.grass ); // create a grass block
drone.up();
drone.box( blocks.grass ); // create another grass block
drone.down();
...you could simply write ...
var drone = new Drone(self).fwd(3).left(2).box(blocks.grass).up().box(blocks.grass).down();
... since each Drone method is also a global function that constructs a drone if none is supplied, you can shorten even further to just...
fwd(3).left(2).box(blocks.grass).up().box(blocks.grass).down()
The Drone object uses a [Fluent Interface][fl] to make ScriptCraft scripts more concise and easier to write and read. Minecraft's in-game command prompt is limited to about 80 characters so chaining drone commands together means more can be done before hitting the command prompt limit. For complex building you should save your commands in a new script file and load it using /js load()
[fl]: http://en.wikipedia.org/wiki/Fluent_interface
### Drone Properties
* x - The Drone's position along the west-east axis (x increases as you move east)
* y - The Drone's position along the vertical axis (y increses as you move up)
* z - The Drone's position along the north-south axis (z increases as you move south)
* dir - The Drone's direction 0 is east, 1 is south , 2 is west and 3 is north.
### Extending Drone
The Drone object can be easily extended - new buidling recipes/blueprints can be added and can become part of a Drone's chain using the *static* method `Drone.extend`.
### Drone.extend() static method
Use this method to add new methods (which also become chainable global functions) to the Drone object.
#### Parameters
* name - The name of the new method e.g. 'pyramid'.
* function - The method body.
Alternatively if you provide just a function as a parameter, then the function name will be used as the new method name. For example the following two approaches are both valid.
#### Example 1 Using name and function as parameters
// submitted by [edonaldson][edonaldson]
Drone.extend('pyramid', function( block,height) {
this.chkpt('pyramid');
for ( var i = height; i > 0; i -= 2) {
this.box(block, i, 1, i).up().right().fwd();
}
return this.move('pyramid');
});
#### Example 2 Using just a named function as a parameter
function pyramid( block,height) {
this.chkpt('pyramid');
for ( var i = height; i > 0; i -= 2) {
this.box(block, i, 1, i).up().right().fwd();
}
return this.move('pyramid');
}
Drone.extend( pyramid );
Once the method is defined (it can be defined in a new pyramid.js file) it can be used like so...
var d = new Drone(self);
d.pyramid(blocks.brick.stone, 12);
... or simply ...
pyramid(blocks.brick.stone, 12);
[edonaldson]: https://github.com/edonaldson
### Drone Constants
#### Drone.PLAYER_STAIRS_FACING
An array which can be used when constructing stairs facing in the Drone's direction...
var d = new Drone(self);
d.box(blocks.stairs.oak + ':' + Drone.PLAYER_STAIRS_FACING[d.dir]);
... will construct a single oak stair block facing the drone.
#### Drone.PLAYER_SIGN_FACING
An array which can be used when placing signs so they face in a given direction. This is used internally by the Drone.sign() method. It should also be used for placing any of the following blocks...
* chest
* ladder
* furnace
* dispenser
By default, chests, dispensers, signs, ladders and furnaces are placed facing towards the drone so to place a chest facing the Drone just use:
drone.box( blocks.chest );
To place a chest facing _away_ from the Drone:
drone.box( blocks.chest + ':' + Drone.PLAYER_SIGN_FACING[(drone.dir + 2) % 4]);
#### Drone.PLAYER_TORCH_FACING
Used when placing torches. By default torches will be placed facing up. If you want to place a torch so that it faces towards the drone:
drone.box( blocks.torch + ':' + Drone.PLAYER_TORCH_FACING[drone.dir]);
If you want to place a torch so it faces _away_ from the drone:
drone.box( blocks.torch + ':' + Drone.PLAYER_TORCH_FACING[(drone.dir + 2) % 4]);
***/
//
// Implementation
// ==============
//
// There is no need to read any further unless you want to understand how the Drone object works.
//
function getDirFromRotation( location ) {
// 0 = east, 1 = south, 2 = west, 3 = north
// 46 to 135 = west
// 136 to 225 = north
// 226 to 315 = east
// 316 to 45 = south
var r;
if (__plugin.canary ) {
r = location.rotation;
}
if (__plugin.bukkit) {
r = location.yaw;
}
// west = -270
// north = -180
// east = -90
// south = 0
r = (r + 360 ) % 360; // east could be 270 or -90
if ( r > 45 && r <= 135 )
return 2; // west
if ( r > 135 && r <= 225 )
return 3; // north
if ( r > 225 && r <= 315 )
return 0; // east
return 1; // south
}
function putBlock( x, y, z, blockId, metadata, world, dir, update ) {
if ( typeof metadata == 'undefined' ) {
metadata = 0;
}
var block = world.getBlockAt( x, y, z );
if (__plugin.canary) {
var BlockType = Packages.net.canarymod.api.world.blocks.BlockType;
block.type = BlockType.fromId(blockId);
var applyProperties = require('blockhelper').applyProperties;
applyProperties(block, metadata);
if (typeof update === 'undefined'){
update = true;
}
if (update){
block.update();
}
}
if (__plugin.bukkit) {
block.setTypeIdAndData( blockId, metadata, false );
block.data = metadata;
}
return block;
}
function Drone( x, y, z, dir, world ) {
this.record = false;
var usePlayerCoords = false;
var player = (typeof self !== 'undefined' ? self : null);
var playerPos;
if ( x.location && x.name) {
player = x;
}
playerPos = x.location;
var that = this;
var populateFromLocation = function( loc ) {
that.x = loc.x;
that.y = loc.y;
that.z = loc.z;
that.dir = getDirFromRotation(loc);
that.world = loc.world;
};
var mp = utils.getMousePos( player );
if ( typeof x == 'undefined' || x.location ) {
if ( mp ) {
populateFromLocation( mp );
if ( playerPos ) {
this.dir = getDirFromRotation(playerPos);
}
} else {
// base it on the player's current location
usePlayerCoords = true;
//
// it's possible that drone.js could be loaded by a non-playing op
// (from the server console)
//
if ( !playerPos ) {
return null;
}
populateFromLocation( playerPos );
}
} else {
if ( arguments[0].x && arguments[0].y && arguments[0].z ) {
populateFromLocation( arguments[ 0 ] );
} else {
this.x = x;
this.y = y;
this.z = z;
if ( typeof dir == 'undefined' ) {
this.dir = getDirFromRotation( playerPos);
} else {
this.dir = dir%4;
}
if ( typeof world == 'undefined' ) {
this.world = playerPos.world;
} else {
this.world = world;
}
}
}
if ( usePlayerCoords ) {
this.fwd( 3 );
}
this.chkpt( 'start' );
this.record = true;
this.history = [];
this.player = player;
return this;
}
exports.Drone = Drone;
/*
because this is a plugin, any of its exports will be exported globally.
Since 'blocks' is a module not a plugin it is convenient to export it via
the Drone module.
*/
var blocks = require('blocks');
exports.Drone = require('drone');
exports.blocks = blocks;
Drone.getDirFromRotation = getDirFromRotation;
Drone.queue = [];
Drone.opsPerSec = 10;
Drone.processQueue = function processQueue(){
var process,
i = 0,
queues = getAllQueues();
for ( ; i < queues.length; i++ ) {
process = queues[i].shift();
if (process){
try {
process();
} catch( e ) {
console.log('Drone build error: ' + e + ' while processing ' + process);
}
}
}
setTimeout( Drone.processQueue, 1000 / Drone.opsPerSec );
};
setTimeout( Drone.processQueue, 1000 / Drone.opsPerSec );
addUnloadHandler( function() {
var pendingBuildOps = 0;
var allQueues = getAllQueues();
for (var i = 0; i < allQueues.length; i++){
pendingBuildOps += allQueues[i].length;
}
if (pendingBuildOps > 0){
console.warn('There were ' + pendingBuildOps + ' pending build operations which were cancelled');
}
});
//
// add custom methods to the Drone object using this function
//
Drone.extend = function( name, func ) {
if (arguments.length == 1){
func = name;
if ( !func.name ){
throw 'A Drone extension function must have a name!';
}
name = func.name;
}
Drone.prototype[ '_' + name ] = func;
Drone.prototype[ name ] = function( ) {
if ( this.record ) {
this.history.push( [ name, arguments ] );
}
var oldVal = this.record;
this.record = false;
this[ '_' + name ].apply( this, arguments );
this.record = oldVal;
return this;
};
global[name] = function( ) {
var result = new Drone( self );
result[name].apply( result, arguments );
return result;
};
};
/**************************************************************************
### Drone.times() Method
The times() method makes building multiple copies of buildings
easy. It's possible to create rows or grids of buildings without
resorting to `for` or `while` loops.
#### Parameters
* numTimes (optional - default 2) : The number of times you want to repeat the preceding statements.
#### Example
Say you want to do the same thing over and over. You have a couple of options...
* You can use a for loop...
d = new Drone(); for ( var i =0;i < 4; i++) { d.cottage().right(8); }
While this will fit on the in-game prompt, it's awkward. You need to
declare a new Drone object first, then write a for loop to create the
4 cottages. It's also error prone, even the `for` loop is too much
syntax for what should really be simple.
* You can use a while loop...
d = new Drone(); var i=4; while (i--) { d.cottage().right(8); }
... which is slightly shorter but still too much syntax. Each of the
above statements is fine for creating a 1-dimensional array of
structures. But what if you want to create a 2-dimensional or
3-dimensional array of structures? Enter the `times()` method.
The `times()` method lets you repeat commands in a chain any number of
times. So to create 4 cottages in a row you would use the following
statement...
cottage().right(8).times(4);
...which will build a cottage, then move right 8 blocks, then do it
again 4 times over so that at the end you will have 4 cottages in a
row. What's more the `times()` method can be called more than once in
a chain. So if you wanted to create a *grid* of 20 houses ( 4 x 5 ),
you would do so using the following statement...
cottage().right(8).times(4).fwd(8).left(32).times(5);
... breaking it down...
1. The first 3 calls in the chain ( `cottage()`, `right(8)`, `times(4)` ) build a single row of 4 cottages.
2. The last 3 calls in the chain ( `fwd(8)`, `left(32)`, `times(5)` ) move the drone forward 8 then left 32 blocks (4 x 8) to return to the original x coordinate, then everything in the chain is repeated again 5 times so that in the end, we have a grid of 20 cottages, 4 x 5. Normally this would require a nested loop but the `times()` method does away with the need for loops when repeating builds.
Another example: This statement creates a row of trees 2 by 3 ...
oak().right(10).times(2).left(20).fwd(10).times(3)
... You can see the results below.
![times example 1](img/times-trees.png)
***/
Drone.prototype.times = function( numTimes, commands ) {
if ( typeof numTimes == 'undefined' ) {
numTimes = 2;
}
if ( typeof commands == 'undefined' ) {
commands = this.history.concat();
}
this.history = [ [ 'times', [ numTimes + 1, commands ] ] ];
var oldVal = this.record;
this.record = false;
for ( var j = 1; j < numTimes; j++ ) {
for ( var i = 0; i < commands.length; i++) {
var command = commands[i];
var methodName = command[0];
var args = command[1];
this[ methodName ].apply( this, args );
}
}
this.record = oldVal;
return this;
};
Drone.prototype.getBlock = function(){
return this.world.getBlockAt(this.x,this.y,this.z);
};
Drone.prototype.setBlock = function(blockType, data, ow, oh, od, update){
if (typeof ow == 'undefined')
ow = 0;
if (typeof oh == 'undefined')
oh = 0;
if (typeof od == 'undefined')
od = 0;
this
.right(ow)
.up(oh)
.fwd(od);
var result = putBlock(this.x, this.y, this.z, blockType, data, this.world, this.dir, update);
this
.left(ow)
.down(oh)
.back(od);
return result;
};
Drone.prototype.traverseWidth = function(width, callback){
_traverse[this.dir].width(this, width, callback);
};
Drone.prototype.traverseHeight = function(height, callback){
traverseHeight(this, height, callback);
};
Drone.prototype.traverseDepth = function(depth, callback){
_traverse[this.dir].depth(this, depth, callback);
};
//
// building
//
var playerQueues = {};
/*
if the drone has an associated player, then use that player's queue otherwise
use the global queue.
*/
function getQueue( drone ){
if ( drone.player ) {
var playerName = ''+drone.player.name;
var result = playerQueues[playerName];
if (result === undefined){
playerQueues[playerName] = [];
return playerQueues[playerName];
}
return result;
} else {
return Drone.queue;
}
}
function getAllQueues() {
var result = [ Drone.queue ];
for (var pq in playerQueues) {
result.push(playerQueues[pq]) ;
}
return result;
}
Drone.prototype.cuboida = function(/* Array */ blocks, w, h, d, overwrite, immediate ) {
//
// wph 20140823 make a copy because don't want to modify array in background
//
var blocksForBuild = blocks.slice();
var len = blocksForBuild.length,
i = 0;
if ( !immediate ) {
for ( ; i < len; i++ ) {
blocksForBuild[i] = this._getBlockIdAndMeta( blocksForBuild[ i ] );
}
var clone = Drone.clone(this);
var impl = this.cuboida.bind(clone, blocksForBuild, w, h, d, overwrite, true);
getQueue(this).push( function cuboida(){ impl(); });
return this;
}
if ( typeof overwrite == 'undefined' ) {
overwrite = true;
}
if ( typeof h == 'undefined' ) {
h = 1;
}
if ( typeof d == 'undefined' ) {
d = 1;
}
if ( typeof w == 'undefined' ) {
w = 1;
}
var bi = 0;
traverseDHW( this, d,h,w, function traverseWidthCallback( ) {
var properBlock = blocksForBuild[ bi % len ];
this.setBlock(properBlock[0], properBlock[1]);
bi++;
});
return this;
};
Drone.MAX_VOLUME = 1 * MILLION;
Drone.MAX_SIDE = 1 * THOUSAND;
var tooBig = function(w, h, d ) {
return ( w * h * d ) >= Drone.MAX_VOLUME ||
( w >= Drone.MAX_SIDE ) ||
( h >= Drone.MAX_SIDE ) ||
( d >= Drone.MAX_SIDE );
};
/*
faster cuboid because blockid, meta and world must be provided
use this method when you need to repeatedly place blocks
*/
Drone.prototype.cuboidX = function( blockType, meta, w, h, d, immediate ) {
if ( typeof h == 'undefined' ) {
h = 1;
}
if ( typeof d == 'undefined' ) {
d = 1;
}
if ( typeof w == 'undefined' ) {
w = 1;
}
if ( tooBig( w, h, d ) ) {
this.sign([
'Build too Big!',
'width:' + w,
'height:' + h,
'depth:' + d
], 68);
console.warn('Build too big! ' + w + ' X ' + h + ' X ' + d);
return this;
}
if ( !immediate ) {
var clone = Drone.clone(this);
var impl = this.cuboidX.bind(clone, blockType, meta, w, h, d, true);
getQueue(this).push(function cuboidX(){ impl(); });
return this;
}
traverseDHW( this, d,h,w, function( ) {
this.setBlock( blockType, meta );
});
return this;
};
/*
deferred execution of a drone method
*/
Drone.prototype.then = function( next ){
getQueue(this).push( next.bind( Drone.clone(this) ) );
};
Drone.prototype.cuboid = function( block, w, h, d, immediate ) {
var bm = this._getBlockIdAndMeta( block );
return this.cuboidX( bm[0], bm[1], w, h, d, immediate);
};
Drone.prototype.cuboid0 = function( block, w, h, d, immediate ) {
var start = 'cuboid0' + w + h + d + immediate;
this
.chkpt( start )
.cuboid( block, w, h, 1, immediate ) // Front wall
.cuboid( block, 1, h, d, immediate ) // Left wall
.right( w - 1 )
.cuboid( block, 1, h, d, immediate ) // Right wall
.left( w - 1 )
.fwd( d - 1 )
.cuboid( block, w, h, 1, immediate ) // Back wall
.move( start );
};
// player dirs: 0 = east, 1 = south, 2 = west, 3 = north
// block dirs: 0 = east, 1 = west, 2 = south , 3 = north
// sign dirs: 5 = east, 3 = south, 4 = west, 2 = north
Drone.PLAYER_STAIRS_FACING = [ 0, 2, 1, 3 ];
// for blocks 68 (wall signs) 65 (ladders) 61,62 (furnaces) 23 (dispenser) and 54 (chest)
Drone.PLAYER_SIGN_FACING = [ 4, 2, 5, 3 ];
Drone.PLAYER_TORCH_FACING = [ 2, 4, 1, 3 ];
Drone.extend('box', Drone.prototype.cuboid );
Drone.extend('box0',Drone.prototype.cuboid0 );
Drone.extend('boxa',Drone.prototype.cuboida );
//
// show the Drone's position and direction
//
Drone.prototype.toString = function( ) {
var dirs = ['east','south','west','north'];
return 'x: ' + this.x + ' y: '+this.y + ' z: ' + this.z + ' dir: ' + this.dir + ' '+dirs[this.dir];
};
Drone.prototype.debug = function( ) {
console.log(this.toString( ) );
return this;
};
function _getBlockIdAndMeta( b ) {
var defaultMeta = 0,
i = 0,
bs,
md,
sp;
if (typeof b === 'number' || /^[0-9]+$/.test(b)) {
// wph 20130414 - use sensible defaults for certain blocks e.g. stairs
// should face the drone.
switch (b) {
case blocks.stairs.oak:
case blocks.stairs.cobblestone:
case blocks.stairs.brick:
case blocks.stairs.stone:
case blocks.stairs.nether:
case blocks.stairs.sandstone:
case blocks.stairs.spruce:
case blocks.stairs.jungle:
case blocks.stairs.quartz:
defaultMeta = Drone.PLAYER_STAIRS_FACING[ this.dir % 4 ];
break;
case blocks.sign:
case blocks.ladder:
// bug: furnace, chest, dispenser don't always use the right metadata
case blocks.furnace:
case blocks.furnace_burning:
case blocks.chest:
case blocks.enderchest:
case blocks.dispenser:
defaultMeta = Drone.PLAYER_SIGN_FACING[ this.dir % 4 ];
break;
case blocks.sign_post:
defaultMeta = ( 12 + ( ( this.dir + 2 ) * 4 ) ) % 16;
break;
}
return [ b, defaultMeta ];
}
if ( typeof b === 'string' ) {
bs = b;
sp = bs.indexOf(':' );
if ( sp == -1 ) {
b = parseInt( bs );
return [ b, defaultMeta ];
}
b = parseInt(bs.substring(0,sp ) );
md = parseInt(bs.substring(sp+1,bs.length ) );
return [b,md];
}
if (b.id){
// wph 20141230 we are dealing with an object
var blockInfo = b;
var metadata = {};
for (i in b){
if (i !== 'id')
metadata[i] = b[i];
}
return [b.id, metadata];
}
}
var _traverse = [{},{},{},{}];
// east
function walkWidthEast( drone, n,callback ) {
var s = drone.z, e = s + n;
for ( ; drone.z < e; drone.z++ ) {
callback.call(drone ,drone.z-s );
}
drone.z = s;
}
function walkDepthEast( drone,n,callback ) {
var s = drone.x, e = s+n;
for ( ;drone.x < e;drone.x++ ) {
callback.call(drone, drone.x-s );
}
drone.x = s;
}
function walkWidthSouth( drone,n,callback ) {
var s = drone.x, e = s-n;
for ( ;drone.x > e;drone.x-- ) {
callback.call(drone, s-drone.x );
}
drone.x = s;
}
function walkWidthWest( drone,n,callback ) {
var s = drone.z, e = s-n;
for ( ;drone.z > e;drone.z-- ) {
callback.call(drone, s-drone.z );
}
drone.z = s;
}
_traverse[0].width = walkWidthEast;
_traverse[0].depth = walkDepthEast;
// south
_traverse[1].width = walkWidthSouth;
_traverse[1].depth = walkWidthEast;
// west
_traverse[2].width = walkWidthWest;
_traverse[2].depth = walkWidthSouth;
// north
_traverse[3].width = walkDepthEast;
_traverse[3].depth = walkWidthWest;
function traverseHeight( drone,n,callback ) {
var s = drone.y, e = s + n;
for ( ; drone.y < e; drone.y++ ) {
callback.call(drone, drone.y-s );
}
drone.y = s;
};
function traverseDHW( drone, d,h,w, callback ){
_traverse[drone.dir].depth( drone, d, function traverseDepthCallback( ) {
traverseHeight( this, h, function traverseHeightCallback( ) {
_traverse[this.dir].width( this, w, callback);
});
});
}
Drone.clone = function(origin) {
var result = new Drone(origin.x,origin.y,origin.z, origin.dir, origin.world);
return result;
};
//
// wph 20130130 - make this a method - extensions can use it.
//
Drone.prototype._getBlockIdAndMeta = _getBlockIdAndMeta;
Drone.bountiful = __plugin.canary ? parseFloat(server.canaryModVersion) > 1.7 : false;