TurnOnVehicle

Description

Specialization for vehicles which can be switched on and off

Functions

actionControllerTurnOnEvent
actionEventTurnOn
actionEventTurnOnAll
dashboardRpmAttributes
dashboardRpmValue
externalActionEventRegister
externalActionEventUpdate
getAIRequiresTurnOffOnHeadland
getAIRequiresTurnOn
getAlarmTriggerIsActive
getBunkerSiloCompacterScale
getCanAIImplementContinueWork
getCanBeSelected
getCanBeTurnedOn
getCanBeTurnedOnAll
getCanToggleTurnedOn
getIsDischargeNodeActive
getIsFillUnitActive
getIsOperating
getIsPowerTakeOffActive
getIsSeedChangeAllowed
getIsTurnedOn
getIsTurnedOnAnimationActive
getIsWorkAreaActive
getIsWorkModeChangeAllowed
getRequiresTurnOn
getShovelNodeIsActive
getTurnedOnNotAllowedWarning
getTurnedOnSpeedFactor
getUseTurnedOnSchema
initSpecialization
loadAlarmTrigger
loadBunkerSiloCompactorFromXML
loadDischargeNode
loadInputAttacherJoint
loadShovelNode
loadTurnedOnAnimationFromXML
loadWorkAreaFromXML
onAlarmTriggerChanged
onDeactivate
onDelete
onLoad
onPostAttach
onPreDetach
onReadStream
onRegisterActionEvents
onRegisterDashboardValueTypes
onRegisterExternalActionEvents
onRootVehicleChanged
onSetBroken
onStateChange
onTurnedOff
onTurnedOn
onUpdate
onUpdateTick
onWriteStream
prerequisitesPresent
registerEventListeners
registerEvents
registerFunctions
registerOverwrittenFunctions
setIsTurnedOn
updateActionEvents

actionControllerTurnOnEvent

Description

Definition

actionControllerTurnOnEvent()

Arguments

any	self
any	direction

Code

function TurnOnVehicle.actionControllerTurnOnEvent( self , direction)
    if direction > 0 then
        if self:getCanBeTurnedOn() then
            self:setIsTurnedOn( true )
            return true
        else
                return false
            end
        else
                self:setIsTurnedOn( false )
                return not self:getIsTurnedOn()
            end
        end

actionEventTurnOn

Description

Definition

actionEventTurnOn()

Arguments

any	self
any	actionName
any	inputValue
any	callbackState
any	isAnalog

Code

function TurnOnVehicle.actionEventTurnOn( self , actionName, inputValue, callbackState, isAnalog)
    if self:getCanToggleTurnedOn() and self:getCanBeTurnedOn() then
        self:setIsTurnedOn( not self:getIsTurnedOn())
    else
            if not self:getIsTurnedOn() then
                local warning = self:getTurnedOnNotAllowedWarning()
                if warning ~ = nil then
                    g_currentMission:showBlinkingWarning(warning, 2000 )
                end
            end
        end
    end

actionEventTurnOnAll

Description

Definition

actionEventTurnOnAll()

Arguments

any	self
any	actionName
any	inputValue
any	callbackState
any	isAnalog

Code

function TurnOnVehicle.actionEventTurnOnAll( self , actionName, inputValue, callbackState, isAnalog)
    if self:getCanToggleTurnedOn() then
        local canBeTurnedOn, warning = self:getCanBeTurnedOnAll()
        if canBeTurnedOn then
            local vehicles = self.rootVehicle:getChildVehicles()
            for i = 1 , #vehicles do
                local vehicle = vehicles[i]
                if vehicle.setIsTurnedOn ~ = nil then
                    vehicle:setIsTurnedOn( not vehicle:getIsTurnedOn())
                end
            end
        else
                if not self:getIsTurnedOn() then
                    if warning ~ = nil then
                        g_currentMission:showBlinkingWarning(warning, 2000 )
                    end
                end
            end
        end
    end

dashboardRpmAttributes

Description

Definition

dashboardRpmAttributes()

Arguments

any	self
any	xmlFile
any	key
any	dashboard
any	isActive

Code

function TurnOnVehicle.dashboardRpmAttributes( self , xmlFile, key, dashboard, isActive)
    dashboard.minRpm = xmlFile:getValue(key .. "#minRpm" , 0 )
    dashboard.maxRpm = xmlFile:getValue(key .. "#maxRpm" , 1000 )

    return true
end

dashboardRpmValue

Description

Definition

dashboardRpmValue()

Arguments

any	self
any	dashboard

Code

function TurnOnVehicle.dashboardRpmValue( self , dashboard)
    return dashboard.minRpm + (dashboard.maxRpm - dashboard.minRpm) * self.spec_turnOnVehicle.turnedOnSpeed.alpha
end

externalActionEventRegister

Description

Definition

externalActionEventRegister()

Arguments

any	data
any	vehicle

Code

function TurnOnVehicle.externalActionEventRegister(data, vehicle)
    local function actionEvent(_, actionName, inputValue, callbackState, isAnalog)
        Motorized.tryStartMotor(vehicle)
        TurnOnVehicle.actionEventTurnOn(vehicle, actionName, inputValue, callbackState, isAnalog)
    end

    local spec = vehicle.spec_turnOnVehicle

    local _
    _, data.actionEventId = g_inputBinding:registerActionEvent(spec.toggleTurnOnInputBinding, data, actionEvent, false , true , false , true )
    g_inputBinding:setActionEventTextPriority(data.actionEventId, GS_PRIO_HIGH)
end

externalActionEventUpdate

Description

Definition

externalActionEventUpdate()

Arguments

any	data
any	vehicle

Code

function TurnOnVehicle.externalActionEventUpdate(data, vehicle)
    if data.actionEventId ~ = nil then
        local state = vehicle:getCanToggleTurnedOn()

        if state then
            local text
            if vehicle:getIsTurnedOn() then
                text = vehicle.spec_turnOnVehicle.turnOffText
            else
                    text = vehicle.spec_turnOnVehicle.turnOnText
                end
                g_inputBinding:setActionEventText(data.actionEventId, text)
            end

            g_inputBinding:setActionEventActive(data.actionEventId, state)
        end
    end

getAIRequiresTurnOffOnHeadland

Description

Definition

getAIRequiresTurnOffOnHeadland()

Code

function TurnOnVehicle:getAIRequiresTurnOffOnHeadland()
    return false
end

getAIRequiresTurnOn

Description

Definition

getAIRequiresTurnOn()

Code

function TurnOnVehicle:getAIRequiresTurnOn()
    return self.spec_turnOnVehicle.aiRequiresTurnOn
end

getAlarmTriggerIsActive

Description

Definition

getAlarmTriggerIsActive()

Arguments

any	superFunc
any	alarmTrigger

Code

function TurnOnVehicle:getAlarmTriggerIsActive(superFunc, alarmTrigger)
    local ret = superFunc( self , alarmTrigger)

    if alarmTrigger.needsTurnOn then
        if not self:getIsTurnedOn() then
            ret = false
        end
    end

    return ret
end

getBunkerSiloCompacterScale

Description

Definition

getBunkerSiloCompacterScale()

Arguments

any	superFunc

Code

function TurnOnVehicle:getBunkerSiloCompacterScale(superFunc)
    local spec = self.spec_bunkerSiloCompacter
    if spec.turnedOnCompactingScale ~ = nil then
        if self:getIsTurnedOn() then
            return spec.turnedOnCompactingScale
        end
    end

    return superFunc( self )
end

getCanAIImplementContinueWork

Description

Returns true if vehicle is ready for ai work

Definition

getCanAIImplementContinueWork()

Arguments

any	superFunc
any	isTurning

Return Values

any	isReady	is ready for ai work

Code

