Initial Commit

LICENSE.txt

@@ -0,0 +1,458 @@
+                  GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 2.1, February 1999
+
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+[This is the first released version of the Lesser GPL.  It also counts
+ as the successor of the GNU Library Public License, version 2, hence
+ the version number 2.1.]
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+Licenses are intended to guarantee your freedom to share and change
+free software--to make sure the software is free for all its users.
+
+  This license, the Lesser General Public License, applies to some
+specially designated software packages--typically libraries--of the
+Free Software Foundation and other authors who decide to use it.  You
+can use it too, but we suggest you first think carefully about whether
+this license or the ordinary General Public License is the better
+strategy to use in any particular case, based on the explanations below.
+
+  When we speak of free software, we are referring to freedom of use,
+not price.  Our General Public Licenses are designed to make sure that
+you have the freedom to distribute copies of free software (and charge
+for this service if you wish); that you receive source code or can get
+it if you want it; that you can change the software and use pieces of
+it in new free programs; and that you are informed that you can do
+these things.
+
+  To protect your rights, we need to make restrictions that forbid
+distributors to deny you these rights or to ask you to surrender these
+rights.  These restrictions translate to certain responsibilities for
+you if you distribute copies of the library or if you modify it.
+
+  For example, if you distribute copies of the library, whether gratis
+or for a fee, you must give the recipients all the rights that we gave
+you.  You must make sure that they, too, receive or can get the source
+code.  If you link other code with the library, you must provide
+complete object files to the recipients, so that they can relink them
+with the library after making changes to the library and recompiling
+it.  And you must show them these terms so they know their rights.
+
+  We protect your rights with a two-step method: (1) we copyright the
+library, and (2) we offer you this license, which gives you legal
+permission to copy, distribute and/or modify the library.
+
+  To protect each distributor, we want to make it very clear that
+there is no warranty for the free library.  Also, if the library is
+modified by someone else and passed on, the recipients should know
+that what they have is not the original version, so that the original
+author's reputation will not be affected by problems that might be
+introduced by others.
+
+  Finally, software patents pose a constant threat to the existence of
+any free program.  We wish to make sure that a company cannot
+effectively restrict the users of a free program by obtaining a
+restrictive license from a patent holder.  Therefore, we insist that
+any patent license obtained for a version of the library must be
+consistent with the full freedom of use specified in this license.
+
+  Most GNU software, including some libraries, is covered by the
+ordinary GNU General Public License.  This license, the GNU Lesser
+General Public License, applies to certain designated libraries, and
+is quite different from the ordinary General Public License.  We use
+this license for certain libraries in order to permit linking those
+libraries into non-free programs.
+
+  When a program is linked with a library, whether statically or using
+a shared library, the combination of the two is legally speaking a
+combined work, a derivative of the original library.  The ordinary
+General Public License therefore permits such linking only if the
+entire combination fits its criteria of freedom.  The Lesser General
+Public License permits more lax criteria for linking other code with
+the library.
+
+  We call this license the "Lesser" General Public License because it
+does Less to protect the user's freedom than the ordinary General
+Public License.  It also provides other free software developers Less
+of an advantage over competing non-free programs.  These disadvantages
+are the reason we use the ordinary General Public License for many
+libraries.  However, the Lesser license provides advantages in certain
+special circumstances.
+
+  For example, on rare occasions, there may be a special need to
+encourage the widest possible use of a certain library, so that it becomes
+a de-facto standard.  To achieve this, non-free programs must be
+allowed to use the library.  A more frequent case is that a free
+library does the same job as widely used non-free libraries.  In this
+case, there is little to gain by limiting the free library to free
+software only, so we use the Lesser General Public License.
+
+  In other cases, permission to use a particular library in non-free
+programs enables a greater number of people to use a large body of
+free software.  For example, permission to use the GNU C Library in
+non-free programs enables many more people to use the whole GNU
+operating system, as well as its variant, the GNU/Linux operating
+system.
+
+  Although the Lesser General Public License is Less protective of the
+users' freedom, it does ensure that the user of a program that is
+linked with the Library has the freedom and the wherewithal to run
+that program using a modified version of the Library.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.  Pay close attention to the difference between a
+"work based on the library" and a "work that uses the library".  The
+former contains code derived from the library, whereas the latter must
+be combined with the library in order to run.
+
+                  GNU LESSER GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License Agreement applies to any software library or other
+program which contains a notice placed by the copyright holder or
+other authorized party saying it may be distributed under the terms of
+this Lesser General Public License (also called "this License").
+Each licensee is addressed as "you".
+
+  A "library" means a collection of software functions and/or data
+prepared so as to be conveniently linked with application programs
+(which use some of those functions and data) to form executables.
+
+  The "Library", below, refers to any such software library or work
+which has been distributed under these terms.  A "work based on the
+Library" means either the Library or any derivative work under
+copyright law: that is to say, a work containing the Library or a
+portion of it, either verbatim or with modifications and/or translated
+straightforwardly into another language.  (Hereinafter, translation is
+included without limitation in the term "modification".)
+
+  "Source code" for a work means the preferred form of the work for
+making modifications to it.  For a library, complete source code means
+all the source code for all modules it contains, plus any associated
+interface definition files, plus the scripts used to control compilation
+and installation of the library.
+
+  Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running a program using the Library is not restricted, and output from
+such a program is covered only if its contents constitute a work based
+on the Library (independent of the use of the Library in a tool for
+writing it).  Whether that is true depends on what the Library does
+and what the program that uses the Library does.
+
+  1. You may copy and distribute verbatim copies of the Library's
+complete source code as you receive it, in any medium, provided that
+you conspicuously and appropriately publish on each copy an
+appropriate copyright notice and disclaimer of warranty; keep intact
+all the notices that refer to this License and to the absence of any
+warranty; and distribute a copy of this License along with the
+Library.
+
+  You may charge a fee for the physical act of transferring a copy,
+and you may at your option offer warranty protection in exchange for a
+fee.
+
+  2. You may modify your copy or copies of the Library or any portion
+of it, thus forming a work based on the Library, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) The modified work must itself be a software library.
+
+    b) You must cause the files modified to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    c) You must cause the whole of the work to be licensed at no
+    charge to all third parties under the terms of this License.
+
+    d) If a facility in the modified Library refers to a function or a
+    table of data to be supplied by an application program that uses
+    the facility, other than as an argument passed when the facility
+    is invoked, then you must make a good faith effort to ensure that,
+    in the event an application does not supply such function or
+    table, the facility still operates, and performs whatever part of
+    its purpose remains meaningful.
+
+    (For example, a function in a library to compute square roots has
+    a purpose that is entirely well-defined independent of the
+    application.  Therefore, Subsection 2d requires that any
+    application-supplied function or table used by this function must
+    be optional: if the application does not supply it, the square
+    root function must still compute square roots.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Library,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Library, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Library.
+
+In addition, mere aggregation of another work not based on the Library
+with the Library (or with a work based on the Library) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may opt to apply the terms of the ordinary GNU General Public
+License instead of this License to a given copy of the Library.  To do
+this, you must alter all the notices that refer to this License, so
+that they refer to the ordinary GNU General Public License, version 2,
+instead of to this License.  (If a newer version than version 2 of the
+ordinary GNU General Public License has appeared, then you can specify
+that version instead if you wish.)  Do not make any other change in
+these notices.
+
+  Once this change is made in a given copy, it is irreversible for
+that copy, so the ordinary GNU General Public License applies to all
+subsequent copies and derivative works made from that copy.
+
+  This option is useful when you wish to copy part of the code of
+the Library into a program that is not a library.
+
+  4. You may copy and distribute the Library (or a portion or
+derivative of it, under Section 2) in object code or executable form
+under the terms of Sections 1 and 2 above provided that you accompany
+it with the complete corresponding machine-readable source code, which
+must be distributed under the terms of Sections 1 and 2 above on a
+medium customarily used for software interchange.
+
+  If distribution of object code is made by offering access to copy
+from a designated place, then offering equivalent access to copy the
+source code from the same place satisfies the requirement to
+distribute the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  5. A program that contains no derivative of any portion of the
+Library, but is designed to work with the Library by being compiled or
+linked with it, is called a "work that uses the Library".  Such a
+work, in isolation, is not a derivative work of the Library, and
+therefore falls outside the scope of this License.
+
+  However, linking a "work that uses the Library" with the Library
+creates an executable that is a derivative of the Library (because it
+contains portions of the Library), rather than a "work that uses the
+library".  The executable is therefore covered by this License.
+Section 6 states terms for distribution of such executables.
+
+  When a "work that uses the Library" uses material from a header file
+that is part of the Library, the object code for the work may be a
+derivative work of the Library even though the source code is not.
+Whether this is true is especially significant if the work can be
+linked without the Library, or if the work is itself a library.  The
+threshold for this to be true is not precisely defined by law.
+
+  If such an object file uses only numerical parameters, data
+structure layouts and accessors, and small macros and small inline
+functions (ten lines or less in length), then the use of the object
+file is unrestricted, regardless of whether it is legally a derivative
+work.  (Executables containing this object code plus portions of the
+Library will still fall under Section 6.)
+
+  Otherwise, if the work is a derivative of the Library, you may
+distribute the object code for the work under the terms of Section 6.
+Any executables containing that work also fall under Section 6,
+whether or not they are linked directly with the Library itself.
+
+  6. As an exception to the Sections above, you may also combine or
+link a "work that uses the Library" with the Library to produce a
+work containing portions of the Library, and distribute that work
+under terms of your choice, provided that the terms permit
+modification of the work for the customer's own use and reverse
+engineering for debugging such modifications.
+
+  You must give prominent notice with each copy of the work that the
+Library is used in it and that the Library and its use are covered by
+this License.  You must supply a copy of this License.  If the work
+during execution displays copyright notices, you must include the
+copyright notice for the Library among them, as well as a reference
+directing the user to the copy of this License.  Also, you must do one
+of these things:
+
+    a) Accompany the work with the complete corresponding
+    machine-readable source code for the Library including whatever
+    changes were used in the work (which must be distributed under
+    Sections 1 and 2 above); and, if the work is an executable linked
+    with the Library, with the complete machine-readable "work that
+    uses the Library", as object code and/or source code, so that the
+    user can modify the Library and then relink to produce a modified
+    executable containing the modified Library.  (It is understood
+    that the user who changes the contents of definitions files in the
+    Library will not necessarily be able to recompile the application
+    to use the modified definitions.)
+
+    b) Use a suitable shared library mechanism for linking with the
+    Library.  A suitable mechanism is one that (1) uses at run time a
+    copy of the library already present on the user's computer system,
+    rather than copying library functions into the executable, and (2)
+    will operate properly with a modified version of the library, if
+    the user installs one, as long as the modified version is
+    interface-compatible with the version that the work was made with.
+
+    c) Accompany the work with a written offer, valid for at
+    least three years, to give the same user the materials
+    specified in Subsection 6a, above, for a charge no more
+    than the cost of performing this distribution.
+
+    d) If distribution of the work is made by offering access to copy
+    from a designated place, offer equivalent access to copy the above
+    specified materials from the same place.
+
+    e) Verify that the user has already received a copy of these
+    materials or that you have already sent this user a copy.
+
+  For an executable, the required form of the "work that uses the
+Library" must include any data and utility programs needed for
+reproducing the executable from it.  However, as a special exception,
+the materials to be distributed need not include anything that is
+normally distributed (in either source or binary form) with the major
+components (compiler, kernel, and so on) of the operating system on
+which the executable runs, unless that component itself accompanies
+the executable.
+
+  It may happen that this requirement contradicts the license
+restrictions of other proprietary libraries that do not normally
+accompany the operating system.  Such a contradiction means you cannot
+use both them and the Library together in an executable that you
+distribute.
+
+  7. You may place library facilities that are a work based on the
+Library side-by-side in a single library together with other library
+facilities not covered by this License, and distribute such a combined
+library, provided that the separate distribution of the work based on
+the Library and of the other library facilities is otherwise
+permitted, and provided that you do these two things:
+
+    a) Accompany the combined library with a copy of the same work
+    based on the Library, uncombined with any other library
+    facilities.  This must be distributed under the terms of the
+    Sections above.
+
+    b) Give prominent notice with the combined library of the fact
+    that part of it is a work based on the Library, and explaining
+    where to find the accompanying uncombined form of the same work.
+
+  8. You may not copy, modify, sublicense, link with, or distribute
+the Library except as expressly provided under this License.  Any
+attempt otherwise to copy, modify, sublicense, link with, or
+distribute the Library is void, and will automatically terminate your
+rights under this License.  However, parties who have received copies,
+or rights, from you under this License will not have their licenses
+terminated so long as such parties remain in full compliance.
+
+  9. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Library or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Library (or any work based on the
+Library), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Library or works based on it.
+
+  10. Each time you redistribute the Library (or any work based on the
+Library), the recipient automatically receives a license from the
+original licensor to copy, distribute, link with or modify the Library
+subject to these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties with
+this License.
+
+  11. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Library at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Library by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Library.
+
+If any portion of this section is held invalid or unenforceable under any
+particular circumstance, the balance of the section is intended to apply,
+and the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  12. If the distribution and/or use of the Library is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Library under this License may add
+an explicit geographical distribution limitation excluding those countries,
+so that distribution is permitted only in or among countries not thus
+excluded.  In such case, this License incorporates the limitation as if
+written in the body of this License.
+
+  13. The Free Software Foundation may publish revised and/or new
+versions of the Lesser General Public License from time to time.
+Such new versions will be similar in spirit to the present version,
+but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Library
+specifies a version number of this License which applies to it and
+"any later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation.  If the Library does not specify a
+license version number, you may choose any version ever published by
+the Free Software Foundation.
+
+  14. If you wish to incorporate parts of the Library into other free
+programs whose distribution conditions are incompatible with these,
+write to the author to ask for permission.  For software which is
+copyrighted by the Free Software Foundation, write to the Free
+Software Foundation; we sometimes make exceptions for this.  Our
+decision will be guided by the two goals of preserving the free status
+of all derivatives of our free software and of promoting the sharing
+and reuse of software generally.
+
+                            NO WARRANTY
+
+  15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
+WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
+KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
+LIBRARY IS WITH YOU.  SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
+FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
+CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
+LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+                     END OF TERMS AND CONDITIONS

