Skip to main content

LicensePlates

LicensePlates​

Description

Specialization for placing license plates to vehicles

Functions

getHasLicensePlates​

Description

Returns if vehicle has license plates

Definition

getHasLicensePlates()

Return Values

anyhasLicensePlateshas license plates

Code

function LicensePlates:getHasLicensePlates()
    return # self.spec_licensePlates.licensePlates > 0
end

getLicensePlateDialogSettings​

Description

Returns license plate settings for dialog

Definition

getLicensePlateDialogSettings()

Return Values

anydefaultPlacementIndexdefault placement
anyhasFrontPlatehas front license plate

Code

function LicensePlates:getLicensePlateDialogSettings()
    local spec = self.spec_licensePlates
    local hasFrontPlate = false
    for i = 1 , #spec.licensePlates do
        local licensePlate = spec.licensePlates[i]
        if licensePlate.position = = LicensePlateManager.PLATE_POSITION.FRONT then
            hasFrontPlate = true
            break
        end
    end

    return spec.defaultPlacementIndex, hasFrontPlate
end

getLicensePlatesData​

Description

Definition

getLicensePlatesData()

Code

function LicensePlates:getLicensePlatesData()
    return self.spec_licensePlates.licensePlateData
end

getLicensePlatesDataIsEqual​

Description

Definition

getLicensePlatesDataIsEqual()

Arguments

anydata

Code

function LicensePlates:getLicensePlatesDataIsEqual(data)
    if data = = nil or self.spec_licensePlates.licensePlateData = = nil then
        return true
    end

    local ownData = self.spec_licensePlates.licensePlateData

    if data.variation ~ = ownData.variation or data.colorIndex ~ = ownData.colorIndex or data.placementIndex ~ = ownData.placementIndex then
        return false
    end

    if data.characters ~ = nil and ownData.characters ~ = nil then
        if #data.characters ~ = #ownData.characters then
            return false
        end

        for i = 1 , #data.characters do
            if data.characters[i] ~ = ownData.characters[i] then
                return false
            end
        end
    end

    return true
end

getSpecValuePlateText​

Description

Definition

getSpecValuePlateText()

Arguments

anystoreItem
anyrealItem

Code

function LicensePlates.getSpecValuePlateText(storeItem, realItem)
    if realItem = = nil then
        return nil
    end

    if realItem.getHasLicensePlates = = nil or not realItem:getHasLicensePlates() then
        return nil
    end

    local spec = realItem.spec_licensePlates
    for i = 1 , #spec.licensePlates do
        local licensePlate = spec.licensePlates[i]
        if licensePlate.position = = LicensePlateManager.PLATE_POSITION.BACK or i = = #spec.licensePlates then
            return licensePlate.data:getFormattedString()
        end
    end

    return nil
end

initSpecialization​

Description

Definition

initSpecialization()

Code

function LicensePlates.initSpecialization()
    g_storeManager:addSpecType( "licensePlate" , "shopListAttributeIconLicensePlate" , LicensePlates.loadSpecValuePlateText, LicensePlates.getSpecValuePlateText, StoreSpecies.VEHICLE)

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

    schema:register(XMLValueType.STRING, "vehicle.licensePlates#defaultPlacement" , "Defines the default placement index independent of map setting(NONE|BOTH|BACK_ONLY)" , false )
    schema:register(XMLValueType.NODE_INDEX, "vehicle.licensePlates.licensePlate(?)#node" , "License plate node" )
    schema:register(XMLValueType.STRING, "vehicle.licensePlates.licensePlate(?)#preferedType" , "Prefered license plate type to be placed if available" )
        schema:register(XMLValueType.STRING, "vehicle.licensePlates.licensePlate(?)#placementArea" , "Defines the available area around the node(top, right, bottom, left) ('-' means unlimited)" )
        schema:register(XMLValueType.STRING, "vehicle.licensePlates.licensePlate(?)#position" , "Position of license plate('FRONT' or 'BACK')" , "ANY" )
        schema:register(XMLValueType.BOOL, "vehicle.licensePlates.licensePlate(?)#frame" , "License plate with frame of without frame" , true )

        ObjectChangeUtil.registerObjectChangeXMLPaths(schema, "vehicle.licensePlates.licensePlate(?)" )

        schema:setXMLSpecializationType()

        local schemaSavegame = Vehicle.xmlSchemaSavegame
        schemaSavegame:register(XMLValueType.INT, "vehicles.vehicle(?).licensePlates#variation" , "License plate variation" , 1 )
        schemaSavegame:register(XMLValueType.STRING, "vehicles.vehicle(?).licensePlates#characters" , "Characters string" )
        schemaSavegame:register(XMLValueType.INT, "vehicles.vehicle(?).licensePlates#colorIndex" , "Selected color index" , 1 )
        schemaSavegame:register(XMLValueType.INT, "vehicles.vehicle(?).licensePlates#placementIndex" , "Selected placement index" , 1 )
    end

