Pickup

Pickup

Description

Specialization for vehicles with independently lowerable PickUps (e.g. forage wagon, baler, ...)

Functions

• actionControllerLowerPickupEvent
• actionEventTogglePickup
• allowPickingUp
• getCanChangePickupState
• getCanDischargeToGround
• getCanDischargeToObject
• getDirtMultiplier
• getIsLowered
• getWearMultiplier
• initSpecialization
• loadPickupFromXML
• onFoldTimeChanged
• onLoad
• onPostLoad
• onReadStream
• onRootVehicleChanged
• onSetLoweredAll
• onWriteStream
• prerequisitesPresent
• registerEventListeners
• registerFunctions
• registerLoweringActionEvent
• registerOverwrittenFunctions
• registerSelfLoweringActionEvent
• setPickupState
• updateActionEvents

actionControllerLowerPickupEvent

Description

Definition

actionControllerLowerPickupEvent()

Arguments

any	direction

Code

function Pickup:actionControllerLowerPickupEvent(direction)
    self:setPickupState(direction > 0 )
    return true
end

actionEventTogglePickup

Description

Definition

actionEventTogglePickup()

Arguments

any	self
any	actionName
any	inputValue
any	callbackState
any	isAnalog

Code

function Pickup.actionEventTogglePickup( self , actionName, inputValue, callbackState, isAnalog)
    local spec = self.spec_pickup
    if self:getCanChangePickupState(spec, not spec.isLowered) then
        self:setPickupState( not spec.isLowered)
    end
end

allowPickingUp

Description

Definition

allowPickingUp()

Code

function Pickup:allowPickingUp()
    local spec = self.spec_pickup
    return spec.isLowered
end

getCanChangePickupState

Description

Definition

getCanChangePickupState()

Arguments

any	spec
any	newState

Code

function Pickup:getCanChangePickupState(spec, newState)
    return true
end

getCanDischargeToGround

Description

Definition

getCanDischargeToGround()

Arguments

any	superFunc
any	dischargeNode

Code

function Pickup:getCanDischargeToGround(superFunc, dischargeNode)
    if not self.spec_pickup.allowWhileTipping then
        if self.spec_pickup.isLowered then
            return false
        end
    end

    return superFunc( self , dischargeNode)
end

getCanDischargeToObject

Description

Definition

getCanDischargeToObject()

Arguments

any	superFunc
any	dischargeNode

Code

function Pickup:getCanDischargeToObject(superFunc, dischargeNode)
    if not self.spec_pickup.allowWhileTipping then
        if self.spec_pickup.isLowered then
            return false
        end
    end

    return superFunc( self , dischargeNode)
end

getDirtMultiplier

Description

Definition

getDirtMultiplier()

Arguments

any	superFunc

Code

function Pickup:getDirtMultiplier(superFunc)
    local spec = self.spec_pickup

    if spec.isLowered and( self.getIsTurnedOn = = nil or self:getIsTurnedOn()) then
        return superFunc( self ) + self:getWorkDirtMultiplier() * self:getLastSpeed() / self.speedLimit
    end

    return superFunc( self )
end

getIsLowered

Description

Definition

getIsLowered()

Arguments

any	superFunc
any	default

Code

function Pickup:getIsLowered(superFunc, default)
    local spec = self.spec_pickup
    return spec.isLowered
end

getWearMultiplier

Description

Definition

getWearMultiplier()

Arguments

any	superFunc

Code

function Pickup:getWearMultiplier(superFunc)
    local spec = self.spec_pickup

    if spec.isLowered and( self.getIsTurnedOn = = nil or self:getIsTurnedOn()) then
        return superFunc( self ) + self:getWorkWearMultiplier() * self:getLastSpeed() / self.speedLimit
    end

    return superFunc( self )
end

initSpecialization

Description

Called on specialization initializing

Definition

initSpecialization()

Code

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

    schema:register(XMLValueType.STRING, Pickup.PICKUP_XML_KEY .. ".animation#name" , "Pickup animation name" )
    schema:register(XMLValueType.FLOAT, Pickup.PICKUP_XML_KEY .. ".animation#lowerSpeed" , "Pickup animation lower speed" )
    schema:register(XMLValueType.FLOAT, Pickup.PICKUP_XML_KEY .. ".animation#liftSpeed" , "Pickup animation lift speed" )
    schema:register(XMLValueType.BOOL, Pickup.PICKUP_XML_KEY .. ".animation#isDefaultLowered" , "Pickup animation is default lowered" )

    schema:setXMLSpecializationType()
end

loadPickupFromXML

Description

Definition

loadPickupFromXML()

Arguments

any	xmlFile
any	key
any	spec

Code

