UniversalProcessKit.lua

-- by mor2000

local UniversalProcessKit_mt = ClassUPK(UniversalProcessKit);
InitObjectClass(UniversalProcessKit, "UniversalProcessKit");

function UniversalProcessKit:onCreate(id)
	printFn('UniversalProcessKit:onCreate('..tostring(id)..')')
	
	local upkbase = OnCreateUPK:new(g_server ~= nil, g_client ~= nil)
	if upkbase==false or upkbase~=nil then
		upkbase:load(id)
		g_currentMission:addOnCreateLoadedObject(upkbase)
		upkbase:register(true)
	else
		upkbase:detele()
	end
end;

function UniversalProcessKit:new(nodeId, parent, customMt)
	printFn('UniversalProcessKit:new('..tostring(nodeId)..', '..tostring(parent)..', '..tostring(customMt)..')')
	
	if nodeId==nil then
		printErr('Error: UniversalProcessKit:new() called with id=nil')
		return false
	end

	--local self = Object:new(g_server ~= nil, g_client ~= nil, customMt or UniversalProcessKit_mt) -- base needs to be object
	--registerObjectClassName(self, "UniversalProcessKit")
	
	local self={}
	
	self.isServer = g_server ~= nil
	self.isClient = g_client ~= nil

	self.rootNode = nodeId
	self.nodeId = nodeId
	self.triggerId = 0
	
	self.parent = parent
	if self.parent == nil then
		self.base = self
	else
		self.base = self.parent.base
	end
	self.kids={}
	self.type=nil

	self.onCreates = {}
	self.onFillLevelChangeFuncs = {}
	
	self.x,self.y,self.z = getTranslation(nodeId)
	self.pos = __c({self.x,self.y,self.z})
	self.wpos = __c({getWorldTranslation(nodeId)})
	self.rot = __c({getRotation(nodeId)})
	self.wrot = __c({getWorldRotation(nodeId)})
	self.scale = __c({getScale(nodeId)})
	
	-- misc
	
	self.name = string.gsub(getName(self.nodeId), "%W", "_")
	self.type = getStringFromUserAttribute(nodeId, "type")
	self.isEnabled = getBoolFromUserAttribute(nodeId, "isEnabled", true)

	-- i18nNameSpace
	
	if self.parent~=nil then
		self.i18nNameSpace = self.parent.i18nNameSpace
		self.i18n = self.parent.i18n
	else
		self.i18n = {}
	end
	
	-- fill types conversion matrix
	
	self.fillTypesConversionMatrix = FillTypesConversionMatrix:new()
	
	-- storageType
	
	self.storageType = UPK_Storage.SEPARATE
	
	local storeArr = getArrayFromUserAttribute(self.nodeId, "store")
	
	if #storeArr==1 then
		if storeArr[1]=="single" then
			self.storageType = UPK_Storage.SINGLE
		elseif storeArr[1]=="fifo" then
			self.storageType = UPK_Storage.FIFO
		elseif storeArr[1]=="filo" then
			self.storageType = UPK_Storage.FILO
		end
	end

	-- capacity/ capacities

	self.p_capacity = getNumberFromUserAttribute(nodeId, "capacity", math.huge)

	local capacities = {}
	if self.storageType==UPK_Storage.SEPARATE or self.storageType==UPK_Storage.SINGLE then
		local capacitiesArr = getArrayFromUserAttribute(nodeId, "capacities")
		for i=1,#capacitiesArr,2 do
			local capacity=tonumber(capacitiesArr[i])
			local fillType=unpack(UniversalProcessKit.fillTypeNameToInt(capacitiesArr[i+1]))
			if capacity~=nil and fillType~=nil then
				printInfo('adding capacity of '..tostring(capacity)..' to '..tostring(fillType))
				capacities[fillType]=capacity
			end
		end
	end

	self.capacities = FillLevelBubbleCapacities:new(self.p_capacity, capacities)

	for k,v in pairs(self.capacities) do
		printAll('capacity of '..tostring(k)..': '..tostring(v))
	end

	-- set metatable

	setmetatable(self, customMt or UniversalProcessKit_mt)

	-- network
	
	self.fillLevelsToSync = {}
	self.nextDirtyFlag = 1
	self.dirtyMask = 0
	self.syncAllDirtyFlag = self:getNextDirtyFlag()
	self.fillLevelDirtyFlag = self:getNextDirtyFlag()
	self.isEnabledDirtyFlag = self:getNextDirtyFlag()
	self.mapHotspotDirtyFlag = self:getNextDirtyFlag()
	
	-- fill level bubbles

	self.p_flbs = {}
	--setmetatable(self.p_flbs,p_flbs_mt)

	if self.storageType == UPK_Storage.SEPARATE then
		for _,v in pairs(UniversalProcessKit.fillTypeNameToInt(storeArr)) do
			self.p_flbs[v] = FillLevelBubble:new()
			self.fillTypesConversionMatrix = self.fillTypesConversionMatrix + FillTypesConversionMatrix:new(v)
		end
	elseif self.storageType==UPK_Storage.SINGLE then
		local flb = FillLevelBubble:new()
		self.p_flbs = {flb}
	elseif self.storageType==UPK_Storage.FIFO then
		local flb = FillLevelBubble:new()
		self.p_flbs = {flb}
		self.p_flbs_fifo_lastkey = 1
		self.p_totalFillLevel = 0
	elseif self.storageType==UPK_Storage.FILO then
		local flb = FillLevelBubble:new()
		self.p_flbs = {flb}
		self.p_totalFillLevel = 0
	end

	

	-- fill types conversion matrix

	local fillTypesConversionMatrixStrStr = getStringFromUserAttribute(nodeId, "convertFillTypes", "")
	self:printInfo('fillTypesConversionMatrixStrStr: '..tostring(fillTypesConversionMatrixStrStr))
	local fillTypesConversionMatrixStrArr = gmatch(fillTypesConversionMatrixStrStr..',','(.-),')
	for _,fillTypesConversionMatrixStr in pairs(fillTypesConversionMatrixStrArr) do
		if fillTypesConversionMatrixStr~=nil and fillTypesConversionMatrixStr~="" then
			self:printAll('dealing with '..tostring(fillTypesConversionMatrixStr))
			self.fillTypesConversionMatrix = self.fillTypesConversionMatrix + FillTypesConversionMatrix:new(UniversalProcessKit.fillTypeNameToInt(gmatch(fillTypesConversionMatrixStr,'%S+')))
		end
	end

	printAll('self.fillTypesConversionMatrix is '..tostring(self.fillTypesConversionMatrix))
	
	for k,v in pairs(self.fillTypesConversionMatrix) do
		for l,w in pairs(v) do
			printInfo('adding '..tostring(l)..' (incoming) to '..tostring(k)..' (stored) ends up as '..tostring(w))
		end
	end
	
	if self.storageType==UPK_Storage.SINGLE or self.storageType==UPK_Storage.FIFO or self.storageType==UPK_Storage.FILO then
		local convertFromUnknown_mt = {
			__index = function(t,k)
				rawset(t,k,k)
				return k
			end
		}
		local convertFromUnknown={}
		setmetatable(convertFromUnknown, convertFromUnknown_mt)
		self.fillTypesConversionMatrix[UniversalProcessKit.FILLTYPE_UNKNOWN] = convertFromUnknown
	end
	
	for _,flb in pairs(self.p_flbs) do
		flb.capacities = self.capacities
		for k,v in pairs(flb.capacities) do
			printInfo('capacity of '..tostring(k)..': '..tostring(v))
		end
		flb.fillTypesConversionMatrix = self.fillTypesConversionMatrix
		flb:registerOnFillLevelChangeFunc(self,"p_onFillLevelChange")
	end
	
	-- addNodeObject
	--[[
	if self.addNodeObject and getRigidBodyType(nodeId) ~= "NoRigidBody" then
		g_currentMission:addNodeObject(nodeId, self)
	end
	--]]
	
	-- MapHotspot -- nothing done yet
	
	self.showMapHotSpotIfDisabled = getBoolFromUserAttribute(nodeId, "showMapHotSpotIfDisabled", true)
	--self.blinkingMapHotspot = getBoolFromUserAttribute(nodeId, "blinkingMapHotspot", false)
	
	self.MapHotspotName = getStringFromUserAttribute(nodeId, "MapHotspot")
	local mapHotspotIcons={
		Bank="$dataS2/menu/hud/hud_pda_spot_bank.png",
		FuelStation="$dataS2/menu/hud/hud_pda_spot_fuelStation.png",
		Shop="$dataS2/menu/hud/hud_pda_spot_shop.png",
		Phone="$dataS2/menu/hud/hud_pda_spot_phone.png",
		Eggs="$dataS/menu/hud/hud_pda_spot_eggs.png",
		TipPlace="$dataS2/menu/hud/hud_pda_spot_tipPlace.png",
		TipPlaceGold="$dataS2/menu/hud/hud_pda_spot_tipPlaceGold.png",
		Cows="$dataS2/menu/hud/hud_pda_spot_cows.png",
		Sheep="$dataS2/menu/hud/hud_pda_spot_sheep.png",
		Chickens="$dataS2/menu/hud/hud_pda_spot_chickens.png",
		Billboard="$dataS2/menu/hud/hud_pda_spot_billboard.png"}
	
	if self.MapHotspotName~=nil and mapHotspotIcons[self.MapHotspotName]~=nil then
		self.MapHotspotIcon = Utils.getFilename(mapHotspotIcons[self.MapHotspotName], getAppBasePath())
	else
		local iconStr = getStringFromUserAttribute(nodeId, "MapHotspotIcon")
		if iconStr~=nil then
			if self.i18nNameSpace==nil then
				self:printInfo('you need to set the modName-UserAttribute to use MapHotspotIcon')
			else
				self.MapHotspotIcon = g_modNameToDirectory[self.i18nNameSpace]..iconStr
				self:printInfo('using \"'..tostring(self.MapHotspotIcon)..'\" as MapHotspotIcon')
			end
		else
			self.MapHotspotIcon = Utils.getFilename(mapHotspotIcons["TipPlace"], getAppBasePath())
		end
	end
	
	self.useMapHotspot = getUserAttribute(nodeId, "showMapHotspot") ~= nil
	
	self:showMapHotspot(getBoolFromUserAttribute(nodeId, "showMapHotspot", false), true)
	
	-- placeable object
	
	if self.type~="base" and self.parent~=nil then
		self.placeable = self.parent.placeable
		self.builtIn = self.parent.builtIn
		self.syncObj = self.parent.syncObj
		self.base = self.parent.base
		self.syncObj:registerObjectToSync(self) -- invokes to call read and writeStream
	end
	
	
	printAll('loaded module '..tostring(self.name)..' with id '..tostring(nodeId))
	
	printAll('self.placeable '..tostring(self.placeable))
	printAll('getBoolFromUserAttribute(nodeId, "adjustToTerrainHeight", false) '..tostring(getBoolFromUserAttribute(nodeId, "adjustToTerrainHeight", false)))
	
	if getBoolFromUserAttribute(nodeId, "adjustToTerrainHeight", false) and self.placeable then
		UniversalProcessKit.adjustToTerrainHeight(nodeId)
	end
	
	UniversalProcessKitListener.registerPostLoadObject(self)
	
	--g_currentMission:addNodeObject(self.nodeId, self)
	
	return self