README.md

@@ -0,0 +1,37 @@
+-------------------------------------------------------------------------------------------------------------
+Placeable Buckets for Catching Rainwater
+[placeable_buckets]
+-------------------------------------------------------------------------------------------------------------
+
+-------------------------------------------------------------------------------------------------------------
+About
+-------------------------------------------------------------------------------------------------------------
+This mod overrides buckets from the buckets mod, so that they can be placed on the ground. These buckets come with a variety of optional features:
+* Catching rainwater over time, which may be useful for situations where easy water renewing is disabled. Requires climate_api.
+* Liquid source nodes will fall into an empty bucket if it's above one.
+* Water will cool lava buckets, at which point they turn into either a block of obsidian or a block of stone.
+* Lava will vaporize any water in nearby buckets.
+* Items thrown into full lava buckets will be incinerated. Requires entitycontrol.
+* Empty and water buckets can be used as inlets for pipe networks from the waterworks mod.
+
+-------------------------------------------------------------------------------------------------------------
+Dependencies and Support
+-------------------------------------------------------------------------------------------------------------
+Hard dependencies:
+* bucket
+* default
+
+Soft dependencies:
+* climate_api, to allow humid weather to slowly fill empty buckets with water.
+* entitycontrol, to override item entities so that they are incinerated upon landing on lava buckets.
+* waterworks, in which empty and water buckets can be used as inlets. Requires my fork, which modifies the api to allow liquid in inlets to be transported.
+
+-------------------------------------------------------------------------------------------------------------
+License
+-------------------------------------------------------------------------------------------------------------
+The LGPL v2.1 License is used with this mod. See https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html or LICENSE.txt for more details.
+
+-------------------------------------------------------------------------------------------------------------
+Installation
+-------------------------------------------------------------------------------------------------------------
+Download, unzip, and place within the usual minetest/current/mods folder, and it will behave in relation to the Minetest engine like any other mod.