function TurnOnVehicle:getCanAIImplementContinueWork(superFunc, isTurning)
    local canContinue, stopAI, stopReason = superFunc( self , isTurning)
    if not canContinue then
        return false , stopAI, stopReason
    end

    if not self:getAIRequiresTurnOn() then
        return true
    end

    -- on headland the tool can be turned off
    if not self:getIsAIImplementInLine() then
        return true
    end

    if self:getCanBeTurnedOn() then
        if not self:getIsTurnedOn() then
            return false
        end
    end

    return true
end

getCanBeSelected

Description

Definition

getCanBeSelected()

Arguments

any	superFunc

Code

function TurnOnVehicle:getCanBeSelected(superFunc)
    return true
end

getCanBeTurnedOn

Description

Returns if vehicle can be turned on

Definition

getCanBeTurnedOn()

Return Values

any	canBeTurnedOn	vehicle can be turned on

Code

function TurnOnVehicle:getCanBeTurnedOn()
    local spec = self.spec_turnOnVehicle

    if spec.isAlwaysTurnedOn then
        return false
    end

    if self.getInputAttacherJoint ~ = nil then
        local inputAttacherJoint = self:getInputAttacherJoint()

        if inputAttacherJoint ~ = nil and inputAttacherJoint.canBeTurnedOn ~ = nil and not inputAttacherJoint.canBeTurnedOn then
            return false
        end
    end

    if not self:getIsPowered() then
        return false
    end

    return true
end

getCanBeTurnedOnAll

Description

Returns if all vehicles can be turned on

Definition

getCanBeTurnedOnAll()

Return Values

any	canBeTurnedOn	all vehicles can be turned on

Code

function TurnOnVehicle:getCanBeTurnedOnAll()
    local vehicles = self.rootVehicle:getChildVehicles()
    for i = 1 , #vehicles do
        local vehicle = vehicles[i]
        if vehicle.getCanBeTurnedOn ~ = nil then
            if not vehicle:getCanBeTurnedOn() then
                return false
            end
        end
    end

    return true
end

getCanToggleTurnedOn

Description

Returns if user is allowed to turn on the vehicle

Definition

getCanToggleTurnedOn()

Return Values

any	allow	allow turn on

Code

function TurnOnVehicle:getCanToggleTurnedOn()
    local spec = self.spec_turnOnVehicle

    if spec.isAlwaysTurnedOn then
        return false
    end

    if spec.turnedOnByAttacherVehicle then
        return false
    end

    return true
end

getIsDischargeNodeActive

Description

Definition

getIsDischargeNodeActive()

Arguments

any	superFunc
any	dischargeNode

Code

function TurnOnVehicle:getIsDischargeNodeActive(superFunc, dischargeNode)
    if dischargeNode.needsSetIsTurnedOn then
        if not self:getIsTurnedOn() then
            return false
        end
    end

    return superFunc( self , dischargeNode)
end

getIsFillUnitActive

Description

Definition

getIsFillUnitActive()

Arguments

any	superFunc
any	fillUnitIndex

Code

function TurnOnVehicle:getIsFillUnitActive(superFunc, fillUnitIndex)
    local spec = self.spec_turnOnVehicle
    if spec.activatableFillUnits[fillUnitIndex] = = true then
        if not self:getIsTurnedOn() then
            return false
        end
    end

    return superFunc( self , fillUnitIndex)
end

getIsOperating

Description

Returns if vehicle is operating

Definition

getIsOperating()

Arguments

any	superFunc

Return Values

any	isOperating	is operating

Code

function TurnOnVehicle:getIsOperating(superFunc)
    if self:getIsTurnedOn() then
        return true
    end

    return superFunc( self )
end

getIsPowerTakeOffActive

Description

Definition

getIsPowerTakeOffActive()

Arguments

any	superFunc

Code

function TurnOnVehicle:getIsPowerTakeOffActive(superFunc)
    return self:getIsTurnedOn() or superFunc( self )
end

getIsSeedChangeAllowed

Description

Definition

getIsSeedChangeAllowed()

Arguments

any	superFunc

Code

function TurnOnVehicle:getIsSeedChangeAllowed(superFunc)
    return superFunc( self ) and not self:getIsTurnedOn()
end

getIsTurnedOn

Description

Returns if vehicle is turned on

Definition

getIsTurnedOn()

Return Values

any	isTurnedOn	vehicle is turned on

Code

function TurnOnVehicle:getIsTurnedOn()
    local spec = self.spec_turnOnVehicle

    return spec.isAlwaysTurnedOn or spec.isTurnedOn
end

getIsTurnedOnAnimationActive

Description

Definition

getIsTurnedOnAnimationActive()

Arguments

any	turnedOnAnimation

Code

function TurnOnVehicle:getIsTurnedOnAnimationActive(turnedOnAnimation)
    if not self:getIsTurnedOn() then
        return false
    end

    return true
end

getIsWorkAreaActive

Description

Returns true if work area is active

Definition

getIsWorkAreaActive(table workArea, )

Arguments

table	workArea	workArea
any	workArea

Return Values

any	isActive	work area is active

Code

function TurnOnVehicle:getIsWorkAreaActive(superFunc, workArea)
    if not self:getIsTurnedOn() and workArea.needsSetIsTurnedOn then
        return false
    end

    return superFunc( self , workArea)
end

getIsWorkModeChangeAllowed

Description

Definition

getIsWorkModeChangeAllowed()

Arguments

any	superFunc

Code

function TurnOnVehicle:getIsWorkModeChangeAllowed(superFunc)
    local spec = self.spec_workMode
    if spec.allowChangeWhileTurnedOn = = false then
        if self:getIsTurnedOn() then
            return false
        end
    end

    return superFunc( self )
end

getRequiresTurnOn

Description

Definition

getRequiresTurnOn()

Code

function TurnOnVehicle:getRequiresTurnOn()
    return self.spec_turnOnVehicle.requiresTurnOn
end

getShovelNodeIsActive

Description

Definition

getShovelNodeIsActive()

Arguments

any	superFunc
any	shovelNode

Code

function TurnOnVehicle:getShovelNodeIsActive(superFunc, shovelNode)
    if shovelNode.needsActiveVehicle then
        if not self:getIsTurnedOn() then
            return false
        end
    end

    return superFunc( self , shovelNode)
end

getTurnedOnNotAllowedWarning

Description

Returns turn on not allowed warning text

Definition

getTurnedOnNotAllowedWarning()

Return Values

any	warningText	turn on not allowed warning text

Code

function TurnOnVehicle:getTurnedOnNotAllowedWarning()
    if not self:getIsPowered() then
        return g_i18n:getText( "warning_attachToPower" )
    end

    return nil
end

getTurnedOnSpeedFactor

Description

Definition

getTurnedOnSpeedFactor()

Code

function TurnOnVehicle:getTurnedOnSpeedFactor()
    return self.spec_turnOnVehicle.turnedOnSpeed.alpha
end

getUseTurnedOnSchema

Description

Definition

getUseTurnedOnSchema()

Arguments

any	superFunc

Code

function TurnOnVehicle:getUseTurnedOnSchema(superFunc)
    return superFunc( self ) or self:getIsTurnedOn()
end

initSpecialization

Description

Definition

initSpecialization()

