Skip to content

WorldEdit FAWE mask list

Jesse Boyd edited this page Dec 15, 2016 · 16 revisions

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.

Separating masks by spaces ( ) or colons (:) uses the intersection of all masks (all of them must be true). Separating masks by commans (,) uses the union of the masks, and only one has to be true.

//gmask [masks...]

Perm: worldedit.global-mask Desc: The global destination mask applies to all edits you do and masks based on the destination blocks (i.e. the blocks in the world).

//gsmask [masks...]

Perm: worldedit.global-mask
Desc: The global source mask applies to all edits you do and masks based on the source blocks (e.g. the blocks in your clipboard)

//mask [masks...]

Perm: worldedit.brush.options.mask
Desc: Set the brush destination mask

//smask [masks...]

Perm: worldedit.brush.options.mask
Desc: Set the brush source mask

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
#wall: Restrict to walls (any block n,e,s,w of air)
#surface: Restrict to surfaces (any block touching air)
#nolight: Restrict to blocks without light (sky or emitted)
#haslight: Restricts to blocks with light (sky or emitted)

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][=min[:max]]

Example ~stone:wood
Explanation: Allows any block if it is adjacent to stone or wood Example: ~bedrock=2:4 Explanation: Allows any block if it is adjacent to between 2 and 4 bedrock

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.
Info: http://wiki.sk89q.com/wiki/WorldEdit/Expression_syntax

offset mask

Example: #offset:1:0:0:stone Explanation: Requires the block to the east to be stone

Light masks

  • #light:<min>:<max>
  • #skylight:<min>:<max>
  • #blocklight:<min>:<max>
  • #opacity:<min>:<max>
  • #brightness:<min>:<max>

Registering a mask through the API

FaweAPI.registerMask(yourCustomMask);