fabric-carpet/docs/scarpet/api/BlocksAndWorldAccess.md

Blocks / World API

Specifying blocks

block(x, y, z), block(l(x,y,z)), block(state)

Returns either a block from specified location, or block with a specific state (as used by /setblock command), so allowing for block properties, block entity data etc. Blocks otherwise can be referenced everywhere by its simple string name, but its only used in its default state.

block('air')  => air
block('iron_trapdoor[half=top]')  => iron_trapdoor
block(0,0,0) == block('bedrock')  => 1
block('hopper[facing=north]{Items:[{Slot:1b,id:"minecraft:slime_ball",Count:16b}]}') => hopper

Retrieving a block with block function has also a side-effect of evaluating its current state and data. So if you use it later it will reflect block state and data of the block that was when block was called, rather than when it was used. Block values passed in various places like scan functions, etc, are not fully evaluated unless its properties are needed. This means that if the block at the location changes before its queried in the program this might result in getting the later state, which might not be desired. Consider the following example:

set(10,10,10,'stone');
scan(10,10,10,0,0,0, b = _);
set(10,10,10,'air');
print(b); // 'air', block was remembered 'lazily', and evaluated by `print`, when it was already set to air
set(10,10,10,'stone');
scan(10,10,10,0,0,0, b = block(_));
set(10,10,10,'air');
print(b); // 'stone', block was evaluated 'eagerly' but call to `block`

World Manipulation

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.

set(pos, block, property?, value?, ...)

First part of the set function is either a coord triple, list of three numbers, or other block with coordinates. Second part, block is either block value as a result of block() function string value indicating the block name, and optional property - value pairs for extra block properties. 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 properties.

The returned value is either the block state that has been set, or false if block setting was skipped

set(0,5,0,'bedrock')  => bedrock
set(l(0,5,0), 'bedrock')  => bedrock
set(block(0,5,0), 'bedrock')  => bedrock
scan(0,5,0,0,0,0,set(_,'bedrock'))  => 1
set(pos(players()), 'bedrock')  => bedrock
set(0,0,0,'bedrock')  => 0   // or 1 in overworlds generated in 1.8 and before
scan(0,100,0,20,20,20,set(_,'glass'))
    // filling the area with glass
scan(0,100,0,20,20,20,set(_,block('glass')))
    // little bit faster due to internal caching of block state selectors
b = block('glass'); scan(0,100,0,20,20,20,set(_,b))
    // yet another option, skips all parsing
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, block('iron_trapdoor[half=top]')) // also correct, block() provides extra parsing
set(x,y,z,'hopper[facing=north]{Items:[{Slot:1b,id:"minecraft:slime_ball",Count:16b}]}') // extra block data

without_updates(expr)

Evaluates subexpression without causing updates when blocks change in the world

Consider following scenario: We would like to generate a bunch of terrain in a flat world following a perling noise generator. The following code causes cascading effect as blocks placed on chunk borders will cause other chunks to get loaded to full, thus generated:

__config() -> m(l('scope', 'global'));
__on_chunk_generated(x, z) -> (
  scan(x,0,z,0,0,0,15,15,15,
    if (perlin(_x/16, _y/8, _z/16) > _y/16,
      set(_, 'black_stained_glass');
    )
  )
)

The following addition resolves this issue, by not allowing block updates pass chunk borders:

__config() -> m(l('scope', 'global'));
__on_chunk_generated(x, z) -> (
  without_updates(
    scan(x,0,z,0,0,0,15,15,15,
      if (perlin(_x/16, _y/8, _z/16) > _y/16,
        set(_, 'black_stained_glass');
      )
    )
  )
)

place_item(item, pos, facing?, sneak?)

