LUADOC - Farming Simulator 19

FillTypeManager

Description
This class handles all fillTypes and fillTypeCategories
Parent
AbstractManager
Functions

getFillTypeByIndex

Description
Gets a fillType by index
Definition
getFillTypeByIndex(integer index)
Arguments
integerindexthe fillType index
Return Values
tablefillTypethe fillType object
Code
309function FillTypeManager:getFillTypeByIndex(index)
310 if index ~= nil then
311 return self.fillTypes[index]
312 end
313 return nil
314end

getFillTypeByName

Description
Gets a fillType by index name
Definition
getFillTypeByName(string name)
Arguments
stringnamethe fillType index name
Return Values
tablefillTypethe fillType object
Code
343function FillTypeManager:getFillTypeByName(name)
344 if ClassUtil.getIsValidIndexName(name) then
345 name = name:upper()
346 return self.nameToFillType[name]
347 end
348 return nil
349end

getFillTypeIndexByName

Description
Gets a fillType index by name
Definition
getFillTypeIndexByName(string name)
Arguments
stringnamethe fillType index name
Return Values
integerfillTypeIndexthe fillType index
Code
331function FillTypeManager:getFillTypeIndexByName(name)
332 if name ~= nil then
333 name = name:upper()
334 return self.nameToIndex[name]
335 end
336 return nil
337end

getFillTypeNameByIndex

Description
Gets a fillTypeName by index
Definition
getFillTypeNameByIndex(integer index)
Arguments
integerindexthe fillType index
Return Values
stringfillTypeNamethe fillType name
Code
320function FillTypeManager:getFillTypeNameByIndex(index)
321 if index ~= nil then
322 return self.indexToName[index]
323 end
324 return nil
325end

getFillTypes

Description
Gets a list of fillTypes
Definition
getFillTypes()
Return Values
tablefillTypeslist of fillTypes
Code
354function FillTypeManager:getFillTypes()
355 return self.fillTypes
356end

getFillTypesByCategoryNames

Description
Gets a list of fillTypes of the given category names
Definition
getFillTypesByCategoryNames(string name, string warning)
Arguments
stringnamefillType category index names
stringwarninga warning text shown if a category is not found
Return Values
tablefillTypeslist of fillTypes
Code
406function FillTypeManager:getFillTypesByCategoryNames(names, warning)
407 local fillTypes = {}
408 local alreadyAdded = {}
409 local categories = StringUtil.splitString(" ", names);
410 for _, categoryName in pairs(categories) do
411 categoryName = categoryName:upper()
412 local categoryFillTypes = self.categoryNameToFillTypes[categoryName];
413 if categoryFillTypes ~= nil then
414 for fillType, _ in pairs(categoryFillTypes) do
415 if alreadyAdded[fillType] == nil then
416 table.insert(fillTypes, fillType);
417 alreadyAdded[fillType] = true
418 end
419 end
420 else
421 if warning ~= nil then
422 print(string.format(warning, categoryName));
423 end
424 end
425 end
426 return fillTypes
427end

initDataStructures

Description
Initialize data structures
Definition
initDataStructures()
Code
30function FillTypeManager:initDataStructures()
31 self.fillTypes = {}
32 self.nameToFillType = {}
33 self.indexToFillType = {}
34 self.nameToIndex = {}
35 self.indexToName = {}
36
37 self.fillTypeConverters = {}
38 self.converterNameToIndex = {}
39 self.nameToConverter = {}
40
41 self.categories = {}
42 self.nameToCategoryIndex = {}
43 self.categoryIndexToFillTypes = {}
44 self.categoryNameToFillTypes = {}
45
46 self.fillTypeSamples = {}
47 self.fillTypeToSample = {}
48
49 FillType = self.nameToIndex
50 FillTypeCategory = self.categories
51end

loadMapData

Description
Load data on map load
Definition
loadMapData()
Return Values
booleantrueif loading was successful else false
Code
62function FillTypeManager:loadMapData(xmlFile, missionInfo, baseDirectory)
63 FillTypeManager:superClass().loadMapData(self)
64
65 self:loadDefaultTypes()
66 return XMLUtil.loadDataFromMapXML(xmlFile, "fillTypes", baseDirectory, self, self.loadFillTypes, missionInfo, baseDirectory)
67end

new

Description
Creating manager
Definition
new()
Return Values
tableinstanceinstance of object
Code
23function FillTypeManager:new(customMt)
24 local self = AbstractManager:new(customMt or FillTypeManager_mt)
25 return self
26end