PlaceableSolarPanels

Description

Specialization for placeables

Functions

getIncomePerHour
getNeedHourChanged
initSpecialization
loadFromXMLFile
onFinalizePlacement
onHourChanged
onLoad
onReadStream
onUpdate
onWriteStream
prerequisitesPresent
registerEventListeners
registerFunctions
registerOverwrittenFunctions
registerSavegameXMLPaths
registerXMLPaths
saveToXMLFile
updateHeadRotation

getIncomePerHour

Description

Definition

getIncomePerHour()

Arguments

any	superFunc

Code

function PlaceableSolarPanels:getIncomePerHour(superFunc)
    local spec = self.spec_solarPanels

    local incomePerHour = superFunc( self )

    if spec.hasSolarPanels then
        local factor = 0
        local environment = g_currentMission.environment
        if environment.isSunOn then
            factor = 1
        end

        if environment.currentSeason = = Season.WINTER then
            factor = factor * 0.75
        end

        if environment.weather:getIsRaining() then
            factor = factor * 0.1
        end

        incomePerHour = incomePerHour + spec.incomePerHour * factor
    end

    return incomePerHour
end

getNeedHourChanged

Description

Definition

getNeedHourChanged()

Arguments

any	superFunc

Code

function PlaceableSolarPanels:getNeedHourChanged(superFunc)
    return self.spec_solarPanels.hasSolarPanels
end

initSpecialization

Description

Definition

initSpecialization()

Code

function PlaceableSolarPanels.initSpecialization()
    g_placeableConfigurationManager:addConfigurationType( "solarPanels" , g_i18n:getText( "configuration_solarPanel" ), "solarPanels" , PlaceableConfigurationItem )
end

loadFromXMLFile

Description

Definition

loadFromXMLFile()

Arguments

any	xmlFile
any	key

Code

function PlaceableSolarPanels:loadFromXMLFile(xmlFile, key)
    local spec = self.spec_solarPanels
    local headRotationRandom = xmlFile:getValue(key .. "#headRotationRandom" )
    if headRotationRandom = = nil then
        spec.headRotationRandom = headRotationRandom
    end
end

onFinalizePlacement

Description

Definition

onFinalizePlacement()

Code

function PlaceableSolarPanels:onFinalizePlacement()
    self:updateHeadRotation()
end

onHourChanged

Description

Definition

onHourChanged()

Code

function PlaceableSolarPanels:onHourChanged()
    self:updateHeadRotation()
end

onLoad

Description

Definition

onLoad()

Arguments

any	savegame

Code

function PlaceableSolarPanels:onLoad(savegame)
    local spec = self.spec_solarPanels
    local xmlFile = self.xmlFile

    local solarPanelsConfigurationId = Utils.getNoNil( self.configurations[ "solarPanels" ], 1 )
    local configKey = string.format( "placeable.solarPanels.solarPanelsConfigurations.solarPanelsConfiguration(%d)" , solarPanelsConfigurationId - 1 )
    local hasSolarPanels = xmlFile:getValue(configKey .. "#isActive" , false )

    spec.headNode = xmlFile:getValue(configKey .. "#headNode" , nil , self.components, self.i3dMappings)
    if spec.headNode ~ = nil then
        hasSolarPanels = true

        spec.randomHeadOffsetRange = xmlFile:getValue(configKey .. "#randomHeadOffsetRange" , 15 )
        spec.rotationSpeed = xmlFile:getValue(configKey .. "#rotationSpeed" , 5 ) / 1000

        local rotVariation = spec.randomHeadOffsetRange * 0.5
        spec.headRotationRandom = math.random( - 1 , 1 ) * rotVariation -- default random -7.5 - 7.5 degrees offset

        spec.currentRotation = spec.headRotationRandom
        spec.targetRotation = spec.headRotationRandom
    end

    spec.incomePerHour = xmlFile:getValue(configKey .. "#incomePerHour" , 0 )
    spec.hasSolarPanels = hasSolarPanels

    if not hasSolarPanels then
        SpecializationUtil.removeEventListener( self , "onFinalizePlacement" , PlaceableSolarPanels )
        SpecializationUtil.removeEventListener( self , "onReadStream" , Cover )
        SpecializationUtil.removeEventListener( self , "onWriteStream" , Cover )
        SpecializationUtil.removeEventListener( self , "onUpdate" , Cover )
        SpecializationUtil.removeEventListener( self , "onHourChanged" , Cover )
    end
end

onReadStream

Description

Definition

onReadStream()

Arguments

any	streamId
any	connection

Code

function PlaceableSolarPanels:onReadStream(streamId, connection)
    local spec = self.spec_solarPanels
    if spec.headNode ~ = nil then
        spec.headRotationRandom = NetworkUtil.readCompressedAngle(streamId)
    end
end

onUpdate

Description

Definition

onUpdate()

Arguments

any	dt

Code

