Script v1.7.1.0
- AI
- Animals
- Contracts
- Debug
- Economy
- Effects
- Events
- Farms
- GUI
- Handtools
- I3d
- Materials
- Misc
- Objects
- Placeables
- Player
- Player
- PlayerModelManager
- PlayerPickUpObjectEvent
- PlayerSetFarmAnswerEvent
- PlayerSetFarmEvent
- PlayerSetHandToolEvent
- PlayerStateActivateObject
- PlayerStateAnimalFeed
- PlayerStateAnimalInteract
- PlayerStateAnimalPet
- PlayerStateAnimalRide
- PlayerStateBase
- PlayerStateCrouch
- PlayerStateCycleHandtool
- PlayerStateDrop
- PlayerStateFall
- PlayerStateIdle
- PlayerStateJump
- PlayerStateMachine
- PlayerStatePickup
- PlayerStateRun
- PlayerStateSwim
- PlayerStateThrow
- PlayerStateUseLight
- PlayerStateWalk
- PlayerStyle
- PlayerSwitchedFarmEvent
- PlayerTeleportEvent
- PlayerThrowObjectEvent
- PlayerToggleLightEvent
- 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
PlayerModelManager
DescriptionThis class handles player modelsFunctions
- addPlayerModel
- getNumOfPlayerModels
- getPlayerByName
- getPlayerModelByIndex
- initDataStructures
- load
- loadMapData
- new
- unloadMapData
addPlayerModel
DescriptionAdds a new playerDefinition
addPlayerModel(string name, string xmlFilename, string description, string baseDir)Arguments
| string | name | index name |
| string | xmlFilename | xml filename |
| string | description | description |
| string | baseDir | the base directory |
| boolean | true | if added successful else false |
| 108 | function PlayerModelManager:addPlayerModel(name, xmlFilename, description, genderId) |
| 109 | if not ClassUtil.getIsValidIndexName(name) then |
| 110 | g_logManager:devWarning("Warning: '%s' is not a valid name for a player. Ignoring it!", tostring(name)) |
| 111 | return nil |
| 112 | end |
| 113 | if xmlFilename == nil or xmlFilename == "" then |
| 114 | g_logManager:devWarning("Warning: Config xmlFilename is missing for player '%s'. Ignoring it!", tostring(name)) |
| 115 | return nil |
| 116 | end |
| 117 | |
| 118 | name = name:upper() |
| 119 | |
| 120 | if self.nameToPlayerModel[name] == nil then |
| 121 | local numPlayerModels = #self.playerModels + 1 |
| 122 | local playerModel = {} |
| 123 | |
| 124 | playerModel.name = name |
| 125 | playerModel.index = numPlayerModels |
| 126 | playerModel.xmlFilename = Utils.getFilename(xmlFilename, nil) |
| 127 | playerModel.description = description |
| 128 | playerModel.genderId = genderId |
| 129 | table.insert(self.playerModels, playerModel) |
| 130 | self.nameToPlayerModel[name] = playerModel |
| 131 | self.nameToIndex[name] = numPlayerModels |
| 132 | return playerModel |
| 133 | else |
| 134 | g_logManager:devWarning("Warning: Player '%s' already exists. Ignoring it!", tostring(name)) |
| 135 | end |
| 136 | |
| 137 | return nil |
| 138 | end |
getNumOfPlayerModels
DescriptionGets number of available player modelsDefinition
getNumOfPlayerModels()Return Values
| integer | number | number of models |
| 166 | function PlayerModelManager:getNumOfPlayerModels() |
| 167 | return #self.playerModels |
| 168 | end |
getPlayerByName
DescriptionGets a player by index nameDefinition
getPlayerByName(string name)Arguments
| string | name | the player index name |
| table | player | the player object |
| 155 | function PlayerModelManager:getPlayerByName(name) |
| 156 | if name ~= nil then |
| 157 | name = name:upper() |
| 158 | return self.nameToPlayerModel[name] |
| 159 | end |
| 160 | return nil |
| 161 | end |
getPlayerModelByIndex
DescriptionGets a player by indexDefinition
getPlayerModelByIndex(integer index)Arguments
| integer | index | the player index |
| table | player | the player object |
| 144 | function PlayerModelManager:getPlayerModelByIndex(index) |
| 145 | if index ~= nil then |
| 146 | return self.playerModels[index] |
| 147 | end |
| 148 | return nil |
| 149 | end |
initDataStructures
DescriptionInitialize data structuresDefinition
initDataStructures()Code
| 36 | function PlayerModelManager:initDataStructures() |
| 37 | self.playerModels = {} |
| 38 | self.nameToPlayerModel = {} |
| 39 | self.nameToIndex = {} |
| 40 | end |
load
DescriptionLoads initial managerDefinition
load()Return Values
| boolean | true | if loading was successful else false |
| 45 | function PlayerModelManager:load(xmlFilename) |
| 46 | local result = false |
| 47 | if xmlFilename ~= nil and xmlFilename ~= "" then |
| 48 | local xmlFile = loadXMLFile("TempXML", xmlFilename) |
| 49 | if xmlFile ~= nil and xmlFile ~= 0 then |
| 50 | local i = 0 |
| 51 | |
| 52 | while true do |
| 53 | local baseKey = "playerModels.playerModel" |
| 54 | local XMLFilenameKey = string.format("%s(%d)#xmlFilename", baseKey, i) |
| 55 | local genderKey = string.format("%s(%d)#gender", baseKey, i) |
| 56 | local defaultNameKey = string.format("%s(%d)#defaultName", baseKey, i) |
| 57 | local descKey = string.format("%s(%d)#desc", baseKey, i) |
| 58 | |
| 59 | if not hasXMLProperty(xmlFile, XMLFilenameKey) or not hasXMLProperty(xmlFile, genderKey) or not hasXMLProperty(xmlFile, defaultNameKey) or not hasXMLProperty(xmlFile, descKey) then |
| 60 | break |
| 61 | end |
| 62 | local modelXMLFilename = getXMLString(xmlFile, XMLFilenameKey) |
| 63 | local modelGender = getXMLString(xmlFile, genderKey) |
| 64 | local modelDefaultName = getXMLString(xmlFile, defaultNameKey) |
| 65 | local modelDesc = getXMLString(xmlFile, descKey) |
| 66 | |
| 67 | local modelGenderId = PlayerModelManager.GENDERS.GENDER_NONE |
| 68 | modelGender = modelGender:upper() |
| 69 | if modelGender == "FEMALE" then |
| 70 | modelGenderId = PlayerModelManager.GENDERS.GENDER_FEMALE |
| 71 | else |
| 72 | modelGenderId = PlayerModelManager.GENDERS.GENDER_MALE |
| 73 | end |
| 74 | if self:addPlayerModel(modelDefaultName, modelXMLFilename, modelDesc, modelGenderId) ~= nil then |
| 75 | result = true |
| 76 | end |
| 77 | i = i + 1 |
| 78 | end |
| 79 | delete(xmlFile) |
| 80 | else |
| 81 | print(string.format("Warning: Cannot open xmlFilename('%s') is missing for player model manager.", tostring(xmlFilename))) |
| 82 | end |
| 83 | else |
| 84 | print(string.format("Warning: Config xmlFilename('%s') is missing for player model manager.", tostring(xmlFilename))) |
| 85 | end |
| 86 | return result |
| 87 | end |
loadMapData
DescriptionLoad data on map loadDefinition
loadMapData()Return Values
| boolean | true | if loading was successful else false |
| 92 | function PlayerModelManager:loadMapData(xmlFile) |
| 93 | return true |
| 94 | end |
new
DescriptionCreating managerDefinition
new()Return Values
| table | instance | instance of object |
| 25 | function PlayerModelManager:new(customMt) |
| 26 | local self = {} |
| 27 | setmetatable(self, customMt or PlayerModelManager_mt) |
| 28 | |
| 29 | self:initDataStructures() |
| 30 | |
| 31 | return self |
| 32 | end |
unloadMapData
DescriptionUnload data on mission deleteDefinition
unloadMapData()Code
| 98 | function PlayerModelManager:unloadMapData() |
| 99 | end |