Code

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

    schema:register(XMLValueType.STRING, "vehicle.turnOnVehicle#toggleButton" , "Input action name" , "IMPLEMENT_EXTRA" )
    schema:register(XMLValueType.L10N_STRING, "vehicle.turnOnVehicle#turnOffText" , "Turn off text" , "action_turnOffOBJECT" )
    schema:register(XMLValueType.L10N_STRING, "vehicle.turnOnVehicle#turnOnText" , "Turn on text" , "action_turnOnOBJECT" )
    schema:register(XMLValueType.BOOL, "vehicle.turnOnVehicle#isAlwaysTurnedOn" , "Always turned on" , false )
    schema:register(XMLValueType.BOOL, "vehicle.turnOnVehicle#turnedOnByAttacherVehicle" , "Turned on by attacher vehicle" , false )
    schema:register(XMLValueType.BOOL, "vehicle.turnOnVehicle#turnOffIfNotAllowed" , "Turn off if not allowed" , true )
        schema:register(XMLValueType.BOOL, "vehicle.turnOnVehicle#turnOffOnDeactivate" , "Turn off if the vehicle is deactivated" , true )

            schema:register(XMLValueType.BOOL, "vehicle.turnOnVehicle#aiRequiresTurnOn" , "AI requires turned on vehicle" , true )
            schema:register(XMLValueType.BOOL, "vehicle.turnOnVehicle#requiresTurnOn" , "(Mobile only) Vehicle requires turn on" , true )

            AnimationManager.registerAnimationNodesXMLPaths(schema, "vehicle.turnOnVehicle.animationNodes" )

            EffectManager.registerEffectXMLPaths(schema, "vehicle.turnOnVehicle.effects" )

            SoundManager.registerSampleXMLPaths(schema, "vehicle.turnOnVehicle.sounds" , "start(?)" )
            SoundManager.registerSampleXMLPaths(schema, "vehicle.turnOnVehicle.sounds" , "stop(?)" )
            SoundManager.registerSampleXMLPaths(schema, "vehicle.turnOnVehicle.sounds" , "work(?)" )

            schema:register(XMLValueType.STRING, "vehicle.turnOnVehicle.turnedAnimation#name" , "Turned animation name(Animation played while activating and deactivating)" )
                schema:register(XMLValueType.FLOAT, "vehicle.turnOnVehicle.turnedAnimation#turnOnSpeedScale" , "Turn on speed scale" , 1 )
                schema:register(XMLValueType.FLOAT, "vehicle.turnOnVehicle.turnedAnimation#turnOffSpeedScale" , "Turn off speed scale" , "Inversed turnOnSpeedScale" )

                schema:register(XMLValueType.STRING, TurnOnVehicle.TURNED_ON_ANIMATION_XML_PATH .. "#name" , "Turned on animation name(Animation played while turn on)" )
                    schema:register(XMLValueType.FLOAT, TurnOnVehicle.TURNED_ON_ANIMATION_XML_PATH .. "#turnOnFadeTime" , "Turn on fade time" , 1 )
                    schema:register(XMLValueType.FLOAT, TurnOnVehicle.TURNED_ON_ANIMATION_XML_PATH .. "#turnOffFadeTime" , "Turn off fade time" , 1 )
                    schema:register(XMLValueType.FLOAT, TurnOnVehicle.TURNED_ON_ANIMATION_XML_PATH .. "#speedScale" , "Speed scale" , 1 )

                    schema:register(XMLValueType.INT, "vehicle.turnOnVehicle.activatableFillUnits.activatableFillUnit(?)#index" , "Activateable fill unit index" )

                    schema:register(XMLValueType.BOOL, Attachable.INPUT_ATTACHERJOINT_XML_KEY .. "#canBeTurnedOn" , "Attacher joint can turn on implement" , true )
                    schema:register(XMLValueType.BOOL, Attachable.INPUT_ATTACHERJOINT_CONFIG_XML_KEY .. "#canBeTurnedOn" , "Attacher joint can turn on implement" , true )

                    schema:register(XMLValueType.BOOL, WorkArea.WORK_AREA_XML_KEY .. "#needsSetIsTurnedOn" , "Work area needs turned on vehicle to work" , true )
                    schema:register(XMLValueType.BOOL, WorkArea.WORK_AREA_XML_CONFIG_KEY .. "#needsSetIsTurnedOn" , "Work area needs turned on vehicle to work" , true )

                    schema:register(XMLValueType.BOOL, FillUnit.ALARM_TRIGGER_XML_KEY .. "#needsTurnOn" , "Needs turned on vehicle" , false )
                    schema:register(XMLValueType.BOOL, FillUnit.ALARM_TRIGGER_XML_KEY .. "#turnOffInTrigger" , "Turn vehicle off when triggered" , false )

                    schema:register(XMLValueType.BOOL, Shovel.SHOVEL_NODE_XML_KEY .. "#needsActivation" , "Needs activation" , false )

                    schema:register(XMLValueType.BOOL, Dischargeable.DISCHARGE_NODE_XML_PATH .. "#needsSetIsTurnedOn" , "Vehicle needs to be turned on to activate discharge node" , false )
                    schema:register(XMLValueType.BOOL, Dischargeable.DISCHARGE_NODE_XML_PATH .. "#turnOnActivateNode" , "Discharge node is set active when vehicle is turned on" , false )

                    schema:register(XMLValueType.BOOL, Dischargeable.DISCHARGE_NODE_CONFIG_XML_PATH .. "#needsSetIsTurnedOn" , "Vehicle needs to be turned on to activate discharge node" , false )
                    schema:register(XMLValueType.BOOL, Dischargeable.DISCHARGE_NODE_CONFIG_XML_PATH .. "#turnOnActivateNode" , "Discharge node is set active when vehicle is turned on" , false )

                    schema:register(XMLValueType.FLOAT, BunkerSiloCompacter.XML_PATH .. "#turnedOnCompactingScale" , "Compacting scale which is used while vehicle is turned on" , "normal scale" )

                        schema:register(XMLValueType.TIME, "vehicle.turnOnVehicle.turnedOnSpeed#fadeInTime" , "(Turned on speed simulation - used as sound modifier and for rpm dashboards) Time to reach max.turned on speed" , 1 )
                            schema:register(XMLValueType.TIME, "vehicle.turnOnVehicle.turnedOnSpeed#fadeOutTime" , "(Turned on speed simulation - used as sound modifier and for rpm dashboards) Time to reach the turned off speed again" , 1 )
                                schema:register(XMLValueType.FLOAT, "vehicle.turnOnVehicle.turnedOnSpeed#variance" , "Variation value at max.speed" , 0.02 )
                                schema:register(XMLValueType.FLOAT, "vehicle.turnOnVehicle.turnedOnSpeed#varianceSpeed" , "Speed factor of variance change" , 1 )

                                Dashboard.registerDashboardXMLPaths(schema, "vehicle.turnOnVehicle.dashboards" , { "turnedOn" , "rpm" } )
                                schema:register(XMLValueType.FLOAT, "vehicle.turnOnVehicle.dashboards.dashboard(?)#minRpm" , "Rpm value if vehicle is turned off" , 0 )
                                    schema:register(XMLValueType.FLOAT, "vehicle.turnOnVehicle.dashboards.dashboard(?)#maxRpm" , "Rpm value if vehicle is turned on" , 1000 )

                                        schema:setXMLSpecializationType()
                                    end

loadAlarmTrigger

Description

Definition

loadAlarmTrigger()

Arguments

any	superFunc
any	xmlFile
any	key
any	alarmTrigger
any	fillUnit

Code

function TurnOnVehicle:loadAlarmTrigger(superFunc, xmlFile, key, alarmTrigger, fillUnit)
    local ret = superFunc( self , xmlFile, key, alarmTrigger, fillUnit)
    alarmTrigger.needsTurnOn = xmlFile:getValue(key .. "#needsTurnOn" , false )
    alarmTrigger.turnOffInTrigger = xmlFile:getValue(key .. "#turnOffInTrigger" , false )

    return ret
end

loadBunkerSiloCompactorFromXML

Description

Definition

loadBunkerSiloCompactorFromXML()

Arguments

any	superFunc
any	xmlFile
any	key

Code

function TurnOnVehicle:loadBunkerSiloCompactorFromXML(superFunc, xmlFile, key)
    superFunc( self , xmlFile, key)

    local spec = self.spec_bunkerSiloCompacter
    spec.turnedOnCompactingScale = xmlFile:getValue(key .. "#turnedOnCompactingScale" )
end

loadDischargeNode

Description