end;

function UniversalProcessKit:findChildrenLoopFunc(childId)
	self:printFn('UniversalProcessKit:findChildrenLoopFunc('..tostring(childId)..')')	
	
	local type = getStringFromUserAttribute(childId, "type")
	self:printInfo('UserAttribute type is '..tostring(type))
	if type~=nil and UniversalProcessKit.ModuleTypes[type]~=nil then
		childName=Utils.getNoNil(getName(childId),"")
		self:printInfo('found module '..childName..' of type '..tostring(type)..' and id '..tostring(childId))
		local module=UniversalProcessKit.ModuleTypes[type]:new(childId,self)
		if module~=nil and module~=false then
			--if debugMode then -- not true/false anymore
			--	module=debugObject(module)
			--end
			table.insert(self.kids,module)
			module:findChildren(childId)
		else
			self:printErr('couldnt load module of type '..tostring(type)..' and id '..tostring(childId))
			self:findChildren(childId)
		end
	else
		if getBoolFromUserAttribute(childId, "adjustToTerrainHeight", false) and self.placeable then
			UniversalProcessKit.adjustToTerrainHeight(childId)
		end
		self:findChildren(childId)
	end
	return true
end

function UniversalProcessKit:findChildren(id)
	self:printFn('UniversalProcessKit:findChildren('..tostring(id)..')')	
	loopThruChildren(id,"findChildrenLoopFunc",self)
