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

Added documentation to the drone.js module.

Browse source 
Added new chkpt and move methods to drone class.
Added support for Trees!!!!!
This commit is contained in:
walterhiggins 2012-12-28 09:15:27 +00:00
parent 0111a93913
commit 13076a9bf2
2 changed files with 254 additions and 137 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
cottage.js
View file

@ -2,8 +2,11 @@
// need to use the drone module to create buildings easily // need to use the drone module to create buildings easily
// it can be done using calls to putBlock(), putSign(), getPlayerPos() and getMousePos() // it can be done using calls to putBlock(), putSign(), getPlayerPos() and getMousePos()
// but it's easier to use the Drone class // but it's easier to use the Drone class
// $SCRIPT_DIR is a special javascript variable whose value is the directory where the
// current script resides.
// $SCRIPT is a special javascript variable whose value is the full name of the current script.
// //
load($SCRIPTPATH + "/drone.js"); // assumes cottage.js and drone.js are in same directory load($SCRIPT_DIR + "/drone.js"); // assumes cottage.js and drone.js are in same directory
// //
// usage: // usage:
// [1] to build a cottage at the player's current location or the cross-hairs location... // [1] to build a cottage at the player's current location or the cross-hairs location...
@ -19,16 +22,18 @@ var cottage = function(drone)
if (typeof drone == "undefined"){ if (typeof drone == "undefined"){
drone = new Drone(); drone = new Drone();
} }
drone drone.chkpt('cottage')
.box0(48,7,6,2) // a 4-walled structure 7 wide by 6 deep by 2 high using mossy-stone (48). .box0(48,7,2,6) // 4 walls
.right(3).door() // door front and center .right(3).door() // door front and center
.up(1).left(2).box(102) // windows to left and right .up(1).left(2).box(102) // windows to left and right
.right(4).box(102) .right(4).box(102)
.left(5).up().prism0(53,7,6); // add a gable roof .left(5).up().prism0(53,7,6);
// //
// put up a sign near door. // put up a sign near door.
// //
drone.down().right(4).sign(["Home","Sweet","Home"],68); drone.down().right(4).sign(["Home","Sweet","Home"],68);
return drone.down().left(4); // return drone to original position return drone.move('cottage');
}; };
print ("loaded " + $SCRIPT);

376
drone.js
View file