Definition

loadDischargeNode()

Arguments

any	superFunc
any	xmlFile
any	key
any	entry

Code

function TurnOnVehicle:loadDischargeNode(superFunc, xmlFile, key, entry)
    if not superFunc( self , xmlFile, key, entry) then
        return false
    end

    entry.needsSetIsTurnedOn = xmlFile:getValue(key .. "#needsSetIsTurnedOn" , false )
    entry.turnOnActivateNode = xmlFile:getValue(key .. "#turnOnActivateNode" , false )
    if entry.turnOnActivateNode then
        local spec = self.spec_turnOnVehicle
        spec.activateableDischargeNode = entry
    end

    return true
end

loadInputAttacherJoint

Description

Called on loading

Definition

loadInputAttacherJoint(table savegame, , , , )

Arguments

table	savegame	savegame
any	xmlFile
any	key
any	inputAttacherJoint
any	i

Code

function TurnOnVehicle:loadInputAttacherJoint(superFunc, xmlFile, key, inputAttacherJoint, i)
    if not superFunc( self , xmlFile, key, inputAttacherJoint, i) then
        return false
    end

    inputAttacherJoint.canBeTurnedOn = xmlFile:getValue(key .. "#canBeTurnedOn" , true )

    return true
end

loadShovelNode

Description

Definition

loadShovelNode()

Arguments

any	superFunc
any	xmlFile
any	key
any	shovelNode

Code

function TurnOnVehicle:loadShovelNode(superFunc, xmlFile, key, shovelNode)
    superFunc( self , xmlFile, key, shovelNode)

    shovelNode.needsActiveVehicle = xmlFile:getValue(key .. "#needsActivation" , false )

    return true
end

loadTurnedOnAnimationFromXML

Description

Definition

loadTurnedOnAnimationFromXML()

Arguments

any	xmlFile
any	key
any	turnedOnAnimation

Code

function TurnOnVehicle:loadTurnedOnAnimationFromXML(xmlFile, key, turnedOnAnimation)
    local name = self.xmlFile:getValue(key .. "#name" )
    if name = = nil then
        Logging.xmlWarning(xmlFile, "Missing animation name in '%s'" , key)
        return false
    end

    turnedOnAnimation.name = name
    turnedOnAnimation.turnOnFadeTime = self.xmlFile:getValue(key .. "#turnOnFadeTime" , 1 ) * 1000
    turnedOnAnimation.turnOffFadeTime = self.xmlFile:getValue(key .. "#turnOffFadeTime" , 1 ) * 1000
    turnedOnAnimation.speedScale = self.xmlFile:getValue(key .. "#speedScale" , 1 )
    turnedOnAnimation.speedDirection = 0
    turnedOnAnimation.currentSpeed = 0
    turnedOnAnimation.isTurnedOn = false

    return true
end

loadWorkAreaFromXML

Description

Loads work areas from xml

Definition

loadWorkAreaFromXML(table workArea, XMLFile xmlFile, string key, )

Arguments

table	workArea	workArea
XMLFile	xmlFile	XMLFile instance
string	key	key
any	key

Code

function TurnOnVehicle:loadWorkAreaFromXML(superFunc, workArea, xmlFile, key)
    local retValue = superFunc( self , workArea, xmlFile, key)

    workArea.needsSetIsTurnedOn = xmlFile:getValue(key .. "#needsSetIsTurnedOn" , true )

    return retValue
end

onAlarmTriggerChanged

Description

Definition

onAlarmTriggerChanged()

Arguments

any	alarmTrigger
any	state

Code

function TurnOnVehicle:onAlarmTriggerChanged(alarmTrigger, state)
    if state then
        if alarmTrigger.turnOffInTrigger then
            self:setIsTurnedOn( false , true )
        end
    end
end

onDeactivate

Description

Called on deactivate

Definition

onDeactivate()

Code

function TurnOnVehicle:onDeactivate()
    local spec = self.spec_turnOnVehicle
    if spec.turnOffOnDeactivate then
        self:setIsTurnedOn( false , true )
    end
end

onDelete

Description

Called on deleting

Definition

onDelete()

Code

function TurnOnVehicle:onDelete()
    local spec = self.spec_turnOnVehicle
    if self.isClient then
        if spec.samples ~ = nil then
            g_soundManager:deleteSamples(spec.samples.start)
            g_soundManager:deleteSamples(spec.samples.stop)
            g_soundManager:deleteSamples(spec.samples.work)
        end
        g_animationManager:deleteAnimations(spec.animationNodes)
        g_effectManager:deleteEffects(spec.effects)
    end
end

onLoad

Description

Called on loading

Definition

onLoad(table savegame)

Arguments

table	savegame	savegame

Code

