Merge pull request #25 from ZtModArchive/bigarluq

Bigarluq

Author: Zt-freak

castor.json

@@ -2,7 +2,7 @@
   "ArchiveName": "zzz-ArluqTools",
   "RepoName": "ZtModArchive/ArluqTools",
   "Author": "Apodemus",
-  "Version": "v2.4",
+  "Version": "v2.5",
   "Type": "package",
   "License": "MIT License",
   "Description": "This is a lua library that is an abstraction  layer around ZT2's libraries.",

scripts/arluq.lua

@@ -5,6 +5,8 @@ include "modules/ZtModArchive/ArluqTools/scripts/services/AnimalService.lua"
 include "modules/ZtModArchive/ArluqTools/scripts/services/CollectionService.lua"
 include "modules/ZtModArchive/ArluqTools/scripts/services/FenceService.lua"
 include "modules/ZtModArchive/ArluqTools/scripts/services/GuestService.lua"
+include "modules/ZtModArchive/ArluqTools/scripts/services/TimeService.lua"
+include "modules/ZtModArchive/ArluqTools/scripts/services/ZooService.lua"
 
 --- Big Daddy Arluq class
 aq = {}
@@ -16,4 +18,6 @@ aq.tryCatch = tryCatch
 aq.collection = CollectionService
 aq.animal = AnimalService
 aq.fence = FenceService
-aq.guest = GuestService
+aq.guest = GuestService
+aq.time = TimeService
+aq.zoo = ZooService

scripts/services/AnimalService.lua

@@ -1,9 +1,3 @@
---- @todo
--- suppressing rampage
--- get/set variations
--- get/set skin variations
--- get/set deletable
-
 -- Include Zoo Tycoon 2 libraries
 include "scenario/scripts/entity.lua"
 include "scenario/scripts/misc.lua"
@@ -100,6 +94,15 @@ function AnimalService.setOld (animal, isOld)
     animal:BFG_ENTITY_MORPH_TO_NEW_ENTITY(species .. age .. gender .. old .. super, false, 0, false, 1)
 end
 
+---- ATTACK ----
+
+--- Get if animal is attacked
+--- @param animal animal
+--- @return bool
+function AnimalService.getAttacked (animal)
+    return animal:BFG_GET_ATTR_BOOLEAN("b_Attacked")
+end
+
 ---- BATHROOM ----
 
 --- Get animal bathroom stat
@@ -206,6 +209,15 @@ function AnimalService.setEnviroment (animal, enviroment)
     setNeed(animal, "enviroment", enviroment)
 end
 
+---- ESCAPE ----
+
+--- Get if animal is escaped
+--- @param animal animal
+--- @return bool
+function AnimalService.getEscaped (animal)
+    return animal:BFG_GET_ATTR_BOOLEAN("b_Escaped")
+end
+
 ---- EXERCISE ----
 
 --- Get animal exercise stat

scripts/services/TimeService.lua

@@ -0,0 +1,32 @@
+include "scenario/scripts/misc.lua"
+
+--- Service for time properties
+TimeService = {}
+
+---- MONTH ----
+
+--- Get current month
+--- @return float
+function TimeService.getMonth ()
+    return getCurrentMonth()
+end
+
+---- TIME ----
+
+--- Get current time of day
+--- @return float
+function TimeService.getTime ()
+    return getCurrentTimeOfDay()
+end
+
+--- Get real time
+--- @return float
+function TimeService.getRealTime ()
+    return getRealTime()
+end
+
+--- Get sim time
+--- @return float
+function TimeService.getSimTime ()
+    return getCurrentSimTime()
+end

scripts/services/ZooService.lua

@@ -0,0 +1,65 @@
+include "scenario/scripts/misc.lua"
+
+--- Service for zoo management
+ZooService = {}
+
+---- ANIMALS ----
+
+--- Get number of animals put up for adoption
+--- @return float
+function ZooService.getAnimalsPutUpForAdoption  ()
+    return getAnimalsPutUpForAdoption()
+end
+
+--- Get number of released animals
+--- @return float
+function ZooService.getAnimalsReleased  ()
+    return getAnimalsReleased()
+end
+
+---- BALLOONS ----
+
+--- Give balloons
+function ZooService.giveBalloons   ()
+    giveBalloons ()
+end
+
+---- ENTRANCE ----
+
+--- Get zoo entrance position
+--- @return table
+function ZooService.getZooEntrancePos  ()
+    return getZooEntrancePos()
+end
+
+---- FAME ----
+
+--- Get zoo fame
+--- @return float
+function ZooService.getZooFame   (cash)
+    return getZooFame(cash)
+end
+
+---- FINANCE ----
+
+--- Give cash
+--- @param cash float
+function ZooService.giveCash  (cash)
+    giveCash(cash)
+end
+
+---- GUESTS ----
+
+--- Get total guest count
+--- @return float
+function ZooService.getNumGuests ()
+    return getNumGuests()
+end
+
+---- NAME ----
+
+--- Get zoo name
+--- @return string
+function ZooService.getZooName   ()
+    return getZooName ()
+end