end;

function UniversalProcessKit:findChildrenShapesLoopFunc(childId)
	self:printFn('UniversalProcessKit:findChildrenShapesLoopFunc('..tostring(childId)..')')
	table.insert(self.childrenShapes,childId)
	self:findChildrenShapes(childId)
	return true
end;

function UniversalProcessKit:findChildrenShapes(id)
	self:printFn('UniversalProcessKit:findChildrenShapes('..tostring(id)..')')
	loopThruChildren(id,"findChildrenShapesLoopFunc",self)
end;

function UniversalProcessKit:delete()
	printFn('delete module '..tostring(self.name)..' with nid '..tostring(self.nodeId))

	self.isEnabled = false

	self:removeTrigger()
	
	for i=1,#self.kids do
		self.kids[i]:removeTrigger()
		self.kids[i]:delete()
	end
	
	self.kids={}
	
	UniversalProcessKitListener.removeUpdateable(self)
	UniversalProcessKitListener.removeDayChangeListener(self)
	UniversalProcessKitListener.removeHourChangeListener(self)
	UniversalProcessKitListener.removeMinuteChangeListener(self)
	UniversalProcessKitListener.removeSecondChangeListener(self)

	if self.addNodeObject and self.nodeId ~= 0 then
		g_currentMission:removeNodeObject(self.nodeId)
	end
	
	unregisterObjectClassName(self)