function TurnOnVehicle:onLoad(savegame)

    XMLUtil.checkDeprecatedXMLElements( self.xmlFile, "vehicle.turnOnSettings#turnOffText" , "vehicle.turnOnVehicle#turnOffText" ) --FS15 to FS17
    XMLUtil.checkDeprecatedXMLElements( self.xmlFile, "vehicle.turnOnSettings#turnOnText" , "vehicle.turnOnVehicle#turnOnText" ) --FS15 to FS17
    XMLUtil.checkDeprecatedXMLElements( self.xmlFile, "vehicle.turnOnSettings#needsSelection" ) --FS15 to FS17
    XMLUtil.checkDeprecatedXMLElements( self.xmlFile, "vehicle.turnOnSettings#isAlwaysTurnedOn" , "vehicle.turnOnVehicle#isAlwaysTurnedOn" ) --FS15 to FS17
    XMLUtil.checkDeprecatedXMLElements( self.xmlFile, "vehicle.turnOnSettings#toggleButton" , "vehicle.turnOnVehicle#toggleButton" ) --FS15 to FS17
    XMLUtil.checkDeprecatedXMLElements( self.xmlFile, "vehicle.turnOnSettings#animationName" , "vehicle.turnOnVehicle.turnedAnimation#name" ) --FS15 to FS17
    XMLUtil.checkDeprecatedXMLElements( self.xmlFile, "vehicle.turnOnSettings#turnOnSpeedScale" , "vehicle.turnOnVehicle.turnedAnimation#turnOnSpeedScale" ) --FS15 to FS17
    XMLUtil.checkDeprecatedXMLElements( self.xmlFile, "vehicle.turnOnSettings#turnOffSpeedScale" , "vehicle.turnOnVehicle.turnedAnimation#turnOffSpeedScale" ) --FS15 to FS17
    XMLUtil.checkDeprecatedXMLElements( self.xmlFile, "vehicle.turnedOnRotationNodes.turnedOnRotationNode#type" , "vehicle.turnOnVehicle.animationNodes.animationNode" , "turnOn" ) --FS17 to FS19
    XMLUtil.checkDeprecatedXMLElements( self.xmlFile, "vehicle.foldable.foldingParts#turnOffOnFold" , "vehicle.turnOnVehicle#turnOffIfNotAllowed" ) --FS17 to FS19

    local spec = self.spec_turnOnVehicle

    local turnOnButtonStr = self.xmlFile:getValue( "vehicle.turnOnVehicle#toggleButton" )
    if turnOnButtonStr ~ = nil then
        spec.toggleTurnOnInputBinding = InputAction[turnOnButtonStr]
    end
    spec.toggleTurnOnInputBinding = Utils.getNoNil(spec.toggleTurnOnInputBinding, InputAction.IMPLEMENT_EXTRA)

    spec.turnOffText = string.format( self.xmlFile:getValue( "vehicle.turnOnVehicle#turnOffText" , "action_turnOffOBJECT" , self.customEnvironment), self.typeDesc)
    spec.turnOnText = string.format( self.xmlFile:getValue( "vehicle.turnOnVehicle#turnOnText" , "action_turnOnOBJECT" , self.customEnvironment), self.typeDesc)
    spec.isTurnedOn = false
    spec.isAlwaysTurnedOn = self.xmlFile:getValue( "vehicle.turnOnVehicle#isAlwaysTurnedOn" , false )
    spec.turnedOnByAttacherVehicle = self.xmlFile:getValue( "vehicle.turnOnVehicle#turnedOnByAttacherVehicle" , false )
    spec.turnOffIfNotAllowed = self.xmlFile:getValue( "vehicle.turnOnVehicle#turnOffIfNotAllowed" , true )
    spec.turnOffOnDeactivate = self.xmlFile:getValue( "vehicle.turnOnVehicle#turnOffOnDeactivate" , not GS_IS_MOBILE_VERSION)

    spec.aiRequiresTurnOn = self.xmlFile:getValue( "vehicle.turnOnVehicle#aiRequiresTurnOn" , true )
    spec.requiresTurnOn = self.xmlFile:getValue( "vehicle.turnOnVehicle#requiresTurnOn" , true )

    if self.isClient then
        spec.animationNodes = g_animationManager:loadAnimations( self.xmlFile, "vehicle.turnOnVehicle.animationNodes" , self.components, self , self.i3dMappings)

        local allowsAnimations = SpecializationUtil.hasSpecialization( AnimatedVehicle , self.specializations)
        if allowsAnimations then
            local turnOnAnimation = self.xmlFile:getValue( "vehicle.turnOnVehicle.turnedAnimation#name" )
            if turnOnAnimation ~ = nil then
                spec.turnOnAnimation = { }
                spec.turnOnAnimation.name = turnOnAnimation
                spec.turnOnAnimation.turnOnSpeedScale = self.xmlFile:getValue( "vehicle.turnOnVehicle.turnedAnimation#turnOnSpeedScale" , 1 )
                spec.turnOnAnimation.turnOffSpeedScale = self.xmlFile:getValue( "vehicle.turnOnVehicle.turnedAnimation#turnOffSpeedScale" , - spec.turnOnAnimation.turnOnSpeedScale)
            end
        end

        spec.turnedOnAnimations = { }
        if allowsAnimations then
            self.xmlFile:iterate( "vehicle.turnOnVehicle.turnedOnAnimation" , function (index, key)
                local entry = { }
                if self:loadTurnedOnAnimationFromXML( self.xmlFile, key, entry) then
                    table.insert(spec.turnedOnAnimations, entry)
                end
            end )
        end

        spec.activatableFillUnits = { }
        local i = 0
        while true do
            local key = string.format( "vehicle.turnOnVehicle.activatableFillUnits.activatableFillUnit(%d)" , i)
            if not self.xmlFile:hasProperty(key) then
                break
            end

            local fillUnitIndex = self.xmlFile:getValue(key .. "#index" )
            if fillUnitIndex ~ = nil then
                spec.activatableFillUnits[fillUnitIndex] = true
            end

            i = i + 1
        end

        spec.effects = g_effectManager:loadEffect( self.xmlFile, "vehicle.turnOnVehicle.effects" , self.components, self , self.i3dMappings)

        spec.samples = { }
        spec.samples.start = g_soundManager:loadSamplesFromXML( self.xmlFile, "vehicle.turnOnVehicle.sounds" , "start" , self.baseDirectory, self.components, 1 , AudioGroup.VEHICLE, self.i3dMappings, self )
        spec.samples.stop = g_soundManager:loadSamplesFromXML( self.xmlFile, "vehicle.turnOnVehicle.sounds" , "stop" , self.baseDirectory, self.components, 1 , AudioGroup.VEHICLE, self.i3dMappings, self )
        spec.samples.work = g_soundManager:loadSamplesFromXML( self.xmlFile, "vehicle.turnOnVehicle.sounds" , "work" , self.baseDirectory, self.components, 0 , AudioGroup.VEHICLE, self.i3dMappings, self )

        -- simple turned on speed simulation - can be used as sound modifier or turned on rpm dashboard
        spec.turnedOnSpeed = { }
        spec.turnedOnSpeed.isActive = self.xmlFile:hasProperty( "vehicle.turnOnVehicle.turnedOnSpeed" )
        spec.turnedOnSpeed.alpha = 0
        spec.turnedOnSpeed.fadeInTime = self.xmlFile:getValue( "vehicle.turnOnVehicle.turnedOnSpeed#fadeInTime" , 1 )
        spec.turnedOnSpeed.fadeOutTime = self.xmlFile:getValue( "vehicle.turnOnVehicle.turnedOnSpeed#fadeOutTime" , 1 )
        spec.turnedOnSpeed.variance = self.xmlFile:getValue( "vehicle.turnOnVehicle.turnedOnSpeed#variance" , 0.02 )
        spec.turnedOnSpeed.varianceSpeed = self.xmlFile:getValue( "vehicle.turnOnVehicle.turnedOnSpeed#varianceSpeed" , 0.01 )
    end

    if not self.isClient then
        SpecializationUtil.removeEventListener( self , "onDelete" , TurnOnVehicle )
        SpecializationUtil.removeEventListener( self , "onUpdate" , TurnOnVehicle )
    end
end

onPostAttach

Description

Definition

onPostAttach()

Arguments

any	attacherVehicle
any	inputJointDescIndex
any	jointDescIndex

Code

function TurnOnVehicle:onPostAttach(attacherVehicle, inputJointDescIndex, jointDescIndex)
    local spec = self.spec_turnOnVehicle
    if spec.turnedOnByAttacherVehicle then
        if attacherVehicle.getIsTurnedOn ~ = nil then
            self:setIsTurnedOn(attacherVehicle:getIsTurnedOn(), true )
        end
    end
end

onPreDetach

Description

Called if vehicle gets detached

Definition

onPreDetach(table attacherVehicle, table implement)

Arguments

table	attacherVehicle	attacher vehicle
table	implement	implement

Code

function TurnOnVehicle:onPreDetach(attacherVehicle, implement)
    self:setIsTurnedOn( false , true )
end

onReadStream

Description

Called on client side on join

Definition

onReadStream(integer streamId, Connection connection)

Arguments

integer	streamId	streamId
Connection	connection	connection

Code

function TurnOnVehicle:onReadStream(streamId, connection)
    local turnedOn = streamReadBool(streamId)
    self:setIsTurnedOn(turnedOn, true )
end

onRegisterActionEvents

Description

Definition

onRegisterActionEvents()

Arguments

any	isActiveForInput
any	isActiveForInputIgnoreSelection

Code

function TurnOnVehicle:onRegisterActionEvents(isActiveForInput, isActiveForInputIgnoreSelection)
    if self.isClient then
        local spec = self.spec_turnOnVehicle
        self:clearActionEventsTable(spec.actionEvents)
        if isActiveForInputIgnoreSelection and self:getCanToggleTurnedOn() then
            local _, actionEventId = self:addPoweredActionEvent(spec.actionEvents, spec.toggleTurnOnInputBinding, self , TurnOnVehicle.actionEventTurnOn, false , true , false , true , nil )
            g_inputBinding:setActionEventTextPriority(actionEventId, GS_PRIO_HIGH)

            TurnOnVehicle.updateActionEvents( self )

            _, actionEventId = self:addPoweredActionEvent(spec.actionEvents, InputAction.TURN_ON_ALL_IMPLEMENTS, self , TurnOnVehicle.actionEventTurnOnAll, false , true , false , true , nil )
            g_inputBinding:setActionEventTextVisibility(actionEventId, false )
        end
    end
end

onRegisterDashboardValueTypes

Description

Called on post load to register dashboard value types

Definition

onRegisterDashboardValueTypes()

Code