function PlaceableSolarPanels:onUpdate(dt)
    local spec = self.spec_solarPanels
    if spec.targetRotation ~ = spec.currentRotation then
        local limitFunc = math.min
        local direction = 1
        if spec.targetRotation < spec.currentRotation then
            limitFunc = math.max
            direction = - 1
        end

        spec.currentRotation = limitFunc(spec.currentRotation + spec.rotationSpeed * dt * direction, spec.targetRotation)
        local dx,_,dz = worldDirectionToLocal(getParent(spec.headNode), math.sin(spec.currentRotation), 0 , math.cos(spec.currentRotation))
        setDirection(spec.headNode, dx, 0 , dz, 0 , 1 , 0 )

        if spec.targetRotation ~ = spec.currentRotation then
            self:raiseActive()
        end
    end
end

onWriteStream

Description

Definition

onWriteStream()

Arguments

any	streamId
any	connection

Code

function PlaceableSolarPanels:onWriteStream(streamId, connection)
    local spec = self.spec_solarPanels
    if spec.headNode ~ = nil then
        NetworkUtil.writeCompressedAngle(streamId, spec.headRotationRandom)
    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 PlaceableSolarPanels.prerequisitesPresent(specializations)
    return SpecializationUtil.hasSpecialization( PlaceableIncomePerHour , specializations)
end

registerEventListeners

Description

Definition

registerEventListeners()

Arguments

any	placeableType

Code

function PlaceableSolarPanels.registerEventListeners(placeableType)
    SpecializationUtil.registerEventListener(placeableType, "onLoad" , PlaceableSolarPanels )
    SpecializationUtil.registerEventListener(placeableType, "onFinalizePlacement" , PlaceableSolarPanels )
    SpecializationUtil.registerEventListener(placeableType, "onReadStream" , PlaceableSolarPanels )
    SpecializationUtil.registerEventListener(placeableType, "onWriteStream" , PlaceableSolarPanels )
    SpecializationUtil.registerEventListener(placeableType, "onHourChanged" , PlaceableSolarPanels )
    SpecializationUtil.registerEventListener(placeableType, "onUpdate" , PlaceableSolarPanels )
end

registerFunctions

Description

Definition

registerFunctions()

Arguments

any	placeableType

Code

function PlaceableSolarPanels.registerFunctions(placeableType)
    SpecializationUtil.registerFunction(placeableType, "updateHeadRotation" , PlaceableSolarPanels.updateHeadRotation)
end

registerOverwrittenFunctions

Description

Definition

registerOverwrittenFunctions()

Arguments

any	placeableType

Code

function PlaceableSolarPanels.registerOverwrittenFunctions(placeableType)
    SpecializationUtil.registerOverwrittenFunction(placeableType, "getIncomePerHour" , PlaceableSolarPanels.getIncomePerHour)
    SpecializationUtil.registerOverwrittenFunction(placeableType, "getNeedHourChanged" , PlaceableSolarPanels.getNeedHourChanged)
end

registerSavegameXMLPaths

Description

Definition

registerSavegameXMLPaths()

Arguments

any	schema
any	basePath

Code

function PlaceableSolarPanels.registerSavegameXMLPaths(schema, basePath)
    schema:setXMLSpecializationType( "SolarPanels" )
    schema:register(XMLValueType.FLOAT, basePath .. "#headRotationRandom" , "Head random rotation" )
    schema:setXMLSpecializationType()
end

registerXMLPaths

Description

Definition

registerXMLPaths()

Arguments

any	schema
any	basePath

Code

function PlaceableSolarPanels.registerXMLPaths(schema, basePath)
    schema:setXMLSpecializationType( "SolarPanels" )

    basePath = basePath .. ".solarPanels.solarPanelsConfigurations.solarPanelsConfiguration(?)"
    schema:register(XMLValueType.NODE_INDEX, basePath .. "#headNode" , "Head Node" )
    schema:register(XMLValueType.ANGLE, basePath .. "#randomHeadOffsetRange" , "Range of random offset" , 15 )
    schema:register(XMLValueType.ANGLE, basePath .. "#rotationSpeed" , "Rotation Speed(deg/sec)" , 5 )
    schema:register(XMLValueType.BOOL, basePath .. "#isActive" , "If solar panels are available" , false )
    schema:register(XMLValueType.FLOAT, basePath .. "#incomePerHour" , "Income per hour" )
    schema:setXMLSpecializationType()
end

saveToXMLFile

Description

Definition

saveToXMLFile()

Arguments

any	xmlFile
any	key
any	usedModNames

Code

function PlaceableSolarPanels:saveToXMLFile(xmlFile, key, usedModNames)
    local spec = self.spec_solarPanels
    if spec.headNode ~ = nil then
        xmlFile:setValue(key .. "#headRotationRandom" , spec.headRotationRandom)
    end
end

updateHeadRotation

Description

Definition

updateHeadRotation()

Code

function PlaceableSolarPanels:updateHeadRotation()
    local spec = self.spec_solarPanels
    if spec.headNode ~ = nil and g_currentMission ~ = nil and g_currentMission.environment ~ = nil then

        local sunLight = g_currentMission.environment.lighting.sunLightId
        if sunLight ~ = nil then
            local dx, _, dz = localDirectionToWorld(sunLight, 0 , 0 , 1 )
            local headRotation = math.atan2(dx, dz)
            if math.abs(dx) > 0.3 then
                headRotation = headRotation + spec.headRotationRandom

                spec.targetRotation = headRotation
                self:raiseActive()
            end
        end
    end
end