AIJob

Description

A job mainly runs on server only. Task starting, stopping and updating is server code only Client gets notified by targets. This avoids a lot of issues with async loading of vehicles e.g. if a vehicle is not available when job gets started or synced

Functions

addNamedParameter
addTask
applyCurrentState
canContinueWork
canStartWork
delete
getCanSkipTask
getDescription
getGroupedParameters
getHelperName
getIsAvailableForVehicle
getIsLooping
getIsStartable
getNamedParameter
getNamedParameters
getNextTaskIndex
getPricePerMs
getStartTaskIndex
getTaskByIndex
getTitle
loadFromXMLFile
new
onParameterValueChanged
readStream
resetTasks
saveToXMLFile
setId
setParameterValid
setValues
showNotification
skipCurrentTask
start
startTask
stop
stopTask
update
updateCost
validate
writeStream

addNamedParameter

Description

Definition

addNamedParameter()

Arguments

any	name
any	parameter

Code

function AIJob:addNamedParameter(name, parameter)
    table.insert( self.namedParameters, { name = name, parameter = parameter } )
end

addTask

Description

Definition

addTask()

Arguments

any	task

Code

function AIJob:addTask(task)
    assert(task.taskIndex = = nil , "Task already added" )
    table.insert( self.tasks, task)
    task.taskIndex = # self.tasks
end

applyCurrentState

Description

Definition

applyCurrentState()

Arguments

any	vehicle
any	mission
any	farmId
any	isDirectStart

Code

function AIJob:applyCurrentState(vehicle, mission, farmId, isDirectStart)
    self.isDirectStart = isDirectStart
end

canContinueWork

Description

Definition

canContinueWork()

Code

function AIJob:canContinueWork()
    return true , nil
end

canStartWork

Description

Definition

canStartWork()

Code

function AIJob:canStartWork()
    return true , nil
end

delete

Description

Definition

delete()

Code

function AIJob:delete()
    for _, namedParameter in ipairs( self.namedParameters) do
        namedParameter.parameter:delete()
    end
    for _, task in ipairs( self.tasks) do
        task:delete()
    end
end

getCanSkipTask

Description

Definition

getCanSkipTask()

Code

function AIJob:getCanSkipTask()
    return false
end

getDescription

Description

Definition

getDescription()

Code

function AIJob:getDescription()
    local jobType = g_currentMission.aiJobTypeManager:getJobTypeByIndex( self.jobTypeIndex)
    return jobType.title
end

getGroupedParameters

Description

Definition

getGroupedParameters()

Code

function AIJob:getGroupedParameters()
    return self.groupedParameters
end

getHelperName

Description

Definition

getHelperName()

Code

function AIJob:getHelperName()
    local helper = g_helperManager:getHelperByIndex( self.helperIndex)
    return helper.title
end

getIsAvailableForVehicle

Description

Definition

getIsAvailableForVehicle()

Arguments

any	vehicle

Code

function AIJob:getIsAvailableForVehicle(vehicle)
    return true
end

getIsLooping

Description

Definition

getIsLooping()

Code

function AIJob:getIsLooping()
    return false
end

getIsStartable

Description

Definition

getIsStartable()

Arguments

any	connection

Code

function AIJob:getIsStartable(connection)
    return true , AIJob.START_SUCCESS
end

getNamedParameter

Description

Definition

getNamedParameter()

Arguments

any	name

Code

function AIJob:getNamedParameter(name)
    if name = = nil then
        return nil
    end

    name = string.upper(name)
    for _, data in ipairs( self.namedParameters) do
        if string.upper(data.name) = = name then
            return data.parameter
        end
    end

    return nil
end

getNamedParameters

Description

Definition

getNamedParameters()

Code

function AIJob:getNamedParameters()
    return self.namedParameters
end

getNextTaskIndex

Description

Definition

getNextTaskIndex()

Code

function AIJob:getNextTaskIndex()
    return self.currentTaskIndex + 1
end

getPricePerMs

Description

Definition

getPricePerMs()

Code

function AIJob:getPricePerMs()
    return 0.0004
end

getStartTaskIndex

Description

Definition

getStartTaskIndex()

Code

function AIJob:getStartTaskIndex()
    return 1
end

getTaskByIndex

Description

Definition

getTaskByIndex()

Arguments

any	taskIndex

Code

function AIJob:getTaskByIndex(taskIndex)
    return self.tasks[taskIndex]
end

getTitle

Description

Definition

getTitle()

Code

function AIJob:getTitle()
    local helper = g_helperManager:getHelperByIndex( self.helperIndex)
    return helper.title
end

loadFromXMLFile

Description

Definition

loadFromXMLFile()

Arguments

any	xmlFile
any	key

Code