function TurnOnVehicle:onRegisterDashboardValueTypes()
    local spec = self.spec_turnOnVehicle

    local turnedOn = DashboardValueType.new( "turnOnVehicle" , "turnedOn" )
    turnedOn:setValue(spec, "isTurnedOn" )
    turnedOn:setPollUpdate( false )
    self:registerDashboardValueType(turnedOn)

    local rpm = DashboardValueType.new( "turnOnVehicle" , "rpm" )
    rpm:setValue( self , TurnOnVehicle.dashboardRpmValue)
    rpm:setAdditionalFunctions( TurnOnVehicle.dashboardRpmAttributes, nil )
    self:registerDashboardValueType(rpm)
end

onRegisterExternalActionEvents

Description

Called on load to register external action events

Definition

onRegisterExternalActionEvents()

Arguments

any	trigger
any	name
any	xmlFile
any	key

Code

function TurnOnVehicle:onRegisterExternalActionEvents(trigger, name, xmlFile, key)
    if name = = "turnOn" then
        self:registerExternalActionEvent(trigger, name, TurnOnVehicle.externalActionEventRegister, TurnOnVehicle.externalActionEventUpdate)
    end
end

onRootVehicleChanged

Description

Called if root vehicle changes

Definition

onRootVehicleChanged(table rootVehicle)

Arguments

table	rootVehicle	root vehicle

Code

function TurnOnVehicle:onRootVehicleChanged(rootVehicle)
    local spec = self.spec_turnOnVehicle
    local actionController = rootVehicle.actionController
    if actionController ~ = nil and self:getCanToggleTurnedOn() then
        if spec.controlledAction ~ = nil then
            spec.controlledAction:updateParent(actionController)
            return
        end

        spec.controlledAction = actionController:registerAction( "turnOn" , spec.toggleTurnOnInputBinding, 1 )
        spec.controlledAction:setCallback( self , TurnOnVehicle.actionControllerTurnOnEvent)
        spec.controlledAction:setFinishedFunctions( self , self.getIsTurnedOn, true , false )
        spec.controlledAction:setIsSaved( true )
        spec.controlledAction:setIsAccessibleFunction( function ()
            -- if g_guidedTourManager:getIsTourRunning() then
                -- if actionController:getActionControllerDirection() = = 1 then
                    -- if not g_currentMission.guidedTour:getCanBeTurnedOn(self) then
                        -- return false
                        -- end
                        -- else
                            -- if not g_currentMission.guidedTour:getCanBeTurnedOff(self) then
                                -- return false
                                -- end
                                -- end
                                -- end

                                return true
                            end )
                            if self:getAIRequiresTurnOn() then
                                if not self:getAIRequiresTurnOffOnHeadland() then
                                    spec.controlledAction:addAIEventListener( self , "onAIFieldWorkerPrepareForWork" , 1 , true )
                                    spec.controlledAction:addAIEventListener( self , "onAIImplementPrepareForWork" , 1 , true )
                                end
                                spec.controlledAction:addAIEventListener( self , "onAIImplementStartLine" , 1 , true )
                                spec.controlledAction:addAIEventListener( self , "onAIImplementContinue" , 1 )
                                spec.controlledAction:addAIEventListener( self , "onAIImplementEnd" , - 1 )
                                spec.controlledAction:addAIEventListener( self , "onAIImplementStart" , - 1 )
                                spec.controlledAction:addAIEventListener( self , "onAIFieldWorkerEnd" , - 1 )
                                if self:getAIRequiresTurnOffOnHeadland() then
                                    spec.controlledAction:addAIEventListener( self , "onAIImplementEndLine" , - 1 )
                                end
                                spec.controlledAction:addAIEventListener( self , "onAIImplementBlock" , - 1 )
                                spec.controlledAction:addAIEventListener( self , "onAIImplementPrepareForTransport" , - 1 )
                            end
                        else
                                if spec.controlledAction ~ = nil then
                                    spec.controlledAction:remove()
                                end
                            end
                        end

onSetBroken

Description

Definition

onSetBroken()

Code

function TurnOnVehicle:onSetBroken()
    self:setIsTurnedOn( false , true )
end

onStateChange

Description

Definition

onStateChange()

Arguments

any	state
any	data

Code

function TurnOnVehicle:onStateChange(state, data)
    if state = = VehicleStateChange.MOTOR_TURN_OFF then
        if not self:getCanBeTurnedOn() then
            self:setIsTurnedOn( false , true )
        end
    end
end

onTurnedOff

Description

Definition

onTurnedOff()

Code

function TurnOnVehicle:onTurnedOff()
    local spec = self.spec_turnOnVehicle
    if self.isClient then
        if spec.turnOnAnimation ~ = nil then
            self:playAnimation(spec.turnOnAnimation.name, spec.turnOnAnimation.turnOffSpeedScale, self:getAnimationTime(spec.turnOnAnimation.name), true )
        end

        g_soundManager:stopSamples(spec.samples.start)
        g_soundManager:stopSamples(spec.samples.work)
        g_soundManager:stopSamples(spec.samples.stop)

        g_soundManager:playSamples(spec.samples.stop)
        g_animationManager:stopAnimations(spec.animationNodes)
        g_effectManager:stopEffects(spec.effects)
    end

    if spec.activateableDischargeNodePrev ~ = nil then
        if spec.activateableDischargeNodePrev.index ~ = nil then
            self:setCurrentDischargeNodeIndex(spec.activateableDischargeNodePrev.index)
            spec.activateableDischargeNodePrev = nil
        end
    end
end

onTurnedOn

Description

Definition

onTurnedOn()

Code

function TurnOnVehicle:onTurnedOn()
    local spec = self.spec_turnOnVehicle
    if self.isClient then
        if spec.turnOnAnimation ~ = nil then
            self:playAnimation(spec.turnOnAnimation.name, spec.turnOnAnimation.turnOnSpeedScale, self:getAnimationTime(spec.turnOnAnimation.name), true )
        end

        g_soundManager:stopSamples(spec.samples.start)
        g_soundManager:stopSamples(spec.samples.work)
        g_soundManager:stopSamples(spec.samples.stop)

        g_soundManager:playSamples(spec.samples.start)
        for i = 1 , #spec.samples.work do
            g_soundManager:playSample(spec.samples.work[i], 0 , spec.samples.start[i] or spec.samples.start[ 1 ])
        end

        g_animationManager:startAnimations(spec.animationNodes)
        g_effectManager:startEffects(spec.effects)
    end

    if spec.activateableDischargeNode ~ = nil then
        if spec.activateableDischargeNode.index ~ = nil then
            spec.activateableDischargeNodePrev = self:getCurrentDischargeNode()
            self:setCurrentDischargeNodeIndex(spec.activateableDischargeNode.index)
        end
    end
end

onUpdate

Description

Called on update

Definition

onUpdate(float dt, boolean isActiveForInput, boolean isSelected, )

Arguments

float	dt	time since last call in ms
boolean	isActiveForInput	true if vehicle is active for input
boolean	isSelected	true if vehicle is selected
any	isSelected

Code