api.txt

@@ -0,0 +1,28 @@
+Registration Functions
+---------
+
+placeable_buckets.register(name, def)
+	--Turn an existing bucket into a fillable bucket.
+	--Currently, this function does assume that a craftitem version of the bucket already exists.
+	--Inherits from minetest.register_node
+
+	_replace = "modename:itemname",
+	--The original name of the bucket, which will be replaced and aliased.
+
+	description = "Description",
+
+	_texture_base = "texture",
+	--The name of the set of textures that this bucket will use, which should specifically be a .png file.
+	--There should be 10 of these in total. In the textures folder, these textures would actually be "texture_1.png", "texture_2.png", etc.
+	--Omit the ending underscore, number, and .png
+
+	_groupname = "group",
+	--A copy of this node is created for every visually distinct fill level.
+	--To group these nodes togeter, this group name is required.
+
+	_register_per_level = function(level)
+	--This allows you to specify definition differences based on each fill level.
+
+	_on_fill = function(pos, level)
+	--Any time the bucket is filled, this function should be called.
+	--This includes occasions where the fill level is incremented by a fraction, and the bucket doens't visually change.

init.lua

@@ -0,0 +1,406 @@
+--[[
+Placeable Buckets for Catching Rainwater
+Copyright (C) 2020 Noodlemire
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+--]]
+
+--Mod-specific global variable
+placeable_buckets = {}
+
+--Get the translator wrapper for various bucket descriptions.
+local S = minetest.get_translator("bucket")
+
+--Make a copy of the empty bucket's definition to freely change.
+local empty_def = table.copy(minetest.registered_items["bucket:bucket_empty"])
+
+--Give the definition properties that are reserved for nodes, including a custom bucket mesh.
+empty_def.drawtype = "mesh"
+empty_def.mesh = "placeable_bucket.obj"
+empty_def.tiles = {"placeable_bucket_empty.png"}
+empty_def.use_texture_alpha = true
+empty_def.wield_image = "bucket.png"
+empty_def.sounds = default.node_sound_metal_defaults()
+
+--Give it a paramtype so that it won't block light.
+empty_def.paramtype = "light"
+
+--Give it some node-related groups
+empty_def.groups.empty_bucket = 1
+empty_def.groups.oddly_breakable_by_hand = 1
+
+--The waterworks_connected group is used to allow empty buckets to be used in waterworks' pipe networks.
+empty_def.groups.waterworks_connected = 1
+
+--A simple collision box that is just big enough to fit the whole bucket mesh.
+empty_def.collision_box = {
+	type = "fixed",
+	fixed = {
+		{-6/16, -8/16, -6/16, 6/16, 3/16, 6/16},
+	},
+}
+empty_def.selection_box = empty_def.collision_box
+
+--Can't register a node that defines these fields, so they must be erased from the copied definition table.
+empty_def.name = nil
+empty_def.type = nil
+empty_def.mod_origin = nil
+
+--Can't override a craftitem into a node, so buckets need to be aliased into new nodes instead.
+minetest.register_node("placeable_buckets:empty", empty_def)
+minetest.register_alias_force("bucket:bucket_empty", "placeable_buckets:empty")
+
+
+
+--A helper that will copy all fields in t2 into t1.
+--Fields inside inner tables will also be individually copied.
+--Provided tables should be given as references, so there is no return value.
+local function deepmerge(t1, t2)
+	if not t2 then
+		return
+	end
+
+	t1 = t1 or {}
+
+	for k, v in pairs(t2) do
+		if type(v) == "table" then
+			deepmerge(t1[k], v)
+		else
+			t1[k] = v
+		end
+	end
+end
+
+--This function changes an existing bucket into a placeable bucket.
+--Note that currently, it must replace an existing bucket type that is filled.
+function placeable_buckets.register(name, def)
+	--Different treatment is given to the 9 levels of partially filled buckets.
+	for i = 1, 9 do
+		--Copy the empty bucket's definition to use as a base.
+		local new_def = table.copy(empty_def)
+		--Allow buckets to define fields that change based on current fill level.
+		local extra_def = (new_def._register_per_level or function() return {} end)(i)
+
+		--Default the waterworks_connected group to 0.
+		new_def.groups.waterworks_connected = 0
+
+		--Merge the given definition information into the copied definition.
+		deepmerge(new_def, def)
+		deepmerge(new_def, extra_def)
+
+		--Give it a distinct description so that if different fill levels are /given, it's possible to tell them apart.
+		new_def.description = def.description.." "..i
+		--Only one model exists, which has every possible fill level present. The shown fill level occurs simply by using different textures.
+		new_def.tiles = {def._texture_base.."_"..i..".png"}
+		--Until a bucket is full, it is only allowed to give an empty bucket when destroyed.
+		new_def.drop = "placeable_buckets:empty"
+
+		--Replace the empty_bucket group with a new groupname used mainly for ABMs.
+		--The number in _groupname should always be the current fill level.
+		new_def.groups.empty_bucket = 0
+		new_def.groups[def._groupname] = i
+
+		--Partially full buckets don't need to clutter the creative inventory.
+		new_def.groups.not_in_creative_inventory = 1
+
+		--Finally, register the bucket that this fill level.
+		minetest.register_node(name.."_"..i, new_def)
+	end
+
+	--This time, base the new_def on whichever bucket type is being replaced.
+	local new_def = table.copy(minetest.registered_items[def._replace])
+	--The fill-level-specific registration function can also apply here, with a fill level of 10.
+	local extra_def = (new_def._register_per_level or function() return {} end)(10)
+
+	--Merge the given definition information into the copied definition.
+	deepmerge(new_def, def)
+	deepmerge(new_def, extra_def)
+
+	--Can't register a node that defines these fields, so they must be erased from the copied definition table.
+	--(This isn't done for the partially filled buckets because they copy a definition table that already did this.)
+	new_def.name = nil
+	new_def.type = nil
+	new_def.mod_origin = nil
+
+	--Add information that was also given to the empty_bucket's definition.
+	new_def.drawtype = "mesh"
+	new_def.mesh = "placeable_bucket.obj"
+	new_def.tiles = {def._texture_base.."_10.png"}
+	new_def.use_texture_alpha = true
+	new_def.wield_image = new_def.inventory_image
+	new_def.sounds = default.node_sound_metal_defaults()
+	new_def.paramtype = "light"
+	new_def.groups[def._groupname] = 10
+	new_def.groups.oddly_breakable_by_hand = 1
+
+	new_def.collision_box = {
+		type = "fixed",
+		fixed = {
+			{-6/16, -8/16, -6/16, 6/16, 3/16, 6/16},
+		},
+	}
+	new_def.selection_box = empty_def.collision_box
+
+	--The default on_place function, which is to dump out the bucket's contents.
+	local dump_on_place = new_def.on_place
+	--Create a new on_place function, which will place the bucket itself if the player is currently sneaking.
+	new_def.on_place = function(itemstack, placer, pointed_thing)
+		if placer:get_player_control()["sneak"] then
+			return minetest.item_place(itemstack, placer, pointed_thing)
+		else
+			return dump_on_place(itemstack, placer, pointed_thing)
+		end
+	end
+
+	--Register the node version of the full bucket, and alias it over the original.
+	--This is done because it isn't possible to override a craftitem into a node.
+	minetest.register_node(name.."_10", new_def)
+	minetest.register_alias_force(def._replace, name.."_10")
+end
+
+--A helper function for water buckets' functionality with the waterworks mod.
+local function place_inlet(pos)
+	if waterworks then
+		waterworks.place_connected(pos, "inlet", {pos = pos, target = vector.add(pos, {x=0, y=1, z=0}), pressure = pos.y})
+	end
+end
+
+--Regular water buckets, which can work as inlets for the waterworks mod when it is active.
+placeable_buckets.register("placeable_buckets:water", {
+	_replace = "bucket:bucket_water",
+	description = S("Water Bucket"),
+	_texture_base = "placeable_bucket_water",
+	_groupname = "water_bucket",
+
+	groups = {waterworks_connected = 1},
+	place_param2 = 4,
+
+	_waterworks_update_connected = place_inlet,
+
+	on_construct = function(pos)
+		place_inlet(pos)
+
+		if minetest.get_node(pos).name == "placeable_buckets:water_10" then
+			minetest.get_meta(pos):set_int("stored_liquid", 1)
+		end
+	end,
+
+	on_destruct = function(pos)
+		if waterworks then
+			waterworks.remove_connected(pos, "inlet")
+		end
+	end,
+
+	_on_fill = function(pos, level)
+		if level >= 10 then
+			minetest.get_meta(pos):set_int("stored_liquid", 1)
+		end
+	end,
+
+	--A waterworks compatability function, which empties the bucket whenever it deposits water into a pipe network.
+	_waterworks_on_liquid_taken = function(pos, meta)
+		if meta:get_int("stored_liquid") <= 0 then
+			minetest.swap_node(pos, {name = "placeable_buckets:empty"})
+			meta:set_int("water_level", 0)
+		end
+	end,
+})
+
+--River water buckets, which have very little functionality other than existing.
+placeable_buckets.register("placeable_buckets:river_water", {
+	_replace = "bucket:bucket_river_water",
+	description = S("River Water Bucket"),
+	_texture_base = "placeable_bucket_river_water",
+	_groupname = "river_water_bucket"
+})
+
+--Lava buckets, which double as light sources depending on how much lava is present.
+--Note that currently, partially full lava buckets are only obtainable through the /give command.
+placeable_buckets.register("placeable_buckets:lava", {
+	_replace = "bucket:bucket_lava",
+	description = S("Lava Bucket"),
+	_texture_base = "placeable_bucket_lava",
+	_groupname = "lava_bucket",
+
+	_register_per_level = function(i)
+		return {
+			light_source = minetest.LIGHT_MAX - 10 + i
+		}
+	end
+})
+
+
+
+--If the climate_api mod is present, rain will slowly fill empty_buckets with water.
+if climate_api and minetest.settings:get_bool("placeable_buckets_rain_filling_buckets") then
+	minetest.register_abm({
+		label = "Rain Filling Buckets",
+
+		nodenames = {"group:empty_bucket", "group:water_bucket"},
+
+		interval = 5,
+		chance = 5,
+
+		action = function(pos, node)
+			--If the current bucket is already full, nothing more needs to be done.
+			if minetest.get_item_group(node.name, "water_bucket") >= 10 then
+				return
+			end
+
+			--Humidity is used to determine when water should fill a bucket.
+			local humi = climate_api.environment.get_humidity(pos)
+
+			--If humidity is at least a 50%...
+			if humi > 50 then
+				--Get the current and future water levels.
+				--Note that water level growth gets faster if it's extra humid.
+				local meta = minetest.get_meta(pos)
+				local water_level = meta:get_int("water_level") or 0
+				local new_water_level = math.min(water_level + (humi - 50) / 10, 100)
+
+				--Flooring is used to know if the bucket should visually fill up some more.
+				if math.floor(water_level / 10) < math.floor(new_water_level / 10) then
+					minetest.swap_node(pos, {name = "placeable_buckets:water_"..math.floor(new_water_level / 10)})
+				end
+
+				--Either way, set the new water level.
+				meta:set_int("water_level", new_water_level)
+
+				--Lastly, let nodes define a callback so that they may do something each time they're filled.
+				local def = minetest.registered_nodes[node.name]
+				if def._on_fill then
+					def._on_fill(pos, new_water_level)
+				end
+			end
+		end
+	})
+end
+
+--This ABM allows liquids on top of empty buckets to fill them.
+--This only happens to the source blocks though, since they're essentially the only units of liquid that actually exist.
+if minetest.settings:get_bool("placeable_buckets_source_filling_buckets") then
+	minetest.register_abm({
+		label = "Sources Filling Buckets",
+
+		nodenames = {"group:empty_bucket"},
+		neighbors = {"default:water_source", "default:river_water_source", "default:lava_source"},
+
+		interval = 1,
+		chance = 1,
+
+		action = function(pos, node)
+			--Get the node above this one, to check later.
+			local above = table.copy(pos)
+			above.y = above.y + 1
+			local anode = minetest.get_node(above)
+			--This variable defaults to false, so that any one of the three following if statements can set it to true.
+			local filled = false
+
+			--Replace the empty bucket with a filled bucket, the type depending on the type of liquid removed.
+			if anode.name == "default:water_source" then
+				minetest.set_node(pos, {name = "placeable_buckets:water_10"})
+				filled = true
+			elseif anode.name == "default:river_water_source" then
+				minetest.set_node(pos, {name = "placeable_buckets:river_water_10"})
+				filled = true
+			elseif anode.name == "default:lava_source" then
+				minetest.set_node(pos, {name = "placeable_buckets:lava_10"})
+				filled = true
+			end
+
+			--If something filled the bucket...
+			if filled then
+				--Delete the source block above the bucket
+				minetest.remove_node(above)
+
+				--Lastly, let nodes define a callback so that they may do something each time they're filled.
+				--get_node is used so that the appropriate node name is obtained, since the node has changed at this point.
+				local def = minetest.registered_nodes[minetest.get_node(pos).name]
+				if def._on_fill then
+					def._on_fill(pos, 10)
+				end
+			end
+		end
+	})
+end
+
+--This allows water to cool nearby lava buckets into stone or obsidian.
+if minetest.settings:get_bool("placeable_buckets_cooling_lava_buckets") then
+	minetest.register_abm({
+		label = "Cooling Lava Buckets",
+
+		nodenames = {"group:lava_bucket"},
+		neighbors = {"group:cools_lava"},
+
+		interval = 3,
+		chance = 3,
+
+		action = function(pos, node)
+			if minetest.get_item_group(node.name, "lava_bucket") >= 10 then
+				--If this lava bucket is already full, replace it with an obsidian block.
+				minetest.set_node(pos, {name = "default:obsidian"})
+			else
+				--Otherwise, replace it with stone.
+				--Note that currently, partially full lava buckets are unobtainable without /give.
+				minetest.set_node(pos, {name = "default:stone"})
+			end
+
+			minetest.sound_play("default_cool_lava", {pos = pos, max_hear_distance = 16, gain = 0.25}, true)
+		end
+	})
+end
+
+--This allows lava to vaporize the water or river water in nearby buckets.
+if minetest.settings:get_bool("placeable_buckets_vaporizing_water_buckets") then
+	minetest.register_abm({
+		label = "Vaporizing Water Buckets",
+
+		nodenames = {"group:water_bucket", "group:river_water_bucket"},
+		neighbors = {"group:igniter"},
+
+		interval = 3,
+		chance = 3,
+
+		action = function(pos, node)
+			minetest.set_node(pos, {name = "placeable_buckets:empty"})
+			minetest.sound_play("default_cool_lava", {pos = pos, max_hear_distance = 16, gain = 0.25}, true)
+		end
+	})
+end
+
+--If the entitycontrol mod is active, this will allow full lava buckets to incinerate items thrown "into" them.
+--Bucket collision is technically just a solid cube, so it's enough for the item to just land on top.
+if entitycontrol and minetest.settings:get_bool("placeable_buckets_lava_buckets_incinerate_items") then
+	--Get the item's current on_step method.
+	local old_on_step = minetest.registered_entities["__builtin:item"].on_step
+	--Override it with this extended version of the method.
+	entitycontrol.override_entity("__builtin:item", {on_step = function(self, dtime, moveresult)
+		--Call the previous on_step first, which handles stuff like when items should despawn.
+		old_on_step(self, dtime, moveresult)
+
+		--Only continue if the item is currently on the ground.
+		if moveresult.touching_ground then
+			--For each collision...
+			for _, c in pairs(moveresult.collisions) do
+				--If it's colliding with a full lava bucket...
+				if c.type == "node" and minetest.get_node(c.node_pos).name == "placeable_buckets:lava_10" then
+					--Delete the item.
+					self.object:remove()
+					minetest.sound_play("default_cool_lava", {pos = pos, max_hear_distance = 16, gain = 0.25}, true)
+				end
+			end
+		end
+	end})
+end

mod.conf

@@ -0,0 +1,5 @@
+placeable_buckets
+description = Allows empty buckets to be placed as nodes in order to collect rainwater.
+depends = bucket, default
+optional_depends = climate_api, entitycontrol, waterworks
+min_minetest_version = 5.3.0

settingtypes.txt

@@ -0,0 +1,5 @@
+placeable_buckets_rain_filling_buckets (Allow Rain to Fill Buckets) bool true
+placeable_buckets_source_filling_buckets (Allow Liquid Source Blocks to Fill Empty Buckets When Placed on Top; requires climate_api) bool true
+placeable_buckets_cooling_lava_buckets (Allow Water and Ice to Cool Lava Buckets) bool true
+placeable_buckets_vaporizing_water_buckets (Allow Lava and Fire to Vaporize Water in Buckets) bool true
+placeable_buckets_lava_buckets_incinerate_items (Allow Lava Buckets to Incinerate Items Thown on Top; requires entitycontrol) bool true