Merge branch 'fix_drop_fix' into 'master'

prevent crash when dropping item

See merge request VanessaE/unifieddyes!3

API.md

@@ -12,8 +12,8 @@ minetest.register_node("mymod:colored_node", {
 	paramtype2 = "color",
 	palette = "unifieddyes_palette_extended.png",
 	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",
+	on_dig = unifieddyes.on_dig
 })
 ```
 
@@ -28,14 +28,18 @@ minetest.register_node("mymod:colored_node", {
 - "unifieddyes_palette_colorwallmounted.png"
 - or one of the "split" hues palettes (see below).
 
-`groups`: If your node can be colored by punching it with dye, its groups entry must contain the key ud_param2_colorable = 1, among whatever else you'd normally put there. If the node is software-controlled, as might be the case for some mesecons-digilines aware node, then this group key should be omitted.
+`groups`: If your node can be colored by using the airbrush, its groups entry must contain the key ud_param2_colorable = 1, among whatever else you'd normally put there. If the node is software-controlled, as might be the case for some mesecons-digilines aware node, then this group key should be omitted.
 
-`on_construct`: see below.
+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).
 
 `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
 
+**`unifieddyes.on_dig(pos, node, digger)`**
+
+Set in a node definition's `on_dig` callback, this makes sure that if the player digs a neutral node, i.e. a colorable node that was left uncolored/white after placing, they receive a version of that item that has been stripped of its itemstack color setting, so that it is identical to what would have been in their inventory when that node was originally placed.  This prevents the engine splitting stacks of that item due to technically-different but visually-identical itemstack coloring.  This function is only needed in the definition of colorable versions of a node, not any uncolored counterparts.  For example, if you have a mod that has a simple, wooden chair, and the mod turns it into one with a colored seat cushion when you airbrush or craft it with dye, then only that latter colored-seat version needs this function.
+
 **`unifieddyes.fix_rotation(pos, placer, itemstack, pointed_thing)`
 `unifieddyes.fix_rotation_nsew(pos, placer, itemstack, pointed_thing)`**
 
@@ -84,10 +88,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.
 
-**`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)`**
 
 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:
@@ -115,12 +115,16 @@ This will loop through all of Unified Dyes' color lists, generating one recipe f
 
 `recipe` is the same as in the normal call, except that Unified Dyes will replace all instances of the string "NEUTRAL_NODE" with the item specified in the preceding `neutral_node` field.  Every instance of "MAIN_DYE" will be replaced with a portion of dye, as Unified Dyes' recipe helper works through its color lists (i.e. this field will become whatever dye is needed for each recipe).
 
-`output_prefix` and `output_suffix`, if specified (must use both if at all), will cause the recipe registration to ignore the usual `output` field, and instead set to the output item to `output_prefix` + (hue) + `output_suffix`.  Used for mods that use the split 89-color palette.  `hue` will thus be one of the 12 hues, or "grey", as defined by the split palettes.
+`output_prefix` and `output_suffix`, if specified (must use both if at all), will cause the recipe registration to set to the output item to `output_prefix` + (hue) + `output_suffix` + `output`.  Used for mods that use the split 89-color palette.  `hue` will thus be one of the 12 hues, or "grey", as defined by the split palettes.  In this situation, you can set `output` to your recipe yield (with a leading space) if needed.  For example, if the prefix is "foo:bar", the suffix is "baz", and the output is set to " 3", then the craft helper will generate output item strings of the form "foo:bar_COLOR_baz 3", for each color in the table.
 
 **`unifieddyes.make_colored_itemstack(itemstack, palette, color)`**
 
 Makes a colored itemstack out of the given `itemstack` and `color` (as a dye, e.g. "dye:dark_red_s50"), setting the correct index per the `palette` field, which works as described above for `unifieddyes.getpaletteidx()`.  Said itemstack is returned as a string suitable for use as the output field of a craft recipe, equal in size to the itemstack passed into the function (e.g. if you give it "mymod:colored_node 7", it'll return a stack of 7 colored items).
 
+**`unifieddyes.generate_split_palette_nodes(name, def, drop)`**
+
+Does just what it sounds like - it registers all the nodes that are needed for a given base node (`def`) to be able to use the split palette, each named according to `name`, with the palette hue appended.  If a custom drop is needed, it can be passed along (only a string is allowed here, specifying a single item).  
+
 #### Tables
 
 In addition to the above API calls, Unified Dyes provides several useful tables
@@ -144,8 +148,8 @@ If your mod used the old paradigm where you craft a neutral-colored item, place
 ```lua
 	place_param2 = 240,
 	after_dig_node = unifieddyes.after_dig_node,
-	after_place_node = unifieddyes.recolor_on_place,
-	ud_replacement_node = "mod:some_node"
+	ud_replacement_node = "mod:some_node",
+	on_dig = unifieddyes.on_dig
 ```
 
 * Add the `airbrush_replacement_node` key to the node definition, if needed.
@@ -160,10 +164,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.
 
-* 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",`
-	`on_construct = unifieddyes.on_construct,`
 
 * Adjust your node's groups to specify that the node can be colored.  Example (note the last item):
 
@@ -173,7 +176,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)
 
