PlaceableFarmhouse

PlaceableFarmhouse

Description

Specialization for placeables

Functions

• farmhouseSleepingTriggerCallback
• getSleepCamera
• getSpawnPoint
• getSpawnWorldPosition
• loadFromXMLFile
• onDelete
• onFinalizePlacement
• onLoad
• prerequisitesPresent
• registerEventListeners
• registerFunctions
• registerOverwrittenFunctions
• registerSavegameXMLPaths
• registerXMLPaths
• saveToXMLFile

farmhouseSleepingTriggerCallback

Description

Definition

farmhouseSleepingTriggerCallback(entityId triggerId, entityId otherActorId, boolean onEnter, boolean onLeave, boolean onStay, entityId otherShapeId)

Arguments

entityId	triggerId
entityId	otherActorId
boolean	onEnter
boolean	onLeave
boolean	onStay
entityId	otherShapeId

Code

function PlaceableFarmhouse:farmhouseSleepingTriggerCallback(triggerId, otherActorId, onEnter, onLeave, onStay, otherShapeId)
    if onEnter or onLeave then
        if g_localPlayer ~ = nil and otherActorId = = g_localPlayer.rootNode then
            -- if onEnter then
                -- TODO:reset player dog to spawn, old code:
                -- function Player:onEnterFarmhouse()
                    -- if self.isServer then
                        -- local dogHouse = g_currentMission:getDoghouse(self.farmId)
                        -- if dogHouse ~ = nil and dogHouse.dog ~ = nil and dogHouse.dog.entityFollow = = self.rootNode then
                            -- dogHouse.dog:teleportToSpawn()
                            -- end
                            -- end
                            -- end
                            -- end

                            local spec = self.spec_farmhouse
                            if onEnter then
                                g_currentMission.activatableObjectsSystem:addActivatable(spec.activatable)
                            else
                                    g_currentMission.activatableObjectsSystem:removeActivatable(spec.activatable)
                                end
                            end
                        end
                    end

getSleepCamera

Description

Definition

getSleepCamera()

Return Values

entityId	sleepCameraNode

Code

function PlaceableFarmhouse:getSleepCamera()
    return self.spec_farmhouse.sleepingCamera
end

getSpawnPoint

Description

Definition

getSpawnPoint()

Return Values

entityId	spawnNode

Code

function PlaceableFarmhouse:getSpawnPoint()
    local spec = self.spec_farmhouse

    if not spec.isFinalized then
        return nil
    end

    return spec.spawnNode
end

getSpawnWorldPosition

Description

Definition

getSpawnWorldPosition()

Code

function PlaceableFarmhouse:getSpawnWorldPosition()
    local spec = self.spec_farmhouse

    if not spec.isFinalized then
        return nil
    end

    return getWorldTranslation(spec.spawnNode)
end

loadFromXMLFile

Description

Definition

loadFromXMLFile(XMLFile xmlFile, string key)

Arguments

XMLFile	xmlFile
string	key

Code

function PlaceableFarmhouse:loadFromXMLFile(xmlFile, key)
    local spec = self.spec_farmhouse
    local isFreeForAll = xmlFile:getValue(key .. "#isFreeForAll" )
    if isFreeForAll ~ = nil then
        spec.isFreeForAll = isFreeForAll
    end
end

onDelete

Description

Definition

onDelete()

Code

function PlaceableFarmhouse:onDelete()
    local spec = self.spec_farmhouse

    g_currentMission.activatableObjectsSystem:removeActivatable(spec.activatable)

    g_currentMission.placeableSystem:removeFarmhouse( self )

    if spec.sleepingTrigger ~ = nil then
        removeTrigger(spec.sleepingTrigger)
    end

    if spec.sleepingCamera ~ = nil then
        g_cameraManager:removeCamera(spec.sleepingCamera)
    end
end

onFinalizePlacement

Description

Definition

onFinalizePlacement()

Code

function PlaceableFarmhouse:onFinalizePlacement()
    local spec = self.spec_farmhouse

    if spec.isFinalized then
        g_currentMission.placeableSystem:addFarmhouse( self )
    end
end

onLoad

Description

Called on loading

Definition

onLoad(table savegame)

Arguments

table	savegame	savegame

Code

