Roller

Roller

Description

Specialization for roller used for removing fields/terrainDetailLayer

Functions

• doCheckSpeedLimit
• getDefaultSpeedLimit
• getDirtMultiplier
• getDoGroundManipulation
• getIsWorkAreaActive
• getWearMultiplier
• initSpecialization
• onDeactivate
• onDelete
• onEndWorkAreaProcessing
• onLoad
• onPostAttach
• onStartWorkAreaProcessing
• prerequisitesPresent
• processRollerArea
• registerEventListeners
• registerFunctions
• registerOverwrittenFunctions
• registerRollerXMLPaths
• updateRollerAIRequirements

doCheckSpeedLimit

Description

Definition

doCheckSpeedLimit()

Arguments

any	superFunc

Code

function Roller:doCheckSpeedLimit(superFunc)
    local spec = self.spec_roller

    return superFunc( self ) or spec.isWorking
end

getDefaultSpeedLimit

Description

Definition

getDefaultSpeedLimit()

Code

function Roller.getDefaultSpeedLimit()
    return 15
end

getDirtMultiplier

Description

Definition

getDirtMultiplier()

Arguments

any	superFunc

Code

function Roller:getDirtMultiplier(superFunc)
    local spec = self.spec_roller
    local multiplier = superFunc( self )

    if spec.isWorking then
        multiplier = multiplier + self:getWorkDirtMultiplier()
    end

    return multiplier
end

getDoGroundManipulation

Description

Definition

getDoGroundManipulation()

Arguments

any	superFunc

Code

function Roller:getDoGroundManipulation(superFunc)
    local spec = self.spec_roller
    return superFunc( self ) and spec.isWorking
end

getIsWorkAreaActive

Description

Definition

getIsWorkAreaActive()

Arguments

any	superFunc
any	workArea

Code

function Roller:getIsWorkAreaActive(superFunc, workArea)
    if workArea.type = = WorkAreaType.ROLLER then
        local spec = self.spec_roller
        if spec.startActivationTime > g_currentMission.time then
            return false
        end

        if spec.onlyActiveWhenLowered and not self:getIsLowered() then
            return false
        end
    end

    return superFunc( self , workArea)
end

getWearMultiplier

Description

Returns current wear multiplier

Definition

getWearMultiplier()

Arguments

any	superFunc

Return Values

any	dirtMultiplier	current wear multiplier

Code

function Roller:getWearMultiplier(superFunc)
    local spec = self.spec_roller
    local multiplier = superFunc( self )

    if spec.isWorking then
        multiplier = multiplier + self:getWorkWearMultiplier()
    end

    return multiplier
end

initSpecialization

Description

Definition

initSpecialization()

Code

function Roller.initSpecialization()
    g_vehicleConfigurationManager:addConfigurationType( "roller" , g_i18n:getText( "configuration_design" ), "roller" , VehicleConfigurationItem )
    g_workAreaTypeManager:addWorkAreaType( "roller" , false , true , true )

    local schema = Vehicle.xmlSchema
    schema:setXMLSpecializationType( "Roller" )

    Roller.registerRollerXMLPaths(schema, "vehicle.roller" )
    Roller.registerRollerXMLPaths(schema, "vehicle.roller.rollerConfigurations.rollerConfiguration(?).roller" )

    schema:setXMLSpecializationType()
end

onDeactivate

Description

Definition

onDeactivate()

Code

function Roller:onDeactivate()
    local spec = self.spec_roller
    g_soundManager:stopSample(spec.samples.work)
    spec.isWorkSamplePlaying = false
end

onDelete

Description

Definition

onDelete()

Code

function Roller:onDelete()
    local spec = self.spec_roller
    g_soundManager:deleteSamples(spec.samples)
end

onEndWorkAreaProcessing

Description

Definition

onEndWorkAreaProcessing()

Arguments

any	dt
any	hasProcessed

Code

function Roller:onEndWorkAreaProcessing(dt, hasProcessed)
    local spec = self.spec_roller

    if self.isClient then
        if spec.isWorking then
            if not spec.isWorkSamplePlaying then
                g_soundManager:playSample(spec.samples.work)
                spec.isWorkSamplePlaying = true
            end
        else
                if spec.isWorkSamplePlaying then
                    g_soundManager:stopSample(spec.samples.work)
                    spec.isWorkSamplePlaying = false
                end
            end
        end
    end

onLoad

Description

Definition

onLoad()

Arguments

any	savegame

Code

