Prototype: Liquid objects

Stackable liquid objects, as a prototype for storing liquids

planet/Objects.ocd/Libraries.ocd/LiquidControl.ocd/Liquid.ocd/Acid.ocd/DefCore.txt

@@ -0,0 +1,10 @@
+[DefCore]
+id=Liquid_Acid
+Version=7,0
+Category=C4D_StaticBack
+Picture=0,0,128,128
+Width=64
+Height=64
+Offset=-32,-32
+Mass=1
+Value=1

planet/Objects.ocd/Libraries.ocd/LiquidControl.ocd/Liquid.ocd/Acid.ocd/Script.c

@@ -0,0 +1,5 @@
+#include Library_Liquid
+
+func IsLiquid() { return "Acid"; }
+
+local Name="$Name$";

planet/Objects.ocd/Libraries.ocd/LiquidControl.ocd/Liquid.ocd/Acid.ocd/StringTblDE.txt

@@ -0,0 +1 @@
+Name=Säure

planet/Objects.ocd/Libraries.ocd/LiquidControl.ocd/Liquid.ocd/Acid.ocd/StringTblUS.txt

@@ -0,0 +1 @@
+Name=Acid

planet/Objects.ocd/Libraries.ocd/LiquidControl.ocd/Liquid.ocd/DefCore.txt

@@ -0,0 +1,4 @@
+[DefCore]
+id=Library_Liquid
+Version=7,0
+Category=C4D_StaticBack

planet/Objects.ocd/Libraries.ocd/LiquidControl.ocd/Liquid.ocd/Lava.ocd/DefCore.txt

@@ -0,0 +1,10 @@
+[DefCore]
+id=Liquid_Lava
+Version=7,0
+Category=C4D_StaticBack
+Picture=0,0,128,128
+Width=64
+Height=64
+Offset=-32,-32
+Mass=1
+Value=1

planet/Objects.ocd/Libraries.ocd/LiquidControl.ocd/Liquid.ocd/Lava.ocd/Script.c

@@ -0,0 +1,5 @@
+#include Library_Liquid
+
+func IsLiquid() { return "Lava"; }
+
+local Name="$Name$";

planet/Objects.ocd/Libraries.ocd/LiquidControl.ocd/Liquid.ocd/Lava.ocd/StringTblDE.txt

@@ -0,0 +1 @@
+Name=Lava

planet/Objects.ocd/Libraries.ocd/LiquidControl.ocd/Liquid.ocd/Lava.ocd/StringTblUS.txt

@@ -0,0 +1 @@
+Name=Lava

planet/Objects.ocd/Libraries.ocd/LiquidControl.ocd/Liquid.ocd/Oil.ocd/DefCore.txt

@@ -0,0 +1,10 @@
+[DefCore]
+id=Liquid_Oil
+Version=6,0
+Category=C4D_StaticBack
+Picture=0,0,128,128
+Width=64
+Height=64
+Offset=-32,-32
+Mass=1
+Value=8

planet/Objects.ocd/Libraries.ocd/LiquidControl.ocd/Liquid.ocd/Oil.ocd/Script.c

@@ -0,0 +1,5 @@
+#include Library_Liquid
+
+func IsLiquid() { return "Oil"; }
+
+local Name="$Name$";

planet/Objects.ocd/Libraries.ocd/LiquidControl.ocd/Liquid.ocd/Oil.ocd/StringTblDE.txt

@@ -0,0 +1 @@
+Name=Öl

planet/Objects.ocd/Libraries.ocd/LiquidControl.ocd/Liquid.ocd/Oil.ocd/StringTblUS.txt

@@ -0,0 +1 @@
+Name=Oil

planet/Objects.ocd/Libraries.ocd/LiquidControl.ocd/Liquid.ocd/Script.c

