From 67f84d7b5ed04cf000a85487a5739a41a2f9ce8a Mon Sep 17 00:00:00 2001 From: Walter Higgins Date: Fri, 23 Dec 2016 09:27:40 +0000 Subject: [PATCH] Documenting Drone.MAX_SIDE and Drone.MAX_VOLUME --- docs/API-Reference.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/docs/API-Reference.md b/docs/API-Reference.md index 83385bc..900c8cd 100644 --- a/docs/API-Reference.md +++ b/docs/API-Reference.md @@ -3722,7 +3722,7 @@ Alternatively if you provide just a function as a parameter, then the function n // submitted by [edonaldson][edonaldson] var Drone = require('drone'); - Drone.extend('pyramid', function( block,height) { + 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(); @@ -3733,7 +3733,7 @@ Alternatively if you provide just a function as a parameter, then the function n #### Example 2 Using just a named function as a parameter var Drone = require('drone'); - function pyramid( block,height) { + function pyramid( block, height ) { this.chkpt('pyramid'); for ( var i = height; i > 0; i -= 2) { this.box(block, i, 1, i).up().right().fwd(); @@ -3791,6 +3791,22 @@ 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.MAX_SIDE + +Specifies the maximum length (in any dimension) when calling the Drone.cuboidX (box) method. +The default value is 1,000 blocks. + +If you see an error message in the console `Build too big!` It's because the width, height or length paramete was greater than the Drone.MAX_SIDE value. + +#### Drone.MAX_VOLUME + +Specifies the maximum value for any call to Drone.cuboidX (box) method. +The default value is 1,000,000 (1 million) blocks. + +If the volume (width X height X length) of any single call to the Drone.cuboidX() method exceeds this value, you will see an error message in the console `Build too big!` . + +The values of both the `Drone.MAX_SiDE` and `Drone.MAX_VOLUME` variables _can_ be overridden but it's not recommended. + ### Drone.times() Method The `times()` method makes building multiple copies of buildings