function TurnOnVehicle:onUpdate(dt, isActiveForInput, isActiveForInputIgnoreSelection, isSelected)
    local spec = self.spec_turnOnVehicle

    for i = 1 , #spec.turnedOnAnimations do
        local turnedOnAnimation = spec.turnedOnAnimations[i]
        local isTurnedOn = self:getIsTurnedOnAnimationActive(turnedOnAnimation)
        if turnedOnAnimation.isTurnedOn ~ = isTurnedOn then
            if isTurnedOn then
                turnedOnAnimation.speedDirection = 1
                self:playAnimation(turnedOnAnimation.name, math.max(turnedOnAnimation.currentSpeed * turnedOnAnimation.speedScale, 0.001 ), self:getAnimationTime(turnedOnAnimation.name), true )
            else
                    turnedOnAnimation.speedDirection = - 1
                end

                turnedOnAnimation.isTurnedOn = isTurnedOn
            end

            if turnedOnAnimation.speedDirection ~ = 0 then
                local duration = turnedOnAnimation.turnOnFadeTime
                if turnedOnAnimation.speedDirection = = - 1 then
                    duration = turnedOnAnimation.turnOffFadeTime
                end
                turnedOnAnimation.currentSpeed = math.clamp(turnedOnAnimation.currentSpeed + turnedOnAnimation.speedDirection * dt / duration, 0 , 1 )
                self:setAnimationSpeed(turnedOnAnimation.name, turnedOnAnimation.currentSpeed * turnedOnAnimation.speedScale)
                if turnedOnAnimation.speedDirection = = - 1 and turnedOnAnimation.currentSpeed = = 0 then
                    self:stopAnimation(turnedOnAnimation.name, true )
                end

                if turnedOnAnimation.currentSpeed = = 1 or turnedOnAnimation.currentSpeed = = 0 then
                    turnedOnAnimation.speedDirection = 0
                end
            end
        end

        if self.isClient then
            if spec.turnedOnSpeed.isActive then
                local targetAlpha = 0
                if self:getIsTurnedOn() then
                    local time = g_ time * spec.turnedOnSpeed.varianceSpeed * 0.05
                    local modValue = math.sin( time ) * math.sin(( time + 2 ) * 0.3 ) * 0.8 + math.cos( time * 5 ) * 0.2
                    targetAlpha = 1 + modValue * spec.turnedOnSpeed.variance
                end

                if targetAlpha ~ = spec.turnedOnSpeed.alpha then
                    local dir = math.sign(targetAlpha - spec.turnedOnSpeed.alpha)
                    local limitFunc = dir < 0 and math.max or math.min
                    local fadeTime = dir < 0 and spec.turnedOnSpeed.fadeOutTime or spec.turnedOnSpeed.fadeInTime
                    spec.turnedOnSpeed.alpha = limitFunc(spec.turnedOnSpeed.alpha + ( 1 / fadeTime) * dir * dt, targetAlpha)
                end
            end
        end
    end

onUpdateTick

Description

Called on update tick

Definition

onUpdateTick(float dt, boolean isActiveForInput, boolean isSelected, )

Arguments

float	dt	time since last call in ms
boolean	isActiveForInput	true if vehicle is active for input
boolean	isSelected	true if vehicle is selected
any	isSelected

Code

function TurnOnVehicle:onUpdateTick(dt, isActiveForInput, isActiveForInputIgnoreSelection, isSelected)
    local spec = self.spec_turnOnVehicle

    if self.isClient then
        if not spec.isAlwaysTurnedOn and not spec.turnedOnByAttacherVehicle then
            TurnOnVehicle.updateActionEvents( self )
        end
    end

    if self.isServer then
        if spec.turnOffIfNotAllowed then
            if not self:getCanBeTurnedOn() then
                if self:getIsTurnedOn() then
                    self:setIsTurnedOn( false )
                else
                        if self.getAttacherVehicle ~ = nil then
                            local attacherVehicle = self:getAttacherVehicle()
                            if attacherVehicle ~ = nil then
                                if attacherVehicle.setIsTurnedOn ~ = nil and attacherVehicle:getIsTurnedOn() then
                                    attacherVehicle:setIsTurnedOn( false )
                                end
                            end
                        end
                    end
                end
            end
        end
    end

onWriteStream

Description

Called on server side on join

Definition

onWriteStream(integer streamId, Connection connection)

Arguments

integer	streamId	streamId
Connection	connection	connection

Code

function TurnOnVehicle:onWriteStream(streamId, connection)
    local spec = self.spec_turnOnVehicle
    streamWriteBool(streamId, spec.isTurnedOn)
end

prerequisitesPresent

Description

Definition

prerequisitesPresent()

Arguments

any	specializations

Code

function TurnOnVehicle.prerequisitesPresent(specializations)
    return true
end

registerEventListeners

Description

Definition

registerEventListeners()

Arguments

any	vehicleType

Code

function TurnOnVehicle.registerEventListeners(vehicleType)
    SpecializationUtil.registerEventListener(vehicleType, "onLoad" , TurnOnVehicle )
    SpecializationUtil.registerEventListener(vehicleType, "onRegisterDashboardValueTypes" , TurnOnVehicle )
    SpecializationUtil.registerEventListener(vehicleType, "onDelete" , TurnOnVehicle )
    SpecializationUtil.registerEventListener(vehicleType, "onReadStream" , TurnOnVehicle )
    SpecializationUtil.registerEventListener(vehicleType, "onWriteStream" , TurnOnVehicle )
    SpecializationUtil.registerEventListener(vehicleType, "onUpdate" , TurnOnVehicle )
    SpecializationUtil.registerEventListener(vehicleType, "onUpdateTick" , TurnOnVehicle )
    SpecializationUtil.registerEventListener(vehicleType, "onRegisterActionEvents" , TurnOnVehicle )
    SpecializationUtil.registerEventListener(vehicleType, "onRegisterExternalActionEvents" , TurnOnVehicle )
    SpecializationUtil.registerEventListener(vehicleType, "onDeactivate" , TurnOnVehicle )
    SpecializationUtil.registerEventListener(vehicleType, "onPostAttach" , TurnOnVehicle )
    SpecializationUtil.registerEventListener(vehicleType, "onPreDetach" , TurnOnVehicle )
    SpecializationUtil.registerEventListener(vehicleType, "onRootVehicleChanged" , TurnOnVehicle )
    SpecializationUtil.registerEventListener(vehicleType, "onTurnedOn" , TurnOnVehicle )
    SpecializationUtil.registerEventListener(vehicleType, "onTurnedOff" , TurnOnVehicle )
    SpecializationUtil.registerEventListener(vehicleType, "onAlarmTriggerChanged" , TurnOnVehicle )
    SpecializationUtil.registerEventListener(vehicleType, "onSetBroken" , TurnOnVehicle )
    SpecializationUtil.registerEventListener(vehicleType, "onStateChange" , TurnOnVehicle )
end

registerEvents

Description

Definition

registerEvents()

Arguments

any	vehicleType

Code

function TurnOnVehicle.registerEvents(vehicleType)
    SpecializationUtil.registerEvent(vehicleType, "onTurnedOn" )
    SpecializationUtil.registerEvent(vehicleType, "onTurnedOff" )
end

registerFunctions

Description

Definition

registerFunctions()

Arguments

any	vehicleType

Code

function TurnOnVehicle.registerFunctions(vehicleType)
    SpecializationUtil.registerFunction(vehicleType, "setIsTurnedOn" , TurnOnVehicle.setIsTurnedOn)
    SpecializationUtil.registerFunction(vehicleType, "getIsTurnedOn" , TurnOnVehicle.getIsTurnedOn)
    SpecializationUtil.registerFunction(vehicleType, "getCanBeTurnedOn" , TurnOnVehicle.getCanBeTurnedOn)
    SpecializationUtil.registerFunction(vehicleType, "getCanBeTurnedOnAll" , TurnOnVehicle.getCanBeTurnedOnAll)
    SpecializationUtil.registerFunction(vehicleType, "getCanToggleTurnedOn" , TurnOnVehicle.getCanToggleTurnedOn)
    SpecializationUtil.registerFunction(vehicleType, "getTurnedOnNotAllowedWarning" , TurnOnVehicle.getTurnedOnNotAllowedWarning)
    SpecializationUtil.registerFunction(vehicleType, "getAIRequiresTurnOn" , TurnOnVehicle.getAIRequiresTurnOn)
    SpecializationUtil.registerFunction(vehicleType, "getRequiresTurnOn" , TurnOnVehicle.getRequiresTurnOn)
    SpecializationUtil.registerFunction(vehicleType, "getAIRequiresTurnOffOnHeadland" , TurnOnVehicle.getAIRequiresTurnOffOnHeadland)
    SpecializationUtil.registerFunction(vehicleType, "loadTurnedOnAnimationFromXML" , TurnOnVehicle.loadTurnedOnAnimationFromXML)
    SpecializationUtil.registerFunction(vehicleType, "getIsTurnedOnAnimationActive" , TurnOnVehicle.getIsTurnedOnAnimationActive)
    SpecializationUtil.registerFunction(vehicleType, "getTurnedOnSpeedFactor" , TurnOnVehicle.getTurnedOnSpeedFactor)
