Skip to content

Commit c2e47e9

Browse files
duplexsystemduplexsystem
authored
Merge pull request #45 from DeathShadez/terrascript
TerraScript | Convert Simple Tables to Grid Tables
2 parents 885bd5b + c1ac981 commit c2e47e9

File tree

1 file changed

+87
-54
lines changed

1 file changed

+87
-54
lines changed

‎docs/config/documentation/terrascript/functions.rst

Lines changed: 87 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,18 @@ recommended to avoid ``getBlock`` in regular structures, and use
6666

6767
Arguments:
6868

69-
========= ======= ==========================================
70-
Parameter Type Description
71-
========= ======= ==========================================
72-
``x`` ``num`` X coordinate (relative to origin) to check
73-
``y`` ``num`` Y coordinate (relative to origin) to check
74-
``z`` ``num`` Z coordinate (relative to origin) to check
75-
========= ======= ==========================================
69+
+------------------------+---------------+-------------------------------+
70+
| Parameter | Type | Description |
71+
+========================+===============+===============================+
72+
| ``x`` | ``num`` | X coordinate (relative to |
73+
| | | origin) to check |
74+
+------------------------+---------------+-------------------------------+
75+
| ``y`` | ``num`` | Y coordinate (relative to |
76+
| | | origin) to check |
77+
+------------------------+---------------+-------------------------------+
78+
| ``z`` | ``num`` | Z coordinate (relative to |
79+
| | | origin) to check |
80+
+------------------------+---------------+-------------------------------+
7681

7782
Returns: ``STRING`` - The type of the location at the parameter
7883
coordinates, added to the structure origin. **Must** be one of the following:
@@ -136,11 +141,11 @@ The randomInt function returns a random value within a range.
136141

137142
Arguments:
138143

139-
========= ======= =========================
140-
Parameter Type Description
141-
========= ======= =========================
142-
``range`` ``num`` Maximum value (exclusive)
143-
========= ======= =========================
144+
+------------------------+---------------+-----------------------------+
145+
| Parameter | Type | Description |
146+
+========================+===============+=============================+
147+
| ``range`` | ``num`` | Maximum value (exclusive) |
148+
+------------------------+---------------+-----------------------------+
144149

145150
Returns: ``NUMBER`` - A random integer (whole number) between ``0``
146151
(inclusive) and ``range`` (exclusive).
@@ -189,14 +194,21 @@ Setting a mark that already exists will overwrite it with a new value.
189194

190195
Arguments:
191196

192-
=========== ======= =============================================
193-
Parameter Type Description
194-
=========== ======= =============================================
195-
``x`` ``num`` X coordinate (relative to origin) to set mark
196-
``y`` ``num`` Y coordinate (relative to origin) to set mark
197-
``z`` ``num`` Z coordinate (relative to origin) to set mark
198-
``content`` ``str`` Content of the mark to place
199-
=========== ======= =============================================
197+
+------------------------+---------------+-----------------------------+
198+
| Parameter | Type | Description |
199+
+========================+===============+=============================+
200+
| ``x`` | ``num`` | X coordinate (relative to |
201+
| | | origin) to set mark |
202+
+------------------------+---------------+-----------------------------+
203+
| ``y`` | ``num`` | Y coordinate (relative to |
204+
| | | origin) to set mark |
205+
+------------------------+---------------+-----------------------------+
206+
| ``z`` | ``num`` | Z coordinate (relative to |
207+
| | | origin) to set mark |
208+
+------------------------+---------------+-----------------------------+
209+
| ``content`` | ``str`` | Content of the mark |
210+
| | | to place |
211+
+------------------------+---------------+-----------------------------+
200212

201213
Returns: ``VOID``
202214

@@ -221,13 +233,18 @@ recursions.
221233

222234
Arguments:
223235

224-
========= ======= ===============================================
225-
Parameter Type Description
226-
========= ======= ===============================================
227-
``x`` ``num`` X coordinate (relative to origin) to check mark
228-
``y`` ``num`` Y coordinate (relative to origin) to check mark
229-
``z`` ``num`` Z coordinate (relative to origin) to check mark
230-
========= ======= ===============================================
236+
+------------------------+---------------+-----------------------------+
237+
| Parameter | Type | Description |
238+
+========================+===============+=============================+
239+
| ``x`` | ``num`` | X coordinate (relative to |
240+
| | | origin) to check mark |
241+
+------------------------+---------------+-----------------------------+
242+
| ``y`` | ``num`` | Y coordinate (relative to |
243+
| | | origin) to check mark |
244+
+------------------------+---------------+-----------------------------+
245+
| ``z`` | ``num`` | Z coordinate (relative to |
246+
| | | origin) to check mark |
247+
+------------------------+---------------+-----------------------------+
231248