function AIJob:loadFromXMLFile(xmlFile, key)
    xmlFile:iterate(key .. ".parameter" , function (_, paramKey)
        local name = xmlFile:getString(paramKey .. "#name" )
        if name ~ = nil then
            local parameter = self:getNamedParameter(name)
            if parameter ~ = nil and parameter.loadFromXMLFile ~ = nil then
                parameter:loadFromXMLFile(xmlFile, paramKey)
            end
        end
    end )
end

new

Description

Definition

new()

Arguments

any	isServer
any	customMt

Code

function AIJob.new(isServer, customMt)
    local self = setmetatable( { } , customMt or AIJob _mt)

    self.isServer = isServer
    self.tasks = { }
    self.namedParameters = { }
    self.groupedParameters = { }
    self.currentTaskIndex = 0
    self.jobId = nil
    self.startedFarmId = nil
    self.isDirectStart = false

    self.pendingCost = 0

    return self
end

onParameterValueChanged

Description

Definition

onParameterValueChanged()

Arguments

any	parameter

Code

function AIJob:onParameterValueChanged(parameter)
end

readStream

Description

Definition

readStream()

Arguments

any	streamId
any	connection

Code

function AIJob:readStream(streamId, connection)
    self.isDirectStart = streamReadBool(streamId)

    if streamReadBool(streamId) then
        self.jobId = streamReadInt32(streamId)
    end

    for _, namedParameter in ipairs( self.namedParameters) do
        namedParameter.parameter:readStream(streamId, connection)
    end

    self:setValues()

    self.currentTaskIndex = streamReadUInt8(streamId)
end

resetTasks

Description

Definition

resetTasks()

Code

function AIJob:resetTasks()
    for _, task in ipairs( self.tasks) do
        task:reset()
    end
end

saveToXMLFile

Description

Definition

saveToXMLFile()

Arguments

any	xmlFile
any	key
any	usedModNames

Code

function AIJob:saveToXMLFile(xmlFile, key, usedModNames)
    local index = 0
    for _, namedParameter in ipairs( self.namedParameters) do
        local parameter = namedParameter.parameter
        if parameter.saveToXMLFile ~ = nil then
            local paramKey = string.format( "%s.parameter(%d)" , key, index)
            xmlFile:setString(paramKey .. "#name" , namedParameter.name)
            namedParameter.parameter:saveToXMLFile(xmlFile, paramKey, usedModNames)
            index = index + 1
        end
    end

    return true
end

setId

Description

Definition

setId()

Arguments

any	id

Code

function AIJob:setId(id)
    self.jobId = id
end

setParameterValid

Description

Definition

setParameterValid()

Arguments

any	isValid

Code

function AIJob:setParameterValid(isValid)
    for _, namedParameter in ipairs( self.namedParameters) do
        namedParameter.parameter:setIsValid(isValid)
    end
end

setValues

Description

Definition

setValues()

Code

function AIJob:setValues()
end

showNotification

Description

Definition

showNotification()

Arguments

any	aiMessage

Code

function AIJob:showNotification(aiMessage)
    local helper = g_helperManager:getHelperByIndex( self.helperIndex)

    -- helper can be nil on game quit
    if helper ~ = nil then
        local playerFarmId
        if g_currentMission ~ = nil and g_localPlayer ~ = nil then
            playerFarmId = g_localPlayer.farmId
        end

        if aiMessage ~ = nil and self.startedFarmId = = playerFarmId then
            local text = aiMessage:getMessage( self )
            local errorType = aiMessage:getType()
            local notificationType = FSBaseMission.INGAME_NOTIFICATION_CRITICAL

            if errorType = = AIMessageType.OK then
                notificationType = FSBaseMission.INGAME_NOTIFICATION_OK
            elseif errorType = = AIMessageType.INFO then
                    notificationType = FSBaseMission.INGAME_NOTIFICATION_INFO
                end

                g_currentMission:addIngameNotification(notificationType, text)
            end
        end
    end

skipCurrentTask

Description

Definition

skipCurrentTask()

Code

function AIJob:skipCurrentTask()
end

start

Description

Definition

start()

Arguments

any	farmId

Code

function AIJob:start(farmId)
    local helper = g_helperManager:getRandomHelper()
    self.helperIndex = helper.index
    self.startedFarmId = farmId
    self.isRunning = true

    if self.isServer then
        self.currentTaskIndex = 0
    end
end

startTask

Description

Definition

startTask()

Arguments

any	task

Code

function AIJob:startTask(task)
    self.currentTaskIndex = task.taskIndex
    task:start()

    if self.isServer then
        g_server:broadcastEvent( AITaskStartEvent.new( self , task))
    end
end

stop

Description

Definition

stop()

Arguments

any	aiMessage

Code