@ -1,4 +1,119 @@
var ScriptCraft = ScriptCraft || {}; var ScriptCraft = ScriptCraft || {};
//
// Interface
// =========
//
// Please read the following section to understand what a Minecraft Drone can do.
//
var Drone = {
//
// creating a new drone
// ====================
//
// Drones can be created in 2 ways...
//
// [1] d = new Drone()
// This will create a new Drone. If the 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.
//
// [2] d = new Drone(x,y,z,direction)
// 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.
//
// movement
// ========
//
// Drones can move freely in minecraft's 3-D world. You control the Drone's movement using
// any of the following methods..
//
// move up - n is the number of blocks you want to move (default 1)
up: function(n){},
// move down - n is the number of blocks you want to move (default 1)
down: function(n){},
// move left - n is the number of blocks you want to move (default 1)
left: function(n){},
// move right - n is the number of blocks you want to move (default 1)
right: function(n){},
// move forward - n is the number of blocks you want to move (default 1)
fwd: function(n){},
// move backwards - n is the number of blocks you want to move (default 1)
back: function(n){},
// to change direction - n is the number of turns right you want to make (default 1)
// turns are always clock-wise. If the drone is facing north, then drone.turn() will
// make the turn face east. If the drone is facing east then drone.turn(2) will make the
// drone turn twice so that it is facing west.
//
turn: function(n){},
// markers
// =======
//
// Markers are useful when your Drone has to do a lot of work. You can set a check-point
// and return to the check-point using the move() method.
// if your drone is about to undertake a lot of work - 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.
// e.g:
//
// drone.chkpt('town-square');
// for (i = 0; i< 100; i++){
// drone.fwd(12).box(6);
// }
// drone.move('town-square');
//
// A 'start' checkpoint is automatically created when the Drone is first created.
//
chkpt: function(checkpoint_name){},
move: function(checkpoint_name){},
// building
// ========
//
// the box() method is the main method for building things.
// parameters
// ----------
// b - the block id - e.g. 6 for an oak sapling or '6:2' for a birch sapling.
// w - the width of the structure (optional - default value is 1)
// h - the height of the structure (optional - default value is 1)
// d - 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.
// (optional - default value is 1)
// e.g:
// To create a stone structure 5 blocks wide, 8 blocks tall and 15 blocks long...
//
// drone.box(48, 5, 8, 15);
//
// To create an oak tree...
// (we can't control the dimensions of a tree since it's a natural object in minecraft)
//
// drone.box(6);
//
box: function(b,w,h,d){},
//
// like box but empties out the inside - ideal for buildings.
//
box0: function(b,w,h,d){},
prism: function(b,w,d){},
prism0: function(b,w,d){},
door: function(b){},
// signs must use block 63 (stand-alone signs) or 68 (signs on walls)
// s can be a string or an array of strings.
sign: function(s,b){}
};
//
// Implementation
// ==============
//
// There is no need to read any further unless you want to understand how the Drone object works.
//
(function(){ (function(){
// //
// Drone Constructor // Drone Constructor
@ -26,53 +141,32 @@ var ScriptCraft = ScriptCraft || {};
this.z = z; this.z = z;
} }
if (typeof dir == "undefined"){ if (typeof dir == "undefined"){
this.dir = getDirFromRotation(playerPos.rotationYaw); this.dir = _getDirFromRotation(playerPos.rotationYaw);
}else{ }else{
this.dir = dir%4; this.dir = dir%4;
} }
if (usePlayerCoords){ if (usePlayerCoords){
this.fwd(2); this.fwd(2);
} }
this.homeCoords = {x:this.x,y:this.y,z:this.z,dir:this.dir}; this.chkpt('start');
}; };
var getDirFromRotation = function(r){ Drone.prototype.chkpt = function(name){
var result = 1; this.checkpoints[name] = {x:this.x,y:this.y,z:this.z,dir:this.dir};
r = Math.abs(Math.ceil(r)); return this;
if (r >= 45 && r < 135){
result = 0;
}
if (r >= 135 && r < 225){
result = 3;
}
if (r >= 225 && r < 315){
result = 2;
}
return result;
}; };
// Drone.prototype.move = function(name){
// movement var coords = this.checkpoints[name];
// if (coords){
var movements = [{},{},{},{}]; this.x = coords.x;
// east this.y = coords.y;
movements[0].right = function(that,n){ that.z +=n; return that;}; this.z = coords.z;
movements[0].left = function(that,n){ that.z -=n; return that;}; this.dir = coords.dir;
movements[0].fwd = function(that,n){ that.x +=n; return that;}; }
movements[0].back = function(that,n){ that.x -= n; return that;}; return this;
// south };
movements[1].right = movements[0].back; Drone.prototype.checkpoints = {};
movements[1].left = movements[0].fwd;
movements[1].fwd = movements[0].right;
movements[1].back = movements[0].left;
// west
movements[2].right = movements[0].left;
movements[2].left = movements[0].right;
movements[2].fwd = movements[0].back;
movements[2].back = movements[0].fwd;
// north
movements[3].right = movements[0].fwd;
movements[3].left = movements[0].back;
movements[3].fwd = movements[0].left;
movements[3].back = movements[0].right;
Drone.prototype.turn = function(n) Drone.prototype.turn = function(n)
{ {
if (typeof n == "undefined"){ if (typeof n == "undefined"){
@ -83,84 +177,21 @@ var ScriptCraft = ScriptCraft || {};
this.dir %=4; this.dir %=4;
return this; return this;
}; };
Drone.prototype.right = function(n){ if (typeof n == "undefined"){ n = 1;} return movements[this.dir].right(this,n);}; Drone.prototype.right = function(n){ if (typeof n == "undefined"){ n = 1;} return _movements[this.dir].right(this,n);};
Drone.prototype.left = function(n){ if (typeof n == "undefined"){ n = 1;} return movements[this.dir].left(this,n);}; Drone.prototype.left = function(n){ if (typeof n == "undefined"){ n = 1;} return _movements[this.dir].left(this,n);};
Drone.prototype.fwd = function(n){ if (typeof n == "undefined"){ n = 1;} return movements[this.dir].fwd(this,n);}; Drone.prototype.fwd = function(n){ if (typeof n == "undefined"){ n = 1;} return _movements[this.dir].fwd(this,n);};
Drone.prototype.back = function(n){ if (typeof n == "undefined"){ n = 1;} return movements[this.dir].back(this,n);}; Drone.prototype.back = function(n){ if (typeof n == "undefined"){ n = 1;} return _movements[this.dir].back(this,n);};
Drone.prototype.up = function(n){ if (typeof n == "undefined"){ n = 1;} this.y+=n; return this;}; Drone.prototype.up = function(n){ if (typeof n == "undefined"){ n = 1;} this.y+=n; return this;};
Drone.prototype.down = function(n){ if (typeof n == "undefined"){ n = 1;} this.y-=n; return this;}; Drone.prototype.down = function(n){ if (typeof n == "undefined"){ n = 1;} this.y-=n; return this;};
Drone.prototype.home = function()
{
this.x = this.homeCoords.x;
this.y = this.homeCoords.y;
this.z = this.homeCoords.z;
this.dir = this.homeCoords.dir;
return this;
};
// //
// building // building
// //
var traverse = [{},{},{},{}];
// east
traverse[0].width = function(that,n,callback){
var s = that.z, e = s + n;
for (; that.z < e; that.z++){
callback();
}
that.z = s;
};
traverse[0].depth = function(that,n,callback){
var s = that.x, e = s+n;
for (;that.x < e;that.x++){
callback();
}
that.x = s;
};
// south
traverse[1].width = function(that,n,callback){
var s = that.x, e = s-n;
for (;that.x > e;that.x--){
callback();
}
that.x = s;
};
traverse[1].depth = traverse[0].width;
// west
traverse[2].width = function(that,n,callback){
var s = that.z, e = s-n;
for (;that.z > e;that.z--){
callback();
}
that.z = s;
};
traverse[2].depth = traverse[1].width;
// north
traverse[3].width = traverse[0].depth;
traverse[3].depth = traverse[2].width;
traverseHeight = function(that,n,callback){
var s = that.y, e = s + n;
for (; that.y < e; that.y++){
callback();
}
that.y = s;
};
var getBlockIdAndMeta = function(b){
if (typeof b == 'string'){
var bs = b;
var sp = bs.indexOf(':')
b = parseInt(bs.substring(0,sp));
md = parseInt(bs.substring(sp+1,bs.length));
return [b,md];
}else{
return [b,0];
}
};
Drone.prototype.sign = function(message,block){ Drone.prototype.sign = function(message,block){
if (message.constructor == Array){ if (message.constructor == Array){
}else{ }else{
message = [message]; message = [message];
} }
var bm = getBlockIdAndMeta(block); var bm = _getBlockIdAndMeta(block);
block = bm[0]; block = bm[0];
meta = bm[1]; meta = bm[1];
if (block != 63 && block != 68){ if (block != 63 && block != 68){
@ -178,12 +209,12 @@ var ScriptCraft = ScriptCraft || {};
return this; return this;
}; };
Drone.prototype.cuboid = function(block,w,d,h){ Drone.prototype.cuboid = function(block,w,h,d){
var md = 0; var md = 0;
if (typeof block == 'object'){ if (typeof block == 'object'){
block = block.blockID; block = block.blockID;
}else{ }else{
var bm = getBlockIdAndMeta(block); var bm = _getBlockIdAndMeta(block);
block = bm[0]; block = bm[0];
md = bm[1]; md = bm[1];
} }
@ -197,17 +228,17 @@ var ScriptCraft = ScriptCraft || {};
w = 1; w = 1;
} }
var that = this; var that = this;
traverse[this.dir].width(that,w,function(){ _traverse[this.dir].width(that,w,function(){
traverseHeight(that,h,function(){ _traverseHeight(that,h,function(){
traverse[that.dir].depth(that,d,function(){ _traverse[that.dir].depth(that,d,function(){
putBlock(that.x,that.y,that.z,block,md); putBlock(that.x,that.y,that.z,block,md);
}); });
}); });
}); });
return this; return this;
}; };
Drone.prototype.cuboid0 = function(block,w,d,h){ Drone.prototype.cuboid0 = function(block,w,h,d){
return this.cuboid(block,w,d,h).fwd().right().cuboid(0,w-2,d-2,h).back().left(); return this.cuboid(block,w,h,d).fwd().right().cuboid(0,w-2,h,d-2).back().left();
}; };
Drone.prototype.door = function(door){ Drone.prototype.door = function(door){
if (typeof door == "undefined"){ if (typeof door == "undefined"){
@ -308,7 +339,7 @@ var ScriptCraft = ScriptCraft || {};
var d2 = d; var d2 = d;
while(d2 >= 1){ while(d2 >= 1){
var bd = block + ':' + (d2 >= d/2?this.dir:(this.dir+2)%4); var bd = block + ':' + (d2 >= d/2?this.dir:(this.dir+2)%4);
this.cuboid(bd,w,d2,1); this.cuboid(bd,w,1,d2);
d2 -= 2; d2 -= 2;
this.fwd().up(); this.fwd().up();
c++; c++;
@ -325,27 +356,108 @@ var ScriptCraft = ScriptCraft || {};
print([this.x,this.y,this.z,this.dir,dirs[this.dir]]); print([this.x,this.y,this.z,this.dir,dirs[this.dir]]);
return this; return this;
} }
Drone.prototype.rehome = function(){
var mp = getMousePos(); // ========================================================================
var playerPos = getPlayerPos(); // Private variables and functions
if (mp){ // ========================================================================
this.x= mp.x;
this.y= mp.y; var _getDirFromRotation = function(r){
this.z= mp.z; var result = 1;
}else{ r = Math.abs(Math.ceil(r));
// base it on the player's current location if (r >= 45 && r < 135){
this.x = playerPos.x; result = 0;
this.y = playerPos.y;
this.z = playerPos.z;
this.fwd(2);
} }
this.dir = getDirFromRotation(playerPos.rotationYaw); if (r >= 135 && r < 225){
this.homeCoords = {x:this.x,y:this.y,z:this.z,dir:this.dir}; result = 3;
return this; }
if (r >= 225 && r < 315){
result = 2;
}
return result;
}; };
var _getBlockIdAndMeta = function(b){
if (typeof b == 'string'){
var bs = b;
var sp = bs.indexOf(':')
b = parseInt(bs.substring(0,sp));
md = parseInt(bs.substring(sp+1,bs.length));
return [b,md];
}else{
return [b,0];
}
};
//
// movement
//
var _movements = [{},{},{},{}];
// east
_movements[0].right = function(that,n){ that.z +=n; return that;};
_movements[0].left = function(that,n){ that.z -=n; return that;};
_movements[0].fwd = function(that,n){ that.x +=n; return that;};
_movements[0].back = function(that,n){ that.x -= n; return that;};
// south
_movements[1].right = _movements[0].back;
_movements[1].left = _movements[0].fwd;
_movements[1].fwd = _movements[0].right;
_movements[1].back = _movements[0].left;
// west
_movements[2].right = _movements[0].left;
_movements[2].left = _movements[0].right;
_movements[2].fwd = _movements[0].back;
_movements[2].back = _movements[0].fwd;
// north
_movements[3].right = _movements[0].fwd;
_movements[3].left = _movements[0].back;
_movements[3].fwd = _movements[0].left;
_movements[3].back = _movements[0].right;
var _traverse = [{},{},{},{}];
// east
_traverse[0].width = function(that,n,callback){
var s = that.z, e = s + n;
for (; that.z < e; that.z++){
callback();
}
that.z = s;
};
_traverse[0].depth = function(that,n,callback){
var s = that.x, e = s+n;
for (;that.x < e;that.x++){
callback();
}
that.x = s;
};
// south
_traverse[1].width = function(that,n,callback){
var s = that.x, e = s-n;
for (;that.x > e;that.x--){
callback();
}
that.x = s;
};
_traverse[1].depth = _traverse[0].width;
// west
_traverse[2].width = function(that,n,callback){
var s = that.z, e = s-n;
for (;that.z > e;that.z--){
callback();
}
that.z = s;
};
_traverse[2].depth = _traverse[1].width;
// north
_traverse[3].width = _traverse[0].depth;
_traverse[3].depth = _traverse[2].width;
_traverseHeight = function(that,n,callback){
var s = that.y, e = s + n;
for (; that.y < e; that.y++){
callback();
}
that.y = s;
};
ScriptCraft.Drone = Drone; ScriptCraft.Drone = Drone;
}()); }());
var Drone = ScriptCraft.Drone; Drone = ScriptCraft.Drone;
drone = new Drone(); drone = new Drone();