SeedTreater

SeedTreater

Description

Specialization for seat treatment tools

Functions

• discharge
• getDischargeFillType
• getDischargeNodeEmptyFactor
• initSpecialization
• onLoad
• onUpdate
• prerequisitesPresent
• registerEventListeners
• registerFunctions
• registerOverwrittenFunctions

discharge

Description

Definition

discharge()

Arguments

any	superFunc
any	dischargeNode
any	emptyLiters

Code

function SeedTreater:discharge(superFunc, dischargeNode, emptyLiters)
    local dischargedLiters, minDropReached, hasMinDropFillLevel = superFunc( self , dischargeNode, emptyLiters)

    local spec = self.spec_seedTreater
    if dischargeNode.index = = spec.dischargeNodeIndex then
        local fillType = self:getFillUnitFillType(dischargeNode.fillUnitIndex)
        if dischargeNode.fillTypeConverter ~ = nil then
            local conversion = dischargeNode.fillTypeConverter[fillType]
            if conversion ~ = nil then
                local usage = - dischargedLiters * spec.usagePerLiter
                if usage > 0 then
                    self:addFillUnitFillLevel( self:getOwnerFarmId(), spec.fillUnitIndex, - usage, self:getFillUnitFillType(spec.fillUnitIndex), ToolType.UNDEFINED, nil )
                end
            end
        end
    end

    return dischargedLiters, minDropReached, hasMinDropFillLevel
end

getDischargeFillType

Description

Definition

getDischargeFillType()

Arguments

any	superFunc
any	dischargeNode

Code

function SeedTreater:getDischargeFillType(superFunc, dischargeNode)
    local spec = self.spec_seedTreater
    if spec ~ = nil and self:getFillUnitFillLevel(spec.fillUnitIndex) = = 0 then
        return self:getFillUnitFillType(dischargeNode.fillUnitIndex), 1
    end

    return superFunc( self , dischargeNode)
end

getDischargeNodeEmptyFactor

Description

Definition

getDischargeNodeEmptyFactor()

Arguments

any	superFunc
any	dischargeNode

Code

function SeedTreater:getDischargeNodeEmptyFactor(superFunc, dischargeNode)
    local spec = self.spec_seedTreater

    local fillType = self:getFillUnitFillType(dischargeNode.fillUnitIndex)
    if dischargeNode.fillTypeConverter ~ = nil then
        local conversion = dischargeNode.fillTypeConverter[fillType]
        if conversion = = nil then
            return superFunc( self , dischargeNode)
        end
    end

    if self:getFillUnitFillLevel(spec.fillUnitIndex) = = 0 then
        return superFunc( self , dischargeNode)
    end

    return superFunc( self , dischargeNode) * spec.treatmentSpeedFactor
end

initSpecialization

Description

Definition

initSpecialization()

Code

function SeedTreater.initSpecialization()
    local schema = Vehicle.xmlSchema
    schema:setXMLSpecializationType( "SeedTreater" )

    schema:register(XMLValueType.INT, "vehicle.seedTreater#fillUnitIndex" , "Fill unit index with seed treatment liquid" , 1 )
    schema:register(XMLValueType.INT, "vehicle.seedTreater#dischargeNodeIndex" , "Discharge node index" , 1 )
    schema:register(XMLValueType.FLOAT, "vehicle.seedTreater#usagePerLiter" , "Usage of treatment liquid" , 0.1 )
    schema:register(XMLValueType.FLOAT, "vehicle.seedTreater#fillFromTriggerThreshold" , "After this amount is available as free capacity the filling from nearby pallets starts" , 5 )
    schema:register(XMLValueType.FLOAT, "vehicle.seedTreater#treatmentSpeedFactor" , "Speed factor while treatment is active" , 0.1 )

        schema:setXMLSpecializationType()
    end

onLoad

Description

Definition

onLoad()

Arguments

any	savegame

Code

function SeedTreater:onLoad(savegame)
    local spec = self.spec_seedTreater

    spec.fillUnitIndex = self.xmlFile:getValue( "vehicle.seedTreater#fillUnitIndex" , 1 )
    spec.dischargeNodeIndex = self.xmlFile:getValue( "vehicle.seedTreater#dischargeNodeIndex" , 1 )
    spec.usagePerLiter = self.xmlFile:getValue( "vehicle.seedTreater#usagePerLiter" , 0.1 )
    spec.fillFromTriggerThreshold = self.xmlFile:getValue( "vehicle.seedTreater#fillFromTriggerThreshold" , 5 )
    spec.treatmentSpeedFactor = self.xmlFile:getValue( "vehicle.seedTreater#treatmentSpeedFactor" , 0.1 )
end

onUpdate

Description

Definition

onUpdate()

Arguments

any	dt
any	isActiveForInput
any	isActiveForInputIgnoreSelection
any	isSelected

Code

function SeedTreater:onUpdate(dt, isActiveForInput, isActiveForInputIgnoreSelection, isSelected)
    if self.isServer then
        local spec = self.spec_seedTreater
        local fillUnit = self:getFillUnitByIndex(spec.fillUnitIndex)
        if fillUnit ~ = nil then
            if (fillUnit.capacity - fillUnit.fillLevel) > 5 then
                local specFillUnit = self.spec_fillUnit
                if not specFillUnit.fillTrigger.isFilling then
                    for _, trigger in ipairs(specFillUnit.fillTrigger.triggers) do
                        if trigger:getCurrentFillType() = = FillType.LIQUIDSEEDTREATMENT then
                            if trigger:getIsActivatable( self ) then
                                self:setFillUnitIsFilling( true )
                            end
                        end
                    end
                end
            elseif self.spec_fillUnit.fillTrigger.isFilling and self:getDischargeState() ~ = Dischargeable.DISCHARGE_STATE_OFF and(fillUnit.capacity - fillUnit.fillLevel) < 0.1 then
                    self:setFillUnitIsFilling( false )
                end
            end
        end
    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 SeedTreater.prerequisitesPresent(specializations)
    return SpecializationUtil.hasSpecialization( Dischargeable , specializations) and SpecializationUtil.hasSpecialization( FillUnit , specializations)
end

registerEventListeners

Description

Definition

registerEventListeners()

Arguments

any	vehicleType

Code

function SeedTreater.registerEventListeners(vehicleType)
    SpecializationUtil.registerEventListener(vehicleType, "onLoad" , SeedTreater )
    SpecializationUtil.registerEventListener(vehicleType, "onUpdate" , SeedTreater )
end

registerFunctions

Description

Definition

registerFunctions()

Arguments

any	vehicleType

Code

function SeedTreater.registerFunctions(vehicleType)
end

registerOverwrittenFunctions

Description

Definition

registerOverwrittenFunctions()

Arguments

any	vehicleType

Code

function SeedTreater.registerOverwrittenFunctions(vehicleType)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "discharge" , SeedTreater.discharge)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getDischargeFillType" , SeedTreater.getDischargeFillType)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getDischargeNodeEmptyFactor" , SeedTreater.getDischargeNodeEmptyFactor)
end