-* 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.
 

colors.txt

@@ -1,90 +0,0 @@
-
-
-Full-saturation colors:
------------------------
-
-dark aqua                          0, 84, 42  unifieddyes_dark_aqua.png
-dark blue                          0,  0, 84  unifieddyes_dark_blue.png
-dark cyan                          0, 84, 83  unifieddyes_dark_cyan.png
-dark green                         0, 84,  0  unifieddyes_dark_green.png
-dark lime                         43, 84,  0  unifieddyes_dark_lime.png
-dark magenta                      84,  0, 83  unifieddyes_dark_magenta.png
-dark orange                       84, 42,  0  unifieddyes_dark_orange.png
-dark red                          84,  0,  0  unifieddyes_dark_red.png
-dark redviolet                    84,  0, 42  unifieddyes_dark_redviolet.png
-dark skyblue                       0, 42, 84  unifieddyes_dark_skyblue.png
-dark violet                       43,  0, 84  unifieddyes_dark_violet.png
-dark yellow                       84, 83,  0  unifieddyes_dark_yellow.png
-medium aqua                        0,169, 84  unifieddyes_medium_aqua.png
-medium blue                        0,  0,169  unifieddyes_medium_blue.png
-medium cyan                        0,169,167  unifieddyes_medium_cyan.png
-medium green                       0,169,  0  unifieddyes_medium_green.png
-medium lime                       87,169,  0  unifieddyes_medium_lime.png
-medium magenta                   169,  0,167  unifieddyes_medium_magenta.png
-medium orange                    169, 84,  0  unifieddyes_medium_orange.png
-medium red                       168,  0,  0  unifieddyes_medium_red.png
-medium redviolet                 169,  0, 84  unifieddyes_medium_redviolet.png
-medium skyblue                     0, 84,169  unifieddyes_medium_skyblue.png
-medium violet                     87,  0,169  unifieddyes_medium_violet.png
-medium yellow                    169,167,  0  unifieddyes_medium_yellow.png
-aqua                               1,255,127  unifieddyes_aqua.png
-blue                               1,  1,255  unifieddyes_blue.png
-cyan                               1,255,252  unifieddyes_cyan.png
-green                              1,255,  1  unifieddyes_green.png
-lime                             132,255,  1  unifieddyes_lime.png
-magenta                          255,  1,252  unifieddyes_magenta.png
-orange                           255,127,  1  unifieddyes_orange.png
-red                              255,  0,  0  unifieddyes_red.png
-redviolet                        255,  1,127  unifieddyes_redviolet.png
-skyblue                            1,127,255  unifieddyes_skyblue.png
-violet                           132,  1,255  unifieddyes_violet.png
-yellow                           255,252,  1  unifieddyes_yellow.png
-
-Low-saturation colors:
-----------------------
-
-dark aqua 50% saturation          21, 63, 42  unifieddyes_dark_aqua_s50.png
-dark blue 50% saturation          21, 21, 63  unifieddyes_dark_blue_s50.png
-dark cyan 50% saturation          21, 63, 63  unifieddyes_dark_cyan_s50.png
-dark green 50% saturation         21, 63, 21  unifieddyes_dark_green_s50.png
-dark lime 50% saturation          43, 63, 21  unifieddyes_dark_lime_s50.png
-dark magenta 50% saturation       63, 21, 63  unifieddyes_dark_magenta_s50.png
-dark orange 50% saturation        63, 42, 21  unifieddyes_dark_orange_s50.png
-dark red 50% saturation           63, 21, 21  unifieddyes_dark_red_s50.png
-dark redviolet 50% saturation     63, 21, 42  unifieddyes_dark_redviolet_s50.png
-dark skyblue 50% saturation       21, 42, 63  unifieddyes_dark_skyblue_s50.png
-dark violet 50% saturation        43, 21, 63  unifieddyes_dark_violet_s50.png
-dark yellow 50% saturation        63, 63, 21  unifieddyes_dark_yellow_s50.png
-medium aqua 50% saturation        42,126, 84  unifieddyes_medium_aqua_s50.png
-medium blue 50% saturation        42, 42,126  unifieddyes_medium_blue_s50.png
-medium cyan 50% saturation        42,126,126  unifieddyes_medium_cyan_s50.png
-medium green 50% saturation       42,126, 42  unifieddyes_medium_green_s50.png
-medium lime 50% saturation        86,126, 42  unifieddyes_medium_lime_s50.png
-medium magenta 50% saturation    126, 42,126  unifieddyes_medium_magenta_s50.png
-medium orange 50% saturation     126, 84, 42  unifieddyes_medium_orange_s50.png
-medium red 50% saturation        127, 42, 42  unifieddyes_medium_red_s50.png
-medium redviolet 50% saturation  126, 42, 84  unifieddyes_medium_redviolet_s50.png
-medium skyblue 50% saturation     42, 84,126  unifieddyes_medium_skyblue_s50.png
-medium violet 50% saturation      86, 42,126  unifieddyes_medium_violet_s50.png
-medium yellow 50% saturation     126,126, 42  unifieddyes_medium_yellow_s50.png
-aqua 50% saturation               65,191,127  unifieddyes_aqua_s50.png
-blue 50% saturation               65, 65,191  unifieddyes_blue_s50.png
-cyan 50% saturation               65,191,190  unifieddyes_cyan_s50.png
-green 50% saturation              65,191, 65  unifieddyes_green_s50.png
-lime 50% saturation              130,191, 65  unifieddyes_lime_s50.png
-magenta 50% saturation           191, 65,190  unifieddyes_magenta_s50.png
-orange 50% saturation            191,127, 65  unifieddyes_orange_s50.png
-red 50% saturation               192, 64, 64  unifieddyes_red_s50.png
-redviolet 50% saturation         191, 65,127  unifieddyes_redviolet_s50.png
-skyblue 50% saturation            65,127,191  unifieddyes_skyblue_s50.png
-violet 50% saturation            130, 65,191  unifieddyes_violet_s50.png
-yellow 50% saturation            191,190, 65  unifieddyes_yellow_s50.png
-
-Greyscale:
-----------
-
-black                              0,  0,  0  unifieddyes_black.png
-dark grey                         64, 64, 64  unifieddyes_darkgrey_paint.png
-medium grey                      128,128,128  unifieddyes_grey_paint.png
-light grey                       192,192,192  unifieddyes_lightgrey_paint.png
-white                            255,255,255  unifieddyes_white_paint.png