end;

function UniversalProcessKit:getActionUserAttributes(actionName, defaultEnableChildren, defaultDisableChildren)
	self:printFn('UniversalProcessKit:getActionUserAttributes(',actionName,', ',defaultEnableChildren,', ',defaultDisableChildren,')')
	
	if self.actions==nil then
		self.actions={}
	end
	
	if type(actionName)~="string" or strlen(actionName)==0 or self.actions[actionName]~=nil then
		self:printErr('faulty actionName')
		return
	end
	
	local nodeId = self.nodeId
	
	local actions_mt = {
		__index = function(t,k)
			rawset(t,k,false)
			return false
		end
	}
	self.actions[actionName] = {}
	setmetatable(self.actions[actionName],actions_mt)
	
	
	local enableChildrenAction = 'enableChildren'..actionName
	local disableChildrenAction = 'disableChildren'..actionName
	
	local emptyFillTypesAction = 'emptyFillTypes'..actionName
	local topUpFillTypesAction = 'topUpFillTypes'..actionName
	
	local addAction = 'add'..actionName
	local removeAction = 'remove'..actionName
	
	local showAction = 'show'..actionName
	local hideAction = 'hide'..actionName
	
	local showChildrenAction = 'showChildren'..actionName
	local hideChildrenAction = 'hideChildren'..actionName
	
	local action = self.actions[actionName]
	
	action['enableChildren'] = getBoolFromUserAttribute(nodeId, enableChildrenAction, defaultEnableChildren or false)
	action['disableChildren'] = getBoolFromUserAttribute(nodeId, disableChildrenAction, defaultDisableChildren or false)
	
	if action['enableChildren'] then
		action['disableChildren'] = false
	end
	
	action['emptyFillTypes'] = {}
	local arr = getArrayFromUserAttribute(nodeId, emptyFillTypesAction)
	for i=1,#arr do
		local fillType = unpack(UniversalProcessKit.fillTypeNameToInt(arr[i]))
		table.insert(action['emptyFillTypes'],fillType)
		action['hasEmptyFillTypes'] = true
	end
	
	action['topUpFillTypes'] = {}
	local arr = getArrayFromUserAttribute(nodeId, topUpFillTypesAction)
	for i=1,#arr do
		local fillType = unpack(UniversalProcessKit.fillTypeNameToInt(arr[i]))
		table.insert(action['topUpFillTypes'],fillType)
		action['hasTopUpFillTypes'] = true
	end
	
	action['add'] = {}
	local arr = getArrayFromUserAttribute(nodeId, addAction)
	for i=1,#arr,2 do
		local amount = tonumber(arr[i])
		local fillType = unpack(UniversalProcessKit.fillTypeNameToInt(arr[i+1]))
		if type(amount)=="number" and amount>0 and type(fillType)=="number" then
			action['add'][fillType] = amount
			action['hasAdd'] = true
		end
	end
	
	action['remove'] = {}
	local arr=getArrayFromUserAttribute(nodeId, removeAction)
	for i=1,#arr,2 do
		local amount = tonumber(arr[i])
		local fillType = unpack(UniversalProcessKit.fillTypeNameToInt(arr[i+1]))
		if type(amount)=="number" and amount>0 and type(fillType)=="number" then
			action['remove'][fillType] = -amount
			action['hasRemove'] = true
		end
	end
	
	action['show'] = getBoolFromUserAttribute(nodeId, showAction, false)
	action['hide'] = getBoolFromUserAttribute(nodeId, hideAction, false)
	
	if action['show'] then
		action['hide'] = false
	end
	
	action['showChildren'] = getBoolFromUserAttribute(nodeId, showChildrenAction, false)
	action['hideChildren'] = getBoolFromUserAttribute(nodeId, hideChildrenAction, false)
	
	if action['showChildren'] then
		action['hideChildren'] = false
	end
end

