CylinderedFoldable

CylinderedFoldable

Description

Specialization to repeat the loading of cylindered states after the folding state was loaded, in case the animation overlaps with the moving tools

Functions

• initSpecialization
• onLoad
• onPreInitComponentPlacement
• onReadStream
• onWriteStream
• prerequisitesPresent
• registerEventListeners

initSpecialization

Description

Definition

initSpecialization()

Code

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

    schema:register(XMLValueType.BOOL, "vehicle.cylindered#loadMovingToolStatesAfterFolding" , "Load moving tool states after folding state was loaded" , false )
    schema:register(XMLValueType.FLOAT, "vehicle.cylindered#loadMovingToolStatesFoldTime" , "Fold time in which moving tool states should be loaded" )

    schema:setXMLSpecializationType()
end

onLoad

Description

Called on loading

Definition

onLoad(table savegame)

Arguments

table	savegame	savegame

Code

function CylinderedFoldable:onLoad(savegame)
    local spec = self.spec_cylinderedFoldable

    spec.loadMovingToolStatesAfterFolding = self.xmlFile:getValue( "vehicle.cylindered#loadMovingToolStatesAfterFolding" , false )
    spec.loadMovingToolStatesFoldTime = self.xmlFile:getValue( "vehicle.cylindered#loadMovingToolStatesFoldTime" )
end

onPreInitComponentPlacement

Description

Definition

onPreInitComponentPlacement()

Arguments

any	savegame

Code

function CylinderedFoldable:onPreInitComponentPlacement(savegame)
    local spec = self.spec_cylinderedFoldable
    if spec.loadMovingToolStatesAfterFolding then
        local targetFoldTime = spec.loadMovingToolStatesFoldTime
        if targetFoldTime = = nil or self:getFoldAnimTime() = = targetFoldTime then
            Cylindered.onPostLoad( self , savegame)
        end
    end
end

onReadStream

Description

Definition

onReadStream()

Arguments

any	streamId
any	connection

Code

function CylinderedFoldable:onReadStream(streamId, connection)
    -- update folding animation so it's finished and won't destroy the cylindered states in the first frame
    AnimatedVehicle.updateAnimations( self , 9999999 )

    -- rerun the sync of cylindered since it was overwritten by foldable
    if streamReadBool(streamId) then
        Cylindered.onReadStream( self , streamId, connection)
    end

    -- update dependent animations initial
    if connection:getIsServer() then
        for i = 1 , # self.spec_cylindered.movingTools do
            local tool = self.spec_cylindered.movingTools[i]
            if tool.dirtyFlag ~ = nil then
                self:updateDependentAnimations(tool, 9999 )
            end
        end
    end
end

onWriteStream

Description

Definition

onWriteStream()

Arguments

any	streamId
any	connection

Code

function CylinderedFoldable:onWriteStream(streamId, connection)
    local spec = self.spec_cylinderedFoldable

    if streamWriteBool(streamId, spec.loadMovingToolStatesFoldTime = = nil or self:getFoldAnimTime() = = spec.loadMovingToolStatesFoldTime) then
        Cylindered.onWriteStream( self , streamId, connection)
    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 CylinderedFoldable.prerequisitesPresent(specializations)
    return SpecializationUtil.hasSpecialization( Cylindered , specializations) and SpecializationUtil.hasSpecialization( Foldable , specializations)
end

registerEventListeners

Description

Definition

registerEventListeners()

Arguments

any	vehicleType

Code

function CylinderedFoldable.registerEventListeners(vehicleType)
    SpecializationUtil.registerEventListener(vehicleType, "onLoad" , CylinderedFoldable )
    SpecializationUtil.registerEventListener(vehicleType, "onPreInitComponentPlacement" , CylinderedFoldable )
    SpecializationUtil.registerEventListener(vehicleType, "onReadStream" , CylinderedFoldable )
    SpecializationUtil.registerEventListener(vehicleType, "onWriteStream" , CylinderedFoldable )
end