replacer (flux's redo)

replacers, but with fewer bugs and fewer "features"

the aim of this variant is to try to use the highest level APIs provided, to trigger all possible callbacks.

features #

• no building on the ocean
• uses the game's builtin mechanisms as much as possible, so there's (hopefully) less need for lots of complicated integration w/ weird mods (awards, xp_redo, machines, etc.)
• for server maintainers, api allows easy customization of behavior. want to limit it to the user's protected areas? almost trivial.

creaplacer #

there's a special creative-only replacer. to get one, do /giveme replacer:creaplacer.

additional features of the creaplacer:

• points at liquid nodes
• longer range (10 nodes)
• copies/pastes node metadata
• can force-replace nodes (as long as they're not blacklisted or something)

API #

blacklists #

• replacer.api.blacklist_item(itemstring)

  blacklists itemstring from use in the replacer.

• replacer.api.blacklist_groups(groups)

  blacklist nodes w/ the given combination of groups from use in the replacer. e.g.

  groups = {
      cracky = 2,
      level = 2,
  }
  

  bans any node which has both cracky >= 2 and level >= 2

• replacer.api.blacklist_item_replacement(itemstring)

  blacklists itemstring from being replaced w/ the replacer.

• replacer.api.blacklist_groups_replacement(groups)

  blacklist nodes w/ the given combination of groups being replaced w/ the replacer. e.g.

  groups = {
      cracky = 2,
      level = 2,
  }
  

  bans any node which has both cracky >= 2 and level >= 2

over-ride-able callbacks #

• replacer.api.is_blacklisted(itemstring)

  override if you want to customize the logic of what can be blacklisted

• replacer.api.is_replacement_blacklisted(itemstring)

  override if you want to customize the logic of what can be blacklisted from being replaced

• replacer.api.can_copy(player, pos, node)

  override if you want to customize which nodes a player can copy

• replacer.api.can_place(player, pos, node)

  override if you want to customize whether a node can be placed by a player

• replacer.api.can_replace(player, pos, current_node, replace_node)

  override if you want to customize whether a node can be replaced by a player

license #

code license:

• LGPL

media license:

• replacer_inspector.png (C) Sokomine GPLv3+
• replacer_replacer.png (C) Sokomine GPLv3+