LUADOC - Farming Simulator 19

ConfigurationManager

Description
This class handles all configuration types
Parent
AbstractManager
Functions

getConfigurationAttribute

Description
Returns configuration attribute by given name and attribute
Definition
getConfigurationAttribute(string configurationName, string attribute)
Arguments
stringconfigurationNamename of config
stringattributename of attribute
Return Values
any_typevaluevalue of attribute
Code
112function ConfigurationManager:getConfigurationAttribute(configurationName, attribute)
113 local config = self:getConfigurationDescByName(configurationName)
114 return config[attribute]
115end

getConfigurationDescByName

Description
Returns configuration desc by name
Definition
getConfigurationDescByName(string name)
Arguments
stringnamename of config
Return Values
tableconfigurationconfiguration
Code
103function ConfigurationManager:getConfigurationDescByName(name)
104 return self.configurations[name]
105end

getConfigurationIndexByName

Description
Returns configuration index by given name
Definition
getConfigurationIndexByName(string name)
Arguments
stringnamename of config
Return Values
integerindexindex of config
Code
95function ConfigurationManager:getConfigurationIndexByName(name)
96 return self.configurationNameToInt[name]
97end

getConfigurationNameByIndex

Description
Returns configuration name by given index
Definition
getConfigurationNameByIndex(integer index)
Arguments
integerindexindex of config
Return Values
stringnamename of config
Code
87function ConfigurationManager:getConfigurationNameByIndex(index)
88 return self.intToConfigurationName[index]
89end

getConfigurationTypes

Description
Returns a table of the available configuration types
Definition
getConfigurationTypes()
Return Values
tableListof configuration types (names)
Code
79function ConfigurationManager:getConfigurationTypes()
80 return self.intToConfigurationName
81end

getNumOfConfigurationTypes

Description
Returns number of configuration types
Definition
getNumOfConfigurationTypes()
Return Values
integernumOfConfigurationTypesnumber of configuration types
Code
72function ConfigurationManager:getNumOfConfigurationTypes()
73 return table.getn(self.intToConfigurationName)
74end

initDataStructures

Description
Initialize data structures
Definition
initDataStructures()
Code
26function ConfigurationManager:initDataStructures()
27 self.configurations = {}
28 self.intToConfigurationName = {}
29 self.configurationNameToInt = {}
30end

new

Description
Creating manager
Definition
new()
Return Values
tableinstanceinstance of object
Code
16function ConfigurationManager:new(customMt)
17 local self = AbstractManager:new(customMt or ConfigurationManager_mt)
18
19 self:initDataStructures()
20
21 return self
22end