doc updates

This commit is contained in:
VorTechnix 2024-09-17 16:19:05 -07:00
parent 753ead2102
commit ea25e36f3c
No known key found for this signature in database
GPG Key ID: 091E91A69545D5BA
2 changed files with 26 additions and 28 deletions

@ -1130,17 +1130,17 @@ This command is intended for debugging and development purposes, but if you're i
--> -->
### Unified Axis Syntax (UAS) ### Unified Axis Syntax (UAS)
The Unified Axis Syntax system allows users to input direction and distance information in three dimensions using "natural" language. The key features include axis clumping, double negatives, relative directions, mirroring and compass directions (more information below). The Unified Axis Syntax system allows users to input direction and distance information in three dimensions using "natural" measurement syntax. The key features include axis clumping, double negatives, relative directions, mirroring and compass directions (more information below).
*Note: negatives can be applied to axes, directions **AND** distances* *Note: negatives can be applied to axes, directions **AND** distances*
#### Relative Directions #### Relative Directions
|Key Words | Interpretation| |Key Words | Interpretation|
|----------|---------------| |----------|---------------|
|f[ront]\|facing\|? | The direction the player is facing most toward in the world |`f[ront]\|facing\|?` | The direction the player is facing most toward in the world
|b[ack]\|behind\|rear | The opposite of the direction the player is facing most toward in the world |`b[ack]\|behind\|rear` | The opposite of the direction the player is facing most toward in the world
|l[eft] | The direction to the left of the player |`l[eft]` | The direction to the left of the player
|r[ight] | The direction to the right of the player |`r[ight]` | The direction to the right of the player
```weacmd ```weacmd
back 1 back 1
@ -1151,12 +1151,12 @@ f r 4
#### Compass Directions #### Compass Directions
|Key Words | Interpretation| |Key Words | Interpretation|
|----------|---------------| |----------|---------------|
|n[orth] | z |`n[orth]` | z
|s[outh] | -z |`s[outh]` | -z
|e[ast] | x |`e[ast]` | x
|w[est] | -x |`w[est]` | -x
|u[p] | y |`u[p]` | y
|d[own] | -y |`d[own]` | -y
```weacmd ```weacmd
south 3 south 3
@ -1167,23 +1167,19 @@ e d -2
#### Axis Clumping #### Axis Clumping
Supported axes are `x`, `y`, `z`, `h`, `v`. All horizontal axes are covered by `h` and both vertical ones are covered by `v`. Supported axes are `x`, `y`, `z`, `h`, `v`. All horizontal axes are covered by `h` and both vertical ones are covered by `v`.
```weacmd - `h 5` == `xz -xz 5` == `x 5 z 5 x -5 z -5`
h 5 == xz -xz 5 == x 5 z 5 x -5 z -5 - `v 5` == `up down 5` == `y -y 5`
v 5 == up down 5 == y -y 5 - `vxz 5` == `xyz -y 5` == `xyz 5 y -5`
vxz 5 == xyz -y 5 == xyz 5 y -5
```
#### Inference and Omnidirectionality #### Inference and Omnidirectionality
The UAK parser takes command input that is split by whitespace and interprets it as a series of values preceded by directional cues. If a number is preceded by another number or nothing it assumes that the number is to be applied on all axes in both positive and negative directions. The UAS parser takes command input that is split by whitespace and interprets it as a series of numbers preceded by directional cues. If a number is preceded by another number or nothing it assumes that the number is to be applied on all axes in both positive and negative directions.
```weacmd - `10` == `hv 10` == `xyz -xyz 10`
10 == hv 10 == xyz -xyz 10 - `x 3 6` == `x 3 hv 6`
x 3 6 == x 3 hv 6
```
From the above examples you can also see the principle of inference. All direction modifiers before a value are interpreted as belonging to that value. So `x v 5` is equivalent to `x 5 v 5` and `xv 5`. From the above examples you can also see the principle of inference. All direction modifiers before a value are interpreted as belonging to that value. So `x v 5` is equivalent to `x 5 v 5` and `xv 5`.
Because UAK attempts to parse "natural" language, there are many ways to express the same direction and distance. This caters to users with different ways of thinking and different play styles which will hopefully make the tools easier to use. Because UAS parses "natural" measurement syntax, there are many ways to express the same direction and distance. This caters to users with different ways of thinking and different play styles which will hopefully make the tools easier to use.
### `//unmark` ### `//unmark`
Hides the in-game UI that indicates where the current positions and region are located. Hides the in-game UI that indicates where the current positions and region are located.

