AIParameterVehicle

AIParameterVehicle

Parent

AIParameter

Functions

• getCanBeChanged
• getString
• getVehicle
• new
• readStream
• saveToXMLFile
• setVehicle
• validate
• writeStream

getCanBeChanged

Description

Definition

getCanBeChanged()

Code

function AIParameterVehicle:getCanBeChanged()
    return false
end

getString

Description

Definition

getString()

Code

function AIParameterVehicle:getString()
    local vehicle = NetworkUtil.getObject( self.vehicleId)
    if vehicle ~ = nil then
        return vehicle:getName()
    end

    return ""
end

getVehicle

Description

Definition

getVehicle()

Code

function AIParameterVehicle:getVehicle()
    local vehicle = NetworkUtil.getObject( self.vehicleId)
    if vehicle ~ = nil and vehicle:getIsSynchronized() then
        return vehicle
    end

    return nil
end

new

Description

Definition

new()

Arguments

any	customMt

Code

function AIParameterVehicle.new(customMt)
    local self = AIParameter.new(customMt or AIParameterVehicle _mt)

    self.type = AIParameterType.TEXT
    self.vehicleId = nil

    return self
end

readStream

Description

Definition

readStream()

Arguments

any	streamId
any	connection

Code

function AIParameterVehicle:readStream(streamId, connection)
    if streamReadBool(streamId) then
        self.vehicleId = NetworkUtil.readNodeObjectId(streamId)
    end
end

saveToXMLFile

Description

Definition

saveToXMLFile()

Arguments

any	xmlFile
any	key
any	usedModNames

Code

function AIParameterVehicle:saveToXMLFile(xmlFile, key, usedModNames)
    local vehicle = self:getVehicle()
    if vehicle ~ = nil then
        xmlFile:setString(key .. "#vehicleUniqueId" , vehicle:getUniqueId())
    end
end

setVehicle

Description

Definition

setVehicle()

Arguments

any	vehicle

Code

function AIParameterVehicle:setVehicle(vehicle)
    self.vehicleId = NetworkUtil.getObjectId(vehicle)
end

validate

Description

Definition

validate()

Arguments

any	needsAITarget

Code

function AIParameterVehicle:validate(needsAITarget)
    if self.vehicleId = = nil then
        return false , g_i18n:getText( "ai_validationErrorNoVehicle" )
    end

    local vehicle = self:getVehicle()
    if vehicle = = nil then
        return false , g_i18n:getText( "ai_validationErrorVehicleDoesNotExistAnymore" )
    elseif vehicle.setAITarget = = nil and(needsAITarget = = nil or needsAITarget = = true ) then
            return false , g_i18n:getText( "ai_validationErrorVehicleDoesNotSupportAI" )
        end

        return true , nil
    end

writeStream

Description

Definition

writeStream()

Arguments

any	streamId
any	connection

Code

function AIParameterVehicle:writeStream(streamId, connection)
    if streamWriteBool(streamId, self.vehicleId ~ = nil ) then
        NetworkUtil.writeNodeObjectId(streamId, self.vehicleId)
    end
end