locale/ru.txt

@@ -0,0 +1,74 @@
+# Translation by @drakes_journey
+
+Lime Dye = Лаймовая краска
+Aqua Dye = Аквамариновая краска
+Sky-blue Dye = Голубая краска
+Red-violet Dye = Красно-фиолетовая краска
+Light Grey Dye = Светло-серая краска
+
+Dark Red Dye (low saturation) = Темная красная краска (низкая насыщенность)
+Dark Orange Dye (low saturation) = Темная оранжевая краска (низкая насыщенность)
+Dark Yellow Dye (low saturation) = Темная желтая краска (низкая насыщенность)
+Dark Lime Dye (low saturation) = Темная лаймовая краска (низкая насыщенность)
+Dark Green Dye (low saturation) = Темная зеленая краска (низкая насыщенность)
+Dark Aqua Dye (low saturation) = Темная аквамариновая краска (низкая насыщенность)
+Dark Cyan Dye (low saturation) = Темная бирюзовая краска (низкая насыщенность)
+Dark Sky-blue Dye (low saturation) = Темная голубая краска (низкая насыщенность)
+Dark Blue Dye (low saturation) = Темная синяя краска (низкая насыщенность)
+Dark Violet Dye (low saturation) = Темная фиолетовая краска (низкая насыщенность)
+Dark Magenta Dye (low saturation) = Темная пурпурная краска (низкая насыщенность)
+Dark Red-violet Dye (low saturation) = Темная краснофиолетовая краска (низкая насыщенность)
+
+Dark Red Dye = Темная красная краска
+Dark Orange Dye = Темная оранжевая краска
+Dark Yellow Dye = Темная желтая краска
+Dark Lime Dye = Темная зеленая краска
+Dark Green Dye = Темная зеленая краска
+Dark Aqua Dye = Темная аквамариновая краска
+Dark Cyan Dye = Темная бирюзовая краска
+Dark Sky-blue Dye = Темная голубая краска
+Dark Blue Dye = Темная синяя краска
+Dark Violet Dye = Темная фиолетовая краска
+Dark Magenta Dye = Темная пурпурная краска
+Dark Red-violet Dye = Темная красно-фиолетовая краска
+
+Medium Red Dye (low saturation) = Средне-красная краска (низкая насыщенность)
+Medium Orange Dye (low saturation) = Средне-оранжевая краска (низкая насыщенность)
+Medium Yellow Dye (low saturation) = Средне-желтая краска (низкая насыщенность)
+Medium Lime Dye (low saturation) = Средне-зеленая краска (низкая насыщенность)
+Medium Green Dye (low saturation) = Средне-зеленая краска (низкая насыщенность)
+Medium Aqua Dye (low saturation) = Средне-аквамариновая краска (низкая насыщенность)
+Medium Cyan Dye (low saturation) = Средне-бирюзовая краска (низкая насыщенность)
+Medium Sky-blue Dye (low saturation) = Средне-голубая краска (низкая насыщенность)
+Medium Blue Dye (low saturation) = Средне-синяя краска (низкая насыщенность)
+Medium Violet Dye (low saturation) = Средне-фиолетовая краска (низкая насыщенность)
+Medium Magenta Dye (low saturation) = Средне-пурпурная краска (низкая насыщенность)
+Medium Red-violet Dye (low saturation) = Средне-краснофиолетовая краска (низкая насыщенность)
+
+Medium Red Dye = Средне-красная краска
+Medium Orange Dye = Средне-оранжевая краска
+Medium Yellow Dye = Средне-желтая краска
+Medium Lime Dye = Средне-лаймовая краска
+Medium Green Dye = Средне-зеленая краска
+Medium Aqua Dye = Средне-аквамариновая краска
+Medium Cyan Dye = Средне-бирюзовая краска
+Medium Sky-blue = Средне-голубая краска
+Medium Blue Dye = Средне-синяя краска
+Medium Violet Dye = Средне-фиолетовая краска
+Medium Magenta Dye = Средне-пурпурная краска
+Medium Red-violet Dye = Средне-краснофиолетовая краска
+
+Red Dye (low saturation) = Красная краска (низкая насыщенность)
+Orange Dye (low saturation) = Оранжевая краска (низкая насыщенность)
+Yellow Dye (low saturation) = Желтая краска (низкая насыщенность)
+Lime Dye (low saturation) = Лаймовая краска (низкая насыщенность)
+Green Dye (low saturation) = Зеленая краска (низкая насыщенность)
+Aqua Dye (low saturation) = Аквамариновая краска (низкая насыщенность)
+Cyan Dye (low saturation) = Бирюзовая краска (низкая насыщенность)
+Sky-blue Dye (low saturation) = Голубая краска (низкая насыщенность)
+Blue Dye (low saturation) = Синяя краска (низкая насыщенность)
+Violet Dye (low saturation) = Фиолетовая краска (низкая насыщенность)
+Magenta Dye (low saturation) = Пурпурная краска (низкая насыщенность)
+Red-violet Dye (low saturation) = Краснофиолетовая краска (низкая насыщенность)
+
+[UnifiedDyes] Loaded! = [UnifiedDyes] загружен!