@ -75,18 +75,20 @@ The detailed explanations have moved! Check them out [here](https://worldeditadd
- [`//ngroups <node_name> [v[erbose]]`](https://worldeditadditions.mooncarrot.space/Reference/#ngroups) - [`//ngroups <node_name> [v[erbose]]`](https://worldeditadditions.mooncarrot.space/Reference/#ngroups)
### Selection ### Selection
- [`//scol [<axis1> ] <length>`](https://worldeditadditions.mooncarrot.space/Reference/#scol) - [~~`//scol`~~ DEPRECATED](https://worldeditadditions.mooncarrot.space/Reference/#scol)
- [`//srect [<axis1> [<axis2>]] <length>`](https://worldeditadditions.mooncarrot.space/Reference/#srect) - [~~`//srect`~~ DEPRECATED](https://worldeditadditions.mooncarrot.space/Reference/#srect)
- [`//scube [<axis1> [<axis2> [<axis3>]]] <length>`](https://worldeditadditions.mooncarrot.space/Reference/#scube) - [~~`//scube`~~ DEPRECATED](https://worldeditadditions.mooncarrot.space/Reference/#scube)
- [`//scloud <0-6|stop|reset>`](https://worldeditadditions.mooncarrot.space/Reference/#scloud) - [`//scloud <0-6|stop|reset>`](https://worldeditadditions.mooncarrot.space/Reference/#scloud)
- [`//scentre`](https://worldeditadditions.mooncarrot.space/Reference/#scentre) - [`//scentre`](https://worldeditadditions.mooncarrot.space/Reference/#scentre)
- [`//srel <axis1> <length1> [<axis2> <length2> [<axis3> <length3>]]`](https://worldeditadditions.mooncarrot.space/Reference/#srel) - [`//sgrow <unified axis syntax>`](https://worldeditadditions.mooncarrot.space/Reference/#sgrow)
- [`//srel <unified axis syntax>`](https://worldeditadditions.mooncarrot.space/Reference/#srel)
- [`//smake <operation:odd|even|equal> <mode:grow|shrink|average> [<target=xz> [<base>]]`](https://worldeditadditions.mooncarrot.space/Reference/#smake) - [`//smake <operation:odd|even|equal> <mode:grow|shrink|average> [<target=xz> [<base>]]`](https://worldeditadditions.mooncarrot.space/Reference/#smake)
- [`//sshrink <unified axis syntax>`](https://worldeditadditions.mooncarrot.space/Reference/#sshrink)
- [`//sstack`](https://worldeditadditions.mooncarrot.space/Reference/#sstack) - [`//sstack`](https://worldeditadditions.mooncarrot.space/Reference/#sstack)
- [`//spush`](https://worldeditadditions.mooncarrot.space/Reference/#spush) - [`//spush`](https://worldeditadditions.mooncarrot.space/Reference/#spush)
- [`//spop`](https://worldeditadditions.mooncarrot.space/Reference/#spop) - [`//spop`](https://worldeditadditions.mooncarrot.space/Reference/#spop)
- [`//sshift <axis1> <length1> [<axis2> <length2> [<axis3> <length3>]]`](https://worldeditadditions.mooncarrot.space/Reference/#sshift) - [`//sshift <unified axis syntax>`](https://worldeditadditions.mooncarrot.space/Reference/#sshift)
- [`//sfactor <mode:grow|shrink|average> <factor> [<target=xz>]`](https://worldeditadditions.mooncarrot.space/Reference/#sfactor) - [~~`//sfactor`~~ DEPRECATED](https://worldeditadditions.mooncarrot.space/Reference/#sfactor)
- [`//pos <index>`](https://worldeditadditions.mooncarrot.space/Reference/#pos) - [`//pos <index>`](https://worldeditadditions.mooncarrot.space/Reference/#pos)
- [`//pos1`](https://worldeditadditions.mooncarrot.space/Reference/#pos1) - [`//pos1`](https://worldeditadditions.mooncarrot.space/Reference/#pos1)
- [`//pos2`](https://worldeditadditions.mooncarrot.space/Reference/#pos2) - [`//pos2`](https://worldeditadditions.mooncarrot.space/Reference/#pos2)