loadSpecValuePlateText​

Description

Definition

loadSpecValuePlateText()

Arguments

anyxmlFile
anycustomEnvironment
anybaseDir

Code

function LicensePlates.loadSpecValuePlateText(xmlFile, customEnvironment, baseDir)
    -- No data to load as this spec is only for existing items
        return nil
    end

onDelete​

Description

Definition

onDelete()

Arguments

anysavegame

Code

function LicensePlates:onDelete(savegame)
    local spec = self.spec_licensePlates

    spec.licensePlates = { }
end

onLoad​

Description

Called on loading

Definition

onLoad(table savegame)

Arguments

tablesavegamesavegame

Code

function LicensePlates:onLoad(savegame)
    local spec = self.spec_licensePlates

    spec.licensePlates = { }
    local defaultPlacementName = self.xmlFile:getValue( "vehicle.licensePlates#defaultPlacement" )
    if defaultPlacementName ~ = nil then
        spec.defaultPlacementIndex = LicensePlateManager.PLACEMENT_OPTION[ string.upper(defaultPlacementName)]
        if spec.defaultPlacementIndex = = nil then
            Logging.xmlWarning( self.xmlFile, "Unknown defaultPlacement '%s' in 'vehicle.licensePlates#defaultPlacement" , defaultPlacementName)
        end
    end

    if g_licensePlateManager:getAreLicensePlatesAvailable() then
        local i = 0
        while true do
            local plateKey = string.format( "vehicle.licensePlates.licensePlate(%d)" , i)
            if not self.xmlFile:hasProperty(plateKey) then
                break
            end

            local licensePlate = { }

            licensePlate.node = self.xmlFile:getValue(plateKey .. "#node" , nil , self.components, self.i3dMappings)
            if licensePlate.node ~ = nil then
                local preferedTypeStr = self.xmlFile:getValue(plateKey .. "#preferedType" , "ELONGATED" )
                licensePlate.preferedType = LicensePlateManager.PLATE_TYPE[preferedTypeStr]
                if licensePlate.preferedType ~ = nil then
                    licensePlate.placementArea = { 1 , 1 , 1 , 1 }
                    local placementAreaString = self.xmlFile:getString(plateKey .. "#placementArea" )
                    if placementAreaString ~ = nil then
                        local placementArea = string.split(placementAreaString, " " )
                        if #placementArea = = 4 then
                            for j = 1 , 4 do
                                if placementArea[j] ~ = "-" then
                                    local numberValue = tonumber(placementArea[j])
                                    if numberValue = = nil then
                                        Logging.xmlWarning( self.xmlFile, "Invalid 4-vector '%s' for '%s'. '%s' is not a number!" , placementAreaString, plateKey .. "#placementArea" , placementArea[j])
                                        else
                                                licensePlate.placementArea[j] = numberValue
                                            end
                                        end
                                    end
                                else
                                        Logging.xmlWarning( self.xmlFile, "Invalid 4-vector '%s' for '%s' " , placementAreaString, plateKey .. "#placementArea" )
                                        end
                                    end

                                    local positionStr = self.xmlFile:getValue(plateKey .. "#position" , "ANY" )
                                    licensePlate.position = LicensePlateManager.PLATE_POSITION[positionStr] or LicensePlateManager.PLATE_POSITION.ANY

                                    local includeFrame = self.xmlFile:getValue(plateKey .. "#frame" , true )

                                    licensePlate.data = g_licensePlateManager:getLicensePlate(licensePlate.preferedType, includeFrame)
                                    if licensePlate.data ~ = nil then
                                        link(licensePlate.node, licensePlate.data.node)
                                        setTranslation(licensePlate.data.node, 0 , 0 , 0 )
                                        setRotation(licensePlate.data.node, 0 , 0 , 0 )
                                        setVisibility(licensePlate.data.node, false )

                                        local widthPos = licensePlate.data.rawWidth * 0.5 + licensePlate.data.widthOffsetLeft
                                        local widthNeg = licensePlate.data.rawWidth * 0.5 + licensePlate.data.widthOffsetRight
                                        local heightPos = licensePlate.data.rawHeight * 0.5 + licensePlate.data.heightOffsetTop
                                        local heightNeg = licensePlate.data.rawHeight * 0.5 + licensePlate.data.heightOffsetBot

                                        local scaleFactorWidth = (licensePlate.placementArea[ 2 ] + licensePlate.placementArea[ 4 ]) / (widthPos + widthNeg)
                                        local scaleFactorHeight = (licensePlate.placementArea[ 1 ] + licensePlate.placementArea[ 3 ]) / (heightPos + heightNeg)
                                        local minFactor = math.clamp( math.min(scaleFactorWidth, scaleFactorHeight), 0 , 1 )
                                        if minFactor < 1 then
                                            setScale(licensePlate.data.node, minFactor, minFactor, minFactor)

                                            widthPos = widthPos * minFactor
                                            widthNeg = widthNeg * minFactor
                                            heightPos = heightPos * minFactor
                                            heightNeg = heightNeg * minFactor
                                        end

                                        local moveX, moveY = 0 , 0
                                        moveX = moveX - math.max(widthPos - licensePlate.placementArea[ 2 ], 0 )
                                        moveX = moveX + math.max(widthNeg - licensePlate.placementArea[ 4 ], 0 )
                                        moveY = moveY - math.max(heightPos - licensePlate.placementArea[ 1 ], 0 )
                                        moveY = moveY + math.max(heightNeg - licensePlate.placementArea[ 3 ], 0 )
                                        setTranslation(licensePlate.data.node, moveX, moveY, 0 )

                                        licensePlate.changeObjects = { }
                                        ObjectChangeUtil.loadObjectChangeFromXML( self.xmlFile, plateKey, licensePlate.changeObjects, self.components, self )

                                        table.insert(spec.licensePlates, licensePlate)
                                    end
                                else
                                        Logging.xmlError( self.xmlFile, "Unknown preferedType '%s' for license plate '%s'" , preferedTypeStr, plateKey)
                                        end
                                    end

                                    i = i + 1
                                end

                                if self:getHasLicensePlates() then
                                    spec.licensePlateData = { variation = 1 , characters = nil , colorIndex = nil }
                                end
                            else
                                    ObjectChangeUtil.updateObjectChanges( self.xmlFile, "vehicle.licensePlates.licensePlate" , - 1 , self.components, self )
                                end
                            end

