Document hand, offhand, and pos1 patterns#73
Conversation
|
|
||
| //set ##*slabs | ||
|
|
||
| Hand and Offhand Patterns |
There was a problem hiding this comment.
These aren't separate patterns, but are part of "Single Block Pattern", so they should go under that section. We can probably just call them "hand"/"offhand" without the "pattern" after.
There was a problem hiding this comment.
Thanks for the feedback. I updated it to move the hand, offhand, and pos1 values under the "single block" section and added a link to the Selecting Cuboids docs.
|
|
||
| //set offhand | ||
|
|
||
| Pos1 Pattern |
| Pos1 Pattern | ||
| ------------ | ||
|
|
||
| The ``pos1`` pattern uses the block at your primary selection point (set with ``//pos1`` or the selection wand). This lets you use a block already in the world as your pattern without having to look up its name or states. |
There was a problem hiding this comment.
Can we link to the "Selecting Cuboids" section here?
octylFractal
left a comment
octylFractal
left a comment
There was a problem hiding this comment.
Looks good, one extra thing that could be added. We also need to fix the docs build so I can double-check what this looks like, but we'll do that separately.
|
|
||
| The most basic pattern of just a single block. A block is identified by three parts: the `block type <https://minecraft.wiki/w/Java_Edition_data_values#IDs>`_, additional `block states <https://minecraft.wiki/w/Block_states>`_, and `nbt data <https://minecraft.wiki/w/NBT_format>`_. These three links to the Minecraft Wiki, along with WorldEdit's in-built tab-completion for commands, should guide you in specifying the block you want. Additional states are always appended to the type using the syntax ``block_type[state1=value,state2=value,...]``. Note that when states are not specified, or if some are left out, the default values will be used for those states. NBT is written using Minecraft's SNBT syntax, ``block_type{'nbt_key':'value'}``. NBT data always comes after the block states if supplied, ``block_type[property=value]{'nbt_key':'value'}``. | ||
|
|
||
| Instead of specifying a block type directly, you can use ``hand`` or ``offhand`` to use the block held in your main hand or offhand respectively. This is useful when you already have the block you want to use in your hotbar. The block type and states are taken from the item you are holding, where applicable. |
There was a problem hiding this comment.
It's probably also worth mentioning that setting states and NBT still works with this.
This is done now, if you don't mind rebasing when you add the extra thing I mentioned. |
2 participants
This pull requests adds documentation for the hand, offhand, and pos1 patterns.
Closes #72