function Pickup:loadPickupFromXML(xmlFile, key, spec)
    XMLUtil.checkDeprecatedXMLElements(xmlFile, "vehicle.pickupAnimation" , key .. ".animation" ) --FS17 to FS19

    spec.isLowered = false
    spec.animationName = xmlFile:getValue(key .. ".animation#name" , "" )
    if not self:getAnimationExists(spec.animationName) then
        spec.animationName = ""
        spec.isLowered = true
    end

    spec.animationLowerSpeed = xmlFile:getValue(key .. ".animation#lowerSpeed" , 1 )
    spec.animationLiftSpeed = xmlFile:getValue(key .. ".animation#liftSpeed" , - spec.animationLowerSpeed)
    spec.animationIsDefaultLowered = xmlFile:getValue(key .. ".animation#isDefaultLowered" , false )

    return true
end

onFoldTimeChanged

Description

Called if fold anim time changes

Definition

onFoldTimeChanged(float foldAnimTime)

Arguments

float	foldAnimTime	fold animation time

Code

function Pickup:onFoldTimeChanged(foldAnimTime)
    Pickup.updateActionEvents( self )
end

onLoad

Description

Definition

onLoad()

Arguments

any	savegame

Code

function Pickup:onLoad(savegame)
    self:loadPickupFromXML( self.xmlFile, "vehicle.pickup" , self.spec_pickup)
end

onPostLoad

Description

Definition

onPostLoad()

Arguments

any	savegame

Code

function Pickup:onPostLoad(savegame)
    local spec = self.spec_pickup

    if spec.animationName ~ = "" then
        local dir = - 20
        if spec.animationIsDefaultLowered then
            dir = 20
            spec.isLowered = true
        end
        self:playAnimation(spec.animationName, dir, nil , true )
        AnimatedVehicle.updateAnimations( self , 99999999 , true )
    end
end

onReadStream

Description

Definition

onReadStream()

Arguments

any	streamId
any	connection

Code

function Pickup:onReadStream(streamId, connection)
    local isPickupLowered = streamReadBool(streamId)
    self:setPickupState(isPickupLowered, true )
end

onRootVehicleChanged

Description

Called if root vehicle changes

Definition

onRootVehicleChanged(table rootVehicle)

Arguments

table	rootVehicle	root vehicle

Code

function Pickup:onRootVehicleChanged(rootVehicle)
    local spec = self.spec_pickup
    if spec.animationName ~ = "" then
        local actionController = rootVehicle.actionController
        if actionController ~ = nil then
            if spec.controlledAction ~ = nil then
                spec.controlledAction:updateParent(actionController)
                return
            end

            spec.controlledAction = actionController:registerAction( "lowerPickup" , InputAction.LOWER_IMPLEMENT, 2 )
            spec.controlledAction:setCallback( self , Pickup.actionControllerLowerPickupEvent)
            spec.controlledAction:setFinishedFunctions( self , self.getIsLowered, true , false )
            spec.controlledAction:setIsSaved( true )
            if self:getAINeedsLowering() then
                spec.controlledAction:addAIEventListener( self , "onAIImplementStartLine" , 1 )
                spec.controlledAction:addAIEventListener( self , "onAIImplementEndLine" , - 1 )
                spec.controlledAction:addAIEventListener( self , "onAIImplementStart" , - 1 )
            end
        else
                if spec.controlledAction ~ = nil then
                    spec.controlledAction:remove()
                end
            end
        end
    end

onSetLoweredAll

Description

Definition

onSetLoweredAll()

Arguments

any	doLowering
any	jointDescIndex

Code

function Pickup:onSetLoweredAll(doLowering, jointDescIndex)
    self:setPickupState(doLowering)
end

onWriteStream

Description

Definition

onWriteStream()

Arguments

any	streamId
any	connection

Code

function Pickup:onWriteStream(streamId, connection)
    local spec = self.spec_pickup
    streamWriteBool(streamId, spec.isLowered)
end

prerequisitesPresent

Description

Definition

prerequisitesPresent()

Arguments

any	specializations

Code

function Pickup.prerequisitesPresent(specializations)
    return SpecializationUtil.hasSpecialization( AnimatedVehicle , specializations)
end

registerEventListeners

Description

Definition

registerEventListeners()

Arguments

any	vehicleType

Code

function Pickup.registerEventListeners(vehicleType)
    SpecializationUtil.registerEventListener(vehicleType, "onLoad" , Pickup )
    SpecializationUtil.registerEventListener(vehicleType, "onPostLoad" , Pickup )
    SpecializationUtil.registerEventListener(vehicleType, "onReadStream" , Pickup )
    SpecializationUtil.registerEventListener(vehicleType, "onWriteStream" , Pickup )
    SpecializationUtil.registerEventListener(vehicleType, "onSetLoweredAll" , Pickup )
    SpecializationUtil.registerEventListener(vehicleType, "onRootVehicleChanged" , Pickup )
    SpecializationUtil.registerEventListener(vehicleType, "onFoldTimeChanged" , Pickup )
end

registerFunctions

Description

Definition

registerFunctions()

Arguments

any	vehicleType

Code