function UniversalProcessKit:operateAction(actionName, alreadySent)
	self:printFn('UniversalProcessKit:operateAction('..tostring(actionName)..','..tostring(alreadySent)..')')
	
	if type(actionName)~="string" or strlen(actionName)==0 or self.actions[actionName]==nil then
		self:printErr('faulty actionName')
		return
	end
		
	local action = self.actions[actionName]
	
	if self.isServer then
		if action['hasEmptyFillTypes'] then
			for i=1,#action['emptyFillTypes'] do
				self:setFillLevel(0,action['emptyFillTypes'][i])
			end
		end
		if action['hasTopUpFillTypes'] then
			for i=1,#action['topUpFillTypes'] do
				local fillType = action['emptyFillTypes'][i]
				local capacity = self:getCapacity(fillType)
				if capacity<math.huge then
					self:setFillLevel(capacity,fillType)
				end
			end
		end
		if action['hasAdd'] then
			self:printAll('hasAddAction')
			self:addFillLevels(action['add'])
		end
		if action['hasRemove'] then
			self:printAll('hasRemoveAction')
			self:addFillLevels(action['remove'])
		end
	end
	
	if action['show'] then
		self:printAll('show')
		self:setEnableChildren(true, alreadySent)
	end
	if action['hide'] then
		self:printAll('hide')
		self:setEnableChildren(false, alreadySent)
	end
	
	if action['showChildren'] then
		self:printAll('show children')
		self:setEnableChildren(true, alreadySent)
	end
	if action['hideChildren'] then
		self:printAll('hide children')
		self:setEnableChildren(false, alreadySent)
	end
	
	if action['enableChildren'] then
		self:printAll('enable children')
		self:setEnableChildren(true, alreadySent)
	end
	if action['disableChildren'] then
		self:printAll('disable children')
		self:setEnableChildren(false, alreadySent)
	end	
end

function UniversalProcessKit:update(dt)
	self:printFn('UniversalProcessKit:update('..tostring(dt)..')')
	-- do sth with time (ms)
	-- requieres UniversalProcessKitListener.addUpdateable(self)
	-- and UniversalProcessKitListener.removeUpdateable(self)
end;

function UniversalProcessKit:registerOnFillLevelChangeFunc(obj,func)
	self:printFn('UniversalProcessKit:registerOnFillLevelChangeFunc('..tostring(obj)..', '..tostring(func)..')')
	if type(obj)=="table" and obj~=self and type(func)=="string" and type(obj[func])=="function" then
		self.onFillLevelChangeFuncs[obj]=func
	end
end

function UniversalProcessKit:unregisterOnFillLevelChangeFunc(obj)
	self:printFn('UniversalProcessKit:unregisterOnFillLevelChangeFunc('..tostring(obj)..')')
	if type(obj)=="table" then
		self.onFillLevelChangeFuncs[obj]=nil
	end
end

function UniversalProcessKit:p_onFillLevelChange(deltaFillLevel, newFillLevel, fillType) -- do sth with syncing
	self:printFn('UniversalProcessKit:p_onFillLevelChange('..tostring(deltaFillLevel)..', '..tostring(newFillLevel)..', '..tostring(fillType)..')')
	
	if self.isServer then
		table.insert(self.fillLevelsToSync,{fillLevel=newFillLevel,fillType=fillType})
		self:raiseDirtyFlags(self.fillLevelDirtyFlag)
	end
	
	for obj,func in pairs(self.onFillLevelChangeFuncs) do
		obj[func](obj, deltaFillLevel, newFillLevel, fillType)
	end
	self:onFillLevelChange(deltaFillLevel, newFillLevel, fillType)
end

function UniversalProcessKit:onFillLevelChange(deltaFillLevel, newFillLevel, fillType) -- to be overwritten
	self:printFn('UniversalProcessKit:onFillLevelChange('..tostring(deltaFillLevel)..', '..tostring(newFillLevel)..', '..tostring(fillType)..')')
end

function UniversalProcessKit:getFillLevelBubbleShellFromFillType(fillType)
	self:printFn('UniversalProcessKit:getFillLevelBubbleShellFromFillType('..tostring(fillType)..')')
	if self.storageType==UPK_Storage.SEPARATE and fillType~=nil then
		local newFillType=self.fillTypesConversionMatrix[Fillable.FILLTYPE_UNKNOWN][fillType] or fillType
		local flb=self.p_flbs[newFillType]
		if flb~=nil then
			return self
		else
			if self.parent~=nil then
				return self.parent:getFillLevelBubbleShellFromFillType(fillType)
			end
		end
	elseif self.storageType==UPK_Storage.SINGLE or self.storageType==UPK_Storage.FIFO or self.storageType==UPK_Storage.FILO then
		return self
	end 
	return nil
end

function UniversalProcessKit:getFillLevel(fillType)
	self:printFn('UniversalProcessKit:getFillLevel('..tostring(fillType)..')')
	if fillType~=nil then
		if UniversalProcessKit.isSpecialFillType(fillType) then
			return UniversalProcessKitEnvironment.flbs[fillType].fillLevel
		end
		
		if self.storageType==UPK_Storage.SEPARATE then
			local newFillType=self.fillTypesConversionMatrix[Fillable.FILLTYPE_UNKNOWN][fillType] or fillType
			local flb=self.p_flbs[newFillType]
			if flb~=nil then
				return flb.fillLevel
			else
				if self.parent~=nil then
					return self.parent:getFillLevel(fillType)
				end
			end
		elseif self.storageType==UPK_Storage.SINGLE or self.storageType==UPK_Storage.FIFO or self.storageType==UPK_Storage.FILO then
			--self:print('self.p_flbs[1].fillType: '..tostring(self.p_flbs[1].fillType))
			if self.p_flbs[1].fillType==fillType then
				return self.p_flbs[1].fillLevel
			else
				return 0
			end
		end
	end
		
	return self.fillLevel
