Create familiars lib, rename from "pet" to "familiar" and others fixes (

#366)

Somes familiars fixes and adjusts

Rename from "pet/Pet" to "familiar/Familiar"
Removed "familiar = false" from monsters, this is false by default (this change is optional)
Renamed from "mtype:isPet" to "mtype:familiar"
Fixed familiar login with god.

Co-authored-by: @beats-dh

data/events/scripts/creature.lua

@@ -4,7 +4,7 @@ function Creature:onChangeOutfit(outfit)
 		local familiarLookType = self:getFamiliarLooktype()
 		if familiarLookType ~= 0 then
 			for _, summon in pairs(self:getSummons()) do
-				if summon:getType():isPet() then
+				if summon:getType():familiar() then
 						if summon:getOutfit().lookType ~= familiarLookType then
 							summon:setOutfit({lookType = familiarLookType})
 						end

data/events/scripts/player.lua

@@ -141,7 +141,7 @@ function Player:onLook(thing, position, distance)
 			if master and table.contains({'sorcerer familiar','knight familiar','druid familiar','paladin familiar'},
 																						thing:getName():lower()) then
 				description = description..' (Master: ' .. master:getName() .. '). \z
-				It will disappear in ' .. getTimeinWords(master:getStorageValue(Storage.PetSummon) - os.time())
+				It will disappear in ' .. getTimeinWords(master:getStorageValue(Storage.FamiliarSummon) - os.time())
 			end
 		end
 	end
@@ -209,7 +209,7 @@ function Player:onLookInBattleList(creature, distance)
 		local summons = {'sorcerer familiar','knight familiar','druid familiar','paladin familiar'}
 		if master and table.contains(summons, creature:getName():lower()) then
 			description = description..' (Master: ' .. master:getName() .. '). \z
-				It will disappear in ' .. getTimeinWords(master:getStorageValue(Storage.PetSummon) - os.time())
+				It will disappear in ' .. getTimeinWords(master:getStorageValue(Storage.FamiliarSummon) - os.time())
 		end
 	end
 	if self:getGroup():getAccess() then

data/lib/core/storages.lua

@@ -106,7 +106,7 @@ Storage = {
 	combatProtectionStorage = 30023,
 	Factions = 30024,
 	blockMovementStorage = 30025,
-	PetSummon = 30026,
+	FamiliarSummon = 30026,
 	TrainerRoom = 30027,
 	NpcSpawn = 30028,
 	ExerciseDummyExhaust = 30029,
@@ -134,8 +134,8 @@ Storage = {
 	StoreExaust = 30051,
 	LemonCupcake = 30052,
 	BlueberryCupcake = 30053,
-	PetSummonEvent10 = 30054,
-	PetSummonEvent60 = 30055,
+	FamiliarSummonEvent10 = 30054,
+	FamiliarSummonEvent60 = 30055,
 	FreeQuests = 990000,
 	PremiumAccount = 998899,
 

data/lib/tables/familiar.lua

@@ -0,0 +1,29 @@
+FAMILIAR_ID = {
+	[VOCATION.BASE_ID.SORCERER] = {id = 994, name = "Sorcerer familiar"},
+	[VOCATION.BASE_ID.DRUID] = {id = 993, name = "Druid familiar"},
+	[VOCATION.BASE_ID.PALADIN] = {id = 992, name = "Paladin familiar"},
+	[VOCATION.BASE_ID.KNIGHT] = {id = 991, name = "Knight familiar"}
+}
+
+FAMILIAR_TIMER = {
+	[1] = {storage=Storage.FamiliarSummonEvent10, countdown=10, message = "10 seconds"},
+	[2] = {storage=Storage.FamiliarSummonEvent60, countdown=60, message = "one minute"}
+}
+
+function sendMessageFunction(pid, message)
+	if Player(pid) then
+		Player(pid):sendTextMessage(MESSAGE_LOOT, "Your summon will disappear in less than " .. message)
+	end
+end
+
+function removeFamiliar(creatureId, playerId)
+	local creature = Creature(creatureId)
+	local player = Player(playerId)
+	if not creature or not player then
+		return true
+	end
+	creature:remove()
+	for sendMessage = 1, #timer do
+		player:setStorageValue(timer[sendMessage].storage, -1)
+	end
+end

data/lib/tables/table.lua

@@ -2,6 +2,7 @@ dofile('data/lib/tables/vocation.lua')
 dofile('data/lib/tables/achievements_lib.lua')
 dofile('data/lib/tables/door.lua')
 dofile('data/lib/tables/exercise_training.lua')
+dofile('data/lib/tables/familiar.lua')
 dofile('data/lib/tables/hireling_items.lua')
 dofile('data/lib/tables/teleport_item_destinations.lua')
 dofile('data/lib/tables/town.lua')

data/monster/amphibics/azure_frog.lua

@@ -60,8 +60,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = false,
-	canWalkOnPoison = false,
-	pet = false
+	canWalkOnPoison = false
 }
 
 monster.light = {

data/monster/amphibics/bog_frog.lua

@@ -60,8 +60,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = false,
-	canWalkOnPoison = false,
-	pet = false
+	canWalkOnPoison = false
 }
 
 monster.light = {

data/monster/amphibics/coral_frog.lua

@@ -60,8 +60,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = false,
-	canWalkOnPoison = false,
-	pet = false
+	canWalkOnPoison = false
 }
 
 monster.light = {

data/monster/amphibics/crimson_frog.lua

@@ -60,8 +60,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = false,
-	canWalkOnPoison = true,
-	pet = false
+	canWalkOnPoison = true
 }
 
 monster.light = {

data/monster/amphibics/deathspawn.lua

@@ -47,8 +47,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = false,
-	canWalkOnPoison = true,
-	pet = false
+	canWalkOnPoison = true
 }
 
 monster.light = {

data/monster/amphibics/filth_toad.lua

@@ -60,8 +60,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = false,
-	canWalkOnPoison = false,
-	pet = false
+	canWalkOnPoison = false
 }
 
 monster.light = {

data/monster/amphibics/green_frog.lua

@@ -60,8 +60,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = false,
-	canWalkOnPoison = false,
-	pet = false
+	canWalkOnPoison = false
 }
 
 monster.light = {

data/monster/amphibics/infernal_frog.lua

@@ -60,8 +60,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = false,
-	canWalkOnPoison = true,
-	pet = false
+	canWalkOnPoison = true
 }
 
 monster.light = {

data/monster/amphibics/orchid_frog.lua

@@ -60,8 +60,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = false,
-	canWalkOnPoison = false,
-	pet = false
+	canWalkOnPoison = false
 }
 
 monster.light = {

data/monster/amphibics/salamander.lua

@@ -60,8 +60,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = false,
-	canWalkOnPoison = false,
-	pet = false
+	canWalkOnPoison = false
 }
 
 monster.light = {

data/monster/amphibics/toad.lua

@@ -61,8 +61,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = false,
-	canWalkOnPoison = false,
-	pet = false
+	canWalkOnPoison = false
 }
 
 monster.light = {

data/monster/aquatics/abyssal_calamary.lua

@@ -60,8 +60,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = true,
-	canWalkOnPoison = true,
-	pet = false
+	canWalkOnPoison = true
 }
 
 monster.light = {

data/monster/aquatics/blood_crab.lua

@@ -61,8 +61,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = false,
-	canWalkOnPoison = true,
-	pet = false
+	canWalkOnPoison = true
 }
 
 monster.light = {

data/monster/aquatics/calamary.lua

@@ -60,8 +60,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = true,
-	canWalkOnPoison = true,
-	pet = false
+	canWalkOnPoison = true
 }
 
 monster.light = {

data/monster/aquatics/crab.lua

@@ -61,8 +61,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = false,
-	canWalkOnPoison = true,
-	pet = false
+	canWalkOnPoison = true
 }
 
 monster.light = {

data/monster/aquatics/crustacea_gigantica.lua

@@ -62,8 +62,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = false,
-	canWalkOnPoison = false,
-	pet = false
+	canWalkOnPoison = false
 }
 
 monster.light = {

data/monster/aquatics/deathling_scout.lua

@@ -60,8 +60,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = true,
-	canWalkOnPoison = false,
-	pet = false
+	canWalkOnPoison = false
 }
 
 monster.light = {

data/monster/aquatics/deathling_spellsinger.lua

@@ -60,8 +60,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = true,
-	canWalkOnPoison = false,
-	pet = false
+	canWalkOnPoison = false
 }
 
 monster.light = {

data/monster/aquatics/deepling_brawler.lua

@@ -63,8 +63,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = true,
-	canWalkOnPoison = false,
-	pet = false
+	canWalkOnPoison = false
 }
 
 monster.light = {

data/monster/aquatics/deepling_elite.lua

@@ -63,8 +63,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = true,
-	canWalkOnPoison = false,
-	pet = false
+	canWalkOnPoison = false
 }
 
 monster.light = {

data/monster/aquatics/deepling_guard.lua

@@ -64,8 +64,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = true,
-	canWalkOnPoison = false,
-	pet = false
+	canWalkOnPoison = false
 }
 
 monster.light = {

data/monster/aquatics/deepling_master_librarian.lua

@@ -63,8 +63,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = true,
-	canWalkOnPoison = false,
-	pet = false
+	canWalkOnPoison = false
 }
 
 monster.light = {

data/monster/aquatics/deepling_scout.lua

@@ -63,8 +63,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = true,
-	canWalkOnPoison = false,
-	pet = false
+	canWalkOnPoison = false
 }
 
 monster.light = {

data/monster/aquatics/deepling_spellsinger.lua

@@ -63,8 +63,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = true,
-	canWalkOnPoison = false,
-	pet = false
+	canWalkOnPoison = false
 }
 
 monster.light = {

data/monster/aquatics/deepling_tyrant.lua

@@ -63,8 +63,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = true,
-	canWalkOnPoison = false,
-	pet = false
+	canWalkOnPoison = false
 }
 
 monster.light = {

data/monster/aquatics/deepling_warrior.lua

@@ -63,8 +63,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = true,
-	canWalkOnPoison = false,
-	pet = false
+	canWalkOnPoison = false
 }
 
 monster.light = {

data/monster/aquatics/deepling_worker.lua

@@ -63,8 +63,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = true,
-	canWalkOnPoison = false,
-	pet = false
+	canWalkOnPoison = false
 }
 
 monster.light = {

data/monster/aquatics/deepsea_blood_crab.lua

@@ -61,8 +61,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = true,
-	canWalkOnPoison = false,
-	pet = false
+	canWalkOnPoison = false
 }
 
 monster.light = {

data/monster/aquatics/fish.lua

@@ -60,8 +60,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = true,
-	canWalkOnPoison = true,
-	pet = false
+	canWalkOnPoison = true
 }
 
 monster.light = {

data/monster/aquatics/jellyfish.lua

@@ -63,8 +63,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = false,
 	canWalkOnFire = true,
-	canWalkOnPoison = true,
-	pet = false
+	canWalkOnPoison = true
 }
 
 monster.light = {

data/monster/aquatics/manta_ray.lua

@@ -60,8 +60,7 @@ monster.flags = {
 	isBlockable = false,
 	canWalkOnEnergy = true,
 	canWalkOnFire = false,
-	canWalkOnPoison = true,
-	pet = false
+	canWalkOnPoison = true
 }
 
 monster.light = {