Merge docs for 'set can now accept map of properties.'
This commit is contained in:
1 parent
5280cda3ee
commit
67c41025b1
1 file changed
+15
-10
+15
-10
@@ -2072,18 +2072,19 @@ print(b); // 'stone', block was evaluated 'eagerly' but call to `block`
|
|||||||
All the functions below can be used with block value, queried with coord triple, or 3-long list. All `pos` in the
|
All the functions below can be used with block value, queried with coord triple, or 3-long list. All `pos` in the
|
||||||
functions referenced below refer to either method of passing block position.
|
functions referenced below refer to either method of passing block position.
|
||||||
|
|
||||||
### `set(pos, block, property?, value?, ..., block_data?)`, `set(pos, block, l(property?, value?, ...), block_data?)`
|
### `set(pos, block, property?, value?, ..., block_data?)`, `set(pos, block, [property?, value?, ...], block_data?)`, `set(pos, block, {property? -> value?, ...}, block_data?)`
|
||||||
|
|
||||||
First part of the `set` function is either a coord triple, list of three numbers, or other block with coordinates.
|
First argument for the `set` function is either a coord triple, list of three numbers, or a world localized block value.
|
||||||
Second part, `block` is either block value as a result of `block()` function string value indicating the block name,
|
Second argument, `block`, is either an existing block value, a result of `block()` function, or a string value indicating the block name
|
||||||
and optional `property - value` pairs for extra block properties. Optional `block_data` include the block data to
|
with optional state and block data. It is then followed by an optional
|
||||||
|
`property - value` pairs for extra block state (which can also be provided in a list or a map). Optional `block_data` include the block data to
|
||||||
be set for the target block.
|
be set for the target block.
|
||||||
|
|
||||||
If `block` is specified only by name, then if a
|
If `block` is specified only by name, then if a
|
||||||
destination block is the same the `set` operation is skipped, otherwise is executed, for other potential extra
|
destination block is the same the `set` operation is skipped, otherwise is executed, for other potential extra
|
||||||
properties.
|
properties that the original source block may have contained.
|
||||||
|
|
||||||
The returned value is either the block state that has been set, or `false` if block setting was skipped
|
The returned value is either the block state that has been set, or `false` if block setting was skipped, or failed
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
set(0,5,0,'bedrock') => bedrock
|
set(0,5,0,'bedrock') => bedrock
|
||||||
@@ -2099,11 +2100,15 @@ scan(0,100,0,20,20,20,set(_,block('glass')))
|
|||||||
b = block('glass'); scan(0,100,0,20,20,20,set(_,b))
|
b = block('glass'); scan(0,100,0,20,20,20,set(_,b))
|
||||||
// yet another option, skips all parsing
|
// yet another option, skips all parsing
|
||||||
set(x,y,z,'iron_trapdoor') // sets bottom iron trapdoor
|
set(x,y,z,'iron_trapdoor') // sets bottom iron trapdoor
|
||||||
set(x,y,z,'iron_trapdoor[half=top]') // Incorrect. sets bottom iron trapdoor - no parsing of properties
|
|
||||||
set(x,y,z,'iron_trapdoor','half','top') // correct - top trapdoor
|
set(x,y,z,'iron_trapdoor[half=top]') // sets the top trapdoor
|
||||||
set(x,y,z, block('iron_trapdoor[half=top]')) // also correct, block() provides extra parsing
|
set(x,y,z,'iron_trapdoor','half','top') // also correct - top trapdoor
|
||||||
|
set(x,y,z,'iron_trapdoor', ['half','top']) // same
|
||||||
|
set(x,y,z,'iron_trapdoor', {'half' -> 'top'}) // same
|
||||||
|
set(x,y,z, block('iron_trapdoor[half=top]')) // also correct, block() provides extra parsing of block state
|
||||||
|
|
||||||
set(x,y,z,'hopper[facing=north]{Items:[{Slot:1b,id:"minecraft:slime_ball",Count:16b}]}') // extra block data
|
set(x,y,z,'hopper[facing=north]{Items:[{Slot:1b,id:"minecraft:slime_ball",Count:16b}]}') // extra block data
|
||||||
set(x,y,z,'hopper', l('facing', 'north'), nbt('{Items:[{Slot:1b,id:"minecraft:slime_ball",Count:16b}]}') ) // same
|
set(x,y,z,'hopper', {'facing' -> 'north'}, nbt('{Items:[{Slot:1b,id:"minecraft:slime_ball",Count:16b}]}') ) // same
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
### `without_updates(expr)`
|
### `without_updates(expr)`
|
||||||
|
|||||||
Reference in new issue
Block a user