PlaceableProductionPoint

PlaceableProductionPoint

Description

Specialization for placeables

Functions

• canBuy
• collectPickObjects
• initSpecialization
• loadFromXMLFile
• onBuy
• onDelete
• onFinalizePlacement
• onLoad
• onReadStream
• onWriteStream
• outputsChanged
• prerequisitesPresent
• productionStatusChanged
• registerEventListeners
• registerEvents
• registerFunctions
• registerOverwrittenFunctions
• registerSavegameXMLPaths
• registerXMLPaths
• saveToXMLFile
• setOwnerFarmId
• updateInfo

canBuy

Description

Definition

canBuy()

Arguments

any	superFunc

Code

function PlaceableProductionPoint:canBuy(superFunc)
    if not g_currentMission.productionChainManager:getHasFreeSlots() then
        return false , g_i18n:getText( "warning_maxNumOfProdPointsReached" )
    end

    return superFunc( self )
end

collectPickObjects

Description

Definition

collectPickObjects()

Arguments

any	superFunc
any	node

Code

function PlaceableProductionPoint:collectPickObjects(superFunc, node)
    local spec = self.spec_productionPoint
    if spec.productionPoint.loadingStation ~ = nil then
        for i = 1 , #spec.productionPoint.loadingStation.loadTriggers do
            local loadTrigger = spec.productionPoint.loadingStation.loadTriggers[i]
            if node = = loadTrigger.triggerNode then
                return
            end
        end
    end

    for i = 1 , #spec.productionPoint.unloadingStation.unloadTriggers do
        local unloadTrigger = spec.productionPoint.unloadingStation.unloadTriggers[i]
        if node = = unloadTrigger.exactFillRootNode then
            return
        end
    end

    superFunc( self , node)
end

initSpecialization

Description

Definition

initSpecialization()

Code

function PlaceableProductionPoint.initSpecialization()
    g_storeManager:addSpecType( "prodPointInputFillTypes" , "shopListAttributeIconInput" , ProductionPoint.loadSpecValueInputFillTypes, ProductionPoint.getSpecValueInputFillTypes, StoreSpecies.PLACEABLE)
    g_storeManager:addSpecType( "prodPointOutputFillTypes" , "shopListAttributeIconOutput" , ProductionPoint.loadSpecValueOutputFillTypes, ProductionPoint.getSpecValueOutputFillTypes, StoreSpecies.PLACEABLE)
    g_placeableConfigurationManager:addConfigurationType( "productionPoint" , g_i18n:getText( "configuration_productionPoint" ), "productionPoint" , PlaceableConfigurationItem )
end

loadFromXMLFile

Description

Definition

loadFromXMLFile()

Arguments

any	xmlFile
any	key

Code

function PlaceableProductionPoint:loadFromXMLFile(xmlFile, key)
    local spec = self.spec_productionPoint
    if spec.productionPoint ~ = nil then
        spec.productionPoint:loadFromXMLFile(xmlFile, key)
    end
end

onBuy

Description

Definition

onBuy()

Code

function PlaceableProductionPoint:onBuy()
    local serverFarmId = g_currentMission:getFarmId()
    local numProductionPoints = 0
    for _, existingPlaceable in ipairs(g_currentMission.placeableSystem.placeables) do
        if existingPlaceable:getOwnerFarmId() = = serverFarmId then
            if existingPlaceable.spec_productionPoint ~ = nil then
                numProductionPoints = numProductionPoints + 1
            end
        end
    end
    g_achievementManager:tryUnlock( "NumProductionPoints" , numProductionPoints)
end

onDelete

Description

Definition

onDelete()

Code

function PlaceableProductionPoint:onDelete()
    local spec = self.spec_productionPoint

    if spec.productionPoint ~ = nil then
        spec.productionPoint:delete()
        spec.productionPoint = nil
    end
end

onFinalizePlacement

Description

Definition

onFinalizePlacement()

Code

function PlaceableProductionPoint:onFinalizePlacement()
    local spec = self.spec_productionPoint

    if spec.productionPoint ~ = nil then
        if self.getHasBuyingTrigger ~ = nil and self:getHasBuyingTrigger() then
            spec.productionPoint.useInteractionTriggerForBuying = false
        end

        spec.productionPoint:register( true )

        local owner = self:getOwnerFarmId()
        if not spec.isFinalized then
            owner = AccessHandler.EVERYONE
        end
        spec.productionPoint:setOwnerFarmId(owner)

        --if not g_currentMission.productionChainManager:addProductionPoint(self.productionPoint) then
            -- printError("PPP:Error:Unable to add production point to manager")
            -- return false
            --end

            spec.productionPoint:findStorageExtensions()

            spec.productionPoint:updateFxState()
        end
    end

