Merge branch 'v2-animalservice' into v2-animallistservice

Author: Zt-freak

scripts/modules/ArluqTools/ArluqTools1/services/AnimalService.lua

@@ -3,6 +3,7 @@ include "scenario/scripts/entity.lua"
 include "scenario/scripts/misc.lua"
 include "scenario/scripts/token.lua"
 include "scenario/scripts/ui.lua"
+include "scripts/canreproduce.lua"
 
 --- Service for modifiying animals.
 AnimalService = {}
@@ -70,6 +71,22 @@ function AnimalService.setBathroom (animal, bathroom)
     setNeed(animal, "bathroom", bathroom)
 end
 
+---- BREATH ----
+
+--- Get animal breath
+--- @param animal animal
+--- @return float
+function AnimalService.getBreath (animal)
+    return animal:BFG_GET_ATTR_FLOAT("breath")
+end
+
+--- Set animal breath
+--- @param animal animal
+--- @param breath float
+function AnimalService.setBreath (animal, breath)
+    setNeed(animal, "breath", breath)
+end
+
 ---- CRATE ----
 
 --- Set animal crated status
@@ -83,6 +100,20 @@ function AnimalService.setCrated (animal, isCrated)
     end
 end
 
+--- Get whether or not an animal can be crated
+--- @param animal animal
+--- @return bool
+function AnimalService.getCrateOption (animal)
+    return animal:BFG_GET_ATTR_BOOLEAN("b_showCrate")
+end
+
+--- Set whether or not an animal can be crated
+--- @param animal animal
+--- @param canBeCrated bool
+function AnimalService.setCrateOption (animal, canBeCrated)
+    animal:BFG_SET_ATTR_BOOLEAN("b_showCrate", canBeCrated)
+end
+
 ---- DELETE ----
 
 --- Delete animal
@@ -123,6 +154,18 @@ function AnimalService.setExercise (animal, exercise)
     setNeed(animal, "exercise", exercise)
 end
 
+---- FAMILY ----
+
+--- Get an animal's children
+--- @param animal animal
+--- @return animalList
+function AnimalService.getChildren (animal)
+    local childrenList = animal:sendMessage("BFAI_GET_RELATED_ENTITIES", "child")
+    if childrenList ~= nil and type(childrenList) == "table" then
+        return childrenList
+    end
+end
+
 ---- GENDER ----
 
 --- Get animal gender, returns true if male, false if female
@@ -202,6 +245,22 @@ function AnimalService.setHygiene (animal, hygiene)
     setNeed(animal, "hygiene", hygiene)
 end
 
+---- LIFESPAN ----
+
+--- Get animal lifespan
+--- @param animal animal
+--- @return float
+function AnimalService.getLifespan (animal)
+    return animal:BFG_GET_ATTR_FLOAT("lifespan")
+end
+
+--- Set animal lifespan
+--- @param animal animal
+--- @param lifespan float
+function AnimalService.setLifespan (animal, lifespan)
+    setNeed(animal, "lifespan", lifespan)
+end
+
 ---- PREGNANCY ----
 
 --- Get if animal is pregnant
@@ -229,6 +288,13 @@ function AnimalService.setPregnant (animal, isPregnant)
     end
 end
 
+--- Get if animal has pregnancy token
+--- @param animal animal
+--- @return bool
+function AnimalService.getPregnancyToken (animal)
+    return checkforpregnant(animal)
+end
+
 ---- PRIVACY ----
 
 --- Get animal privacy
@@ -277,6 +343,29 @@ function AnimalService.setReleaseOption (animal, canBeReleased)
     animal:BFG_SET_ATTR_BOOLEAN("b_showRelease", canBeReleased)
 end
 
+---- REPRODUCTION ----
+
+--- Get animal reproduction stat
+--- @param animal animal
+--- @return float
+function AnimalService.getReproduction (animal)
+    return animal:BFG_GET_ATTR_FLOAT("reproduction")
+end
+
+--- Set animal reproduction stat
+--- @param animal animal
+--- @param reproduction float
+function AnimalService.setReproduction (animal, reproduction)
+    setNeed(animal, "reproduction", reproduction)
+end
+
+--- Get if animal can reproduce
+--- @param animal animal
+--- @return bool
+function AnimalService.getCanReproduce (animal)
+    return canreproduce(animal)
+end
+
 ---- REST ----
 
 --- Get animal rest status