Class PlayerEntity
Implements DaggerfallEntity with properties specific to a Player.
Assembly: Assembly-CSharp.dll
Syntax
public class PlayerEntity : DaggerfallEntity
Constructors
|
Improve this Doc
View Source
PlayerEntity(DaggerfallEntityBehaviour)
Declaration
public PlayerEntity(DaggerfallEntityBehaviour entityBehaviour)
Parameters
Fields
|
Improve this Doc
View Source
arrested
Declaration
Field Value
|
Improve this Doc
View Source
biographyAvoidHitMod
Declaration
protected int biographyAvoidHitMod
Field Value
|
Improve this Doc
View Source
biographyFatigueMod
Declaration
protected int biographyFatigueMod
Field Value
|
Improve this Doc
View Source
biographyReactionMod
Declaration
protected int biographyReactionMod
Field Value
|
Improve this Doc
View Source
biographyResistDiseaseMod
Declaration
protected int biographyResistDiseaseMod
Field Value
|
Improve this Doc
View Source
biographyResistMagicMod
Declaration
protected int biographyResistMagicMod
Field Value
|
Improve this Doc
View Source
biographyResistPoisonMod
Declaration
protected int biographyResistPoisonMod
Field Value
|
Improve this Doc
View Source
ClimbingFatigueLoss
Declaration
public const int ClimbingFatigueLoss = 22
Field Value
|
Improve this Doc
View Source
crimeCommitted
Declaration
protected PlayerEntity.Crimes crimeCommitted
Field Value
|
Improve this Doc
View Source
currentLevelUpSkillSum
Declaration
protected int currentLevelUpSkillSum
Field Value
|
Improve this Doc
View Source
darkBrotherhoodRequirementTally
Declaration
protected int darkBrotherhoodRequirementTally
Field Value
|
Improve this Doc
View Source
DefaultFatigueLoss
Declaration
public const int DefaultFatigueLoss = 11
Field Value
|
Improve this Doc
View Source
faceIndex
Declaration
Field Value
|
Improve this Doc
View Source
factionData
Declaration
protected PersistentFactionData factionData
Field Value
|
Improve this Doc
View Source
globalVars
Declaration
protected PersistentGlobalVars globalVars
Field Value
|
Improve this Doc
View Source
goldPieces
Declaration
Field Value
|
Improve this Doc
View Source
halfOfLegalRepPlayerLostFromCrime
Declaration
protected short halfOfLegalRepPlayerLostFromCrime
Field Value
|
Improve this Doc
View Source
haveShownSurrenderToGuardsDialogue
Declaration
protected bool haveShownSurrenderToGuardsDialogue
Field Value
|
Improve this Doc
View Source
JumpingFatigueLoss
Declaration
public const int JumpingFatigueLoss = 11
Field Value
|
Improve this Doc
View Source
lastGameMinutes
Declaration
protected uint lastGameMinutes
Field Value
|
Improve this Doc
View Source
lastTimePlayerAteOrDrankAtTavern
Declaration
protected uint lastTimePlayerAteOrDrankAtTavern
Field Value
|
Improve this Doc
View Source
lightSource
Declaration
protected DaggerfallUnityItem lightSource
Field Value
|
Improve this Doc
View Source
lycanthropySpellTag
Declaration
public const string lycanthropySpellTag = "lycanthrope"
Field Value
|
Improve this Doc
View Source
notebook
Declaration
protected PlayerNotebook notebook
Field Value
|
Improve this Doc
View Source
oghmaLevelUp
Declaration
protected bool oghmaLevelUp
Field Value
|
Improve this Doc
View Source
otherItems
Declaration
protected ItemCollection otherItems
Field Value
|
Improve this Doc
View Source
raceTemplate
Declaration
protected RaceTemplate raceTemplate
Field Value
|
Improve this Doc
View Source
readyToLevelUp
Declaration
protected bool readyToLevelUp
Field Value
|
Improve this Doc
View Source
reflexes
Declaration
protected PlayerReflexes reflexes
Field Value
|
Improve this Doc
View Source
regionData
Declaration
protected PlayerEntity.RegionDataRecord[] regionData
Field Value
|
Improve this Doc
View Source
RunningFatigueLoss
Declaration
public const int RunningFatigueLoss = 88
Field Value
|
Improve this Doc
View Source
sGroupReputations
Declaration
protected short[] sGroupReputations
Field Value
|
Improve this Doc
View Source
skillsRecentlyRaised
Declaration
protected uint[] skillsRecentlyRaised
Field Value
|
Improve this Doc
View Source
skillUses
Declaration
protected short[] skillUses
Field Value
|
Improve this Doc
View Source
startingLevelUpSkillSum
Declaration
protected int startingLevelUpSkillSum
Field Value
|
Improve this Doc
View Source
SwimmingFatigueLoss
Declaration
public const int SwimmingFatigueLoss = 44
Field Value
|
Improve this Doc
View Source
thievesGuildRequirementTally
Declaration
protected int thievesGuildRequirementTally
Field Value
|
Improve this Doc
View Source
timeForDarkBrotherhoodLetter
Declaration
protected uint timeForDarkBrotherhoodLetter
Field Value
|
Improve this Doc
View Source
timeForThievesGuildLetter
Declaration
protected uint timeForThievesGuildLetter
Field Value
|
Improve this Doc
View Source
timeOfLastSkillIncreaseCheck
Declaration
protected uint timeOfLastSkillIncreaseCheck
Field Value
|
Improve this Doc
View Source
timeOfLastSkillTraining
Declaration
protected uint timeOfLastSkillTraining
Field Value
|
Improve this Doc
View Source
timeOfLastStealthCheck
Declaration
protected uint timeOfLastStealthCheck
Field Value
|
Improve this Doc
View Source
timeToBecomeVampireOrWerebeast
Declaration
protected uint timeToBecomeVampireOrWerebeast
Field Value
|
Improve this Doc
View Source
vampireSpellTag
Declaration
public const string vampireSpellTag = "vampire"
Field Value
|
Improve this Doc
View Source
wagonItems
Declaration
protected ItemCollection wagonItems
Field Value
Properties
|
Improve this Doc
View Source
AnchorPosition
Declaration
public PlayerPositionData_v1 AnchorPosition { get; set; }
Property Value
|
Improve this Doc
View Source
Arrested
Declaration
public bool Arrested { get; set; }
Property Value
|
Improve this Doc
View Source
BackStory
Declaration
public List<string> BackStory { get; set; }
Property Value
|
Improve this Doc
View Source
BiographyAvoidHitMod
Declaration
public int BiographyAvoidHitMod { get; set; }
Property Value
|
Improve this Doc
View Source
BiographyFatigueMod
Declaration
public int BiographyFatigueMod { get; set; }
Property Value
|
Improve this Doc
View Source
BiographyReactionMod
Declaration
public int BiographyReactionMod { get; set; }
Property Value
|
Improve this Doc
View Source
BiographyResistDiseaseMod
Declaration
public int BiographyResistDiseaseMod { get; set; }
Property Value
|
Improve this Doc
View Source
BiographyResistMagicMod
Declaration
public int BiographyResistMagicMod { get; set; }
Property Value
|
Improve this Doc
View Source
BiographyResistPoisonMod
Declaration
public int BiographyResistPoisonMod { get; set; }
Property Value
|
Improve this Doc
View Source
BirthRaceTemplate
Declaration
public RaceTemplate BirthRaceTemplate { get; set; }
Property Value
|
Improve this Doc
View Source
CarriedWeight
Declaration
public float CarriedWeight { get; }
Property Value
|
Improve this Doc
View Source
CrimeCommitted
Declaration
public PlayerEntity.Crimes CrimeCommitted { get; set; }
Property Value
|
Improve this Doc
View Source
CurrentLevelUpSkillSum
Declaration
public int CurrentLevelUpSkillSum { get; }
Property Value
|
Improve this Doc
View Source
CurrentRestMode
Declaration
public DaggerfallRestWindow.RestModes CurrentRestMode { get; set; }
Property Value
|
Improve this Doc
View Source
DaedraSummonDay
Declaration
public int DaedraSummonDay { get; set; }
Property Value
|
Improve this Doc
View Source
DaedraSummonIndex
Declaration
public int DaedraSummonIndex { get; set; }
Property Value
|
Improve this Doc
View Source
DarkBrotherhoodRequirementTally
Declaration
public int DarkBrotherhoodRequirementTally { get; set; }
Property Value
|
Improve this Doc
View Source
EnemyAlertActive
Declaration
public bool EnemyAlertActive { get; }
Property Value
|
Improve this Doc
View Source
FaceIndex
Declaration
public int FaceIndex { get; set; }
Property Value
|
Improve this Doc
View Source
FactionData
Declaration
public PersistentFactionData FactionData { get; }
Property Value
|
Improve this Doc
View Source
GlobalVars
Declaration
public PersistentGlobalVars GlobalVars { get; }
Property Value
|
Improve this Doc
View Source
GodMode
Declaration
public bool GodMode { get; set; }
Property Value
|
Improve this Doc
View Source
GoldPieces
Declaration
public int GoldPieces { get; set; }
Property Value
|
Improve this Doc
View Source
HaveShownSurrenderToGuardsDialogue
Declaration
public bool HaveShownSurrenderToGuardsDialogue { get; set; }
Property Value
|
Improve this Doc
View Source
InPrison
Declaration
public bool InPrison { get; set; }
Property Value
|
Improve this Doc
View Source
IsAzurasStarEquipped
Declaration
public bool IsAzurasStarEquipped { get; set; }
Property Value
|
Improve this Doc
View Source
Declaration
public bool IsInBeastForm { get; set; }
Property Value
|
Improve this Doc
View Source
IsLoitering
Declaration
public bool IsLoitering { get; set; }
Property Value
|
Improve this Doc
View Source
IsResting
Declaration
public bool IsResting { get; set; }
Property Value
|
Improve this Doc
View Source
LastGameMinutes
Declaration
public uint LastGameMinutes { get; set; }
Property Value
|
Improve this Doc
View Source
LastTimePlayerAteOrDrankAtTavern
Declaration
public uint LastTimePlayerAteOrDrankAtTavern { get; set; }
Property Value
|
Improve this Doc
View Source
LightSource
Declaration
public DaggerfallUnityItem LightSource { get; set; }
Property Value
|
Improve this Doc
View Source
NoClipMode
Declaration
public bool NoClipMode { get; set; }
Property Value
|
Improve this Doc
View Source
NoTargetMode
Declaration
public bool NoTargetMode { get; set; }
Property Value
|
Improve this Doc
View Source
Notebook
Declaration
public PlayerNotebook Notebook { get; }
Property Value
|
Improve this Doc
View Source
OghmaLevelUp
Declaration
public bool OghmaLevelUp { get; set; }
Property Value
|
Improve this Doc
View Source
OtherItems
Declaration
public ItemCollection OtherItems { get; set; }
Property Value
|
Improve this Doc
View Source
PreventEnemySpawns
Declaration
public bool PreventEnemySpawns { get; set; }
Property Value
|
Improve this Doc
View Source
PreventNormalizingReputations
Declaration
public bool PreventNormalizingReputations { get; set; }
Property Value
|
Improve this Doc
View Source
PreviousVampireClan
Declaration
public VampireClans PreviousVampireClan { get; set; }
Property Value
|
Improve this Doc
View Source
Race
Declaration
public Races Race { get; }
Property Value
|
Improve this Doc
View Source
RaceTemplate
Declaration
public RaceTemplate RaceTemplate { get; }
Property Value
|
Improve this Doc
View Source
ReadyToLevelUp
Declaration
public bool ReadyToLevelUp { get; set; }
Property Value
|
Improve this Doc
View Source
Reflexes
Declaration
public PlayerReflexes Reflexes { get; set; }
Property Value
|
Improve this Doc
View Source
RegionData
Declaration
public PlayerEntity.RegionDataRecord[] RegionData { get; set; }
Property Value
|
Improve this Doc
View Source
RentedRooms
Declaration
public List<RoomRental_v1> RentedRooms { get; set; }
Property Value
|
Improve this Doc
View Source
SGroupReputations
Declaration
public short[] SGroupReputations { get; set; }
Property Value
|
Improve this Doc
View Source
SkillsRecentlyRaised
Declaration
public uint[] SkillsRecentlyRaised { get; set; }
Property Value
|
Improve this Doc
View Source
SkillUses
Declaration
public short[] SkillUses { get; set; }
Property Value
|
Improve this Doc
View Source
StartingLevelUpSkillSum
Declaration
public int StartingLevelUpSkillSum { get; set; }
Property Value
|
Improve this Doc
View Source
ThievesGuildRequirementTally
Declaration
public int ThievesGuildRequirementTally { get; set; }
Property Value
|
Improve this Doc
View Source
TimeForDarkBrotherhoodLetter
Declaration
public uint TimeForDarkBrotherhoodLetter { get; set; }
Property Value
|
Improve this Doc
View Source
TimeForThievesGuildLetter
Declaration
public uint TimeForThievesGuildLetter { get; set; }
Property Value
|
Improve this Doc
View Source
TimeOfLastSkillIncreaseCheck
Declaration
public uint TimeOfLastSkillIncreaseCheck { get; set; }
Property Value
|
Improve this Doc
View Source
TimeOfLastSkillTraining
Declaration
public uint TimeOfLastSkillTraining { get; set; }
Property Value
|
Improve this Doc
View Source
TimeOfLastStealthCheck
Declaration
public uint TimeOfLastStealthCheck { get; set; }
Property Value
|
Improve this Doc
View Source
TimeToBecomeVampireOrWerebeast
Declaration
public uint TimeToBecomeVampireOrWerebeast { get; set; }
Property Value
|
Improve this Doc
View Source
WagonItems
Declaration
public ItemCollection WagonItems { get; set; }
Property Value
|
Improve this Doc
View Source
WagonWeight
Declaration
public float WagonWeight { get; }
Property Value
Methods
|
Improve this Doc
View Source
AlreadyMasteredASkill()
Gets whether the player has already become master of a skill.
Declaration
public bool AlreadyMasteredASkill()
Returns
|
Improve this Doc
View Source
AssignCharacter(CharacterDocument, Int32, Int32, Boolean)
Assigns player entity settings from a character document.
Declaration
public void AssignCharacter(CharacterDocument character, int level = 1, int maxHealth = 0, bool fillVitals = true)
Parameters
|
Improve this Doc
View Source
AssignDiseasesAndPoisons(SaveTree, out LycanthropyTypes)
Assigns diseases and poisons to player from classic save tree.
Declaration
public void AssignDiseasesAndPoisons(SaveTree saveTree, out LycanthropyTypes lycanthropyType)
Parameters
|
Improve this Doc
View Source
AssignGuildMemberships(SaveTree, Boolean)
Assigns guild memberships to player from classic save tree.
Declaration
public void AssignGuildMemberships(SaveTree saveTree, bool vampire = false)
Parameters
|
Improve this Doc
View Source
AssignItemsAndSpells(SaveTree)
Assigns character items and spells from classic save tree.
Spells are stored as a child of spellbook item container, which is why they are imported along with items.
Declaration
public void AssignItemsAndSpells(SaveTree saveTree)
Parameters
|
Improve this Doc
View Source
AssignPlayerLycanthropySpell()
Declaration
public void AssignPlayerLycanthropySpell()
|
Improve this Doc
View Source
AssignPlayerVampireSpells(VampireClans)
Declaration
public void AssignPlayerVampireSpells(VampireClans clan)
Parameters
|
Improve this Doc
View Source
ChangeReactionMod(FactionFile.SocialGroups, Int32)
Declaration
public void ChangeReactionMod(FactionFile.SocialGroups socialGroup, int amount)
Parameters
|
Improve this Doc
View Source
CheckForLevelUp()
Calculate level and check for level up.
Declaration
public bool CheckForLevelUp()
Returns
|
Improve this Doc
View Source
ClampLegalReputations()
Declaration
public void ClampLegalReputations()
|
Improve this Doc
View Source
ClearConstantEffects()
Clear player-only constant effects.
Declaration
public override void ClearConstantEffects()
Overrides
|
Improve this Doc
View Source
ClearReactionMods()
Declaration
public void ClearReactionMods()
|
Improve this Doc
View Source
CourtWindow()
Declaration
public void CourtWindow()
|
Improve this Doc
View Source
DeductGoldAmount(Int32)
Deducts the amount of gold specified from the player. (check GoldAmount first)
Gold pieces first if enough, then letters of credit, then gold pieces.
Declaration
public int DeductGoldAmount(int amount)
Parameters
Type |
Name |
Description |
Int32 |
amount |
Amount to deduct
|
Returns
Type |
Description |
Int32 |
Amount remaining to be paid if not enough funds.
|
|
Improve this Doc
View Source
EstimateStartingLevelUpSkillSum()
Estimate the starting sum of skills used for determining player level.
Declaration
public void EstimateStartingLevelUpSkillSum()
|
Improve this Doc
View Source
FixedUpdate()
Declaration
public override void FixedUpdate()
Overrides
|
Improve this Doc
View Source
GetGoldAmount()
Returns the amount of gold carried by the player. (gold pieces + letters of credit)
Declaration
public int GetGoldAmount()
Returns
|
Improve this Doc
View Source
GetLiveRaceTemplate()
Declaration
public RaceTemplate GetLiveRaceTemplate()
Returns
|
Improve this Doc
View Source
GetReactionMod(FactionFile.SocialGroups)
Declaration
public int GetReactionMod(FactionFile.SocialGroups socialGroup)
Parameters
Returns
|
Improve this Doc
View Source
GetRemainingHours(RoomRental_v1)
Declaration
public static int GetRemainingHours(RoomRental_v1 room)
Parameters
Returns
|
Improve this Doc
View Source
GetRentedRoom(Int32, Int32)
Declaration
public RoomRental_v1 GetRentedRoom(int mapId, int buildingKey)
Parameters
Type |
Name |
Description |
Int32 |
mapId |
|
Int32 |
buildingKey |
|
Returns
|
Improve this Doc
View Source
GetRentedRooms(Int32)
Declaration
public List<RoomRental_v1> GetRentedRooms(int mapId)
Parameters
Type |
Name |
Description |
Int32 |
mapId |
|
Returns
|
Improve this Doc
View Source
GetSkillRecentlyIncreased(DFCareer.Skills)
Declaration
public bool GetSkillRecentlyIncreased(DFCareer.Skills skill)
Parameters
Returns
|
Improve this Doc
View Source
InitializeRegionData()
Initialize region data arrays.
Declaration
public void InitializeRegionData()
|
Improve this Doc
View Source
IntermittentEnemySpawn(UInt32)
Declaration
public bool IntermittentEnemySpawn(uint Minutes)
Parameters
Type |
Name |
Description |
UInt32 |
Minutes |
|
Returns
|
Improve this Doc
View Source
LowerRepForCrime()
Declaration
public void LowerRepForCrime()
|
Improve this Doc
View Source
LowerRepForCrime(Int32, PlayerEntity.Crimes)
Declaration
public void LowerRepForCrime(int regionIndex, PlayerEntity.Crimes crime)
Parameters
|
Improve this Doc
View Source
NormalizeReputations()
Normalize reputations towards 0. Called every certain number of game days.
Declaration
public void NormalizeReputations()
|
Improve this Doc
View Source
RaiseReputationForDoingSentence()
Declaration
public void RaiseReputationForDoingSentence()
|
Improve this Doc
View Source
RaiseSkills()
Raise skills if conditions are met.
Declaration
public void RaiseSkills()
|
Improve this Doc
View Source
RegionPowerAndConditionsUpdate(Boolean)
Update regional power and conditions. Called every certain number of game days.
Declaration
public void RegionPowerAndConditionsUpdate(bool updateConditions)
Parameters
Type |
Name |
Description |
Boolean |
updateConditions |
|
|
Improve this Doc
View Source
ReleaseQuestItemForReoffer(UInt64, Item, Boolean)
Releases a quest item carried by player so it can be assigned back again by quest script.
This ensures item is properly unequipped and optionally makes permanent.
Declaration
public void ReleaseQuestItemForReoffer(ulong questUID, Item item, bool makePermanent = false)
Parameters
Type |
Name |
Description |
UInt64 |
questUID |
Quest UID owning Item.
|
Item |
item |
Quest Item to release.
|
Boolean |
makePermanent |
True to make item permanent.
|
|
Improve this Doc
View Source
RemoveExpiredRentedRooms()
Declaration
public void RemoveExpiredRentedRooms()
|
Improve this Doc
View Source
Reset()
Resets entity to initial state.
Declaration
|
Improve this Doc
View Source
ResetSkillsRecentlyRaised()
Declaration
public void ResetSkillsRecentlyRaised()
|
Improve this Doc
View Source
SetCurrentLevelUpSkillSum()
Calculate current sum of skills used for determining player level.
Declaration
public void SetCurrentLevelUpSkillSum()
|
Improve this Doc
View Source
SetEnemyAlert(Boolean)
Enemy alert is raised by hostile enemies or attempting to rest near hostile enemies.
Enemy alert is lowered when killing a hostile enemy or after some time has passed.
Declaration
public void SetEnemyAlert(bool alert)
Parameters
Type |
Name |
Description |
Boolean |
alert |
|
|
Improve this Doc
View Source
SetEntityDefaults()
Assigns default entity settings.
Declaration
public override void SetEntityDefaults()
Overrides
|
Improve this Doc
View Source
SetFatigue(Int32, Boolean)
Sets new fatigue value.
Override for godmode support.
Declaration
public override int SetFatigue(int amount, bool restoreMode = false)
Parameters
Returns
Overrides
|
Improve this Doc
View Source
SetHealth(Int32, Boolean)
Sets new health value.
Override for godmode support.
Declaration
public override int SetHealth(int amount, bool restoreMode = false)
Parameters
Returns
Overrides
|
Improve this Doc
View Source
SetMagicka(Int32, Boolean)
Sets new magicka value.
Override for godmode support.
Declaration
public override int SetMagicka(int amount, bool restoreMode = false)
Parameters
Returns
Overrides
|
Improve this Doc
View Source
SetSkillRecentlyIncreased(Int32)
Declaration
public void SetSkillRecentlyIncreased(int index)
Parameters
Type |
Name |
Description |
Int32 |
index |
|
|
Improve this Doc
View Source
SpawnCityGuard(Vector3, Vector3)
Declaration
public GameObject SpawnCityGuard(Vector3 position, Vector3 direction)
Parameters
Returns
|
Improve this Doc
View Source
SpawnCityGuards(Boolean)
Declaration
public void SpawnCityGuards(bool immediateSpawn)
Parameters
Type |
Name |
Description |
Boolean |
immediateSpawn |
|
|
Improve this Doc
View Source
SurrenderToCityGuards(Boolean)
Declaration
public bool SurrenderToCityGuards(bool voluntarySurrender)
Parameters
Type |
Name |
Description |
Boolean |
voluntarySurrender |
|
Returns
|
Improve this Doc
View Source
TallyCrimeGuildRequirements(Boolean, Byte)
Tally thefts/break-ins and murders for starting Thieves Guild and Dark Brotherhood quests
Declaration
public void TallyCrimeGuildRequirements(bool thievingCrime, byte amount)
Parameters
Type |
Name |
Description |
Boolean |
thievingCrime |
|
Byte |
amount |
|
|
Improve this Doc
View Source
TallySkill(DFCareer.Skills, Int16)
Declaration
public override void TallySkill(DFCareer.Skills skill, short amount)
Parameters
Overrides
|
Improve this Doc
View Source
TurnOffConditionFlag(Int32, PlayerEntity.RegionDataFlags)
Declaration
public void TurnOffConditionFlag(int regionID, PlayerEntity.RegionDataFlags flagID)
Parameters
|
Improve this Doc
View Source
TurnOnConditionFlag(Int32, PlayerEntity.RegionDataFlags)
Declaration
public void TurnOnConditionFlag(int regionID, PlayerEntity.RegionDataFlags flagID)
Parameters
|
Improve this Doc
View Source
Update(DaggerfallEntityBehaviour)
Declaration
public override void Update(DaggerfallEntityBehaviour sender)
Parameters
Overrides