onLoad

Description

Called on loading

Definition

onLoad(table savegame)

Arguments

table	savegame	savegame

Code

function PlaceableProductionPoint:onLoad(savegame)
    local spec = self.spec_productionPoint

    local productionPointConfigurationId = Utils.getNoNil( self.configurations[ "productionPoint" ], 1 )
    local configKey = string.format( "placeable.productionPoint.productionPointConfigurations.productionPointConfiguration(%d).productionPoint" , productionPointConfigurationId - 1 )
    if not self.xmlFile:hasProperty(configKey) then
        configKey = "placeable.productionPoint"
    end

    local productionPoint = ProductionPoint.new( self.isServer, self.isClient, self.baseDirectory)
    productionPoint.owningPlaceable = self
    if productionPoint:load( self.components, self.xmlFile, configKey, self.customEnvironment, self.i3dMappings) then
        spec.productionPoint = productionPoint
        spec.isFinalized = self.xmlFile:getBool(configKey .. "#isFinalized" , true )

        if not spec.isFinalized then
            productionPoint.isFinalized = false
            productionPoint.unloadingStation.hideFromPricesMenu = true
            spec.unloadingStationDefaultAllowMissions = productionPoint.unloadingStation.allowMissions
            productionPoint.unloadingStation.allowMissions = false
        end
    else
            productionPoint:delete()
            self:setLoadingState(PlaceableLoadingState.ERROR)
        end
    end

onReadStream

Description

Definition

onReadStream()

Arguments

any	streamId
any	connection

Code

function PlaceableProductionPoint:onReadStream(streamId, connection)
    local spec = self.spec_productionPoint
    if spec.productionPoint ~ = nil then
        local productionPointId = NetworkUtil.readNodeObjectId(streamId)
        spec.productionPoint:readStream(streamId, connection)
        g_client:finishRegisterObject(spec.productionPoint, productionPointId)
    end
end

onWriteStream

Description

Definition

onWriteStream()

Arguments

any	streamId
any	connection

Code

function PlaceableProductionPoint:onWriteStream(streamId, connection)
    local spec = self.spec_productionPoint
    if spec.productionPoint ~ = nil then
        NetworkUtil.writeNodeObjectId(streamId, NetworkUtil.getObjectId(spec.productionPoint))
        spec.productionPoint:writeStream(streamId, connection)
        g_server:registerObjectInStream(connection, spec.productionPoint)
    end
end

outputsChanged

Description

Definition

outputsChanged()

Arguments

any	outputs
any	state

Code

function PlaceableProductionPoint:outputsChanged(outputs, state)
    SpecializationUtil.raiseEvent( self , "onOutputFillTypesChanged" , outputs, state)
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 PlaceableProductionPoint.prerequisitesPresent(specializations)
    return SpecializationUtil.hasSpecialization( PlaceableInfoTrigger , specializations)
end

productionStatusChanged

Description

Definition

productionStatusChanged()

Arguments

any	production
any	status

Code

function PlaceableProductionPoint:productionStatusChanged(production, status )
    SpecializationUtil.raiseEvent( self , "onProductionStatusChanged" , production, status )
end

registerEventListeners

Description

Definition

registerEventListeners()

Arguments

any	placeableType

Code

function PlaceableProductionPoint.registerEventListeners(placeableType)
    SpecializationUtil.registerEventListener(placeableType, "onLoad" , PlaceableProductionPoint )
    SpecializationUtil.registerEventListener(placeableType, "onDelete" , PlaceableProductionPoint )
    SpecializationUtil.registerEventListener(placeableType, "onFinalizePlacement" , PlaceableProductionPoint )
    SpecializationUtil.registerEventListener(placeableType, "onWriteStream" , PlaceableProductionPoint )
    SpecializationUtil.registerEventListener(placeableType, "onReadStream" , PlaceableProductionPoint )
    SpecializationUtil.registerEventListener(placeableType, "onBuy" , PlaceableProductionPoint )
end

registerEvents

Description

Definition

registerEvents()

Arguments

any	placeableType

Code