function PlaceableFarmhouse:onLoad(savegame)
    local spec = self.spec_farmhouse

    spec.activatable = FarmhouseActivatable.new( self )

    spec.spawnNode = self.xmlFile:getValue( "placeable.farmhouse#spawnNode" , nil , self.components, self.i3dMappings)
    if spec.spawnNode = = nil then
        Logging.xmlError( self.xmlFile, "No spawn node defined for farmhouse" )
            spec.spawnNode = self.rootNode
        end

        local sleepingTriggerKey = "placeable.farmhouse.sleeping#triggerNode"
        spec.sleepingTrigger = self.xmlFile:getValue(sleepingTriggerKey, nil , self.components, self.i3dMappings)
        if spec.sleepingTrigger ~ = nil then
            if not CollisionFlag.getHasMaskFlagSet(spec.sleepingTrigger, CollisionFlag.PLAYER) then
                Logging.warning( "%s sleep trigger '%s' does not have 'TRIGGER_PLAYER' bit(%s) set" , self.configFileName, sleepingTriggerKey, CollisionFlag.getBit(CollisionFlag.PLAYER))
            end
            addTrigger(spec.sleepingTrigger, "farmhouseSleepingTriggerCallback" , self )
        end

        local cameraKey = "placeable.farmhouse.sleeping#cameraNode"
        local camera = self.xmlFile:getValue(cameraKey, nil , self.components, self.i3dMappings)
        if camera then
            if getHasClassId(camera, ClassIds.CAMERA) then
                spec.sleepingCamera = camera
                g_cameraManager:addCamera(camera, nil , false )
            else
                    Logging.xmlError( self.xmlFile, "Sleeping camera node '%s' (%s) is not a camera!" , getName(camera), cameraKey)
                end
            end

            spec.isFreeForAll = self.xmlFile:getValue( "placeable.farmhouse.sleeping#isFreeForAll" , false )
            spec.isFinalized = self.xmlFile:getBool( "placeable.farmhouse#isFinalized" , true )
        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 PlaceableFarmhouse.prerequisitesPresent(specializations)
    return true
end

registerEventListeners

Description

Definition

registerEventListeners(table placeableType)

Arguments

table	placeableType

Code

function PlaceableFarmhouse.registerEventListeners(placeableType)
    SpecializationUtil.registerEventListener(placeableType, "onLoad" , PlaceableFarmhouse )
    SpecializationUtil.registerEventListener(placeableType, "onDelete" , PlaceableFarmhouse )
    SpecializationUtil.registerEventListener(placeableType, "onFinalizePlacement" , PlaceableFarmhouse )
end

registerFunctions

Description

Definition

registerFunctions(table placeableType)

Arguments

table	placeableType

Code

function PlaceableFarmhouse.registerFunctions(placeableType)
    SpecializationUtil.registerFunction(placeableType, "farmhouseSleepingTriggerCallback" , PlaceableFarmhouse.farmhouseSleepingTriggerCallback)
    SpecializationUtil.registerFunction(placeableType, "getSleepCamera" , PlaceableFarmhouse.getSleepCamera)
    SpecializationUtil.registerFunction(placeableType, "getSpawnWorldPosition" , PlaceableFarmhouse.getSpawnWorldPosition)
    SpecializationUtil.registerFunction(placeableType, "getSpawnPoint" , PlaceableFarmhouse.getSpawnPoint)
    SpecializationUtil.registerFunction(placeableType, "getIsAllowedToSleep" , PlaceableFarmhouse.getIsAllowedToSleep)
end

registerOverwrittenFunctions

Description

Definition

registerOverwrittenFunctions(table placeableType)

Arguments

table	placeableType

Code

function PlaceableFarmhouse.registerOverwrittenFunctions(placeableType)
    SpecializationUtil.registerOverwrittenFunction(placeableType, "finalizeConstruction" , PlaceableFarmhouse.finalizeConstruction)
end

registerSavegameXMLPaths

Description

Definition

registerSavegameXMLPaths(XMLSchema schema, string basePath)

Arguments

XMLSchema	schema
string	basePath

Code

function PlaceableFarmhouse.registerSavegameXMLPaths(schema, basePath)
    schema:setXMLSpecializationType( "Farmhouse" )
    schema:register(XMLValueType.BOOL, basePath .. "#isFreeForAll" , "Marks if everybody can sleep there" )
        schema:setXMLSpecializationType()
    end

registerXMLPaths

Description

Definition

registerXMLPaths(XMLSchema schema, string basePath)

Arguments

XMLSchema	schema
string	basePath

Code

function PlaceableFarmhouse.registerXMLPaths(schema, basePath)
    schema:setXMLSpecializationType( "Farmhouse" )
    schema:register(XMLValueType.NODE_INDEX, basePath .. ".farmhouse#spawnNode" , "Player spawn node" )
    schema:register(XMLValueType.NODE_INDEX, basePath .. ".farmhouse.sleeping#triggerNode" , "Sleeping trigger" )
    schema:register(XMLValueType.NODE_INDEX, basePath .. ".farmhouse.sleeping#cameraNode" , "Camera while sleeping" )
        schema:register(XMLValueType.BOOL, basePath .. ".farmhouse.sleeping#isFreeForAll" , "Marks if everybody can sleep there" )
            schema:register(XMLValueType.BOOL, basePath .. ".farmhouse#isFinalized" , "If the farmhouse is finalized and ready on start.E.g.constructible" )
            schema:setXMLSpecializationType()
        end

saveToXMLFile

Description

Definition

saveToXMLFile(XMLFile xmlFile, string key, table usedModNames)

Arguments

XMLFile	xmlFile
string	key
table	usedModNames

Code

function PlaceableFarmhouse:saveToXMLFile(xmlFile, key, usedModNames)
    xmlFile:setValue(key .. "#isFreeForAll" , self.spec_farmhouse.isFreeForAll)
end