🧵 StringBlock Mechanic¶

Info

STRINGBLOCK-type allows for up-to 127 custom blocks.
One per custom_variation

Another quirk with this CustomBlock is that it has 2 different hitbox-states
All variations after 64 will have a smaller hitbox than those before.

How does it work?¶

This is a type of CustomBlock best aimed at plants, rocks and other foliage.
It uses the vanilla TripWire block and therefore will disable all normal behaviour TripWires might have.

How do I create a StringBlock?¶

Info

If you are unsure how to reference a ResourcePack-File in a NexoItem config; How do I reference a ResourcePack file in a config?

Nexo Resourcepack configuration¶

Below is an example of how to configure the model/texture to use.
block/cross is what normal vanilla plants use and allows for converting a 2d-texture into a block.
If you want an example, look at RoseBushes in-game.

jasmine_flower:
  itemname: "<white>Jasmine Flower"
  material: PAPER
  Pack:
    parent_model: "block/cross"
    texture: custom/flowers/jasmine_flower.png # .png extension is not mandatory

StringBlock Mechanic Configuration¶

To use this mechanic you need to tell nexo which model to use (to use the generated one, just put the id name of your item).
Then you need to use custom_variation that is not already used by another decoration.
You can also configure the hardness of the block, which specifies how long a block should take to break.
drop.best_tool allows you to specify which tool should be best.
An example would be PICKAXE for a small stone

jasmine_flower:
  Mechanics:
    custom_block:
      type: STRINGBLOCK
      custom_variation: 2
      model: jasmine_flower
      hardness: 2
      drop:
        silktouch: false

Sub-Properties¶

Placeable On Water¶

placeable_on_water lets you make a stringblock only placeable when placed on water.
This aims to mimic how Lilypads work in vanilla. Defaults to false

placeable_on_water:
  Mechanics:
    custom_block:
      type: STRINGBLOCK
      placeable_on_water: true

Requires Supporting¶

requires_supporting will make the block "unstable" and make it break when the block beneath it is broken. Defaults to false

placeable_on_water:
  Mechanics:
    custom_block:
      type: STRINGBLOCK
      requires_supporting: true

Random Place¶

This takes a list of strings representing other stringblock-mechanics.
It will then select a random one to place when placing this item.

random_place:
  Mechaincs:
    custom_block:
      type: STRINGBLOCK
      custom_variation: 1
      random_place:
        - random_place
        - random_place2
        - random_place3
random_place2:
 Mechanics:
   custom_block:
     type: STRINGBLOCK
     custom_variation: 2
random_place3:
 Mechanics:
   custom_block:
     type: STRINGBLOCK
     custom_variation: 3

Tall Plants¶

Nexo has a is_tall - property which makes the STRINGBLOCK take up two spaces, similar to Tall Grass. This requires using a specific parent-model and two separate textures, for the top and bottom block. Nexo also provides a default parent-model for use with this.
Below is an example config using two different PNGs

plant:
  Pack:
    parent_model: nexo:block/tall_plant
    textures:
      bottom: bottom_texture
      top: top_texture
  Mechanics:
    custom_block:
      type: STRINGBLOCK
      is_tall: true

Sapling¶

sapling:
  Mechanics:
    custom_block:
      type: STRINGBLOCK
      sapling:
        grows_naturally: true # if you want only the player can grow it
        natural_growth_time: 6000 #in ticks
        grows_from_bonemeal: true
        bonemeal_growth_speedup: 1250
        grow_sound: block.grass.break
        min_light_level: 4
        requires_water_source: false #if you want it to need water
        schematic: schemTest #structure that will put
        # this also allows you to use a list of schematics:
        # schematic:
        # - schem: palmTree1
        #   chance: 0.5
        # - schem: palmTree2
        #   chance: 0.5
        replace_blocks: false
        copy_biomes: false
        copy_entities: false

You can also add some randomness to the growth, or just increase the delay between checks.
Go into mechanics.yml and under stringblock-mechanic, adjust sapling_growth_check_delay
This is in ticks, so 20 = 1 second.

For your sapling to work and grow make sure you have created a schematics folder in Nexo and copy all your schems from FAWE into the schematics folder. If this is not done, your sapling will not work at all.

Stackable¶

This lets you make a block which can be stacked, much like Pink Petals. This will alter the model shown and the drop amount given when it is broken. Below is an example using carrots.
If you only have Textures and not Models, you will need to either make them or make dummy NexoItems that then generates this Model for you.

stackable:
  material: PAPER
  Pack:
    model: item/carrot
  Mechanics:
    custom_block:
      type: STRINGBLOCK
      model: block/carrots_stage0
      stackable:
        - model: block/carrots_stage1
        - model: block/carrots_stage2
        - model: block/carrots_stage3

BlockLocker¶

You can use this to allow protection via BlockLocker
Valid protectionTypes are CONTAINER, DOOR, ATTACHABLE

Mechanics:
  custom_block:
    type: STRINGBLOCK
    blocklocker:
      can_protect: true
      protection_type: CONTAINER