onPostLoad​

Description

Definition

onPostLoad()

Arguments

anysavegame

Code

function LicensePlates:onPostLoad(savegame)
    local spec = self.spec_licensePlates

    -- disable all object changes by default - will be enabled again if plate data is available
        for i = 1 , #spec.licensePlates do
            ObjectChangeUtil.setObjectChanges(spec.licensePlates[i].changeObjects, false , self , self.setMovingToolDirty)
        end

        if savegame ~ = nil and self:getHasLicensePlates() then
            local variation = savegame.xmlFile:getValue(savegame.key .. ".licensePlates#variation" , 1 )
            local characters = savegame.xmlFile:getValue(savegame.key .. ".licensePlates#characters" )
            local colorIndex = savegame.xmlFile:getValue(savegame.key .. ".licensePlates#colorIndex" , 1 )
            local placementIndex = savegame.xmlFile:getValue(savegame.key .. ".licensePlates#placementIndex" , 1 )

            if variation ~ = nil and characters ~ = nil and colorIndex ~ = nil and placementIndex ~ = nil then
                local characterTbl = { }
                local characterLength = characters:len() -- TODO:not utf8 compatible
                for i = 1 , characterLength do
                    table.insert(characterTbl, characters:sub(i, i)) -- TODO:not utf8 compatible
                end

                spec.licensePlateData = { variation = variation, characters = characterTbl, colorIndex = colorIndex, placementIndex = placementIndex }
                self:setLicensePlatesData(spec.licensePlateData)
            end
        end
    end

onReadStream​

Description

Called on client side on join

Definition

onReadStream(integer streamId, Connection connection)

Arguments

integerstreamIdstreamId
Connectionconnectionconnection

Code

function LicensePlates:onReadStream(streamId, connection)
    local spec = self.spec_licensePlates
    spec.licensePlateData = LicensePlateManager.readLicensePlateData(streamId, connection)
    self:setLicensePlatesData(spec.licensePlateData)
end

onWriteStream​

Description

Called on server side on join

Definition

onWriteStream(integer streamId, Connection connection)

Arguments

integerstreamIdstreamId
Connectionconnectionconnection

Code

function LicensePlates:onWriteStream(streamId, connection)
    local spec = self.spec_licensePlates
    LicensePlateManager.writeLicensePlateData(streamId, connection, spec.licensePlateData)
end

