Cleaner (v1.3-dev)

• Index

Contents

• Functions
• Unsafe Methods

Topics

• settings
• api
• commands
• tools
• config

Topic api

Cleaner API

Functions

cleaner.get_replace_items ()	Retrieves list of items to be replaced.
cleaner.get_replace_nodes ()	Retrieves list of nodes to be replaced.
cleaner.register_entity_removal (src)	Registers an entity to be removed.
cleaner.register_node_removal (src)	Registers a node to be removed.
cleaner.replace_item (src, tgt[, update_players])	Replaces an item with another registered item.
cleaner.register_item_replacement (src, tgt)	Registeres an item to be replaced.
cleaner.register_node_replacement (src, tgt)	Registers a node to be replaced.

Unsafe Methods

cleaner.get_remove_ores ()	Retrieves list of ores to be removed.
cleaner.register_ore_removal (src)	Registers an ore to be removed after server startup.
cleaner.remove_ore (src)	Removes an ore definition.

Functions

cleaner.get_replace_items ()

Retrieves list of items to be replaced.

Returns:

table Items to be replaced.

cleaner.get_replace_nodes ()

Retrieves list of nodes to be replaced.

Returns:

table Nodes to be replaced.

cleaner.register_entity_removal (src)

Registers an entity to be removed.

Parameters:

• src string Entity technical name.

cleaner.register_node_removal (src)

Registers a node to be removed.

Parameters:

• src string Node technical name.

cleaner.replace_item (src, tgt[, update_players])

Replaces an item with another registered item.

Parameters:

• src string Technical name of item to be replaced.
• tgt string Technical name of item to be used in place.
• update_players bool true updates inventory lists associated with players (default: false). (optional)

cleaner.register_item_replacement (src, tgt)

Registeres an item to be replaced.

Parameters:

• src string Technical name of item to be replaced.
• tgt string Technical name of item to be used in place.

cleaner.register_node_replacement (src, tgt)

Registers a node to be replaced.

Parameters:

• src string Technical name of node to be replaced.
• tgt string Technical name of node to be used in place.

Unsafe Methods

cleaner.get_remove_ores ()

Retrieves list of ores to be removed.

Returns:

table Ores to be removed.

cleaner.register_ore_removal (src)

Registers an ore to be removed after server startup.

Parameters:

• src string Ore technical name.

cleaner.remove_ore (src)

Removes an ore definition.

Parameters:

• src string Ore technical name.