function PlaceableProductionPoint.registerEvents(placeableType)
    SpecializationUtil.registerEvent(placeableType, "onOutputFillTypesChanged" )
    SpecializationUtil.registerEvent(placeableType, "onProductionStatusChanged" )
end

registerFunctions

Description

Definition

registerFunctions()

Arguments

any	placeableType

Code

function PlaceableProductionPoint.registerFunctions(placeableType)
    SpecializationUtil.registerFunction(placeableType, "outputsChanged" , PlaceableProductionPoint.outputsChanged)
    SpecializationUtil.registerFunction(placeableType, "productionStatusChanged" , PlaceableProductionPoint.productionStatusChanged)
end

registerOverwrittenFunctions

Description

Definition

registerOverwrittenFunctions()

Arguments

any	placeableType

Code

function PlaceableProductionPoint.registerOverwrittenFunctions(placeableType)
    SpecializationUtil.registerOverwrittenFunction(placeableType, "setOwnerFarmId" , PlaceableProductionPoint.setOwnerFarmId)
    SpecializationUtil.registerOverwrittenFunction(placeableType, "collectPickObjects" , PlaceableProductionPoint.collectPickObjects)
    SpecializationUtil.registerOverwrittenFunction(placeableType, "canBuy" , PlaceableProductionPoint.canBuy)
    SpecializationUtil.registerOverwrittenFunction(placeableType, "updateInfo" , PlaceableProductionPoint.updateInfo)
    SpecializationUtil.registerOverwrittenFunction(placeableType, "finalizeConstruction" , PlaceableProductionPoint.finalizeConstruction)
end

registerSavegameXMLPaths

Description

Definition

registerSavegameXMLPaths()

Arguments

any	schema
any	basePath

Code

function PlaceableProductionPoint.registerSavegameXMLPaths(schema, basePath)
    schema:setXMLSpecializationType( "ProductionPoint" )
    ProductionPoint.registerSavegameXMLPaths(schema, basePath)
    schema:setXMLSpecializationType()
end

registerXMLPaths

Description

Definition

registerXMLPaths()

Arguments

any	schema
any	basePath

Code

function PlaceableProductionPoint.registerXMLPaths(schema, basePath)
    schema:setXMLSpecializationType( "ProductionPoint" )

    local function registerPlaceableSchema(schema, basePath)
        schema:register(XMLValueType.BOOL, basePath .. "#isFinalized" , "If the production point is finalized and ready on start.E.g.constructible" )
    end

    ProductionPoint.registerXMLPaths(schema, basePath .. ".productionPoint" )
    registerPlaceableSchema(schema, basePath .. ".productionPoint" )

    ProductionPoint.registerXMLPaths(schema, basePath .. ".productionPoint.productionPointConfigurations.productionPointConfiguration(?).productionPoint" )
    registerPlaceableSchema(schema, basePath .. ".productionPoint.productionPointConfigurations.productionPointConfiguration(?).productionPoint" )

    schema:setXMLSpecializationType()
end

saveToXMLFile

Description

Definition

saveToXMLFile()

Arguments

any	xmlFile
any	key
any	usedModNames

Code

function PlaceableProductionPoint:saveToXMLFile(xmlFile, key, usedModNames)
    local spec = self.spec_productionPoint
    if spec.productionPoint ~ = nil then
        spec.productionPoint:saveToXMLFile(xmlFile, key, usedModNames)
    end
end

setOwnerFarmId

Description

Definition

setOwnerFarmId()

Arguments

any	superFunc
any	farmId
any	noEventSend

Code

function PlaceableProductionPoint:setOwnerFarmId(superFunc, farmId, noEventSend)
    superFunc( self , farmId, noEventSend)

    local spec = self.spec_productionPoint
    if spec.productionPoint ~ = nil then
        local owner = self:getOwnerFarmId()
        if not spec.isFinalized then
            owner = AccessHandler.EVERYONE
        end
        spec.productionPoint:setOwnerFarmId(owner)

        if not spec.isFinalized then
            g_currentMission.productionChainManager:removeProductionPoint(spec.productionPoint)
        end
    end
end

updateInfo

Description

Definition

updateInfo()

Arguments

any	superFunc
any	infoTable

Code

function PlaceableProductionPoint:updateInfo(superFunc, infoTable)
    superFunc( self , infoTable)

    self.spec_productionPoint.productionPoint:updateInfo(infoTable)
end