prerequisitesPresent​

Description

Checks if all prerequisite specializations are loaded

Definition

prerequisitesPresent(table specializations)

Arguments

tablespecializationsspecializations

Return Values

tablehasPrerequisitetrue if all prerequisite specializations are loaded

Code

function LicensePlates.prerequisitesPresent(specializations)
    return true
end

registerEventListeners​

Description

Definition

registerEventListeners()

Arguments

anyvehicleType

Code

function LicensePlates.registerEventListeners(vehicleType)
    SpecializationUtil.registerEventListener(vehicleType, "onLoad" , LicensePlates )
    SpecializationUtil.registerEventListener(vehicleType, "onDelete" , LicensePlates )
    SpecializationUtil.registerEventListener(vehicleType, "onPostLoad" , LicensePlates )
    SpecializationUtil.registerEventListener(vehicleType, "onReadStream" , LicensePlates )
    SpecializationUtil.registerEventListener(vehicleType, "onWriteStream" , LicensePlates )
end

registerFunctions​

Description

Definition

registerFunctions()

Arguments

anyvehicleType

Code

function LicensePlates.registerFunctions(vehicleType)
    SpecializationUtil.registerFunction(vehicleType, "setLicensePlatesData" , LicensePlates.setLicensePlatesData)
    SpecializationUtil.registerFunction(vehicleType, "getLicensePlatesData" , LicensePlates.getLicensePlatesData)
    SpecializationUtil.registerFunction(vehicleType, "getLicensePlatesDataIsEqual" , LicensePlates.getLicensePlatesDataIsEqual)
    SpecializationUtil.registerFunction(vehicleType, "getHasLicensePlates" , LicensePlates.getHasLicensePlates)
    SpecializationUtil.registerFunction(vehicleType, "getLicensePlateDialogSettings" , LicensePlates.getLicensePlateDialogSettings)
end

saveToXMLFile​

Description

Definition

saveToXMLFile()

Arguments

anyxmlFile
anykey
anyusedModNames

Code

function LicensePlates:saveToXMLFile(xmlFile, key, usedModNames)
    local spec = self.spec_licensePlates

    if self:getHasLicensePlates() and spec.licensePlateData then
        if spec.licensePlateData.placementIndex ~ = LicensePlateManager.PLACEMENT_OPTION.NONE then
            if spec.licensePlateData.variation ~ = nil
                and spec.licensePlateData.characters ~ = nil
                and spec.licensePlateData.colorIndex ~ = nil then
                xmlFile:setValue(key .. "#variation" , spec.licensePlateData.variation)
                xmlFile:setValue(key .. "#characters" , table.concat(spec.licensePlateData.characters, "" ))
                xmlFile:setValue(key .. "#colorIndex" , spec.licensePlateData.colorIndex)
                xmlFile:setValue(key .. "#placementIndex" , spec.licensePlateData.placementIndex)
            end
        end
    end
end

setLicensePlatesData​

Description

Definition

setLicensePlatesData()

Arguments

anylicensePlateData

Code

function LicensePlates:setLicensePlatesData(licensePlateData)
    local spec = self.spec_licensePlates
    if licensePlateData ~ = nil and licensePlateData.variation ~ = nil and licensePlateData.characters ~ = nil and licensePlateData.colorIndex ~ = nil and licensePlateData.placementIndex ~ = nil then
        for i = 1 , #spec.licensePlates do
            local licensePlate = spec.licensePlates[i]

            local allowLicensePlate = true
            if licensePlateData.placementIndex = = LicensePlateManager.PLACEMENT_OPTION.NONE then
                allowLicensePlate = false
            elseif licensePlateData.placementIndex = = LicensePlateManager.PLACEMENT_OPTION.BACK_ONLY then
                    if licensePlate.position = = LicensePlateManager.PLATE_POSITION.FRONT then
                        allowLicensePlate = false
                    end
                end

                if allowLicensePlate then
                    licensePlate.data:updateData(licensePlateData.variation, licensePlate.position, table.concat(licensePlateData.characters, "" ), true )
                    licensePlate.data:setColorIndex(licensePlateData.colorIndex)

                    setVisibility(licensePlate.data.node, true )
                else
                        setVisibility(licensePlate.data.node, false )
                    end

                    ObjectChangeUtil.setObjectChanges(licensePlate.changeObjects, allowLicensePlate, self , self.setMovingToolDirty)
                end

                spec.licensePlateData = licensePlateData
            else
                    for i = 1 , #spec.licensePlates do
                        setVisibility(spec.licensePlates[i].data.node, false )
                    end
                end
            end