Places a given item in the world like it was placed by a player. Item names are default minecraft item name, less the minecraft prefix. Default facing is 'up', but there are other options: 'down', 'north', 'east', 'south', 'west', but also there are other secondary directions important for placement of blocks like stairs, doors, etc. Try experiment with options like 'north-up' which is placed facing north with cursor pointing to the upper part of the block, or 'up-north', which means a block placed facing up (player looking down) and placed smidge away of the block center towards north. Optional sneak is a boolean indicating if a player would be sneaking while placing the block - this option only affects placement of chests and scaffolding at the moment. Returns true if placement was successful, false otherwise.

place_item('stone',x,y,z) // places a stone block on x,y,z block
place_item('piston,x,y,z,'down') // places a piston facing down
place_item('carrot',x,y,z) // attempts to plant a carrot plant. Returns true if could place carrots at that position.

set_poi(pos, type, occupancy?)

Sets a Point of Interest (POI) of a specified type with optional custom occupancy. By default new POIs are not occupied. If type is null, POI at position is removed. In any case, previous POI is also removed. Available POI types are:

• 'unemployed', 'armorer', 'butcher', 'cartographer', 'cleric', 'farmer', 'fisherman', 'fletcher', 'leatherworker', 'librarian', 'mason', 'nitwit', 'shepherd', 'toolsmith', 'weaponsmith', 'home', 'meeting', 'beehive', 'bee_nest', 'nether_portal'

Interestingly, unemployed, and nitwit are not used in the game, meaning, they could be used as permanent spatial markers for scarpet apps. meeting is the only one with increased max occupancy of 32.

set_biome(pos, biome_name)

changes biome at that block position.

update(pos)

Causes a block update at position.

block_tick(pos)

Causes a block to tick at position.

random_tick(pos)

Causes a random tick at position.

destroy(pos), destroy(pos, -1), destroy(pos, <N>), destroy(pos, tool, nbt?)

Destroys the block like it was mined by a player. Add -1 for silk touch, and positive number for fortune level. If tool is specified, and optionally its nbt, it will use that tool and will attempt to mine the block with this tool. If called without item context, this function, unlike harvest, will affect all kinds of blocks. If called with item in context, it will fail to break blocks that cannot be broken by a survival player.

Without item context it returns false if failed to destroy the block and true if block breaking was successful. In item context, true means that breaking item has no nbt to use, null indicating that the tool should be considered broken in process, and nbt type value, for a resulting NBT tag on a hypothetical tool. Its up to the programmer to use that nbt to apply it where it belong

Here is a sample code that can be used to mine blocks using items in player inventory, without using player context for mining. Obviously, in this case the use of harvest would be much more applicable:

mine(x,y,z) ->
(
   p = player();
   slot = p~'selected_slot';
   item_tuple = inventory_get(p, slot);
   if (!item_tuple, destroy(x,y,z,'air'); return()); // empty hand, just break with 'air'
   l(item, count, tag) = item_tuple;
   tag_back = destroy(x,y,z, item, tag);
   if (tag_back == false, // failed to break the item
	     return(tag_back)
   );
   if (tag_back == true, // block broke, tool has no tag
	     return(tag_back)
   );
   if (tag_back == null, //item broke
	     delete(tag:'Damage');
	     inventory_set(p, slot, count-1, item, tag);
	     return(tag_back)
   );
   if (type(tag_back) == 'nbt', // item didn't break, here is the effective nbt
	     inventory_set(p, slot, count, item, tag_back);
	     return(tag_back)
   );
   print('How did we get here?');
)

harvest(player, pos)

Causes a block to be harvested by a specified player entity. Honors player item enchantments, as well as damages the tool if applicable. If the entity is not a valid player, no block gets destroyed. If a player is not allowed to break that block, a block doesn't get destroyed either.

Block and World querying

pos(block), pos(entity)

Returns a triple of coordinates of a specified block or entity. Technically entities are queried with query function and the same can be achieved with query(entity,'pos'), but for simplicity pos allows to pass all positional objects.

pos(block(0,5,0))  => l(0,5,0)
pos(players()) => l(12.3, 45.6, 32.05)
pos(block('stone'))  => Error: Cannot fetch position of an unrealized block

pos_offset(pos, direction, amount?)

Returns a coords triple that is offset in a specified direction by amount of blocks. The default offset amount is 1 block. To offset into opposite facing, use negative numbers for the amount.

pos_offset(block(0,5,0), 'up', 2)  => l(0,7,0)
pos_offset(l(0,5,0), 'up', -2 ) => l(0,3,0)

block_properties(pos)

Returns a list of available block properties for a particular block. If a block has no properties, returns an empty list.

property(pos, name)

Returns property of block at pos, or specified by block argument. If a block doesn't have that property, null value is returned. Returned values are always strings. It is expected from the user to know what to expect and convert values to numbers using number() function or booleans using bool() function.

set(x,y,z,'iron_trapdoor','half','top'); property(x,y,z,'half')  => top
set(x,y,z,'air'); property(x,y,z,'half')  => null
property(block('iron_trapdoor[half=top]'),'half')  => top
property(block('iron_trapdoor[half=top]'),'powered')  => false
bool(property(block('iron_trapdoor[half=top]'),'powered'))  => 0

block_data(pos)

Return NBT string associated with specific location, or null if the block does not carry block data. Can be currently used to match specific information from it, or use it to copy to another block

    block_data(x,y,z) => '{TransferCooldown:0,x:450,y:68, ... }'

poi(pos), poi(pos, radius), poi(pos, radius, status)

Queries a POI (Point of Interest) at a given position, returning null if none is found, or tuple of poi type and its occupancy load. With optional radius and status, returns a list of POIs around pos within a given radius. If status is specified (either 'available', or 'occupied') returns only POIs with that status. The return format is again, poi type, occupancy load, and extra tripple of coordinates.

Querying for POIs using the radius is intended use of POI mechanics and ability of accessing individual POIs via poi(pos) in only provided for completness.

poi(x,y,z) => null  // nothing set at position
poi(x,y,z) => ['meeting',3]  // its a bell-type meeting point occupied by 3 villagers
poi(x,y,z,5) => []  // nothing around
poi(x,y,z,5) => [['nether_portal',0,[7,8,9]],['nether_portal',0,[7,9,9]]] // two portal blocks in the range

biome(pos)

returns biome at that block position.

solid(pos)

Boolean function, true if the block is solid

air(pos)

Boolean function, true if a block is air.... or cave air... or void air.... or any other air they come up with.

liquid(pos)

Boolean function, true if the block is liquid, or liquidlogged

flammable(pos)

Boolean function, true if the block is flammable

transparent(pos)

Boolean function, true if the block is transparent

opacity(pos)

Numeric, returning opacity level of a block

blocks_daylight(pos)

Boolean function, true if the block blocks daylight

emitted_light(pos)

Numeric, returning light level emitted from block

light(pos)

Integer function, returning total light level at position

block_light(pos)

Integer function, returning block light at position. From torches and other light sources.

sky_light(pos)

Numeric function, returning sky light at position. From the sky access.

see_sky(pos)

Boolean function, returning true if the block can see sky.

hardness(pos)

Numeric function, indicating hardness of a block.

blast_resistance(pos)

Numeric function, indicating blast_resistance of a block.

in_slime_chunk(pos)

Boolean indicating if the given block position is in a slime chunk.

top(type, pos)

Returns the Y value of the topmost block at given x, z coords (y value of a block is not important), according to the heightmap specified by type. Valid options are:

• light: topmost light blocking block (1.13 only)
• motion: topmost motion blocking block
• terrain: topmost motion blocking block except leaves
• ocean_floor: topmost non-water block
• surface: topmost surface block

top('motion', x, y, z)  => 63
top('ocean_floor', x, y, z)  => 41

loaded(pos)

Boolean function, true if the block is accessible for the game mechanics. Normally scarpet doesn't check if operates on loaded area - the game will automatically load missing blocks. We see this as advantage. Vanilla fill/clone commands only check the specified corners for loadness.

To check if block is truly loaded, I mean in memory, use generation_status(x) != null, as chunks can still be loaded outside of the playable area, just are not used any of the game mechanics processes.

loaded(pos(players()))  => 1
loaded(100000,100,1000000)  => 0

(Deprecated) loaded_ep(pos)

Boolean function, true if the block is loaded and entity processing, as per 1.13.2

Deprecated as of scarpet 1.6, use loaded_status(x) > 0, or just loaded(x) with the same effect

loaded_status(pos)

Returns loaded status as per new 1.14 chunk ticket system, 0 for inaccessible, 1 for border chunk, 2 for ticking, 3 for entity ticking

generation_status(pos), generation_status(pos, true)

Returns generation status as per new 1.14 chunk ticket system. Can return any value from several available but chunks can only be valid in a few states: full, features, liquid_carvers, and structure_starts. Returns null if the chunk is not in memory unless called with optional true.

structures(pos), structures(pos, structure_name)

Returns structure information for a given block position. Note that structure information is the same for all the blocks from the same chunk. structures function can be called with a block, or a block and a structure name. In the first case it returns a map of structures at a given position, keyed by structure name, with values indicating the bounding box of the structure - a pair of two 3-value coords (see examples). When called with an extra structure name, returns list of components for that structure, with their name, direction and two sets of coordinates indicating the bounding box of the structure piece.

structure_references(pos), structure_references(pos, structure_name)

Returns structure information that a chunk with a given block position is part of. structure_references function can be called with a block, or a block and a structure name. In the first case it returns a list of structure names that give chunk belongs to. When called with an extra structure name, returns list of positions pointing to the lowest block position in chunks that hold structure starts for these structures. You can query that chunk structures then to get its bounding boxes.

set_structure(pos, structure_name), set_structure(pos, structure_name, null)

Creates or removes structure information of a structure associated with a chunk of pos. Unlike plop, blocks are not placed in the world, only structure information is set. For the game this is a fully functional structure even if blocks are not set. To remove structure a given point is in, use structure_references to find where current structure starts.

suffocates(pos)

Boolean function, true if the block causes suffocation.

power(pos)

Numeric function, returning redstone power level at position.

ticks_randomly(pos)

Boolean function, true if the block ticks randomly.

blocks_movement(pos)

Boolean function, true if block at position blocks movement.

block_sound(pos)

Returns the name of sound type made by the block at position. One of:

• wood
• gravel
• grass
• stone
• metal
• glass
• wool
• sand
• snow
• ladder
• anvil
• slime
• sea_grass
• coral

material(pos)

Returns the name of material of the block at position. very useful to target a group of blocks. One of:

• air
• void
• portal
• carpet
• plant
• water_plant
• vine
• sea_grass
• water
• bubble_column
• lava
• snow_layer
• fire
• redstone_bits
• cobweb
• redstone_lamp
• clay
• dirt
• grass
• packed_ice
• sand
• sponge
• wood
• wool
• tnt
• leaves
• glass
• ice
• cactus
• stone
• iron
• snow
• anvil
• barrier
• piston
• coral
• gourd
• dragon_egg
• cake

map_colour(pos)

Returns the map colour of a block at position. One of:

• air
• grass
• sand
• wool
• tnt
• ice
• iron
• foliage
• snow
• clay
• dirt
• stone
• water
• wood
• quartz
• adobe
• magenta
• light_blue
• yellow
• lime
• pink
• gray
• light_gray
• cyan
• purple
• blue
• brown
• green
• red
• black
• gold
• diamond
• lapis
• emerald
• obsidian
• netherrack
• white_terracotta
• orange_terracotta
• magenta_terracotta
• light_blue_terracotta
• yellow_terracotta
• lime_terracotta
• pink_terracotta
• gray_terracotta
• light_gray_terracotta
• cyan_terracotta
• purple_terracotta
• blue_terracotta
• brown_terracotta
• green_terracotta
• red_terracotta
• black_terracotta