function Roller:onLoad(savegame)
    local spec = self.spec_roller

    XMLUtil.checkDeprecatedXMLElements( self.xmlFile, "vehicle.rollerSound" , "vehicle.roller.sounds.work" ) --FS17 to FS19
    XMLUtil.checkDeprecatedXMLElements( self.xmlFile, "vehicle.onlyActiveWhenLowered#value" , "vehicle.roller#onlyActiveWhenLowered" ) --FS17 to FS19

    local rollerConfigurationId = Utils.getNoNil( self.configurations[ "roller" ], 1 )
    local configKey = string.format( "vehicle.roller.rollerConfigurations.rollerConfiguration(%d).roller" , rollerConfigurationId - 1 )

    if not self.xmlFile:hasProperty(configKey) then
        configKey = "vehicle.roller"
    end

    spec.directionNode = self.xmlFile:getValue(configKey .. ".directionNode#node" , self.components[ 1 ].node, self.components, self.i3dMappings)

    if self.isClient then
        spec.samples = { }
        spec.isWorkSamplePlaying = false
        spec.samples.work = g_soundManager:loadSampleFromXML( self.xmlFile, configKey .. ".sounds" , "work" , self.baseDirectory, self.components, 0 , AudioGroup.VEHICLE, self.i3dMappings, self )
    end

    spec.isSoilRoller = self.xmlFile:getValue(configKey .. "#isSoilRoller" )
    spec.isGrassRoller = self.xmlFile:getValue(configKey .. "#isGrassRoller" )
    if spec.isSoilRoller = = nil and spec.isGrassRoller = = nil then
        spec.isSoilRoller = true
        spec.isGrassRoller = false
    else
            if spec.isGrassRoller = = nil then
                spec.isGrassRoller = false
            end
            if spec.isSoilRoller = = nil then
                spec.isSoilRoller = false
            end
        end

        spec.grassFruitTypes = { FruitType.GRASS, FruitType.MEADOW }

        spec.usingAIRequirements = self.xmlFile:getValue(configKey .. "#usingAIRequirements" , true )
        spec.onlyActiveWhenLowered = self.xmlFile:getValue(configKey .. "#onlyActiveWhenLowered" , true )
        spec.startActivationTimeout = 2000
        spec.startActivationTime = 0
        spec.isWorking = false
        spec.angle = 0

        self:updateRollerAIRequirements()

        spec.dirtyFlag = self:getNextDirtyFlag()
    end

onPostAttach

Description

Called after vehicle gets attached

Definition

onPostAttach(table attacherVehicle, integer inputJointDescIndex, integer jointDescIndex)

Arguments

table	attacherVehicle	attacher vehicle
integer	inputJointDescIndex	index of input attacher joint
integer	jointDescIndex	index of attacher joint it gets attached to

Code

function Roller:onPostAttach(attacherVehicle, inputJointDescIndex, jointDescIndex)
    local spec = self.spec_roller
    spec.startActivationTime = g_currentMission.time + spec.startActivationTimeout
end

onStartWorkAreaProcessing

Description

Definition

onStartWorkAreaProcessing()

Arguments

any	dt

Code

function Roller:onStartWorkAreaProcessing(dt)
    local spec = self.spec_roller

    local dx,_,dz = localDirectionToWorld(spec.directionNode, 0 , 0 , 1 )

    spec.angle = FSDensityMapUtil.convertToDensityMapAngle( MathUtil.getYRotationFromDirection(dx, dz), g_currentMission.fieldGroundSystem:getGroundAngleMaxValue())
    spec.isWorking = false
end

prerequisitesPresent

Description

Definition

prerequisitesPresent()

Arguments

any	specializations

Code

function Roller.prerequisitesPresent(specializations)
    return SpecializationUtil.hasSpecialization( WorkArea , specializations)
end

processRollerArea

Description

Definition

processRollerArea()

Arguments

any	workArea
any	dt

Code

function Roller:processRollerArea(workArea, dt)
    local spec = self.spec_roller

    local xs,_,zs = getWorldTranslation(workArea.start)
    local xw,_,zw = getWorldTranslation(workArea.width)
    local xh,_,zh = getWorldTranslation(workArea.height)

    FSDensityMapUtil.eraseTireTrack(xs, zs, xw, zw, xh, zh)

    if not self.isServer and self.currentUpdateDistance > Roller.CLIENT_DM_UPDATE_RADIUS then
        return 0
    end

    local realArea
    if spec.isGrassRoller then
        realArea, _ = FSDensityMapUtil.updateGrassRollerArea(xs, zs, xw, zw, xh, zh, not spec.isSoilRoller)
    end
    if spec.isSoilRoller then
        realArea, _ = FSDensityMapUtil.updateRollerArea(xs, zs, xw, zw, xh, zh, spec.angle)
    end

    spec.isWorking = self:getLastSpeed() > 0.5

    return realArea
end

registerEventListeners

Description

Definition

registerEventListeners()

Arguments

any	vehicleType

Code