end

function UniversalProcessKit:getCapacity(fillType)
	self:printFn('UniversalProcessKit:getCapacity('..tostring(fillType)..')')
	if self.storageType==UPK_Storage.SEPARATE and fillType~=nil then
		local newFillType=self.fillTypesConversionMatrix[Fillable.FILLTYPE_UNKNOWN][fillType] or fillType
		local flb=self.p_flbs[newFillType]
		if flb~=nil then
			return self.capacities[newFillType]
		else
			if self.parent~=nil then
				return self.parent:getCapacity(fillType)
			end
		end
	end
	return self.capacity
end

function UniversalProcessKit:getFillType() -- for single, fifo and filo
	self:printFn('UniversalProcessKit:getFillType()')
	if self.storageType==UPK_Storage.SEPARATE then
		if self.parent~=nil then
			return self.parent:getFillType()
		end
		return Fillable.FILLTYPE_UNKNOWN
	end
	return self.fillType
end

function UniversalProcessKit:resetFillLevelIfNeeded()
	self:printFn('UniversalProcessKit:resetFillLevelIfNeeded()')
end

function UniversalProcessKit:allowFillType(fillType, allowEmptying) -- also check for capacity
	self:printFn('UniversalProcessKit:allowFillType('..tostring(fillType)..', '..tostring(allowEmptying)..')')
	if fillType~=nil then
		local newFillType=self.fillTypesConversionMatrix[UniversalProcessKit.FILLTYPE_UNKNOWN][fillType] or fillType
		if UniversalProcessKit.isSpecialFillType(newFillType) then
			return true
		elseif self.storageType==UPK_Storage.SEPARATE then
			local flb=self.p_flbs[newFillType]
			if flb~=nil then
				return flb.fillLevel < flb.capacity
			else
				if self.parent~=nil then
					return self.parent:allowFillType(fillType, allowEmptying)
				end
			end
		elseif self.storageType==UPK_Storage.SINGLE then
			local myFillType=self.fillType
			newFillType=self.fillTypesConversionMatrix[myFillType][fillType]
			if myFillType==newFillType then
				return self.fillLevel < self.capacity
			elseif myFillType==UniversalProcessKit.FILLTYPE_UNKNOWN then
				return true
			end
		elseif self.storageType==UPK_Storage.FIFO or self.storageType==UPK_Storage.FILO then
			return self.fillLevel < self.capacity
		end
	end
	return false
end

function UniversalProcessKit:setFillLevel(newFillLevel, fillType, force)
	self:printFn('UniversalProcessKit:setFillLevel('..tostring(newFillLevel)..', '..tostring(fillType)..', '..tostring(force)..')')
	if fillType~=nil then
		newFillType=self.fillTypesConversionMatrix[Fillable.FILLTYPE_UNKNOWN][fillType] or fillType
		if UniversalProcessKit.isSpecialFillType(newFillType) then -- should not happen
			self:addFillLevel(newFillLevel, newFillType)
		else
			local oldFillLevel = self:getFillLevel(newFillType)
			self:addFillLevel(newFillLevel-oldFillLevel, newFillType)
		end
	end
end

function UniversalProcessKit:addFillLevel(deltaFillLevel, fillType)
	self:printFn('UniversalProcessKit:addFillLevel('..tostring(deltaFillLevel)..', '..tostring(fillType)..')')
	if fillType~=nil then
		fillType=self.fillTypesConversionMatrix[Fillable.FILLTYPE_UNKNOWN][fillType] or fillType
	end
	return self + {deltaFillLevel, fillType}
end;

function UniversalProcessKit:addFillLevels(fillLevelsArr)
	self:printFn('UniversalProcessKit:addFillLevels('..tostring(fillLevelsArr)..')')
	for fillType, deltaFillLevel in pairs(fillLevelsArr) do
		if type(deltaFillLevel)=="number" and type(fillType)=="number" then
			self:addFillLevel(deltaFillLevel,fillType)
		end
	end
end

function UniversalProcessKit:getUniqueFillType()
	self:printFn('UniversalProcessKit:getUniqueFillType()')
	local currentFillType=Fillable.FILLTYPE_UNKNOWN
	for _,v in pairs(self:getAcceptedFillTypes()) do
		fillLevel=self.fillLevels[v]
		if fillLevel~=nil and fillLevel>0 then
			return v
		end
	end
	return currentFillType
end;

