LUADOC - Farming Simulator 19

HelpLineManager

Description
This class handles all basic functionality for map help line
Parent
AbstractManager
Functions

getCategories

Description
Gets a list of all categories
Definition
getCategories()
Return Values
tablecategoriesa list of categories
Code
135function HelpLineManager:getCategories()
136 return self.categories
137end

getCategory

Description
Gets a category by category index
Definition
getCategory(integer categoryIndex)
Arguments
integercategoryIndexcategory index
Return Values
tablecategorythe corresponding category
Code
143function HelpLineManager:getCategory(categoryIndex)
144 if categoryIndex ~= nil then
145 return self.categories[categoryIndex]
146 end
147 return nil
148end

initDataStructures

Description
Initialize data structures
Definition
initDataStructures()
Code
28function HelpLineManager:initDataStructures()
29 self.categories = {}
30 self.categoryNames = {}
31end

loadMapData

Description
Load data on map load
Definition
loadMapData()
Return Values
booleantrueif loading was successful else false
Code
36function HelpLineManager:loadMapData(xmlFile, missionInfo)
37 HelpLineManager:superClass().loadMapData(self)
38
39 local filename = Utils.getFilename(getXMLString(xmlFile, "map.helpline#filename"), g_currentMission.baseDirectory)
40 if filename == nil or filename == "" then
41 print("Error: Could not load helpline config file '"..tostring(filename).."'!")
42 return false
43 end
44
45 self:loadFromXML(filename, missionInfo)
46
47 return true
48end

new

Description
Creating manager
Definition
new()
Return Values
tableinstanceinstance of object
Code
20function HelpLineManager:new(customMt)
21 local self = AbstractManager:new(customMt or HelpLineManager_mt)
22
23 return self
24end