function Roller.registerEventListeners(vehicleType)
    SpecializationUtil.registerEventListener(vehicleType, "onLoad" , Roller )
    SpecializationUtil.registerEventListener(vehicleType, "onDelete" , Roller )
    SpecializationUtil.registerEventListener(vehicleType, "onPostAttach" , Roller )
    SpecializationUtil.registerEventListener(vehicleType, "onDeactivate" , Roller )
    SpecializationUtil.registerEventListener(vehicleType, "onStartWorkAreaProcessing" , Roller )
    SpecializationUtil.registerEventListener(vehicleType, "onEndWorkAreaProcessing" , Roller )
end

registerFunctions

Description

Definition

registerFunctions()

Arguments

any	vehicleType

Code

function Roller.registerFunctions(vehicleType)
    SpecializationUtil.registerFunction(vehicleType, "processRollerArea" , Roller.processRollerArea)
    SpecializationUtil.registerFunction(vehicleType, "updateRollerAIRequirements" , Roller.updateRollerAIRequirements)
end

registerOverwrittenFunctions

Description

Definition

registerOverwrittenFunctions()

Arguments

any	vehicleType

Code

function Roller.registerOverwrittenFunctions(vehicleType)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "doCheckSpeedLimit" , Roller.doCheckSpeedLimit)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getDoGroundManipulation" , Roller.getDoGroundManipulation)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getDirtMultiplier" , Roller.getDirtMultiplier)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getWearMultiplier" , Roller.getWearMultiplier)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getIsWorkAreaActive" , Roller.getIsWorkAreaActive)
end

registerRollerXMLPaths

Description

Definition

registerRollerXMLPaths()

Arguments

any	schema
any	basePath

Code

function Roller.registerRollerXMLPaths(schema, basePath)
    schema:register(XMLValueType.NODE_INDEX, basePath .. ".directionNode#node" , "Roller direction node" )
    schema:register(XMLValueType.BOOL, basePath .. "#onlyActiveWhenLowered" , "Only active when lowered" , true )
    schema:register(XMLValueType.BOOL, basePath .. "#isSoilRoller" , "If roller is for soil" , true )
        schema:register(XMLValueType.BOOL, basePath .. "#isGrassRoller" , "If roller is for grassland" , false )
            schema:register(XMLValueType.BOOL, basePath .. "#usingAIRequirements" , "Tool using roller ai requirements" , true )
            SoundManager.registerSampleXMLPaths(schema, basePath .. ".sounds" , "work" )
        end

updateRollerAIRequirements

Description

Definition

updateRollerAIRequirements()

Code

function Roller:updateRollerAIRequirements()
    if self.clearAITerrainDetailRequiredRange ~ = nil then
        local spec = self.spec_roller

        if not spec.usingAIRequirements then
            return
        end

        local hasSowingMachine = false
        if SpecializationUtil.hasSpecialization( SowingMachine , self.specializations) then
            if self:getUseSowingMachineAIRequirements() then
                hasSowingMachine = true
            end
        end

        self:clearAIFruitRequirements()
        self:clearAIFruitProhibitions()
        self:clearAITerrainDetailRequiredRange()

        -- if we also have a active sowing machine attached the sowingMachine is fully handling it
            if not hasSowingMachine then
                if spec.isGrassRoller and not spec.isSoilRoller then
                    self:addAIGroundTypeRequirements( Roller.AI_REQUIRED_GROUND_TYPES_GRASS)

                    for i = 1 , #spec.grassFruitTypes do
                        local fruitTypeDesc = g_fruitTypeManager:getFruitTypeByIndex(spec.grassFruitTypes[i])
                        if fruitTypeDesc ~ = nil and fruitTypeDesc.terrainDataPlaneId ~ = nil then
                            self:addAIFruitRequirement(fruitTypeDesc.index, 2 , fruitTypeDesc.cutState + 1 )
                        end
                    end
                end

                if spec.isSoilRoller then
                    self:addAIGroundTypeRequirements( Roller.AI_REQUIRED_GROUND_TYPES)

                    for fruitTypeIndex, fruitType in pairs(g_fruitTypeManager:getFruitTypes()) do
                        if fruitType.terrainDataPlaneId ~ = nil then
                            if not spec.isGrassRoller or fruitTypeIndex ~ = FruitType.GRASS then
                                -- rolling only allowed in first growth state
                                self:addAIFruitProhibitions(fruitType.index, 2 , 15 )
                            end
                        end
                    end

                    -- for combined tools we allow working on all grass states
                        if spec.isGrassRoller then
                            self:addAIGroundTypeRequirements( Roller.AI_REQUIRED_GROUND_TYPES_GRASS)

                            for i = 1 , #spec.grassFruitTypes do
                                local fruitTypeDesc = g_fruitTypeManager:getFruitTypeByIndex(spec.grassFruitTypes[i])
                                if fruitTypeDesc ~ = nil and fruitTypeDesc.terrainDataPlaneId ~ = nil then
                                    self:addAIFruitProhibitions(fruitTypeDesc.index, 1 , 1 )
                                end
                            end
                        end
                    end
                end
            end
        end