@@ -0,0 +1,97 @@
+/**
+ * Liquid
+ *
+ * Basic interface for liquids. The logic for adding and removing liquid,
+ * PutLiquid() and RemoveLiquid() is deliberately the same as in the
+ * liquid container, so that scripts can be read more easily.
+ *
+ * Author: Marky
+ */
+
+#include Library_Stackable
+
+
+func IsLiquid() { return "undefined"; }
+func GetLiquidAmount() { return GetStackCount(); }
+func MaxStackCount() { return 999; } // was 1000000, but the stackable_max_count is hindering here. Copying the whole stackable library does not seem useful, though
+
+
+protected func Construction()
+{
+	_inherited(...);
+	SetStackCount(1); // not max stack!
+}
+
+
+// 10 liquid items count as 1 mass unit
+// this may have to be tuned or made object-specific?
+private func UpdateMass()
+{
+	SetMass(GetID()->GetMass() * Max(GetStackCount(), 1) / 10);
+}
+
+// 100 liquid items count as 1 wealth unit
+// this may have to be tuned or made object-specific?
+public func CalcValue(object in_base, int for_plr)
+{
+	return GetID()->GetValue() * Max(GetStackCount(), 1) / 100;
+}
+
+
+/** 
+Inserts liquid into the object.
+@param liquid_name: Material to insert
+@param amount: Max Amount of Material being inserted 
+@param source: Object which inserts the liquid
+@return returned_amount: The inserted amount
+*/
+func PutLiquid(string liquid_name, int amount, object source)
+{
+	if (amount < 0)
+	{
+		FatalError(Format("You can insert positive amounts of liquid only, got %d", amount));
+	}
+
+	if (IsLiquid() == liquid_name)
+	{
+		amount = Max(amount, MaxStackCount() - GetStackCount());
+		DoStackCount(amount);
+		return amount;
+	}
+	else //Wrong material?
+	{
+		return 0;
+	}
+}
+
+
+/**
+Extracts liquid from the object.
+@param liquid_name: Material to extract; Wildcardsupport
+               Defaults to the current liquid if 'nil' is passed.
+@param amount: Max Amount of liquid being extracted;
+               Defaults to all contained liquid if 'nil' is passed.
+@param destination: Object that extracts the liquid
+@return [returned_liquid, returned_amount]
+	   - returned_liquid: Material being extracted
+	   - returned_amount: Amount being extracted
+*/
+func RemoveLiquid(string liquid_name, int amount, object destination)
+{
+	if (amount < 0)
+	{
+		FatalError(Format("You can remove positive amounts of liquid only, got %d", amount));
+	}
+
+	// default parameters if nothing is provided: the current material and level
+	liquid_name = liquid_name ?? IsLiquid();
+	amount = amount ?? GetLiquidAmount();
+
+	//Wrong material?
+	if (!WildcardMatch(IsLiquid(), liquid_name))
+		return [IsLiquid(), 0];
+
+	amount = Min(amount, GetLiquidAmount());
+	DoStackCount(-amount);
+	return [liquid_name, amount];
+}

planet/Objects.ocd/Libraries.ocd/LiquidControl.ocd/Liquid.ocd/Water.ocd/DefCore.txt

@@ -0,0 +1,10 @@
+[DefCore]
+id=Liquid_Water
+Version=7,0
+Category=C4D_StaticBack
+Picture=0,0,128,128
+Width=64
+Height=64
+Offset=-32,-32
+Mass=1
+Value=0

planet/Objects.ocd/Libraries.ocd/LiquidControl.ocd/Liquid.ocd/Water.ocd/Script.c

@@ -0,0 +1,5 @@
+#include Library_Liquid
+
+func IsLiquid() { return "Water"; }
+
+local Name="$Name$";

planet/Objects.ocd/Libraries.ocd/LiquidControl.ocd/Liquid.ocd/Water.ocd/StringTblDE.txt

@@ -0,0 +1 @@
+Name=Wasser

planet/Objects.ocd/Libraries.ocd/LiquidControl.ocd/Liquid.ocd/Water.ocd/StringTblUS.txt

@@ -0,0 +1 @@
+Name=Water