end

registerOverwrittenFunctions

Description

Definition

registerOverwrittenFunctions()

Arguments

any	vehicleType

Code

function TurnOnVehicle.registerOverwrittenFunctions(vehicleType)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getUseTurnedOnSchema" , TurnOnVehicle.getUseTurnedOnSchema)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "loadInputAttacherJoint" , TurnOnVehicle.loadInputAttacherJoint)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "loadWorkAreaFromXML" , TurnOnVehicle.loadWorkAreaFromXML)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getIsWorkAreaActive" , TurnOnVehicle.getIsWorkAreaActive)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getCanAIImplementContinueWork" , TurnOnVehicle.getCanAIImplementContinueWork)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getIsOperating" , TurnOnVehicle.getIsOperating)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getAlarmTriggerIsActive" , TurnOnVehicle.getAlarmTriggerIsActive)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "loadAlarmTrigger" , TurnOnVehicle.loadAlarmTrigger)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getIsFillUnitActive" , TurnOnVehicle.getIsFillUnitActive)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "loadShovelNode" , TurnOnVehicle.loadShovelNode)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getShovelNodeIsActive" , TurnOnVehicle.getShovelNodeIsActive)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getIsSeedChangeAllowed" , TurnOnVehicle.getIsSeedChangeAllowed)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getCanBeSelected" , TurnOnVehicle.getCanBeSelected)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getIsPowerTakeOffActive" , TurnOnVehicle.getIsPowerTakeOffActive)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "loadDischargeNode" , TurnOnVehicle.loadDischargeNode)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getIsDischargeNodeActive" , TurnOnVehicle.getIsDischargeNodeActive)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "loadBunkerSiloCompactorFromXML" , TurnOnVehicle.loadBunkerSiloCompactorFromXML)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getBunkerSiloCompacterScale" , TurnOnVehicle.getBunkerSiloCompacterScale)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getIsWorkModeChangeAllowed" , TurnOnVehicle.getIsWorkModeChangeAllowed)
end

setIsTurnedOn

Description

Set is turned on state

Definition

setIsTurnedOn(boolean isTurnedOn, boolean noEventSend)

Arguments

boolean	isTurnedOn	new is is turned on state
boolean	noEventSend	no event send

Code

function TurnOnVehicle:setIsTurnedOn(isTurnedOn, noEventSend)
    local spec = self.spec_turnOnVehicle

    if isTurnedOn ~ = spec.isTurnedOn then
        SetTurnedOnEvent.sendEvent( self , isTurnedOn, noEventSend)
        spec.isTurnedOn = isTurnedOn

        if spec.isTurnedOn then
            SpecializationUtil.raiseEvent( self , "onTurnedOn" )
            self.rootVehicle:raiseStateChange(VehicleStateChange.TURN_ON, self )
        else
                SpecializationUtil.raiseEvent( self , "onTurnedOff" )
                self.rootVehicle:raiseStateChange(VehicleStateChange.TURN_OFF, self )
            end

            if self.isClient then
                if self.updateDashboardValueType ~ = nil then
                    self:updateDashboardValueType( "turnOnVehicle.turnedOn" )
                end
            end
        end
    end

updateActionEvents

Description

Definition

updateActionEvents()

Arguments

any	self

Code

function TurnOnVehicle.updateActionEvents( self )
    local spec = self.spec_turnOnVehicle

    -- update activity of actionEvent
    local actionEvent = spec.actionEvents[spec.toggleTurnOnInputBinding]
    if actionEvent ~ = nil then
        local state = self:getCanToggleTurnedOn()

        if state then
            local text
            if self:getIsTurnedOn() then
                text = spec.turnOffText
            else
                    text = spec.turnOnText
                end
                g_inputBinding:setActionEventText(actionEvent.actionEventId, text)
            end

            g_inputBinding:setActionEventActive(actionEvent.actionEventId, state)
        end
    end

TurnOnVehicle​

actionControllerTurnOnEvent​

actionEventTurnOn​

actionEventTurnOnAll​

dashboardRpmAttributes​

dashboardRpmValue​

externalActionEventRegister​

externalActionEventUpdate​

getAIRequiresTurnOffOnHeadland​

getAIRequiresTurnOn​

getAlarmTriggerIsActive​

getBunkerSiloCompacterScale​

getCanAIImplementContinueWork​

getCanBeSelected​

getCanBeTurnedOn​

getCanBeTurnedOnAll​

getCanToggleTurnedOn​

getIsDischargeNodeActive​

getIsFillUnitActive​

getIsOperating​

getIsPowerTakeOffActive​

getIsSeedChangeAllowed​

getIsTurnedOn​

getIsTurnedOnAnimationActive​

getIsWorkAreaActive​

getIsWorkModeChangeAllowed​

getRequiresTurnOn​

getShovelNodeIsActive​

getTurnedOnNotAllowedWarning​

getTurnedOnSpeedFactor​

getUseTurnedOnSchema​

initSpecialization​

loadAlarmTrigger​

loadBunkerSiloCompactorFromXML​

loadDischargeNode​

loadInputAttacherJoint​

loadShovelNode​

loadTurnedOnAnimationFromXML​

loadWorkAreaFromXML​

onAlarmTriggerChanged​

onDeactivate​

onDelete​

onLoad​

onPostAttach​

onPreDetach​

onReadStream​

onRegisterActionEvents​

onRegisterDashboardValueTypes​

onRegisterExternalActionEvents​

onRootVehicleChanged​

onSetBroken​

onStateChange​

onTurnedOff​

onTurnedOn​

onUpdate​

onUpdateTick​

onWriteStream​

prerequisitesPresent​

registerEventListeners​

registerEvents​

registerFunctions​

registerOverwrittenFunctions​

setIsTurnedOn​

updateActionEvents​

TurnOnVehicle

actionControllerTurnOnEvent

actionEventTurnOn

actionEventTurnOnAll

dashboardRpmAttributes

dashboardRpmValue

externalActionEventRegister

externalActionEventUpdate

getAIRequiresTurnOffOnHeadland

getAIRequiresTurnOn

getAlarmTriggerIsActive

getBunkerSiloCompacterScale

getCanAIImplementContinueWork

getCanBeSelected

getCanBeTurnedOn

getCanBeTurnedOnAll

getCanToggleTurnedOn

getIsDischargeNodeActive

getIsFillUnitActive

getIsOperating

getIsPowerTakeOffActive

getIsSeedChangeAllowed

getIsTurnedOn

getIsTurnedOnAnimationActive

getIsWorkAreaActive

getIsWorkModeChangeAllowed

getRequiresTurnOn

getShovelNodeIsActive

getTurnedOnNotAllowedWarning

getTurnedOnSpeedFactor

getUseTurnedOnSchema

initSpecialization

loadAlarmTrigger

loadBunkerSiloCompactorFromXML

loadDischargeNode

loadInputAttacherJoint

loadShovelNode

loadTurnedOnAnimationFromXML

loadWorkAreaFromXML

onAlarmTriggerChanged

onDeactivate

onDelete

onLoad

onPostAttach

onPreDetach

onReadStream

onRegisterActionEvents

onRegisterDashboardValueTypes

onRegisterExternalActionEvents

onRootVehicleChanged

onSetBroken

onStateChange

onTurnedOff

onTurnedOn

onUpdate

onUpdateTick

onWriteStream

prerequisitesPresent

registerEventListeners

registerEvents

registerFunctions

registerOverwrittenFunctions

setIsTurnedOn

updateActionEvents