require("config") require("enumerations") require("patterns") stateHelper = require("stateHelper") tableHelper = require("tableHelper") local BasePlayer = class("BasePlayer") function BasePlayer:__init(pid, playerName) self.dbPid = nil self.data = { login = { name = "", password = "" }, settings = { staffRank = 0, difficulty = "default", consoleAllowed = "default", bedRestAllowed = "default", wildernessRestAllowed = "default", waitAllowed = "default", enforcedLogLevel = "default", physicsFramerate = "default" }, character = { race = "", head = "", hair = "", gender = 1, class = "", birthsign = "" }, location = { cell = "", regionName = "", posX = 0, posY = 0, posZ = 0, rotX = 0, rotZ = 0 }, stats = { level = 1, levelProgress = 0, healthBase = 1, healthCurrent = 1, magickaBase = 1, magickaCurrent = 1, fatigueBase = 1, fatigueCurrent = 1 }, fame = { bounty = 0, reputation = 0 }, miscellaneous = { markLocation = { cell = "", posX = 0, posY = 0, posZ = 0, rotX = 0, rotZ = 0 }, selectedSpell = "" }, customClass = {}, attributes = {}, attributeSkillIncreases = {}, skills = {}, skillProgress = {}, equipment = {}, inventory = {}, spellbook = {}, quickKeys = {}, shapeshift = {}, journal = {}, factionRanks = {}, factionExpulsion = {}, factionReputation = {}, topics = {}, books = {}, mapExplored = {}, ipAddresses = {}, recordLinks = {}, customVariables = {} } for index = 0, (tes3mp.GetAttributeCount() - 1) do local attributeName = tes3mp.GetAttributeName(index) self.data.attributes[attributeName] = 1 self.data.attributeSkillIncreases[attributeName] = 0 end for index = 0, (tes3mp.GetSkillCount() - 1) do local skillName = tes3mp.GetSkillName(index) self.data.skills[skillName] = 1 self.data.skillProgress[skillName] = 0 end self.initTimestamp = os.time() if playerName == nil then self.accountName = tes3mp.GetName(pid) else self.accountName = playerName end self.pid = pid self.loggedIn = false self.loginTimerId = nil self.hasAccount = nil self.cellsLoaded = {} self.summons = {} self.generatedRecordsReceived = {} self.unresolvedEnchantments = {} self.hasFinishedInitialTeleportation = false end function BasePlayer:Destroy() if self.loginTimerId ~= nil then tes3mp.StopTimer(self.loginTimerId) self.loginTimerId = nil end self.loggedIn = false self.hasAccount = nil end function BasePlayer:Kick() self:Destroy() tes3mp.Kick(self.pid) end function BasePlayer:Register(password) self.loggedIn = true self.data.login.password = password self.data.settings.consoleAllowed = "default" if not self.hasAccount then tes3mp.SetCharGenStage(self.pid, 1, 4) end end function BasePlayer:FinishLogin() self.loggedIn = true if self.hasAccount ~= false then -- load account self:SaveIpAddress() self:LoadSettings() self:LoadCharacter() self:LoadClass() self:LoadLevel() self:LoadAttributes() self:LoadSkills() self:LoadStatsDynamic() WorldInstance:LoadTime(self.pid, false) WorldInstance:LoadWeather(self.pid, false) if self.data.recordLinks == nil then self.data.recordLinks = {} end for _, storeType in ipairs(config.recordStoreLoadOrder) do local recordStore = RecordStores[storeType] if recordStore ~= nil then -- Load all the permanent records in this record store recordStore:LoadRecords(self.pid, recordStore.data.permanentRecords, tableHelper.getArrayFromIndexes(recordStore.data.permanentRecords)) -- Load the generated records linked to us in this record store if self.data.recordLinks[storeType] ~= nil then recordStore:LoadGeneratedRecords(self.pid, recordStore.data.generatedRecords, self.data.recordLinks[storeType]) end end end self:CleanInventory() self:LoadInventory() self:LoadEquipment() self:CleanSpellbook() self:LoadSpellbook() self:LoadQuickKeys() self:LoadBooks() self:LoadShapeshift() self:LoadMarkLocation() self:LoadSelectedSpell() if config.shareJournal == true then WorldInstance:LoadJournal(self.pid) else self:LoadJournal() end if config.shareFactionRanks == true then WorldInstance:LoadFactionRanks(self.pid) else self:LoadFactionRanks() end if config.shareFactionExpulsion == true then WorldInstance:LoadFactionExpulsion(self.pid) else self:LoadFactionExpulsion() end if config.shareFactionReputation == true then WorldInstance:LoadFactionReputation(self.pid) else self:LoadFactionReputation() end if config.shareTopics == true then WorldInstance:LoadTopics(self.pid) else self:LoadTopics() end if config.shareBounty == true then WorldInstance:LoadBounty(self.pid) else self:LoadBounty() end if config.shareReputation == true then WorldInstance:LoadReputation(self.pid) else self:LoadReputation() end WorldInstance:LoadKills(self.pid) self:LoadSpecialStates() if config.shareMapExploration == true then WorldInstance:LoadMap(self.pid) else self:LoadMap() end self:LoadCell() end end function BasePlayer:EndCharGen() self:SaveLogin() self:SaveCharacter() self:SaveClass() self:SaveStatsDynamic() self:SaveEquipment() self:SaveIpAddress() self:CreateAccount() WorldInstance:LoadTime(self.pid, false) WorldInstance:LoadWeather(self.pid, false, true) for _, storeType in ipairs(config.recordStoreLoadOrder) do local recordStore = RecordStores[storeType] -- Load all the permanent records in this record store recordStore:LoadRecords(self.pid, recordStore.data.permanentRecords, tableHelper.getArrayFromIndexes(recordStore.data.permanentRecords)) end if config.shareJournal == true then WorldInstance:LoadJournal(self.pid) end if config.shareFactionRanks == true then WorldInstance:LoadFactionRanks(self.pid) end if config.shareFactionExpulsion == true then WorldInstance:LoadFactionExpulsion(self.pid) end if config.shareFactionReputation == true then WorldInstance:LoadFactionReputation(self.pid) end if config.shareTopics == true then WorldInstance:LoadTopics(self.pid) end WorldInstance:LoadKills(self.pid) if config.defaultSpawnCell ~= nil then tes3mp.SetCell(self.pid, config.defaultSpawnCell) tes3mp.SendCell(self.pid) if config.defaultSpawnPos ~= nil and config.defaultSpawnRot ~= nil then tes3mp.SetPos(self.pid, config.defaultSpawnPos[1], config.defaultSpawnPos[2], config.defaultSpawnPos[3]) tes3mp.SetRot(self.pid, config.defaultSpawnRot[1], config.defaultSpawnRot[2]) tes3mp.SendPos(self.pid) end end if config.shareJournal == true and WorldInstance.data.customVariables ~= nil then if WorldInstance.data.customVariables.deliveredCaiusPackage ~= true then local item = { refId = "bk_a1_1_caiuspackage", count = 1, charge = -1, enchantmentCharge = -1, soul = "" } inventoryHelper.addItem(self.data.inventory, item.refId, item.count, item.charge, item.enchantmentCharge, item.soul) self:LoadItemChanges({item}, enumerations.inventory.ADD) tes3mp.MessageBox(self.pid, -1, "Multiplayer skips over the original character generation." .. "\n\nAs a result, you start out with Caius Cosades' package.") end end end function BasePlayer:IsLoggedIn() return self.loggedIn end function BasePlayer:IsServerStaff() return self.data.settings.staffRank > 0 end function BasePlayer:IsServerOwner() return self.data.settings.staffRank == 3 end function BasePlayer:IsAdmin() return self.data.settings.staffRank >= 2 end function BasePlayer:IsModerator() return self.data.settings.staffRank >= 1 end function BasePlayer:AddLinkToRecord(storeType, recordId) if self.data.recordLinks == nil then self.data.recordLinks = {} end local recordStore = RecordStores[storeType] if recordStore ~= nil then local recordLinks = self.data.recordLinks if recordLinks[storeType] == nil then recordLinks[storeType] = {} end if not tableHelper.containsValue(recordLinks[storeType], recordId) then table.insert(recordLinks[storeType], recordId) end recordStore:AddLinkToPlayer(recordId, self) recordStore:Save() end end function BasePlayer:RemoveLinkToRecord(storeType, recordId) local recordStore = RecordStores[storeType] if recordStore ~= nil then local recordLinks = self.data.recordLinks if recordLinks ~= nil and recordLinks[storeType] ~= nil then local linkIndex = tableHelper.getIndexByValue(recordLinks[storeType], recordId) if linkIndex ~= nil then recordLinks[storeType][linkIndex] = nil tableHelper.cleanNils(recordLinks[storeType]) end recordStore:RemoveLinkToPlayer(recordId, self) recordStore:Save() end end end function BasePlayer:GetHealthCurrent() self.data.stats.healthCurrent = tes3mp.GetHealthCurrent(self.pid) return self.data.stats.healthCurrent end function BasePlayer:SetHealthCurrent(health) self.data.stats.healthCurrent = health tes3mp.SetHealthCurrent(self.pid, health) end function BasePlayer:GetHealthBase() self.data.stats.healthBase = tes3mp.GetHealthBase(self.pid) return self.data.stats.healthBase end function BasePlayer:SetHealthBase(health) self.data.stats.healthBase = health tes3mp.SetHealthBase(self.pid, health) end function BasePlayer:HasAccount() return self.hasAccount end function BasePlayer:Message(message) tes3mp.SendMessage(self.pid, message, false) end function BasePlayer:CreateAccount() error("Not implemented") end function BasePlayer:Save() error("Not implemented") end function BasePlayer:Load() error("Not implemented") end function BasePlayer:SaveLogin() self.data.login.name = tes3mp.GetName(self.pid) end function BasePlayer:SaveIpAddress() if self.data.ipAddresses == nil then self.data.ipAddresses = {} end local ipAddress = tes3mp.GetIP(self.pid) if not tableHelper.containsValue(self.data.ipAddresses, ipAddress) then table.insert(self.data.ipAddresses, ipAddress) end end function BasePlayer:ProcessDeath() local deathReason = "committed suicide" if tes3mp.DoesPlayerHavePlayerKiller(self.pid) then local killerPid = tes3mp.GetPlayerKillerPid(self.pid) if self.pid ~= killerPid then deathReason = "was killed by player " .. logicHandler.GetChatName(killerPid) end else local killerName = tes3mp.GetPlayerKillerName(self.pid) if killerName ~= "" then deathReason = "was killed by " .. killerName end end local message = logicHandler.GetChatName(self.pid) .. " " .. deathReason .. ".\n" tes3mp.SendMessage(self.pid, message, true) if config.playersRespawn then self.resurrectTimerId = tes3mp.CreateTimerEx("OnDeathTimeExpiration", time.seconds(config.deathTime), "i", self.pid) tes3mp.StartTimer(self.resurrectTimerId) else tes3mp.SendMessage(self.pid, "You have died permanently.", false) end end function BasePlayer:Resurrect() local currentResurrectType if config.respawnAtImperialShrine == true then if config.respawnAtTribunalTemple == true then if math.random() > 0.5 then currentResurrectType = enumerations.resurrect.IMPERIAL_SHRINE else currentResurrectType = enumerations.resurrect.TRIBUNAL_TEMPLE end else currentResurrectType = enumerations.resurrect.IMPERIAL_SHRINE end elseif config.respawnAtTribunalTemple == true then currentResurrectType = enumerations.resurrect.TRIBUNAL_TEMPLE elseif config.defaultRespawnCell ~= nil then currentResurrectType = enumerations.resurrect.REGULAR tes3mp.SetCell(self.pid, config.defaultRespawnCell) tes3mp.SendCell(self.pid) if config.defaultRespawnPos ~= nil and config.defaultRespawnRot ~= nil then tes3mp.SetPos(self.pid, config.defaultRespawnPos[1], config.defaultRespawnPos[2], config.defaultRespawnPos[3]) tes3mp.SetRot(self.pid, config.defaultRespawnRot[1], config.defaultRespawnRot[2]) tes3mp.SendPos(self.pid) end end local message = "You have been revived" if currentResurrectType == enumerations.resurrect.IMPERIAL_SHRINE then message = message .. " at the nearest Imperial shrine" elseif currentResurrectType == enumerations.resurrect.TRIBUNAL_TEMPLE then message = message .. " at the nearest Tribunal temple" end message = message .. ".\n" -- Ensure that dying as a werewolf turns you back into your normal form if self.data.shapeshift.isWerewolf == true then self:SetWerewolfState(false) end -- Ensure that we unequip deadly items when applicable, to prevent an -- infinite death loop contentFixer.UnequipDeadlyItems(self.pid) tes3mp.Resurrect(self.pid, currentResurrectType) if config.deathPenaltyJailDays > 0 then local resurrectionText = "You've been revived and brought back here, " .. "but your skills have been affected by " local jailTime = config.deathPenaltyJailDays if config.bountyResetOnDeath == true then if config.bountyDeathPenalty == true then local currentBounty = tes3mp.GetBounty(self.pid) if currentBounty > 0 then jailTime = jailTime + math.floor(currentBounty / 100) resurrectionText = resurrectionText .. "your bounty and " end end tes3mp.SetBounty(self.pid, 0) tes3mp.SendBounty(self.pid) self:SaveBounty() end resurrectionText = resurrectionText .. "your time spent incapacitated.\n" tes3mp.Jail(self.pid, jailTime, true, true, "Recovering", resurrectionText) end tes3mp.SendMessage(self.pid, message, false) end function BasePlayer:DeleteSummons() if self.summons ~= nil then for summonUniqueIndex, summonRefId in pairs(self.summons) do tes3mp.LogAppend(enumerations.log.INFO, "- removing player's summon " .. summonUniqueIndex .. ", refId " .. summonRefId) local cell = logicHandler.GetCellContainingActor(summonUniqueIndex) if cell ~= nil then cell:DeleteObjectData(summonUniqueIndex) local splitIndex = summonUniqueIndex:split("-") logicHandler.DeleteObjectForEveryone(summonRefId, splitIndex[1], splitIndex[2]) end end end end function BasePlayer:LoadCharacter() tes3mp.SetRace(self.pid, self.data.character.race) tes3mp.SetHead(self.pid, self.data.character.head) tes3mp.SetHair(self.pid, self.data.character.hair) tes3mp.SetIsMale(self.pid, self.data.character.gender) tes3mp.SetBirthsign(self.pid, self.data.character.birthsign) tes3mp.SendBaseInfo(self.pid) end function BasePlayer:SaveCharacter() self.data.character.race = tes3mp.GetRace(self.pid) self.data.character.head = tes3mp.GetHead(self.pid) self.data.character.hair = tes3mp.GetHair(self.pid) self.data.character.gender = tes3mp.GetIsMale(self.pid) self.data.character.birthsign = tes3mp.GetBirthsign(self.pid) end function BasePlayer:LoadClass() if self.data.character.class ~= "custom" then tes3mp.SetDefaultClass(self.pid, self.data.character.class) elseif self.data.customClass ~= nil then tes3mp.SetClassName(self.pid, self.data.customClass.name) tes3mp.SetClassSpecialization(self.pid, self.data.customClass.specialization) if self.data.customClass.description ~= nil then tes3mp.SetClassDesc(self.pid, self.data.customClass.description) end local index = 0 for value in string.gmatch(self.data.customClass.majorAttributes, patterns.commaSplit) do tes3mp.SetClassMajorAttribute(self.pid, index, tes3mp.GetAttributeId(value)) index = index + 1 end index = 0 for value in string.gmatch(self.data.customClass.majorSkills, patterns.commaSplit) do tes3mp.SetClassMajorSkill(self.pid, index, tes3mp.GetSkillId(value)) index = index + 1 end index = 0 for value in string.gmatch(self.data.customClass.minorSkills, patterns.commaSplit) do tes3mp.SetClassMinorSkill(self.pid, index, tes3mp.GetSkillId(value)) index = index + 1 end end tes3mp.SendClass(self.pid) end function BasePlayer:SaveClass() if tes3mp.IsClassDefault(self.pid) == 1 then self.data.character.class = tes3mp.GetDefaultClass(self.pid) else self.data.character.class = "custom" self.data.customClass.name = tes3mp.GetClassName(self.pid) self.data.customClass.description = tes3mp.GetClassDesc(self.pid):gsub("\n", "\\n") self.data.customClass.specialization = tes3mp.GetClassSpecialization(self.pid) local majorAttributes = {} local majorSkills = {} local minorSkills = {} for index = 0, 1, 1 do majorAttributes[index + 1] = tes3mp.GetAttributeName(tonumber(tes3mp.GetClassMajorAttribute(self.pid, index))) end for index = 0, 4, 1 do majorSkills[index + 1] = tes3mp.GetSkillName(tonumber(tes3mp.GetClassMajorSkill(self.pid, index))) minorSkills[index + 1] = tes3mp.GetSkillName(tonumber(tes3mp.GetClassMinorSkill(self.pid, index))) end self.data.customClass.majorAttributes = table.concat(majorAttributes, ", ") self.data.customClass.majorSkills = table.concat(majorSkills, ", ") self.data.customClass.minorSkills = table.concat(minorSkills, ", ") end end function BasePlayer:LoadStatsDynamic() tes3mp.SetHealthBase(self.pid, self.data.stats.healthBase) tes3mp.SetMagickaBase(self.pid, self.data.stats.magickaBase) tes3mp.SetFatigueBase(self.pid, self.data.stats.fatigueBase) tes3mp.SetHealthCurrent(self.pid, self.data.stats.healthCurrent) tes3mp.SetMagickaCurrent(self.pid, self.data.stats.magickaCurrent) tes3mp.SetFatigueCurrent(self.pid, self.data.stats.fatigueCurrent) tes3mp.SendStatsDynamic(self.pid) end function BasePlayer:SaveStatsDynamic() local healthBase = tes3mp.GetHealthBase(self.pid) -- Sometimes, the player's base health gets set to 1 serverside; -- use this temporary fix until we figure why if healthBase > 1 then self.data.stats.healthBase = healthBase self.data.stats.magickaBase = tes3mp.GetMagickaBase(self.pid) self.data.stats.fatigueBase = tes3mp.GetFatigueBase(self.pid) self.data.stats.healthCurrent = tes3mp.GetHealthCurrent(self.pid) self.data.stats.magickaCurrent = tes3mp.GetMagickaCurrent(self.pid) self.data.stats.fatigueCurrent = tes3mp.GetFatigueCurrent(self.pid) end end function BasePlayer:LoadAttributes() for name, value in pairs(self.data.attributes) do tes3mp.SetAttributeBase(self.pid, tes3mp.GetAttributeId(name), value) end for name, value in pairs(self.data.attributeSkillIncreases) do tes3mp.SetSkillIncrease(self.pid, tes3mp.GetAttributeId(name), value) end tes3mp.SendAttributes(self.pid) end function BasePlayer:SaveAttributes() for name in pairs(self.data.attributes) do local attributeId = tes3mp.GetAttributeId(name) local baseValue = tes3mp.GetAttributeBase(self.pid, attributeId) local modifierValue = tes3mp.GetAttributeModifier(self.pid, attributeId) local maxAttributeValue = config.maxAttributeValue if name == "Speed" then maxAttributeValue = config.maxSpeedValue end if baseValue > maxAttributeValue then self:LoadAttributes() local message = "Your base " .. name .. " has exceeded the maximum allowed value " .. "and been reset to its last recorded one.\n" tes3mp.SendMessage(self.pid, message) elseif (baseValue + modifierValue) > maxAttributeValue then tes3mp.ClearAttributeModifier(self.pid, attributeId) tes3mp.SendAttributes(self.pid) local message = "Your " .. name .. " fortification has exceeded the maximum allowed " .. "value and been removed.\n" tes3mp.SendMessage(self.pid, message) else self.data.attributes[name] = baseValue self.data.attributeSkillIncreases[name] = tes3mp.GetSkillIncrease(self.pid, attributeId) end end end function BasePlayer:LoadSkills() for name, value in pairs(self.data.skills) do tes3mp.SetSkillBase(self.pid, tes3mp.GetSkillId(name), value) end for name, value in pairs(self.data.skillProgress) do tes3mp.SetSkillProgress(self.pid, tes3mp.GetSkillId(name), value) end tes3mp.SendSkills(self.pid) end function BasePlayer:SaveSkills() for name in pairs(self.data.skills) do local skillId = tes3mp.GetSkillId(name) local baseValue = tes3mp.GetSkillBase(self.pid, skillId) local modifierValue = tes3mp.GetSkillModifier(self.pid, skillId) local maxSkillValue = config.maxSkillValue if name == "Acrobatics" then maxSkillValue = config.maxAcrobaticsValue end if baseValue > maxSkillValue then self:LoadSkills() local message = "Your base " .. name .. " has exceeded the maximum allowed value " .. "and been reset to its last recorded one.\n" tes3mp.SendMessage(self.pid, message) elseif (baseValue + modifierValue) > maxSkillValue then tes3mp.ClearSkillModifier(self.pid, skillId) tes3mp.SendSkills(self.pid) local message = "Your " .. name .. " fortification has exceeded the maximum allowed " .. "value and been removed.\n" tes3mp.SendMessage(self.pid, message) else self.data.skills[name] = baseValue self.data.skillProgress[name] = tes3mp.GetSkillProgress(self.pid, skillId) end end end function BasePlayer:LoadLevel() tes3mp.SetLevel(self.pid, self.data.stats.level) tes3mp.SetLevelProgress(self.pid, self.data.stats.levelProgress) tes3mp.SendLevel(self.pid) end function BasePlayer:SaveLevel() self.data.stats.level = tes3mp.GetLevel(self.pid) self.data.stats.levelProgress = tes3mp.GetLevelProgress(self.pid) end function BasePlayer:LoadShapeshift() if self.data.shapeshift == nil then self.data.shapeshift = {} end if self.data.shapeshift.scale == nil then self.data.shapeshift.scale = 1 end if self.data.shapeshift.isWerewolf == nil then self.data.shapeshift.isWerewolf = false end if self.data.shapeshift.creatureRefId == nil then self.data.shapeshift.creatureRefId = "" end if self.data.shapeshift.displayCreatureName == nil then self.data.shapeshift.displayCreatureName = false end tes3mp.SetScale(self.pid, self.data.shapeshift.scale) tes3mp.SetWerewolfState(self.pid, self.data.shapeshift.isWerewolf) tes3mp.SetCreatureRefId(self.pid, self.data.shapeshift.creatureRefId) tes3mp.SetCreatureNameDisplayState(self.pid, self.data.shapeshift.displayCreatureName) tes3mp.SendShapeshift(self.pid) end function BasePlayer:SaveShapeshift() if self.data.shapeshift == nil then self.data.shapeshift = {} end local newScale = tes3mp.GetScale(self.pid) if newScale ~= self.data.shapeshift.scale then tes3mp.LogMessage(enumerations.log.INFO, "Player " .. logicHandler.GetChatName(self.pid) .. " has changed their scale to " .. newScale) self.data.shapeshift.scale = newScale end self.data.shapeshift.isWerewolf = tes3mp.IsWerewolf(self.pid) end function BasePlayer:LoadCell() if self.data.location ~= nil then local newCell = self.data.location.cell if newCell ~= nil then tes3mp.SetCell(self.pid, newCell) local pos = {0, 0, 0} local rot = {0, 0} pos[0] = self.data.location.posX pos[1] = self.data.location.posY pos[2] = self.data.location.posZ rot[0] = self.data.location.rotX rot[1] = self.data.location.rotZ if pos[0] ~= nil and pos[1] ~= nil and pos[2] ~= nil then tes3mp.SetPos(self.pid, pos[0], pos[1], pos[2]) end if rot[0] ~= nil and rot[1] ~= nil then tes3mp.SetRot(self.pid, rot[0], rot[1]) end tes3mp.SendCell(self.pid) tes3mp.SendPos(self.pid) local regionName = self.data.location.regionName if regionName ~= nil then logicHandler.LoadRegionForPlayer(self.pid, regionName, true) end end end end function BasePlayer:SaveCell() if self.data.location == nil then self.data.location = {} end -- Keep this around to update old player files if self.data.mapExplored == nil then self.data.mapExplored = {} end local cell = tes3mp.GetCell(self.pid) self.data.location.cell = cell self.data.location.posX = tes3mp.GetPosX(self.pid) self.data.location.posY = tes3mp.GetPosY(self.pid) self.data.location.posZ = tes3mp.GetPosZ(self.pid) self.data.location.rotX = tes3mp.GetRotX(self.pid) self.data.location.rotZ = tes3mp.GetRotZ(self.pid) stateHelper:SaveMapExploration(self.pid, self) end function BasePlayer:LoadEquipment() for index = 0, tes3mp.GetEquipmentSize() - 1 do local currentItem = self.data.equipment[index] if currentItem ~= nil then if currentItem.enchantmentCharge == nil then currentItem.enchantmentCharge = -1 end tes3mp.EquipItem(self.pid, index, currentItem.refId, currentItem.count, currentItem.charge, currentItem.enchantmentCharge) else tes3mp.UnequipItem(self.pid, index) end end tes3mp.SendEquipment(self.pid) end function BasePlayer:SaveEquipment() local reloadAtEnd = false self.data.equipment = {} for index = 0, tes3mp.GetEquipmentSize() - 1 do local itemRefId = tes3mp.GetEquipmentItemRefId(self.pid, index) if itemRefId ~= "" then if tableHelper.containsValue(config.bannedEquipmentItems, itemRefId) then self:Message("You have tried wearing an item that isn't allowed!\n") reloadAtEnd = true else self.data.equipment[index] = { refId = itemRefId, count = tes3mp.GetEquipmentItemCount(self.pid, index), charge = tes3mp.GetEquipmentItemCharge(self.pid, index), enchantmentCharge = tes3mp.GetEquipmentItemEnchantmentCharge(self.pid, index) } end end end if reloadAtEnd then self:LoadEquipment() end end -- Iterate through inventory items and remove the ones whose records no longer exist -- Note: This can only handle generated records for now function BasePlayer:CleanInventory() for index, currentItem in pairs(self.data.inventory) do if logicHandler.IsGeneratedRecord(currentItem.refId) then local recordStore = logicHandler.GetRecordStoreByRecordId(currentItem.refId) if recordStore == nil or recordStore.data.generatedRecords[currentItem.refId] == nil then self.data.inventory[index] = nil end end end end -- Send a packet with some specific item changes to the player, to avoid having -- to resend the entire inventory -- -- Note: This just sends a packet, so the same item changes should be applied to -- self.data.inventory separately function BasePlayer:LoadItemChanges(itemArray, inventoryAction) tes3mp.ClearInventoryChanges(self.pid) tes3mp.SetInventoryChangesAction(self.pid, inventoryAction) for index, currentItem in pairs(itemArray) do if currentItem.count > 0 then packetBuilder.AddPlayerInventoryItemChange(self.pid, currentItem) end end tes3mp.SendInventoryChanges(self.pid) end function BasePlayer:LoadInventory() if self.data.inventory == nil then self.data.inventory = {} end tes3mp.ClearInventoryChanges(self.pid) tes3mp.SetInventoryChangesAction(self.pid, enumerations.inventory.SET) for index, currentItem in pairs(self.data.inventory) do if currentItem.count > 0 then packetBuilder.AddPlayerInventoryItemChange(self.pid, currentItem) else self.data.inventory[index] = nil end end tes3mp.SendInventoryChanges(self.pid) end function BasePlayer:SaveInventory() local action = tes3mp.GetInventoryChangesAction(self.pid) local itemChangesCount = tes3mp.GetInventoryChangesSize(self.pid) tes3mp.LogMessage(enumerations.log.INFO, "Saving " .. itemChangesCount .. " item(s) to inventory with action " .. tableHelper.getIndexByValue(enumerations.inventory, action)) if action == enumerations.inventory.SET then self.data.inventory = {} end for index = 0, itemChangesCount - 1 do local itemRefId = tes3mp.GetInventoryItemRefId(self.pid, index) if itemRefId ~= "" then local item = { refId = itemRefId, count = tes3mp.GetInventoryItemCount(self.pid, index), charge = tes3mp.GetInventoryItemCharge(self.pid, index), enchantmentCharge = tes3mp.GetInventoryItemEnchantmentCharge(self.pid, index), soul = tes3mp.GetInventoryItemSoul(self.pid, index) } tes3mp.LogAppend(enumerations.log.INFO, "- id: " .. item.refId .. ", count: " .. item.count .. ", charge: " .. item.charge .. ", enchantmentCharge: " .. item.enchantmentCharge .. ", soul: " .. item.soul) if action == enumerations.inventory.SET or action == enumerations.inventory.ADD then inventoryHelper.addItem(self.data.inventory, item.refId, item.count, item.charge, item.enchantmentCharge, item.soul) if logicHandler.IsGeneratedRecord(item.refId) then local recordStore = logicHandler.GetRecordStoreByRecordId(item.refId) if recordStore ~= nil then self:AddLinkToRecord(recordStore.storeType, item.refId) end end elseif action == enumerations.inventory.REMOVE then local remainingItem = inventoryHelper.removeItem(self.data.inventory, item.refId, item.count, item.charge, item.enchantmentCharge, item.soul) if remainingItem == nil and logicHandler.IsGeneratedRecord(item.refId) then local recordStore = logicHandler.GetRecordStoreByRecordId(item.refId) if recordStore ~= nil then self:RemoveLinkToRecord(recordStore.storeType, item.refId) end end end end end if action == enumerations.inventory.REMOVE then tableHelper.cleanNils(self.data.inventory) end self:Save() end -- Iterate through spells and remove the ones whose records no longer exist -- Note: This can only handle generated records for now function BasePlayer:CleanSpellbook() local shouldCleanNils = false local recordStore = RecordStores["spell"] for index, spellId in pairs(self.data.spellbook) do -- Make sure we skip over old spell tables from previous versions of TES3MP if type(spellId) ~= "table" and logicHandler.IsGeneratedRecord(spellId) then if recordStore.data.generatedRecords[spellId] == nil then self.data.spellbook[index] = nil shouldCleanNils = true end end end if shouldCleanNils then tableHelper.cleanNils(self.data.spellbook) end end function BasePlayer:LoadSpellbook() if self.data.spellbook == nil then self.data.spellbook = {} end tes3mp.ClearSpellbookChanges(self.pid) tes3mp.SetSpellbookChangesAction(self.pid, enumerations.spellbook.SET) for index, spellId in pairs(self.data.spellbook) do -- Is this an old spell table from a previous version of TES3MP? -- If so, update it to the new format if type(spellId) == "table" then spellId = spellId.spellId self.data.spellbook[index] = spellId end tes3mp.AddSpell(self.pid, spellId) end tes3mp.SendSpellbookChanges(self.pid) end function BasePlayer:SaveSpellbook() local action = tes3mp.GetSpellbookChangesAction(self.pid) if action == enumerations.spellbook.SET then self.data.spellbook = {} end for index = 0, tes3mp.GetSpellbookChangesSize(self.pid) - 1 do local spellId = tes3mp.GetSpellId(self.pid, index) if action == enumerations.spellbook.SET or action == enumerations.spellbook.ADD then -- Only add new spell if we don't already have it if not tableHelper.containsValue(self.data.spellbook, spellId) then tes3mp.LogMessage(enumerations.log.INFO, "Adding spell " .. spellId .. " to " .. logicHandler.GetChatName(self.pid)) table.insert(self.data.spellbook, spellId) end elseif action == enumerations.spellbook.REMOVE then -- Only print spell removal if the spell actually exists if tableHelper.containsValue(self.data.spellbook, spellId) == true then tes3mp.LogMessage(enumerations.log.INFO, "Removing spell " .. spellId .. " from " .. logicHandler.GetChatName(self.pid)) local foundIndex = tableHelper.getIndexByPattern(self.data.spellbook, spellId) self.data.spellbook[foundIndex] = nil if logicHandler.IsGeneratedRecord(spellId) then local recordStore = RecordStores["spell"] if recordStore ~= nil then self:RemoveLinkToRecord(recordStore.storeType, spellId) end end end end end if action == enumerations.spellbook.REMOVE then tableHelper.cleanNils(self.data.spellbook) end end function BasePlayer:LoadQuickKeys() if self.data.quickKeys == nil then self.data.quickKeys = {} end tes3mp.ClearQuickKeyChanges(self.pid) for slot, currentQuickKey in pairs(self.data.quickKeys) do if currentQuickKey ~= nil then tes3mp.AddQuickKey(self.pid, slot, currentQuickKey.keyType, currentQuickKey.itemId) end end tes3mp.SendQuickKeyChanges(self.pid) end function BasePlayer:SaveQuickKeys() for index = 0, tes3mp.GetQuickKeyChangesSize(self.pid) - 1 do local slot = tes3mp.GetQuickKeySlot(self.pid, index) self.data.quickKeys[slot] = { keyType = tes3mp.GetQuickKeyType(self.pid, index), itemId = tes3mp.GetQuickKeyItemId(self.pid, index) } end end function BasePlayer:LoadJournal() stateHelper:LoadJournal(self.pid, self) end function BasePlayer:SaveJournal() stateHelper:SaveJournal(self.pid, self) end function BasePlayer:LoadFactionRanks() stateHelper:LoadFactionRanks(self.pid, self) end function BasePlayer:SaveFactionRanks() stateHelper:SaveFactionRanks(self.pid, self) end function BasePlayer:LoadFactionExpulsion() stateHelper:LoadFactionExpulsion(self.pid, self) end function BasePlayer:SaveFactionExpulsion() stateHelper:SaveFactionExpulsion(self.pid, self) end function BasePlayer:LoadFactionReputation() stateHelper:LoadFactionReputation(self.pid, self) end function BasePlayer:SaveFactionReputation() stateHelper:SaveFactionReputation(self.pid, self) end function BasePlayer:LoadTopics() stateHelper:LoadTopics(self.pid, self) end function BasePlayer:SaveTopics() stateHelper:SaveTopics(self.pid, self) end function BasePlayer:LoadBounty() stateHelper:LoadBounty(self.pid, self) end function BasePlayer:SaveBounty() stateHelper:SaveBounty(self.pid, self) end function BasePlayer:LoadReputation() stateHelper:LoadReputation(self.pid, self) end function BasePlayer:SaveReputation() stateHelper:SaveReputation(self.pid, self) end function BasePlayer:LoadMap() stateHelper:LoadMap(self.pid, self) end function BasePlayer:LoadBooks() if self.data.books == nil then self.data.books = {} end tes3mp.ClearBookChanges(self.pid) for index, bookId in pairs(self.data.books) do tes3mp.AddBook(self.pid, bookId) end tes3mp.SendBookChanges(self.pid) end function BasePlayer:AddBooks() for index = 0, tes3mp.GetBookChangesSize(self.pid) - 1 do local bookId = tes3mp.GetBookId(self.pid, index) -- Only add new book if we don't already have it if not tableHelper.containsValue(self.data.books, bookId, false) then tes3mp.LogMessage(enumerations.log.INFO, "Adding book " .. bookId .. " to " .. logicHandler.GetChatName(self.pid)) table.insert(self.data.books, bookId) end end end function BasePlayer:LoadMarkLocation() if self.data.miscellaneous == nil then self.data.miscellaneous = {} end if self.data.miscellaneous.markLocation ~= nil then local markLocation = self.data.miscellaneous.markLocation tes3mp.SetMarkCell(self.pid, markLocation.cell) tes3mp.SetMarkPos(self.pid, markLocation.posX, markLocation.posY, markLocation.posZ) tes3mp.SetMarkRot(self.pid, markLocation.rotX, markLocation.rotZ) tes3mp.SendMarkLocation(self.pid) end end function BasePlayer:SaveMarkLocation() if self.data.miscellaneous == nil then self.data.miscellaneous = {} end self.data.miscellaneous.markLocation = { cell = tes3mp.GetMarkCell(self.pid), posX = tes3mp.GetMarkPosX(self.pid), posY = tes3mp.GetMarkPosY(self.pid), posZ = tes3mp.GetMarkPosZ(self.pid), rotX = tes3mp.GetMarkRotX(self.pid), rotZ = tes3mp.GetMarkRotZ(self.pid) } end function BasePlayer:LoadSelectedSpell() if self.data.miscellaneous == nil then self.data.miscellaneous = {} end if self.data.miscellaneous.selectedSpell ~= nil then tes3mp.SetSelectedSpellId(self.pid, self.data.miscellaneous.selectedSpell) tes3mp.SendSelectedSpell(self.pid) end end function BasePlayer:SaveSelectedSpell() if self.data.miscellaneous == nil then self.data.miscellaneous = {} end self.data.miscellaneous.selectedSpell = tes3mp.GetSelectedSpellId(self.pid) end function BasePlayer:GetDifficulty() return self.data.settings.difficulty end function BasePlayer:GetConsoleAllowed() return self.data.settings.consoleAllowed end function BasePlayer:GetBedRestAllowed() return self.data.settings.bedRestAllowed end function BasePlayer:GetWildernessRestAllowed() return self.data.settings.wildernessRestAllowed end function BasePlayer:GetWaitAllowed() return self.data.settings.waitAllowed end function BasePlayer:GetEnforcedLogLevel() return self.data.settings.enforcedLogLevel end function BasePlayer:GetPhysicsFramerate() return self.data.settings.physicsFramerate end function BasePlayer:SetDifficulty(difficulty) if difficulty == nil or difficulty == "default" then difficulty = config.difficulty self.data.settings.difficulty = "default" else self.data.settings.difficulty = difficulty end tes3mp.SetDifficulty(self.pid, difficulty) tes3mp.LogMessage(enumerations.log.INFO, "Set difficulty to " .. tostring(difficulty) .. " for " .. logicHandler.GetChatName(self.pid)) end function BasePlayer:SetEnforcedLogLevel(enforcedLogLevel) if enforcedLogLevel == nil or enforcedLogLevel == "default" then enforcedLogLevel = config.enforcedLogLevel self.data.settings.enforcedLogLevel = "default" else self.data.settings.enforcedLogLevel = enforcedLogLevel end tes3mp.SetEnforcedLogLevel(self.pid, enforcedLogLevel) tes3mp.LogMessage(enumerations.log.INFO, "Set enforced log level to " .. tostring(enforcedLogLevel) .. " for " .. logicHandler.GetChatName(self.pid)) end function BasePlayer:SetPhysicsFramerate(physicsFramerate) if physicsFramerate == nil or physicsFramerate == "default" then physicsFramerate = config.physicsFramerate self.data.settings.physicsFramerate = "default" else self.data.settings.physicsFramerate = physicsFramerate end tes3mp.SetPhysicsFramerate(self.pid, physicsFramerate) tes3mp.LogMessage(enumerations.log.INFO, "Set physics framerate to " .. tostring(physicsFramerate) .. " for " .. logicHandler.GetChatName(self.pid)) end function BasePlayer:SetConsoleAllowed(state) if state == nil or state == "default" then state = config.allowConsole self.data.settings.consoleAllowed = "default" else self.data.settings.consoleAllowed = state end tes3mp.SetConsoleAllowed(self.pid, state) end function BasePlayer:SetBedRestAllowed(state) if state == nil or state == "default" then state = config.allowBedRest self.data.settings.bedRestAllowed = "default" else self.data.settings.bedRestAllowed = state end tes3mp.SetBedRestAllowed(self.pid, state) end function BasePlayer:SetWildernessRestAllowed(state) if state == nil or state == "default" then state = config.allowWildernessRest self.data.settings.wildernessRestAllowed = "default" else self.data.settings.wildernessRestAllowed = state end tes3mp.SetWildernessRestAllowed(self.pid, state) end function BasePlayer:SetWaitAllowed(state) if state == nil or state == "default" then state = config.allowWait self.data.settings.waitAllowed = "default" else self.data.settings.waitAllowed = state end tes3mp.SetWaitAllowed(self.pid, state) end function BasePlayer:SetWerewolfState(state) self.data.shapeshift.isWerewolf = state tes3mp.SetWerewolfState(self.pid, state) tes3mp.SendShapeshift(self.pid) end function BasePlayer:SetScale(scale) self.data.shapeshift.scale = scale tes3mp.SetScale(self.pid, scale) tes3mp.SendShapeshift(self.pid) end function BasePlayer:SetConfiscationState(state) self.data.customVariables.isConfiscationTarget = state if self:IsLoggedIn() then if state == true then logicHandler.RunConsoleCommandOnPlayer(self.pid, "tm") logicHandler.RunConsoleCommandOnPlayer(self.pid, "disableplayercontrols") tes3mp.MessageBox(self.pid, -1, "You are immobilized while an item is being confiscated from you") elseif not state then self.data.customVariables.isConfiscationTarget = nil logicHandler.RunConsoleCommandOnPlayer(self.pid, "tm") logicHandler.RunConsoleCommandOnPlayer(self.pid, "enableplayercontrols") tes3mp.MessageBox(self.pid, -1, "You are free to move again") end end end function BasePlayer:LoadSettings() -- Change admin variable from old player files to the current staffRank if self.data.settings.staffRank == nil and self.data.settings.admin ~= nil then self.data.settings.staffRank = self.data.settings.admin self.data.settings.admin = nil end self:SetDifficulty(self.data.settings.difficulty) self:SetConsoleAllowed(self.data.settings.consoleAllowed) self:SetBedRestAllowed(self.data.settings.bedRestAllowed) self:SetWildernessRestAllowed(self.data.settings.wildernessRestAllowed) self:SetWaitAllowed(self.data.settings.waitAllowed) self:SetEnforcedLogLevel(self.data.settings.enforcedLogLevel) self:SetPhysicsFramerate(self.data.settings.physicsFramerate) tes3mp.SendSettings(self.pid) end function BasePlayer:LoadSpecialStates() if self.data.customVariables.isConfiscationTarget ~= nil then self:SetConfiscationState(self.data.customVariables.isConfiscationTarget) end end function BasePlayer:AddCellLoaded(cellDescription) -- Only add new loaded cell if we don't already have it if not tableHelper.containsValue(self.cellsLoaded, cellDescription) then table.insert(self.cellsLoaded, cellDescription) end end function BasePlayer:RemoveCellLoaded(cellDescription) tableHelper.removeValue(self.cellsLoaded, cellDescription) end return BasePlayer