function AIJob:stop(aiMessage)
    self.isRunning = false

    if self.isServer and self.currentTaskIndex ~ = 0 then
        -- client will be notified in stopTask function
            local task = self:getTaskByIndex( self.currentTaskIndex)
            self:stopTask(task, true )
        end

        if self.pendingCost > 0 then
            g_currentMission:addMoney( - self.pendingCost, self.startedFarmId, MoneyType.AI, true )
            self.pendingCost = 0
        end

        self:showNotification(aiMessage)

        self:resetTasks()
    end

stopTask

Description

Definition

stopTask()

Arguments

any	task
any	wasJobStopped

Code

function AIJob:stopTask(task, wasJobStopped)
    task:stop(wasJobStopped)

    if self.isServer then
        g_server:broadcastEvent( AITaskStopEvent.new( self , task, wasJobStopped))
    end
end

update

Description

Definition

update()

Arguments

any	dt

Code

function AIJob:update(dt)
    -- task update and handling is done on server side only
    if self.isServer then
        local currentTask
        if self.currentTaskIndex = = 0 then
            local canStart, aiMessage = self:canStartWork()
            if canStart then
                local taskIndex = self:getStartTaskIndex()
                local task = self:getTaskByIndex(taskIndex)
                self:startTask(task)
            else
                    g_currentMission.aiSystem:stopJob( self , aiMessage)
                    return
                end
            else
                    currentTask = self:getTaskByIndex( self.currentTaskIndex)
                end

                if currentTask ~ = nil then
                    currentTask:update(dt)

                    if currentTask:getIsFinished() then
                        local canContinue, aiMessage = self:canContinueWork()
                        if not canContinue then
                            g_currentMission.aiSystem:stopJob( self , aiMessage)
                            return
                        end

                        local newTaskIndex = self:getNextTaskIndex()

                        if newTaskIndex > # self.tasks then
                            if self:getIsLooping() then
                                newTaskIndex = 1
                            else
                                    g_currentMission.aiSystem:stopJob( self , AIMessageSuccessFinishedJob.new())
                                    return
                                end
                            end

                            self:stopTask(currentTask, false )

                            local nextTask = self:getTaskByIndex(newTaskIndex)
                            self:startTask(nextTask)
                        end
                    end
                end
            end

updateCost

Description

Definition

updateCost()

Arguments

any	dt

Code

function AIJob:updateCost(dt)
    local price = self:getPricePerMs()
    if price > 0 then
        price = price * dt * EconomyManager.getCostMultiplier()

        self.pendingCost = self.pendingCost + price

        local farm = g_farmManager:getFarmById( self.startedFarmId)
        if farm ~ = nil then
            if farm:getBalance() - self.pendingCost < 0 then
                g_currentMission.aiSystem:stopJob( self , AIMessageErrorOutOfMoney.new())
            end
        end

        if self.pendingCost > 25 then
            g_currentMission:addMoney( - self.pendingCost, self.startedFarmId, MoneyType.AI, true )
            self.pendingCost = 0
        end
    end
end

validate

Description

Definition

validate()

Arguments

any	farmId

Code

function AIJob:validate(farmId)
    return true , nil
end

writeStream

Description

Definition

writeStream()

Arguments

any	streamId
any	connection

Code

function AIJob:writeStream(streamId, connection)
    streamWriteBool(streamId, self.isDirectStart)

    if streamWriteBool(streamId, self.jobId ~ = nil ) then
        streamWriteInt32(streamId, self.jobId)
    end

    for _, namedParameter in ipairs( self.namedParameters) do
        namedParameter.parameter:writeStream(streamId, connection)
    end

    streamWriteUInt8(streamId, self.currentTaskIndex)
end

AIJob​

addNamedParameter​

addTask​

applyCurrentState​

canContinueWork​

canStartWork​

delete​

getCanSkipTask​

getDescription​

getGroupedParameters​

getHelperName​

getIsAvailableForVehicle​

getIsLooping​

getIsStartable​

getNamedParameter​

getNamedParameters​

getNextTaskIndex​

getPricePerMs​

getStartTaskIndex​

getTaskByIndex​

getTitle​

loadFromXMLFile​

new​

onParameterValueChanged​

readStream​

resetTasks​

saveToXMLFile​

setId​

setParameterValid​

setValues​

showNotification​

skipCurrentTask​

start​

startTask​

stop​

stopTask​

update​

updateCost​

validate​

writeStream​

AIJob

addNamedParameter

addTask

applyCurrentState

canContinueWork

canStartWork

delete

getCanSkipTask

getDescription

getGroupedParameters

getHelperName

getIsAvailableForVehicle

getIsLooping

getIsStartable

getNamedParameter

getNamedParameters

getNextTaskIndex

getPricePerMs

getStartTaskIndex

getTaskByIndex

getTitle

loadFromXMLFile

new

onParameterValueChanged

readStream

resetTasks

saveToXMLFile

setId

setParameterValid

setValues

showNotification

skipCurrentTask

start

startTask

stop

stopTask

update

updateCost

validate

writeStream