Script v1.7.1.0
- AI
- Animals
- Contracts
- Debug
- Economy
- Effects
- Events
- Farms
- GUI
- Handtools
- I3d
- Materials
- Misc
- AbstractManager
- AsyncManager
- AutoSaveManager
- BaleTypeManager
- BrandColorManager
- ConnectionHoseManager
- DeferredLoadingManager
- DepthOfFieldManager
- FillTypeManager
- FruitTypeManager
- GameplayHintManager
- GroundTypeManager
- HelpLineManager
- MapManager
- PlaceableTypeManager
- SleepManager
- SplitTypeManager
- SprayTypeManager
- TensionBeltManager
- ToolTypeManager
- TreePlantManager
- Objects
- Placeables
- Player
- Shop
- Sounds
- Specializations
- Triggers
- Utils
- Vehicles
- Weather
Engine v1.7.1.0
- AI
- Animation
- Camera
- Entity
- Fillplanes
- General
- I3D
- Input
- Lighting
- Math
- Network
- Node
- Overlays
- Particle System
- Physics
- Rendering
- Scenegraph
- Shape
- Sound
- Spline
- String
- Terrain Detail
- Text Rendering
- Tire Track
- XML
- general
Foundation Reference
SprayTypeManager
DescriptionThis class handles all sprayTypesParent
AbstractManagerFunctions
- getFillTypeByName
- getFillTypeIndexByName
- getFillTypeNameByIndex
- getSprayTypeByIndex
- getSprayTypeByName
- getSprayTypeIndexByFillTypeIndex
- getSprayTypes
- initDataStructures
- loadMapData
- loadSprayTypes
- new
getFillTypeByName
DescriptionGets a sprayType by index nameDefinition
getFillTypeByName(string name)Arguments
| string | name | the sprayType index name |
| table | sprayType | the sprayType object |
| 185 | function SprayTypeManager:getFillTypeByName(name) |
| 186 | if name ~= nil then |
| 187 | name = name:upper() |
| 188 | return self.nameToSprayType[name] |
| 189 | end |
| 190 | return nil |
| 191 | end |
getFillTypeIndexByName
DescriptionGets a sprayType index by nameDefinition
getFillTypeIndexByName(string name)Arguments
| string | name | the sprayType index name |
| integer | fillTypeIndex | the sprayType index |
| 173 | function SprayTypeManager:getFillTypeIndexByName(name) |
| 174 | if name ~= nil then |
| 175 | name = name:upper() |
| 176 | return self.nameToIndex[name] |
| 177 | end |
| 178 | return nil |
| 179 | end |
getFillTypeNameByIndex
DescriptionGets a fillTypeName by indexDefinition
getFillTypeNameByIndex(integer index)Arguments
| integer | index | the sprayType index |
| string | fillTypeName | the sprayType name |
| 162 | function SprayTypeManager:getFillTypeNameByIndex(index) |
| 163 | if index ~= nil then |
| 164 | return self.indexToName[index] |
| 165 | end |
| 166 | return nil |
| 167 | end |
getSprayTypeByIndex
DescriptionGets a sprayType by indexDefinition
getSprayTypeByIndex(integer index)Arguments
| integer | index | the sprayType index |
| table | sprayType | the sprayType object |
| 139 | function SprayTypeManager:getSprayTypeByIndex(index) |
| 140 | if index ~= nil then |
| 141 | return self.sprayTypes[index] |
| 142 | end |
| 143 | return nil |
| 144 | end |
getSprayTypeByName
DescriptionGets a sprayType by nameDefinition
getSprayTypeByName(string name)Arguments
| string | name | the sprayType name |
| table | sprayType | the sprayType object |
| 150 | function SprayTypeManager:getSprayTypeByName(name) |
| 151 | if name ~= nil then |
| 152 | name = name:upper() |
| 153 | return self.nameToSprayType[name] |
| 154 | end |
| 155 | return nil |
| 156 | end |
getSprayTypeIndexByFillTypeIndex
DescriptionGets a sprayTypeIndex by fillType indexDefinition
getSprayTypeIndexByFillTypeIndex(integer index)Arguments
| integer | index | the fillType index |
| integer | sprayTypeIndex | the sprayType index |
| 204 | function SprayTypeManager:getSprayTypeIndexByFillTypeIndex(index) |
| 205 | if index ~= nil then |
| 206 | local sprayType = self.fillTypeIndexToSprayType[index] |
| 207 | if sprayType ~= nil then |
| 208 | return sprayType.index |
| 209 | end |
| 210 | end |
| 211 | return nil |
| 212 | end |
getSprayTypes
DescriptionGets a list of sprayTypesDefinition
getSprayTypes()Return Values
| table | sprayTypes | list of sprayTypes |
| 217 | function SprayTypeManager:getSprayTypes() |
| 218 | return self.sprayTypes |
| 219 | end |
initDataStructures
DescriptionInitialize data structuresDefinition
initDataStructures()Code
| 25 | function SprayTypeManager:initDataStructures() |
| 26 | self.numSprayTypes = 0 |
| 27 | self.sprayTypes = {} |
| 28 | self.nameToSprayType = {} |
| 29 | self.nameToIndex = {} |
| 30 | self.indexToName = {} |
| 31 | self.fillTypeIndexToSprayType = {} |
| 32 | |
| 33 | SprayType = self.nameToIndex |
| 34 | end |
loadMapData
DescriptionLoad data on map loadDefinition
loadMapData()Return Values
| boolean | true | if loading was successful else false |
| 45 | function SprayTypeManager:loadMapData(xmlFile, missionInfo, baseDirectory) |
| 46 | SprayTypeManager:superClass().loadMapData(self) |
| 47 | self:loadDefaultTypes() |
| 48 | return XMLUtil.loadDataFromMapXML(xmlFile, "sprayTypes", baseDirectory, self, self.loadSprayTypes, missionInfo) |
| 49 | end |
loadSprayTypes
DescriptionLoad data on map loadDefinition
loadSprayTypes()Return Values
| boolean | true | if loading was successful else false |
| 54 | function SprayTypeManager:loadSprayTypes(xmlFile, missionInfo, isBaseType) |
| 55 | local i = 0 |
| 56 | while true do |
| 57 | local key = string.format("map.sprayTypes.sprayType(%d)", i) |
| 58 | if not hasXMLProperty(xmlFile, key) then |
| 59 | break |
| 60 | end |
| 61 | |
| 62 | local name = getXMLString(xmlFile, key.."#name") |
| 63 | local litersPerSecond = getXMLFloat(xmlFile, key.."#litersPerSecond") |
| 64 | local typeName = getXMLString(xmlFile, key.."#type") |
| 65 | local groundType = getXMLInt(xmlFile, key.."#groundType") |
| 66 | |
| 67 | self:addSprayType(name, litersPerSecond, typeName, groundType, isBaseType) |
| 68 | |
| 69 | i = i + 1 |
| 70 | end |
| 71 | |
| 72 | return true |
| 73 | end |
new
DescriptionCreating managerDefinition
new()Return Values
| table | instance | instance of object |
| 18 | function SprayTypeManager:new(customMt) |
| 19 | local self = AbstractManager:new(customMt or SprayTypeManager_mt) |
| 20 | return self |
| 21 | end |