animals.lua

local function animal_is_geldable(unit)
	local bparts = df.global.world.raws.creatures.all[unit.race].caste[unit.caste].body_info.body_parts

	for i,v in ipairs(bparts) do
		if v.flags.GELDABLE then
			return true
		end
	end

	return false
end

--luacheck: in=
function animals_get()
    return execute_with_status_page(status_pages.Animals, function(ws)
    	local ws = ws --as:df.viewscreen_petst
		local ret = {}

		for i,v in ipairs(ws.is_vermin) do
			if istrue(v) then
				local item = ws.animal[i].item --as:df.item_petst

				if item._type == df.item_petst then -- just in case
					local title = itemname(item, 0, true)

					local ownerid = item.owner_id
					local owner = (ownerid ~= -1) and df.unit.find(ownerid) or nil
					local ownername = owner and unit_fulltitle(owner) or mp.NIL

					local flags = bit(1,true) + bit(2,item.pet_flags.available_for_adoption) + bit(12,true)

					table.insert(ret, { title, item.id, 0, ownername, flags, mp.NIL, 0 })
				end

			else
				local unit = ws.animal[i].unit

				local prof = unitprof(unit)
				local work = (unit.profession == df.profession.TRAINED_WAR or unit.profession == df.profession.TRAINED_HUNTER)
				local ownerid = unit.relationship_ids[df.unit_relationship_type.Pet]
				local owner = (ownerid ~= -1) and df.unit.find(ownerid) or nil
				local ownername = owner and unit_fulltitle(owner) or mp.NIL

				local caste = df.creature_raw.find(unit.race).caste[unit.caste]
				local adoptable = not caste.flags.ADOPTS_OWNER
				local available = unit.flags3.available_for_adoption
				local slaughter = unit.flags2.slaughter

				local geld = unit.flags3.marked_for_gelding
				local gelded = unit.flags3.gelded
				local can_geld = not gelded and unit.sex == 1 and animal_is_geldable(unit)
				
				local trainable = not work and not owner and unit.profession ~= df.profession.CHILD
				local trainable_war = trainable and caste.flags.TRAINABLE_WAR 
				local trainable_hunting = trainable and caste.flags.TRAINABLE_HUNTING 

				local fullname = unit_fulltitle(unit)

				--xxx: I'm quite sure there will be no units with id 0,1,2, so let's use these values for our special cases
				local training = (trainable_war or trainable_hunting) and df.training_assignment.find(unit.id)
				local trainer = (training and training.trainer_id ~= -1) and df.unit.find(training.trainer_id) or nil
				local trainername = trainer and (unitname(trainer) .. ', ' .. unitprof(trainer)) or mp.NIL
				local trainerid = 0
	
				if trainer then
					trainerid = trainer.id
				elseif training and training.flags.any_trainer then
					trainerid = 1
				elseif training and training.flags.any_unassigned_trainer then
					trainerid = 2
				end
					
				local train_war = training and training.flags.train_war
				local train_hunt = training and training.flags.train_hunt

				local flags = bit(0,work) + bit(1,adoptable) + bit(2,available) + bit(3,trainable_war) + bit(4,trainable_hunting)
							+ bit(5,slaughter) + bit(6,train_war) + bit(7,train_hunt)
							+ bit(8,geld) + bit(9,can_geld) + bit(10,gelded) + bit(11,unit.flags1.tame) + bit(12,false)

				table.insert(ret, { fullname, unit.id, unit.sex, ownername, flags, trainername, trainerid })
			end
		end

		return ret
	end)
end

--luacheck: in=number,bool
function animals_set_slaughter(unitid, val)
	--xxx: should check if it's a valid action here?

	local unit = df.unit.find(unitid)

	if not unit then
		return false
	end

	unit.flags2.slaughter = istrue(val)
	return true
end

--luacheck: in=number,bool
function animals_set_geld(unitid, val)
	--xxx: should check if it's a valid action here?

	local unit = df.unit.find(unitid)
	if not unit then
		error('no unit '..tostring(unitid))
	end

	unit.flags3.marked_for_gelding = istrue(val)
	return true
end

--xxx: should check if it's a valid action here?
--luacheck: in=number,bool,bool
function animals_set_available(unitid, val, is_vermin)
	val = istrue(val)

	if istrue(is_vermin) then
		local item = df.item.find(unitid) --as:df.item_petst
		if not item or item._type ~= df.item_petst then
			error('no item or wrong item type ' .. (item and tostring(item) or tostring(unitid)))
		end

		item.pet_flags.available_for_adoption = val

		return true
	end

	local unit = df.unit.find(unitid)

	if not unit then
		error('no unit '..tostring(unitid))
	end

	unit.flags3.available_for_adoption = val

	return true
end

--luacheck: in=number,bool
function animals_train_war(unitid, val)
	local unit = df.unit.find(unitid)

	if not unit then
		return false
	end

	local training = df.training_assignment.find(unit.id)
	if not training then
		training = df.training_assignment:new()
		training.animal_id = unit.id
		utils.insert_sorted(df.global.ui.equipment.training_assignments, training, 'animal_id')
	end
	
	training.flags.train_war = true
	training.flags.train_hunt = false
	
	return true
end

--luacheck: in=number,bool
function animals_train_hunting(unitid, val)
	local unit = df.unit.find(unitid)

	if not unit then
		return false
	end

	local training = df.training_assignment.find(unit.id)
	if not training then
		training = df.training_assignment:new()
		training.animal_id = unit.id
		utils.insert_sorted(df.global.ui.equipment.training_assignments, training, 'animal_id')
	end
	
	training.flags.train_war = false
	training.flags.train_hunt = true

	return true
end

--luacheck: in=
function animals_trainer_get_choices()
	local ret = {}

	for i,unit in ipairs(df.global.world.units.active) do
		if unit_iscitizen(unit) then
			local uname = unitname(unit)
		    local prof = unitprof(unit)
		    local fullname = uname .. ', ' .. prof

		    if unit.status.labors[df.unit_labor.ANIMALTRAIN] then
		    	table.insert(ret, { fullname, unit.id })
		    end
		end
	end

	return ret
end

--luacheck: in=number,number
function animals_trainer_set(animalid, trainerid)
	local animal = df.unit.find(animalid)
	local trainer = df.unit.find(trainerid)

	if not animal or (trainerid > 2 and not trainer) then
		return false
	end

	if trainerid == 0 then
		utils.erase_sorted_key(df.global.ui.equipment.training_assignments, animalid, 'animal_id')
		return true
	end

	local training = df.training_assignment.find(animalid)
	if not training then
		training = df.training_assignment:new()
		training.animal_id = animalid
		utils.insert_sorted(df.global.ui.equipment.training_assignments, training, 'animal_id')
	end
	
	if trainerid == 1 then
		training.flags.any_trainer = true
		training.flags.any_unassigned_trainer = false
		training.trainer_id = -1
	elseif trainerid == 2 then
		training.flags.any_trainer = false
		training.flags.any_unassigned_trainer = true
		training.trainer_id = -1
	else
		training.flags.any_trainer = false
		training.flags.any_unassigned_trainer = false
		training.trainer_id = trainerid
	end

	return true
end