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

Further testing and tweaking of Documentation.

Browse source
This commit is contained in:
walterhiggins 2014-12-30 18:12:10 +00:00
parent 1a0b71f92e
commit e388cdbc8e
3 changed files with 42 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
docs/API-Reference.md
View file

@ -4265,21 +4265,21 @@ Construct a rainbow-colored road 100 blocks long...
All of the Drone methods return a Drone object, which means methods can be 'chained' together so instead of writing this... All of the Drone methods return a Drone object, which means methods can be 'chained' together so instead of writing this...
drone = new Drone(); drone = new Drone( self );
drone.fwd( 3 ); drone.fwd( 3 );
drone.left( 2 ); drone.left( 2 );
drone.box(2); // create a grass block drone.box( blocks.grass ); // create a grass block
drone.up(); drone.up();
drone.box(2); // create another grass block drone.box( blocks.grass ); // create another grass block
drone.down(); drone.down();
...you could simply write ... ...you could simply write ...
var drone = new Drone().fwd(3).left(2).box(2).up().box(2).down(); 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... ... 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(2).up().box(2).down() 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() 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()
@ -4331,7 +4331,7 @@ Alternatively if you provide just a function as a parameter, then the function n
Once the method is defined (it can be defined in a new pyramid.js file) it can be used like so... 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(); var d = new Drone(self);
d.pyramid(blocks.brick.stone, 12); d.pyramid(blocks.brick.stone, 12);
... or simply ... ... or simply ...
@ -4346,7 +4346,7 @@ Once the method is defined (it can be defined in a new pyramid.js file) it can b
An array which can be used when constructing stairs facing in the Drone's direction... An array which can be used when constructing stairs facing in the Drone's direction...
var d = new Drone(); var d = new Drone(self);
d.box(blocks.stairs.oak + ':' + Drone.PLAYER_STAIRS_FACING[d.dir]); d.box(blocks.stairs.oak + ':' + Drone.PLAYER_STAIRS_FACING[d.dir]);
... will construct a single oak stair block facing the drone. ... will construct a single oak stair block facing the drone.
@ -4360,16 +4360,24 @@ An array which can be used when placing signs so they face in a given direction.
* furnace * furnace
* dispenser * dispenser
To place a chest facing the Drone ... 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 + ':' + Drone.PLAYER_SIGN_FACING[drone.dir]); 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 #### Drone.PLAYER_TORCH_FACING
Used when placing torches so that they face towards the drone. 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]); 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]);
### Drone.times() Method ### Drone.times() Method
The times() method makes building multiple copies of buildings The times() method makes building multiple copies of buildings

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

@ -48,7 +48,7 @@ function fort( side, height ) {
this this
.box( blocks.brick.stone ) // solid brick corners .box( blocks.brick.stone ) // solid brick corners
.up() .up()
.box(blocks.torch + ':5') .box(blocks.torch)
.down() // light a torch on each corner .down() // light a torch on each corner
.fwd() .fwd()
.boxa( turret, 1, 1, side-2) .boxa( turret, 1, 1, side-2)

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

@ -164,21 +164,21 @@ Construct a rainbow-colored road 100 blocks long...
All of the Drone methods return a Drone object, which means methods can be 'chained' together so instead of writing this... All of the Drone methods return a Drone object, which means methods can be 'chained' together so instead of writing this...
drone = new Drone(); drone = new Drone( self );
drone.fwd( 3 ); drone.fwd( 3 );
drone.left( 2 ); drone.left( 2 );
drone.box(2); // create a grass block drone.box( blocks.grass ); // create a grass block
drone.up(); drone.up();
drone.box(2); // create another grass block drone.box( blocks.grass ); // create another grass block
drone.down(); drone.down();
...you could simply write ... ...you could simply write ...
var drone = new Drone().fwd(3).left(2).box(2).up().box(2).down(); 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... ... 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(2).up().box(2).down() 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() 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()
@ -230,7 +230,7 @@ Alternatively if you provide just a function as a parameter, then the function n
Once the method is defined (it can be defined in a new pyramid.js file) it can be used like so... 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(); var d = new Drone(self);
d.pyramid(blocks.brick.stone, 12); d.pyramid(blocks.brick.stone, 12);
... or simply ... ... or simply ...
@ -245,7 +245,7 @@ Once the method is defined (it can be defined in a new pyramid.js file) it can b
An array which can be used when constructing stairs facing in the Drone's direction... An array which can be used when constructing stairs facing in the Drone's direction...
var d = new Drone(); var d = new Drone(self);
d.box(blocks.stairs.oak + ':' + Drone.PLAYER_STAIRS_FACING[d.dir]); d.box(blocks.stairs.oak + ':' + Drone.PLAYER_STAIRS_FACING[d.dir]);
... will construct a single oak stair block facing the drone. ... will construct a single oak stair block facing the drone.
@ -259,16 +259,24 @@ An array which can be used when placing signs so they face in a given direction.
* furnace * furnace
* dispenser * dispenser
To place a chest facing the Drone ... 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 + ':' + Drone.PLAYER_SIGN_FACING[drone.dir]); 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 #### Drone.PLAYER_TORCH_FACING
Used when placing torches so that they face towards the drone. 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]); 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]);
***/ ***/
// //
@ -310,12 +318,8 @@ function putBlock( x, y, z, blockId, metadata, world, dir ) {
if ( typeof metadata == 'undefined' ) { if ( typeof metadata == 'undefined' ) {
metadata = 0; metadata = 0;
} }
var block = world.getBlockAt( x, y, z ), var block = world.getBlockAt( x, y, z );
placed = false;
if (block.typeId === blockId && block.data === metadata) {
return;
}
if (__plugin.canary) { if (__plugin.canary) {
var BlockType = Packages.net.canarymod.api.world.blocks.BlockType; var BlockType = Packages.net.canarymod.api.world.blocks.BlockType;
block.type = BlockType.fromId(blockId); block.type = BlockType.fromId(blockId);