232249
Returns: ``STRING`` - The content of the mark at the location. Returns
233250
``""`` (empty string) if the mark is empty or not present.
@@ -330,13 +347,18 @@ The getBiome function gets the Terra biome at a location.
330347

331348
Arguments:
332349

333-
========= ======= ================================================
334-
Parameter Type Description
335-
========= ======= ================================================
336-
``x`` ``num`` X coordinate (relative to origin) to check biome
337-
``y`` ``num`` Y coordinate (relative to origin) to check biome
338-
``z`` ``num`` Z coordinate (relative to origin) to check biome
339-
========= ======= ================================================
350+
+------------------------+---------------+-----------------------------+
351+
| Parameter | Type | Description |
352+
+========================+===============+=============================+
353+
| ``x`` | ``num`` | X coordinate (relative to |
354+
| | | origin) to check biome |
355+
+------------------------+---------------+-----------------------------+
356+
| ``y`` | ``num`` | Y coordinate (relative to |
357+
| | | origin) to check biome |
358+
+------------------------+---------------+-----------------------------+
359+
| ``z`` | ``num`` | Z coordinate (relative to |
360+
| | | origin) to check biome |
361+
+------------------------+---------------+-----------------------------+
340362

341363
Returns: ``STRING`` - The ID of the biome, E.G. ``"ARID_MOUNTAINS"``.
342364

@@ -355,13 +377,18 @@ cause cascading chunk loading whenever a structure generates. **Use the
355377

356378
Arguments:
357379

358-
========= ======= ================================================
359-
Parameter Type Description
360-
========= ======= ================================================
361-
``x`` ``num`` X coordinate (relative to origin) to check block
362-
``y`` ``num`` Y coordinate (relative to origin) to check block
363-
``z`` ``num`` Z coordinate (relative to origin) to check block
364-
========= ======= ================================================
380+
+------------------------+---------------+-----------------------------+
381+
| Parameter | Type | Description |
382+
+========================+===============+=============================+
383+
| ``x`` | ``num`` | X coordinate (relative to |
384+
| | | origin) to check block |
385+
+------------------------+---------------+-----------------------------+
386+
| ``y`` | ``num`` | Y coordinate (relative to |
387+
| | | origin) to check block |
388+
+------------------------+---------------+-----------------------------+
389+
| ``z`` | ``num`` | Z coordinate (relative to |
390+
| | | origin) to check block |
391+
+------------------------+---------------+-----------------------------+
365392

366393
Returns: ``STRING`` - The ID of the block, without properties, E.G.
367394
``"minecraft:stone"``.
@@ -385,14 +412,20 @@ read:
385412

386413
Arguments:
387414

388-
========= ======= ==========================================
389-
Parameter Type Description
390-
========= ======= ==========================================
391-
``x`` ``num`` X coordinate (relative to origin) of block
392-
``y`` ``num`` Y coordinate (relative to origin) of block
393-
``z`` ``num`` Z coordinate (relative to origin) of block
394-
``data`` ``str`` Data to apply to block
395-
========= ======= ==========================================
415+
+------------------------+---------------+-----------------------------+
416+
| Parameter | Type | Description |
417+
+========================+===============+=============================+
418+
| ``x`` | ``num`` | X coordinate (relative to |
419+
| | | origin) of block |
420+
+------------------------+---------------+-----------------------------+
421+
| ``y`` | ``num`` | Y coordinate (relative to |
422+
| | | origin) of block |
423+
+------------------------+---------------+-----------------------------+
424+
| ``z`` | ``num`` | Z coordinate (relative to |
425+
| | | origin) of block |
426+
+------------------------+---------------+-----------------------------+
427+
| ``data`` | ``str`` | Data to apply to block |
428+
+------------------------+---------------+-----------------------------+
396429

397430
Returns: ``VOID``
398431

@@ -406,11 +439,11 @@ function, and as such will only work with debug mode enabled.
406439

407440
Arguments:
408441

409-
=========== ======= ===========================
410-
Parameter Type Description
411-
=========== ======= ===========================
412-
``message`` ``str`` Message to print to console
413-
=========== ======= ===========================
442+
+------------------------+---------------+-----------------------------+
443+
| Parameter | Type | Description |
444+
+========================+===============+=============================+
445+
| ``message`` | ``str`` | Message to print to console |
446+
+------------------------+---------------+-----------------------------+
414447

415448
Returns: ``VOID``
416449

0 commit comments

Comments
 (0)