ProtectedBundleVehicle

ProtectedBundleVehicle

Description

Specialization for bundle vehicles that cannot be detached from each other and need to act as one vehicle while selling, reset, mapOverview, selection

Functions

• getReloadXML
• initSpecialization
• onLoad
• onPostDetach
• prerequisitesPresent
• registerEventListeners
• registerOverwrittenFunctions

getReloadXML

Description

Get reload xml

Definition

getReloadXML()

Arguments

any	superFunc

Return Values

any	xml	xml

Code

function ProtectedBundleVehicle:getReloadXML(superFunc)
    local spec = self.spec_protectedBundleVehicle
    if spec.isBundleRoot and spec.bundleFilename ~ = nil then
        local vehicleXMLFile = superFunc( self )
        if vehicleXMLFile ~ = nil then
            vehicleXMLFile:setValue( "vehicles.vehicle(0)#filename" , HTMLUtil.encodeToHTML(NetworkUtil.convertToNetworkFilename(spec.bundleFilename)))
        end
        return vehicleXMLFile
    end

    return superFunc( self )
end

initSpecialization

Description

Definition

initSpecialization()

Code

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

    schema:register(XMLValueType.BOOL, "vehicle.protectedBundleVehicle#isBundleRoot" , "Vehicle acts are bundle root vehicle(the only vehicle to be selectable, shown in overview, sellable, resetable)" , false )
    schema:register(XMLValueType.BOOL, "vehicle.protectedBundleVehicle#isBundleChild" , "Vehicle acts as bundle child vehicle(can not be selected, not shown in map overview, reset and sold with attacher vehicle)" , false )
    schema:register(XMLValueType.STRING, "vehicle.protectedBundleVehicle#bundleFilename" , "Path to bundle xml file(required for reset of the vehicle to spawn the bundle instead of the single vehicle)" )

        schema:setXMLSpecializationType()
    end

onLoad

Description

Called on loading

Definition

onLoad(table savegame)

Arguments

table	savegame	savegame

Code

function ProtectedBundleVehicle:onLoad(savegame)
    local spec = self.spec_protectedBundleVehicle

    spec.isBundleRoot = self.xmlFile:getValue( "vehicle.protectedBundleVehicle#isBundleRoot" , false )
    spec.isBundleChild = self.xmlFile:getValue( "vehicle.protectedBundleVehicle#isBundleChild" , false )
    spec.bundleFilename = Utils.getFilename( self.xmlFile:getValue( "vehicle.protectedBundleVehicle#bundleFilename" ), self.baseDirectory)
    if spec.bundleFilename ~ = nil then
        if g_storeManager:getItemByXMLFilename(spec.bundleFilename) = = nil then
            Logging.xmlWarning( self.xmlFile, "Missing bundle vehicle store item for '%s'" , spec.bundleFilename)
            end
        end

        if spec.isBundleChild then
            self.canBeReset = false
            self.showInVehicleOverview = false
            self.allowSelection = false
        end

        if not self.isServer or not spec.isBundleChild then
            SpecializationUtil.removeEventListener( self , "onPostDetach" , ProtectedBundleVehicle )
        end
    end

onPostDetach

Description

Definition

onPostDetach()

Code

function ProtectedBundleVehicle:onPostDetach()
    if not g_currentMission.vehicleSystem.isReloadRunning and not g_currentMission.isTeleporting and not self.isDeleted and not self.isDeleting then
        self:delete()
    end
end

prerequisitesPresent

Description

Checks if all prerequisite specializations are loaded

Definition

prerequisitesPresent(table specializations)

Arguments

table	specializations	specializations

Return Values

table	hasPrerequisite	true if all prerequisite specializations are loaded

Code

function ProtectedBundleVehicle.prerequisitesPresent(specializations)
    return true
end

registerEventListeners

Description

Definition

registerEventListeners()

Arguments

any	vehicleType

Code

function ProtectedBundleVehicle.registerEventListeners(vehicleType)
    SpecializationUtil.registerEventListener(vehicleType, "onLoad" , ProtectedBundleVehicle )
    SpecializationUtil.registerEventListener(vehicleType, "onPostDetach" , ProtectedBundleVehicle )
end

registerOverwrittenFunctions

Description

Definition

registerOverwrittenFunctions()

Arguments

any	vehicleType

Code

function ProtectedBundleVehicle.registerOverwrittenFunctions(vehicleType)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getReloadXML" , ProtectedBundleVehicle.getReloadXML)
end