function UniversalProcessKit:getAcceptedFillTypes()
	self:printFn('UniversalProcessKit:getAcceptedFillTypes()')
	local r={}
	for k,v in pairs(UniversalProcessKit.fillTypeIntToName) do
		if self.acceptedFillTypes[k] then
			table.insert(r,k)
		end
	end
	return r
end;

-- show or hide an icon on the mini map
function UniversalProcessKit:showMapHotspot(on,alreadySent)
	self:printFn('UniversalProcessKit:showMapHotspot('..tostring(on)..', '..tostring(alreadySent)..')')
	self.appearsOnMap=on
	if on==true and self.mapHotspot == nil then
		
		--[[
		if not g_currentMission.ingameMap.upk_tested then
			for k,v in pairs(g_currentMission.ingameMap) do
				self:print('g_currentMission.ingameMap.'..tostring(k)..' = '..tostring(v))
			end
			g_currentMission.ingameMap.upk_tested=true
		end
		]]--
		
		local widthHeightRatio = g_currentMission.syncBackgroundOverlay.height
		self:printInfo('widthHeightRatio = '..tostring(widthHeightRatio))
		self:printInfo('g_currentMission.ingameMap.mapWidth = '..tostring(g_currentMission.ingameMap.mapWidth))
		local iconSize = 0.015625 --g_currentMission.ingameMap.mapWidth / 10
		local x,_,z = unpack(self.wpos)
		self.mapHotspot = g_currentMission.ingameMap:createMapHotspot(nil, self.MapHotspotIcon, x, z, iconSize, iconSize * widthHeightRatio, false, false, false, 0, true)
	end
	if on==false and type(self.mapHotspot)=="table" and self.mapHotspot.delete~=nil then
		g_currentMission.ingameMap:deleteMapHotspot(self.mapHotspot)
		self.mapHotspot=nil
	end
	if not alreadySent then
		--self:raiseDirtyFlags(self.maphotspotDirtyFlag)
	end
end;

function UniversalProcessKit:setEnable(isEnabled,alreadySent)
	self:printFn('UniversalProcessKit:setEnable('..tostring(isEnabled)..', '..tostring(alreadySent)..')')
	if isEnabled~=nil then
		self.isEnabled=isEnabled
		if not alreadySent then
			--self:raiseDirtyFlags(self.isEnabledDirtyFlag)
		end
	end
	if self.useMapHotspot then
		if self.isEnabled or self.showMapHotSpotIfDisabled then
			self:printAll('self.isEnabled or self.showMapHotSpotIfDisabled')
			self:showMapHotspot(true,true)
		else
			self:printAll('not (self.isEnabled or self.showMapHotSpotIfDisabled)')
			self:showMapHotspot(false,true)
		end
	end
	self:setEnableChildren(isEnabled,alreadySent)
end;

function UniversalProcessKit:setEnableChildren(isEnabled,alreadySent)
	self:printFn('UniversalProcessKit:setEnableChildren('..tostring(isEnabled)..', '..tostring(alreadySent)..')')
	for i=1,#self.kids do
		self.kids[i]:setEnable(isEnabled,alreadySent)
	end
end;

function UniversalProcessKit:postLoad()
	self:printFn('UniversalProcessKit:postLoad()')
	-- initial fill levels
	if self.isServer and self.base.timesSaved==0 then
		local initialFillLevelsArr = getArrayFromUserAttribute(self.nodeId, "initialFillLevels")
		for i=1,#initialFillLevelsArr,2 do
			local fillLevel=tonumber(initialFillLevelsArr[i])
			local fillType=unpack(UniversalProcessKit.fillTypeNameToInt(initialFillLevelsArr[i+1]))
			self:printAll('want to initially add '..tostring(fillLevel)..' to '..tostring(fillType))
			if fillLevel~=nil and fillType~=nil then
				self:addFillLevel(fillLevel, fillType)
			end
		end
	end
end;