function Pickup.registerFunctions(vehicleType)
    SpecializationUtil.registerFunction(vehicleType, "allowPickingUp" , Pickup.allowPickingUp)
    SpecializationUtil.registerFunction(vehicleType, "setPickupState" , Pickup.setPickupState)
    SpecializationUtil.registerFunction(vehicleType, "loadPickupFromXML" , Pickup.loadPickupFromXML)
    SpecializationUtil.registerFunction(vehicleType, "getCanChangePickupState" , Pickup.getCanChangePickupState)
end

registerLoweringActionEvent

Description

Definition

registerLoweringActionEvent()

Arguments

any	superFunc
any	actionEventsTable
any	inputAction
any	target
any	callback
any	triggerUp
any	triggerDown
any	triggerAlways
any	startActive
any	callbackState
any	customIconName

Code

function Pickup:registerLoweringActionEvent(superFunc, actionEventsTable, inputAction, target, callback, triggerUp, triggerDown, triggerAlways, startActive, callbackState, customIconName)
    local spec = self.spec_pickup
    if spec.animationName ~ = "" then
        local _, actionEventId = self:addPoweredActionEvent(spec.actionEvents, InputAction.LOWER_IMPLEMENT, self , Pickup.actionEventTogglePickup, triggerUp, triggerDown, triggerAlways, startActive, callbackState, customIconName)
        g_inputBinding:setActionEventTextPriority(actionEventId, GS_PRIO_HIGH)

        Pickup.updateActionEvents( self )

        if inputAction = = InputAction.LOWER_IMPLEMENT then
            return
        end
    end

    superFunc( self , actionEventsTable, inputAction, target, callback, triggerUp, triggerDown, triggerAlways, startActive, callbackState, customIconName)
end

registerOverwrittenFunctions

Description

Definition

registerOverwrittenFunctions()

Arguments

any	vehicleType

Code

function Pickup.registerOverwrittenFunctions(vehicleType)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getIsLowered" , Pickup.getIsLowered)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getDirtMultiplier" , Pickup.getDirtMultiplier)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getWearMultiplier" , Pickup.getWearMultiplier)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "registerLoweringActionEvent" , Pickup.registerLoweringActionEvent)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "registerSelfLoweringActionEvent" , Pickup.registerSelfLoweringActionEvent)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getCanDischargeToGround" , Pickup.getCanDischargeToGround)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getCanDischargeToObject" , Pickup.getCanDischargeToObject)
end

registerSelfLoweringActionEvent

Description

Definition

registerSelfLoweringActionEvent()

Arguments

any	superFunc
any	actionEventsTable
any	inputAction
any	target
any	callback
any	triggerUp
any	triggerDown
any	triggerAlways
any	startActive
any	callbackState
any	customIconName
any	ignoreCollisions

Code

function Pickup:registerSelfLoweringActionEvent(superFunc, actionEventsTable, inputAction, target, callback, triggerUp, triggerDown, triggerAlways, startActive, callbackState, customIconName, ignoreCollisions)
    return Pickup.registerLoweringActionEvent( self , superFunc, actionEventsTable, inputAction, target, callback, triggerUp, triggerDown, triggerAlways, startActive, callbackState, customIconName, ignoreCollisions)
end

setPickupState

Description

Definition

setPickupState()

Arguments

any	isPickupLowered
any	noEventSend

Code

function Pickup:setPickupState(isPickupLowered, noEventSend)
    local spec = self.spec_pickup

    if isPickupLowered ~ = spec.isLowered then
        PickupSetStateEvent.sendEvent( self , isPickupLowered, noEventSend)

        spec.isLowered = isPickupLowered

        if spec.animationName ~ = "" then
            local animTime = nil
            if self:getIsAnimationPlaying(spec.animationName) then
                animTime = self:getAnimationTime(spec.animationName)
            end
            if isPickupLowered then
                self:playAnimation(spec.animationName, spec.animationLowerSpeed, animTime, true )
            else
                    self:playAnimation(spec.animationName, spec.animationLiftSpeed, animTime, true )
                end
            end

            Pickup.updateActionEvents( self )
        end
    end

updateActionEvents

Description

Definition

updateActionEvents()

Arguments

any	self

Code

function Pickup.updateActionEvents( self )
    local spec = self.spec_pickup

    if spec.animationName ~ = "" then
        local actionEvent = spec.actionEvents[InputAction.LOWER_IMPLEMENT]
        if actionEvent ~ = nil then
            if spec.isLowered then
                g_inputBinding:setActionEventText(actionEvent.actionEventId, string.format(g_i18n:getText( "action_liftOBJECT" ), g_i18n:getText( "typeDesc_pickup" )))
            else
                    g_inputBinding:setActionEventText(actionEvent.actionEventId, string.format(g_i18n:getText( "action_lowerOBJECT" ), g_i18n:getText( "typeDesc_pickup" )))
                end

                g_inputBinding:setActionEventActive(actionEvent.actionEventId, self:getCanChangePickupState(spec, not spec.isLowered))
            end
        end
    end