mtcontrib/unifieddyes
1
0
Fork 1
mirror of https://github.com/mt-mods/unifieddyes.git synced 2024-12-24 09:40:29 +01:00
Code Issues Releases Wiki Activity

remove mentions of on_construct

Browse Source 
(outdated, no longer valid or necessary)
This commit is contained in:
Vanessa Dannenberg 2019-07-07 15:53:03 -04:00
parent 6c8a0b2387
commit e048da9c3c
1 changed files with 2 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
API.md
View File

@ -12,7 +12,6 @@ minetest.register_node("mymod:colored_node", {
paramtype2 = "color", paramtype2 = "color",
palette = "unifieddyes_palette_extended.png", palette = "unifieddyes_palette_extended.png",
groups = {snappy = 1, cracky = 2, ud_param2_colorable = 1} groups = {snappy = 1, cracky = 2, ud_param2_colorable = 1}
on_construct = unifieddyes.on_construct,
airbrush_replacement_node = "mymod:my_other_colored_node" airbrush_replacement_node = "mymod:my_other_colored_node"
}) })
``` ```
@ -32,8 +31,6 @@ minetest.register_node("mymod:colored_node", {
If your node if of the kind where you need the split palette, but you need to put the *full color name* into the node name, as opposed to just the hue, then add the keys `ud_color_start` and `ud_color_end` and set them to the positions of the first and last characters of the color name (where 1 is the first character of the mod name at the start of the node name, i.e. "mymod:foo_bar_orange_baz" would have the start set to 15 and the end at 20). If your node if of the kind where you need the split palette, but you need to put the *full color name* into the node name, as opposed to just the hue, then add the keys `ud_color_start` and `ud_color_end` and set them to the positions of the first and last characters of the color name (where 1 is the first character of the mod name at the start of the node name, i.e. "mymod:foo_bar_orange_baz" would have the start set to 15 and the end at 20).
`on_construct`: see below.
`airbrush_replacement_node`: The node to swap in when the airbrush is used on this node. For example, you could `minetest.override_item()` on some default node to add this field, pointing to a colorable node of your own, so that when the default node is painted, it's replaced with yours in the new color. `airbrush_replacement_node`: The node to swap in when the airbrush is used on this node. For example, you could `minetest.override_item()` on some default node to add this field, pointing to a colorable node of your own, so that when the default node is painted, it's replaced with yours in the new color.
#### Function calls #### Function calls
@ -86,10 +83,6 @@ This is called when a node is punched while wielding the airbrush.
This one does just what it sounds like - it shows the color selector formspec. This one does just what it sounds like - it shows the color selector formspec.
**`unifieddyes.on_construct(pos)`**
This function, usually called from your node definition's `on_construct`, just sets the `palette = "ext"` metadata key for the node after it's been placed. This can then be read in an LBM to determine if this node needs to be converted from the old 89-color palette to the extended 256-color palette. Although it is good practice to call this for any node that uses the 256-color palette, it isn't actually necessary as long as the node has never used the 89-color palette, and won't be subjected to an LBM that changes its color.
**`unifieddyes.register_color_craft(recipe)`** **`unifieddyes.register_color_craft(recipe)`**
This will loop through all of Unified Dyes' color lists, generating one recipe for every color in the palette given in the call. Example usage: This will loop through all of Unified Dyes' color lists, generating one recipe for every color in the palette given in the call. Example usage:
@ -167,10 +160,9 @@ If your mod used the old paradigm where you craft a neutral-colored item, place
* Convert that remaining texture to grayscale, enhance its contrast as much as you can without distorting it, and rename it and the node it'll be used to something neutral-sounding. * Convert that remaining texture to grayscale, enhance its contrast as much as you can without distorting it, and rename it and the node it'll be used to something neutral-sounding.
* Add the `on_construct` and `palette` keys to your neutral node definition, for example: * Add the `palette` key to your neutral node definition, for example:
`palette = "unifieddyes_palette_extended.png",` `palette = "unifieddyes_palette_extended.png",`
`on_construct = unifieddyes.on_construct,`
* Adjust your node's groups to specify that the node can be colored. Example (note the last item): * Adjust your node's groups to specify that the node can be colored. Example (note the last item):
@ -180,7 +172,7 @@ If your mod used the old paradigm where you craft a neutral-colored item, place
* Add the above recipes helper call (which replaces those delted recipes) * Add the above recipes helper call (which replaces those delted recipes)
* If your colored node is based on someone else's neutral node, for example if you made a mod that creates multiple colors of minetest_game's default clay, you may find it best to create a single "stand-in" node that's identical to the neutral node, but named for your mod, hidden from the creative inventory, and which has a properly-prepared grayscale texture image in addition to the above keys. Use `minetest.override_item()` to add the `on_construct`, `palette`, and `airbrush_replacement_node` keys, and the `ud_param2_colorable` group, to that "someone else's" node. Then use that node and your custom, hidden node in the craft helper call. * If your colored node is based on someone else's neutral node, for example if you made a mod that creates multiple colors of minetest_game's default clay, you may find it best to create a single "stand-in" node that's identical to the neutral node, but named for your mod, hidden from the creative inventory, and which has a properly-prepared grayscale texture image in addition to the above keys. Use `minetest.override_item()` to add the `palette` and `airbrush_replacement_node` keys, and the `ud_param2_colorable` group, to that "someone else's" node. Then use that node and your custom, hidden node in the craft helper call.
* You will need to write a run-only-once LBM to convert your old statically-colored nodes to use hardware coloring. See above for functions that will help reduce the work required for this part. * You will need to write a run-only-once LBM to convert your old statically-colored nodes to use hardware coloring. See above for functions that will help reduce the work required for this part.