function UniversalProcessKit:loadFromAttributesAndNodes(xmlFile, key)
	self:printFn('UniversalProcessKit:loadFromAttributesAndNodes('..tostring(xmlFile)..', '..tostring(key)..')')
	key=key.."."..self.name

	local fillLevelsStr = getXMLString(xmlFile, key .. "#fillLevels")
	self:printInfo('read save fillLevels '..tostring(fillLevelsStr))
	local fillLevelsArr = gmatch(fillLevelsStr, "%S+")
	for i=1,#fillLevelsArr,2 do
		local fillLevel=tonumber(fillLevelsArr[i])
		local fillType=unpack(UniversalProcessKit.fillTypeNameToInt(fillLevelsArr[i+1]))
		self:printInfo('want to add saved '..tostring(fillLevel)..' to '..tostring(fillType))
		if fillLevel~=nil and fillType~=nil then
			self:addFillLevel(fillLevel, fillType) -- should be good for fifo and filo
		end
	end
	
	local isEnabled = getXMLBool(xmlFile, key .. "#isEnabled")
	self:printInfo('read from save file: isEnabled = '..tostring(isEnabled)..' ('..type(isEnabled)..')')
	self:setEnable(Utils.getNoNil(getXMLBool(xmlFile, key .. "#isEnabled"), true), true)
	
	local appearsOnMap = getXMLBool(xmlFile, key .. "#showMapHotspot")
	self:printInfo('read from save file: showMapHotspot = '..tostring(appearsOnMap)..' ('..type(appearsOnMap)..')')
	self:showMapHotspot(Utils.getNoNil(getXMLBool(xmlFile, key .. "#showMapHotspot"), getBoolFromUserAttribute(self.nodeId, "showMapHotspot", false)), true)
	self.entitiesInTriggerLoaded = getXMLInt(xmlFile, key .. "#entitiesInTrigger") or 0
	self:loadExtraNodes(xmlFile, key)
	
	for i=1,#self.kids do
		self.kids[i]:loadFromAttributesAndNodes(xmlFile, key)
	end
	
	return true
end;

function UniversalProcessKit:getSaveAttributesAndNodes(nodeIdent)
	self:printFn('UniversalProcessKit:getSaveAttributesAndNodes('..tostring(nodeIdent)..')')
	local attributes=""
		
	local nodes = "<"..tostring(self.name)
	
	local extraNodes=""
	
	if not self.isEnabled then
		extraNodes=extraNodes.." isEnabled=\"false\""
	end
	
	self:printInfo('save to file: showMapHotspot = '..tostring(self.appearsOnMap))
	extraNodes=extraNodes.." showMapHotspot=\""..tostring(self.appearsOnMap).."\""
	
	local fillLevels = ""
	if self.storageType==UPK_Storage.SEPARATE then
		for _,flb in pairs(self.p_flbs) do
			local fillType = UniversalProcessKit.fillTypeIntToName[flb.fillType]
			local fillLevel = flb.fillLevel
			if fillType~="unknown" then
				if fillLevels~="" then
					fillLevels = fillLevels .. ' '
				end
				fillLevels = fillLevels .. tostring(round(fillLevel,4)) .. ' ' .. tostring(fillType)
			end
		end
	elseif self.storageType==UPK_Storage.SINGLE or self.storageType==UPK_Storage.FIFO or self.storageType==UPK_Storage.FILO then
		for i=1,#self.p_flbs do
			local flb = self.p_flbs[i]
			local fillType = UniversalProcessKit.fillTypeIntToName[flb.fillType]
			local fillLevel = flb.fillLevel
			if fillType~="unknown" then
				if fillLevels~="" then
					fillLevels = fillLevels .. ' '
				end
				fillLevels = fillLevels .. tostring(round(fillLevel,6)) .. ' ' .. tostring(fillType)
			end
		end
	end
	
	self:printInfo('fillLevels: '..tostring(fillLevels))
	
	if fillLevels~="" then
		extraNodes = extraNodes.." fillLevels=\"" .. tostring(fillLevels) .. "\""
	end
	
	if self.triggerId~=nil and self.triggerId~=0 then
		extraNodes = extraNodes.." entitiesInTrigger=\"" .. tostring(self.entitiesInTrigger) .. "\""
	end
	
	local extraNodesF = self:getSaveExtraNodes(nodeIdent)
	
	if extraNodesF ~= "" then
		extraNodes = extraNodes .. ' ' .. extraNodesF
	end
	
	local nodesKids=""
	
	for i=1,#self.kids do
		local attributesKid, nodesKid = self.kids[i]:getSaveAttributesAndNodes(nodeIdent)
		attributes = attributes .. attributesKid
		if nodesKid~="" then
			nodesKids = nodesKids .. nodesKid
		end
	end
	
	if nodesKids=="" then
		if extraNodes=="" then
			nodes=""
		else
			nodes = nodes .. extraNodes .. " />"
		end
	else
		nodes = nodes .. extraNodes ..">\n" .. "\t" .. nodesKids .. "\n" .. "</"..tostring(self.name)..">"
	end
	
	self:printInfo('nodes: '..tostring(nodes))
	
	return attributes, nodes
end;

-- use this function to load your extra Nodes (YourClass:loadExtraNodes)
function UniversalProcessKit:loadExtraNodes(xmlFile, key)
	self:printFn('UniversalProcessKit:loadExtraNodes('..tostring(xmlFile)..', '..tostring(key)..')')
	return true
end;

-- use this function to save your own values (YourClass:getSaveExtraNodes)
function UniversalProcessKit:getSaveExtraNodes(nodeIdent)
	self:printFn('UniversalProcessKit:getSaveExtraNodes('..tostring(nodeIdent)..')')
	return ""
end;