Created WorldEdit + FAWE mask list (markdown)

Jesse Boyd 2016-09-25 04:47:46 +10:00
parent a179f80512
commit fbe3f636d7

@ -0,0 +1,56 @@
# Masks
A mask is a restriction on an edit e.g. only replace blocks below stone. Global masks apply to all edits, brush masks apply to just the current brush.
#### `//gmask [mask]`
Perm: `worldedit.global-mask`
Desc: Set the global mask
#### `//mask [masks...]`
Perm: `worldedit.brush.options.mask`
Desc: Set the brush mask (separate multiple masks by spaces)
## List of masks
#### Simple masks
`#existing`: Allow any non air blocks
`#solid`: Allow any solid block
`#selection`: Restrict to current selection
`#dselection`: Same as `#selection`
`#xaxis`: Restrict to initial x-axis
`#yaxis`: Restrict to initial y-axis
`#zaxis`: Restrict to initial z-axis
`#id`: Restrict to initial id
`#data`: Restrict to initial data
`#iddata`: Restrict to initial id and data
#### Block mask `[blocks]`
Example: `stone,wood`
Explanation: Allows any block which is already stone or wood
#### Angle mask `/[min],[max]`
Example: `/-20,-5
Explanation: Allows any block where the adjacent block is between 20 and 5 blocks below
#### Radius mask `{[min],[max]`
Example: `{5,20`
Explanation: Restricts blocks to within a specific radius range of the initial block
#### Adjacent mask `~[pattern]`
Example `~stone,wood`
Explanation: Allows any block if it is adjacent to stone or wood
#### Below mask `<[pattern]`
Example: `<stone`
Explanation: Allows any block directly beneath stone
#### Above mask `>[pattern]`
Example: `>stone`
Explanation: Allows any block directly above stone
#### Biome mask `$[biome]`
Example: `$FOREST`
Explanation: Restricts to the specified biome
#### Random mask `%[chance]`
Example: `%34`
Explanation: 34% chance any block is allowed
#### Negate mask
Example: `!<stone`
Explanation: Can negate any mask, this will allow any block not below stone
#### Expression mask `=[expression]`
Example: `=abs(z+1)%2-abs(x)%2`
Explanation: Restricts to blocks where x and z coords are even numbers.
## Registering a mask through the API
```Java
FaweAPI.registerMask(yourCustomMask);
```