PlaceableHusbandryWater

PlaceableHusbandryWater

Description

Specialization for placeables

Functions

• getConditionInfos
• onDelete
• onFinalizePlacement
• onHusbandryAnimalsCreated
• onHusbandryAnimalsUpdate
• onHusbandryFillLevelChanged
• onLoad
• onPostFinalizePlacement
• prerequisitesPresent
• registerEventListeners
• registerFunctions
• registerOverwrittenFunctions
• registerXMLPaths
• updateFeeding
• updateInfo
• updateWaterPlane

getConditionInfos

Description

Definition

getConditionInfos()

Arguments

any	superFunc

Code

function PlaceableHusbandryWater:getConditionInfos(superFunc)
    local infos = superFunc( self )
    local spec = self.spec_husbandryWater

    if not spec.automaticWaterSupply then
        local info = { }
        local fillType = g_fillTypeManager:getFillTypeByIndex(spec.fillType)
        if fillType ~ = nil then
            info.title = fillType.title
            info.value = self:getHusbandryFillLevel(spec.fillType)
            local capacity = self:getHusbandryCapacity(spec.fillType)
            local ratio = 0
            if capacity > 0 then
                ratio = info.value / capacity
            end
            info.ratio = math.clamp(ratio, 0 , 1 )
            info.invertedBar = false

            table.insert(infos, info)
        end
    end

    return infos
end

onDelete

Description

Definition

onDelete()

Code

function PlaceableHusbandryWater:onDelete()
    local spec = self.spec_husbandryWater
    if spec.waterPlane ~ = nil then
        spec.waterPlane:delete()
        spec.waterPlane = nil
    end
end

onFinalizePlacement

Description

Definition

onFinalizePlacement()

Code

function PlaceableHusbandryWater:onFinalizePlacement()
    local spec = self.spec_husbandryWater

    if not spec.automaticWaterSupply then
        if not self:getHusbandryIsFillTypeSupported(spec.fillType) then
            Logging.warning( "Missing filltype 'water' in husbandry storage! Changing to automatic water supply" )
            spec.automaticWaterSupply = true
        end
    end
end

onHusbandryAnimalsCreated

Description

Definition

onHusbandryAnimalsCreated()

Arguments

any	husbandryId

Code

function PlaceableHusbandryWater:onHusbandryAnimalsCreated(husbandryId)
    if husbandryId ~ = nil then
        local spec = self.spec_husbandryWater
        spec.husbandryId = husbandryId
        for _, waterPlace in ipairs(spec.waterPlaces) do
            local feedingPlaceIndex, isAccessible = addFeedingPlace(husbandryId, waterPlace.node, 0.0 , AnimalHusbandryFeedingType.WATER)
            if isAccessible then
                waterPlace.place = feedingPlaceIndex
            else
                    -- DebugGizmo.new():createWithNode(waterPlace.node, string.format("%q outside of nav mesh", getName(waterPlace.node))):setTextColor(Color.PRESETS.ORANGE):addToManager(nil, 30000)
                end
            end
        end
    end

onHusbandryAnimalsUpdate

Description

Definition

onHusbandryAnimalsUpdate()

Arguments

any	clusters

Code

function PlaceableHusbandryWater:onHusbandryAnimalsUpdate(clusters)
    local spec = self.spec_husbandryWater

    spec.litersPerHour = 0
    for _, cluster in ipairs(clusters) do
        local subType = g_currentMission.animalSystem:getSubTypeByIndex(cluster.subTypeIndex)
        if subType ~ = nil then
            local water = subType.input.water
            if water ~ = nil then
                local age = cluster:getAge()
                local litersPerAnimal = water:get(age)
                local litersPerDay = litersPerAnimal * cluster:getNumAnimals()

                spec.litersPerHour = spec.litersPerHour + (litersPerDay / 24 )
            end
        end
    end
end

onHusbandryFillLevelChanged

Description

Definition

onHusbandryFillLevelChanged()

Arguments

any	fillTypeIndex
any	delta

Code

function PlaceableHusbandryWater:onHusbandryFillLevelChanged(fillTypeIndex, delta)
    local spec = self.spec_husbandryWater
    if fillTypeIndex = = spec.fillType then
        self:updateWaterPlane()
    end
end

onLoad

Description

Definition

onLoad()

Arguments

any	savegame

Code

function PlaceableHusbandryWater:onLoad(savegame)
    local spec = self.spec_husbandryWater

    spec.husbandryId = nil
    spec.litersPerHour = 0
    spec.automaticWaterSupply = false
    spec.fillType = FillType.WATER
    spec.waterPlaces = { }
    spec.info = { title = g_i18n:getText( "fillType_water" ), text = "" }
    spec.automaticWaterSupply = self.xmlFile:getValue( "placeable.husbandry.water#automaticWaterSupply" , spec.automaticWaterSupply)

    spec.waterPlane = FillPlane.new()
    if spec.waterPlane:load( self.components, self.xmlFile, "placeable.husbandry.water.waterPlane" , self.i3dMappings) then
        spec.waterPlane:setState(spec.automaticWaterSupply and 1 or 0 )
    else
            spec.waterPlane:delete()
            spec.waterPlane = nil
        end

        self.xmlFile:iterate( "placeable.husbandry.water.waterPlaces.waterPlace" , function (_, key)
            local node = self.xmlFile:getValue(key .. "#node" , nil , self.components, self.i3dMappings)
            table.insert(spec.waterPlaces, { node = node, place = nil } )
        end )
    end

onPostFinalizePlacement

Description

Definition

onPostFinalizePlacement()

Code

function PlaceableHusbandryWater:onPostFinalizePlacement()
    self:updateWaterPlane()
end

prerequisitesPresent

Description

Checks if all prerequisite specializations are loaded

Definition

prerequisitesPresent(table specializations)

Arguments

table	specializations	specializations

Return Values

table	hasPrerequisite	true if all prerequisite specializations are loaded

Code

function PlaceableHusbandryWater.prerequisitesPresent(specializations)
    return true
end

registerEventListeners

Description

Definition

registerEventListeners()

Arguments

any	placeableType

Code

function PlaceableHusbandryWater.registerEventListeners(placeableType)
    SpecializationUtil.registerEventListener(placeableType, "onLoad" , PlaceableHusbandryWater )
    SpecializationUtil.registerEventListener(placeableType, "onDelete" , PlaceableHusbandryWater )
    SpecializationUtil.registerEventListener(placeableType, "onFinalizePlacement" , PlaceableHusbandryWater )
    SpecializationUtil.registerEventListener(placeableType, "onPostFinalizePlacement" , PlaceableHusbandryWater )
    SpecializationUtil.registerEventListener(placeableType, "onHusbandryAnimalsUpdate" , PlaceableHusbandryWater )
    SpecializationUtil.registerEventListener(placeableType, "onHusbandryAnimalsCreated" , PlaceableHusbandryWater )
    SpecializationUtil.registerEventListener(placeableType, "onHusbandryFillLevelChanged" , PlaceableHusbandryWater )
end

registerFunctions

Description

Definition

registerFunctions()

Arguments

any	placeableType

Code

function PlaceableHusbandryWater.registerFunctions(placeableType)
    SpecializationUtil.registerFunction(placeableType, "updateWaterPlane" , PlaceableHusbandryWater.updateWaterPlane)
end

registerOverwrittenFunctions

Description

Definition

registerOverwrittenFunctions()

Arguments

any	placeableType

Code

function PlaceableHusbandryWater.registerOverwrittenFunctions(placeableType)
    SpecializationUtil.registerOverwrittenFunction(placeableType, "updateFeeding" , PlaceableHusbandryWater.updateFeeding)
    SpecializationUtil.registerOverwrittenFunction(placeableType, "getConditionInfos" , PlaceableHusbandryWater.getConditionInfos)
    SpecializationUtil.registerOverwrittenFunction(placeableType, "updateInfo" , PlaceableHusbandryWater.updateInfo)
end

registerXMLPaths

Description

Definition

registerXMLPaths()

Arguments

any	schema
any	basePath

Code

function PlaceableHusbandryWater.registerXMLPaths(schema, basePath)
    schema:setXMLSpecializationType( "Husbandry" )
    basePath = basePath .. ".husbandry.water"
    schema:register(XMLValueType.BOOL, basePath .. "#automaticWaterSupply" , "If husbandry has a automatic water supply" , false )
    schema:register(XMLValueType.NODE_INDEX, basePath .. ".waterPlaces.waterPlace(?)#node" , "Water place" )
    FillPlane.registerXMLPaths(schema, basePath .. ".waterPlane" )
    schema:setXMLSpecializationType()
end

updateFeeding

Description

Definition

updateFeeding()

Arguments

any	superFunc

Code

function PlaceableHusbandryWater:updateFeeding(superFunc)
    local factor = superFunc( self )
    local spec = self.spec_husbandryWater

    if self.isServer and spec.litersPerHour > 0 then
        local delta = spec.litersPerHour * g_currentMission.environment.timeAdjustment

        if spec.automaticWaterSupply then
            local fillType = g_fillTypeManager:getFillTypeByIndex(spec.fillType)
            local price = delta * fillType.pricePerLiter
            g_currentMission:addMoney( - price, self:getOwnerFarmId(), MoneyType.PURCHASE_WATER, false , false )
        else
                local remainingLiters = self:removeHusbandryFillLevel( nil , delta, spec.fillType)
                local usedDelta = (delta - remainingLiters)
                factor = factor * math.clamp(usedDelta / delta, 0 , 1 )
            end
        end

        return factor
    end

updateInfo

Description

Definition

updateInfo()

Arguments

any	superFunc
any	infoTable

Code

function PlaceableHusbandryWater:updateInfo(superFunc, infoTable)
    superFunc( self , infoTable)
    local spec = self.spec_husbandryWater
    if not spec.automaticWaterSupply then
        local fillLevel = self:getHusbandryFillLevel(spec.fillType)
        spec.info.text = string.format( "%d l" , fillLevel)
        table.insert(infoTable, spec.info)
    end
end

updateWaterPlane

Description

Definition

updateWaterPlane()

Code

function PlaceableHusbandryWater:updateWaterPlane()
    local spec = self.spec_husbandryWater
    local fillLevel = self:getHusbandryFillLevel(spec.fillType, nil )

    if spec.waterPlane ~ = nil then
        local capacity = self:getHusbandryCapacity(spec.fillType, nil )
        local factor = 0
        if capacity > 0 then
            factor = fillLevel / capacity
        end
        spec.waterPlane:setState(factor)
    end

    if spec.husbandryId ~ = nil then
        for _, waterPlace in pairs(spec.waterPlaces) do
            if waterPlace.place ~ = nil then
                updateFeedingPlace(spec.husbandryId, waterPlace.place, fillLevel)
            end
        end
    end
end