Class DaggerfallEntity

Base entity type for all living GameObjects in the world. The Effect system (spells, diseases, etc.) operates on entities.

Inheritance

Object

DaggerfallEntity

CivilianEntity

EnemyEntity

PlayerEntity

Namespace: DaggerfallWorkshop.Game.Entity

Assembly: Assembly-CSharp.dll

Syntax

[Serializable]
public abstract class DaggerfallEntity

Constructors

DaggerfallEntity(DaggerfallEntityBehaviour)

Declaration

public DaggerfallEntity(DaggerfallEntityBehaviour entityBehaviour)

Parameters

Type	Name	Description
DaggerfallEntityBehaviour	entityBehaviour

Fields

armorValues

Declaration

protected sbyte[] armorValues

Field Value

Type	Description
SByte[]

career

Declaration

protected DFCareer career

Field Value

Type	Description
DFCareer

currentBreath

Declaration

protected int currentBreath

Field Value

Type	Description
Int32

currentFatigue

Declaration

protected int currentFatigue

Field Value

Type	Description
Int32

currentHealth

Declaration

protected int currentHealth

Field Value

Type	Description
Int32

currentMagicka

Declaration

protected int currentMagicka

Field Value

Type	Description
Int32

entityBehaviour

Declaration

protected DaggerfallEntityBehaviour entityBehaviour

Field Value

Type	Description
DaggerfallEntityBehaviour

equipTable

Declaration

protected ItemEquipTable equipTable

Field Value

Type	Description
ItemEquipTable

FatigueMultiplier

Declaration

public const int FatigueMultiplier = 64

Field Value

Type	Description
Int32

gender

Declaration

protected Genders gender

Field Value

Type	Description
Genders

items

Declaration

protected ItemCollection items

Field Value

Type	Description
ItemCollection

level

Declaration

protected int level

Field Value

Type	Description
Int32

maxHealth

Declaration

protected int maxHealth

Field Value

Type	Description
Int32

maxMagicka

Declaration

protected int maxMagicka

Field Value

Type	Description
Int32

minMetalToHit

Declaration

protected WeaponMaterialTypes minMetalToHit

Field Value

Type	Description
WeaponMaterialTypes

name

Declaration

protected string name

Field Value

Type	Description
String

NumberBodyParts

Declaration

public const int NumberBodyParts = 7

Field Value

Type	Description
Int32

resistances

Declaration

protected DaggerfallResistances resistances

Field Value

Type	Description
DaggerfallResistances

skills

Declaration

protected DaggerfallSkills skills

Field Value

Type	Description
DaggerfallSkills

spellbook

Declaration

protected List<EffectBundleSettings> spellbook

Field Value

Type	Description
List<EffectBundleSettings>

stats

Declaration

protected DaggerfallStats stats

Field Value

Type	Description
DaggerfallStats

team

Declaration

protected MobileTeams team

Field Value

Type	Description
MobileTeams

worldContext

Declaration

protected WorldContext worldContext

Field Value

Type	Description
WorldContext

Properties

ArmorValues

Declaration

public sbyte[] ArmorValues { get; set; }

Property Value

Type	Description
SByte[]

Career

Declaration

public DFCareer Career { get; set; }

Property Value

Type	Description
DFCareer

ChanceToHitModifier

Declaration

public int ChanceToHitModifier { get; }

Property Value

Type	Description
Int32

CurrentBreath

Declaration

public int CurrentBreath { get; set; }

Property Value

Type	Description
Int32

CurrentFatigue

Declaration

public int CurrentFatigue { get; set; }

Property Value

Type	Description
Int32

CurrentHealth

Declaration

public int CurrentHealth { get; set; }

Property Value

Type	Description
Int32

CurrentHealthPercent

Declaration

public float CurrentHealthPercent { get; }

Property Value

Type	Description
Single

CurrentMagicka

Declaration

public int CurrentMagicka { get; set; }

Property Value

Type	Description
Int32

DamageModifier

Declaration

public int DamageModifier { get; }

Property Value

Type	Description
Int32

DecreasedArmorValueModifier

Declaration

public int DecreasedArmorValueModifier { get; }

Property Value

Type	Description
Int32

EntityBehaviour

Gets the DaggerfallEntityBehaviour related to this DaggerfallEntity.

Declaration

public DaggerfallEntityBehaviour EntityBehaviour { get; }

Property Value

Type	Description
DaggerfallEntityBehaviour

Gender

Declaration

public Genders Gender { get; set; }

Property Value

Type	Description
Genders

HealingRateModifier

Declaration

public int HealingRateModifier { get; }

Property Value

Type	Description
Int32

HitPointsModifier

Declaration

public int HitPointsModifier { get; }

Property Value

Type	Description
Int32

ImprovedAcuteHearing

Declaration

public bool ImprovedAcuteHearing { get; set; }

Property Value

Type	Description
Boolean

ImprovedAdrenalineRush

Declaration

public bool ImprovedAdrenalineRush { get; set; }

Property Value

Type	Description
Boolean

ImprovedAthleticism

Declaration

public bool ImprovedAthleticism { get; set; }

Property Value

Type	Description
Boolean

IncreasedArmorValueModifier

Declaration

public int IncreasedArmorValueModifier { get; }

Property Value

Type	Description
Int32

IncreasedWeightAllowanceMultiplier

Declaration

public float IncreasedWeightAllowanceMultiplier { get; }

Property Value

Type	Description
Single

IsAbsorbingSpells

Declaration

public bool IsAbsorbingSpells { get; set; }

Property Value

Type	Description
Boolean

IsAShade

True if entity is a shadow (normal or true).

Declaration

public bool IsAShade { get; }

Property Value

Type	Description
Boolean

IsBlending

True if entity is blending (normal or true).

Declaration

public bool IsBlending { get; }

Property Value

Type	Description
Boolean

IsEnhancedClimbing

Declaration

public bool IsEnhancedClimbing { get; set; }

Property Value

Type	Description
Boolean

IsEnhancedJumping

Declaration

public bool IsEnhancedJumping { get; set; }

Property Value

Type	Description
Boolean

IsImmuneToDisease

Declaration

public bool IsImmuneToDisease { get; set; }

Property Value

Type	Description
Boolean

IsImmuneToParalysis

Declaration

public bool IsImmuneToParalysis { get; set; }

Property Value

Type	Description
Boolean

IsInvisible

True if entity is invisible (normal or true).

Declaration

public bool IsInvisible { get; }

Property Value

Type	Description
Boolean

IsMagicallyConcealed

True if entity is magically concealed by invisibility/chameleon/shadow (normal or true).

Declaration

public bool IsMagicallyConcealed { get; }

Property Value

Type	Description
Boolean

IsMagicallyConcealedNormalPower

True if entity is magically concealed by invisibility/chameleon/shadow (normal only).

Declaration

public bool IsMagicallyConcealedNormalPower { get; }

Property Value

Type	Description
Boolean

IsMagicallyConcealedTruePower

True if entity is magically concealed by invisibility/chameleon/shadow (true only).

Declaration

public bool IsMagicallyConcealedTruePower { get; }

Property Value

Type	Description
Boolean

IsParalyzed

Gets or sets paralyzation flag. Always returns false when isImmuneToParalysis is true. Each entity type will need to act on paralyzation in their own unique way. Note: This value is intentionally not serialized. It should only be set by live effects.

Declaration

public bool IsParalyzed { get; set; }

Property Value

Type	Description
Boolean

IsResistingDiseaseOrPoison

Gets or sets resisting disease or poison flag. Note: This value is intentionally not serialized. It should only be set by live effects.

Declaration

public bool IsResistingDiseaseOrPoison { get; set; }

Property Value

Type	Description
Boolean

IsResistingFire

Gets or sets resisting fire flag. Note: This value is intentionally not serialized. It should only be set by live effects.

Declaration

public bool IsResistingFire { get; set; }

Property Value

Type	Description
Boolean

IsResistingFrost

Gets or sets resisting frost flag. Note: This value is intentionally not serialized. It should only be set by live effects.

Declaration

public bool IsResistingFrost { get; set; }

Property Value

Type	Description
Boolean

IsResistingMagic

Gets or sets resisting magic flag. Note: This value is intentionally not serialized. It should only be set by live effects.

Declaration

public bool IsResistingMagic { get; set; }

Property Value

Type	Description
Boolean

IsResistingShock

Gets or sets resisting shock flag. Note: This value is intentionally not serialized. It should only be set by live effects.

Declaration

public bool IsResistingShock { get; set; }

Property Value

Type	Description
Boolean

IsSilenced

Declaration

public bool IsSilenced { get; set; }

Property Value

Type	Description
Boolean

IsSlowFalling

Declaration

public bool IsSlowFalling { get; set; }

Property Value

Type	Description
Boolean

IsWaterBreathing

Declaration

public bool IsWaterBreathing { get; set; }

Property Value

Type	Description
Boolean

IsWaterWalking

Declaration

public bool IsWaterWalking { get; set; }

Property Value

Type	Description
Boolean

ItemEquipTable

Declaration

public ItemEquipTable ItemEquipTable { get; }

Property Value

Type	Description
ItemEquipTable

Items

Declaration

public ItemCollection Items { get; set; }

Property Value

Type	Description
ItemCollection

Level

Declaration

public int Level { get; set; }

Property Value

Type	Description
Int32

MagicalConcealmentFlags

Declaration

public MagicalConcealmentFlags MagicalConcealmentFlags { get; set; }

Property Value

Type	Description
MagicalConcealmentFlags

MagicResist

Declaration

public int MagicResist { get; }

Property Value

Type	Description
Int32

MaxBreath

Declaration

public int MaxBreath { get; }

Property Value

Type	Description
Int32

MaxEncumbrance

Declaration

public int MaxEncumbrance { get; }

Property Value

Type	Description
Int32

MaxFatigue

Declaration

public int MaxFatigue { get; }

Property Value

Type	Description
Int32

MaxHealth

Declaration

public int MaxHealth { get; set; }

Property Value

Type	Description
Int32

MaxHealthLimiter

Declaration

public int MaxHealthLimiter { get; }

Property Value

Type	Description
Int32

MaxMagicka

Declaration

public int MaxMagicka { get; set; }

Property Value

Type	Description
Int32

MaxMagickaModifier

Declaration

public int MaxMagickaModifier { get; }

Property Value

Type	Description
Int32

MinMetalToHit

Declaration

public WeaponMaterialTypes MinMetalToHit { get; set; }

Property Value

Type	Description
WeaponMaterialTypes

Name

Declaration

public string Name { get; set; }

Property Value

Type	Description
String

Quiesce

Set true to suppress events during state restore.

Declaration

public bool Quiesce { get; set; }

Property Value

Type	Description
Boolean

RawMaxHealth

Declaration

public int RawMaxHealth { get; }

Property Value

Type	Description
Int32

RawMaxMagicka

Declaration

public int RawMaxMagicka { get; }

Property Value

Type	Description
Int32

Resistances

Declaration

public DaggerfallResistances Resistances { get; set; }

Property Value

Type	Description
DaggerfallResistances

Skills

Declaration

public DaggerfallSkills Skills { get; set; }

Property Value

Type	Description
DaggerfallSkills

Stats

Declaration

public DaggerfallStats Stats { get; set; }

Property Value

Type	Description
DaggerfallStats

Team

Declaration

public MobileTeams Team { get; set; }

Property Value

Type	Description
MobileTeams

ToHitModifier

Declaration

public int ToHitModifier { get; }

Property Value

Type	Description
Int32

WorldContext

Gets or sets world context of this entity for floating origin support. Not required by all systems but this is a nice central place for mobiles.

Declaration

public WorldContext WorldContext { get; set; }

Property Value

Type	Description
WorldContext

Methods

AddSpell(EffectBundleSettings)

Declaration

public void AddSpell(EffectBundleSettings spell)

Parameters

Type	Name	Description
EffectBundleSettings	spell

ChangeChanceToHitModifier(Int32)

Declaration

public void ChangeChanceToHitModifier(int amount)

Parameters

Type	Name	Description
Int32	amount

ChangeMaxMagickaModifier(Int32)

Declaration

public void ChangeMaxMagickaModifier(int amount)

Parameters

Type	Name	Description
Int32	amount

ClearConstantEffects()

Constant effects are cleared each frame by peered entity effect manager and must be actively set by effects maintaining them.

Declaration

public virtual void ClearConstantEffects()

DecreaseFatigue(Int32, Boolean)

Declaration

public int DecreaseFatigue(int amount, bool assignMultiplier = false)

Parameters

Type	Name	Description
Int32	amount
Boolean	assignMultiplier

Returns

Type	Description
Int32

DecreaseHealth(Int32)

Declaration

public int DecreaseHealth(int amount)

Parameters

Type	Name	Description
Int32	amount

Returns

Type	Description
Int32

DecreaseMagicka(Int32)

Declaration

public int DecreaseMagicka(int amount)

Parameters

Type	Name	Description
Int32	amount

Returns

Type	Description
Int32

DeleteSpell(Int32)

Declaration

public void DeleteSpell(int index)

Parameters

Type	Name	Description
Int32	index

DeleteTaggedSpells(String)

Declaration

public void DeleteTaggedSpells(string tag)

Parameters

Type	Name	Description
String	tag

DeserializeSpellbook(EffectBundleSettings[])

Declaration

public void DeserializeSpellbook(EffectBundleSettings[] otherSpellbook)

Parameters

Type	Name	Description
EffectBundleSettings[]	otherSpellbook

FillVitalSigns()

Declaration

public void FillVitalSigns()

FixedUpdate()

Called by DaggerfallEntityBehaviour at regular intervals.

Declaration

public virtual void FixedUpdate()

GetClassCareerTemplate(ClassCareers)

Gets class career template. Currently read from CLASS??.CFG. Would like to migrate this to a custom JSON format later.

Declaration

public static DFCareer GetClassCareerTemplate(ClassCareers career)

Parameters

Type	Name	Description
ClassCareers	career

Returns

Type	Description
DFCareer

GetCustomCareerTemplate(Int32)

Gets the career template for a custom (ie: mod-provided) enemy type

Declaration

public static DFCareer GetCustomCareerTemplate(int enemyId)

Parameters

Type	Name	Description
Int32	enemyId	ID, as defined in EnemyBasics.Enemies

Returns

Type	Description
DFCareer	The custom DFCareer template registered for this id, or null

GetMajorSkills()

Gets list of major skills.

Declaration

public List<DFCareer.Skills> GetMajorSkills()

Returns

Type	Description
List<DFCareer.Skills>

GetMinorSkills()

Gets list of minor skills.

Declaration

public List<DFCareer.Skills> GetMinorSkills()

Returns

Type	Description
List<DFCareer.Skills>

GetMiscSkills()

Gets list of miscellaneous skills.

Declaration

public List<DFCareer.Skills> GetMiscSkills()

Returns

Type	Description
List<DFCareer.Skills>

GetMonsterCareerTemplate(MonsterCareers)

Gets monster career template. Currently read from MONSTER.BSA. Would like to migrate this to a custom JSON format later.

Declaration

public static DFCareer GetMonsterCareerTemplate(MonsterCareers career)

Parameters

Type	Name	Description
MonsterCareers	career

Returns

Type	Description
DFCareer

GetPrimarySkills()

Gets list of primary skills.

Declaration

public List<DFCareer.Skills> GetPrimarySkills()

Returns

Type	Description
List<DFCareer.Skills>

GetRaceGenderAttackSound(Races, Genders, Boolean)

Declaration

public static SoundClips GetRaceGenderAttackSound(Races race, Genders gender, bool isPlayerAttack = false)

Parameters

Type	Name	Description
Races	race
Genders	gender
Boolean	isPlayerAttack

Returns

Type	Description
SoundClips

GetRaceGenderPainSound(Races, Genders, Boolean)

Declaration

public static SoundClips GetRaceGenderPainSound(Races race, Genders gender, bool heavyDamage)

Parameters

Type	Name	Description
Races	race
Genders	gender
Boolean	heavyDamage

Returns

Type	Description
SoundClips

GetResistanceChance(DFCareer.Elements)

Gets current total resistance chance for an element. This is only used when corresponding elemental resistance flag is raised by effect.

Declaration

public int GetResistanceChance(DFCareer.Elements elementType)

Parameters

Type	Name	Description
DFCareer.Elements	elementType	Element type to check total resistance value of.

Returns

Type	Description
Int32	Resistance chance for that element.

GetSpell(Int32, out EffectBundleSettings)

Declaration

public bool GetSpell(int index, out EffectBundleSettings spell)

Parameters

Type	Name	Description
Int32	index
EffectBundleSettings	spell

Returns

Type	Description
Boolean

GetSpells()

Declaration

public EffectBundleSettings[] GetSpells()

Returns

Type	Description
EffectBundleSettings[]

HasConcealment(MagicalConcealmentFlags)

Helper to check if specific magical concealment flags are active on player.

Declaration

public bool HasConcealment(MagicalConcealmentFlags flags)

Parameters

Type	Name	Description
MagicalConcealmentFlags	flags	Comparison flags.

Returns

Type	Description
Boolean	True if matching.

HasResistanceFlag(DFCareer.Elements)

Check if entity has a specific resistance flag raised.

Declaration

public bool HasResistanceFlag(DFCareer.Elements elementType)

Parameters

Type	Name	Description
DFCareer.Elements	elementType	Element type.

Returns

Type	Description
Boolean

IncreaseFatigue(Int32, Boolean)

Declaration

public int IncreaseFatigue(int amount, bool assignMultiplier = false)

Parameters

Type	Name	Description
Int32	amount
Boolean	assignMultiplier

Returns

Type	Description
Int32

IncreaseHealth(Int32)

Declaration

public int IncreaseHealth(int amount)

Parameters

Type	Name	Description
Int32	amount

Returns

Type	Description
Int32

IncreaseMagicka(Int32)

Declaration

public int IncreaseMagicka(int amount)

Parameters

Type	Name	Description
Int32	amount

Returns

Type	Description
Int32

RaiseOnDeathEvent()

Declaration

protected void RaiseOnDeathEvent()

RaiseResistanceChance(DFCareer.Elements, Int32)

Raise resistance chance total for an element. This is only used when corresponding element resistance flag is raised by effect. Resistance chance is reset each frame so multiple effects can contribute to total resistance chance.

Declaration

public void RaiseResistanceChance(DFCareer.Elements elementType, int value)

Parameters

Type	Name	Description
DFCareer.Elements	elementType	Element type to raise resistance of.
Int32	value	Amount to raise resist chance for element.

RegisterCustomCareerTemplate(Int32, DFCareer)

Sets the career template for a custom (ie: mod-provided) enemy type.

Declaration

public static void RegisterCustomCareerTemplate(int enemyId, DFCareer career)

Parameters

Type	Name	Description
Int32	enemyId	ID, as defined in EnemyBasics.Enemies
DFCareer	career	The custom DFCareer template to register

ResetEntityState()

Called when starting a new game or when a game starts to load. Used to clear out any state that should not persist to a new game session.

Declaration

protected virtual void ResetEntityState()

SerializeSpellbook()

Declaration

public EffectBundleSettings[] SerializeSpellbook()

Returns

Type	Description
EffectBundleSettings[]

SetBreath(Int32)

Declaration

public virtual int SetBreath(int amount)

Parameters

Type	Name	Description
Int32	amount

Returns

Type	Description
Int32

SetDecreasedArmorValueModifier(Int32)

Declaration

public void SetDecreasedArmorValueModifier(int amount)

Parameters

Type	Name	Description
Int32	amount

SetEntityDefaults()

Sets entity defaults during scene startup. Defaults should be overwritten by normal processes such as character creation, monster instantiation, and save game deserialization.

Declaration

public abstract void SetEntityDefaults()

SetFatigue(Int32, Boolean)

Declaration

public virtual int SetFatigue(int amount, bool restoreMode = false)

Parameters

Type	Name	Description
Int32	amount
Boolean	restoreMode

Returns

Type	Description
Int32

SetHealth(Int32, Boolean)

Declaration

public virtual int SetHealth(int amount, bool restoreMode = false)

Parameters

Type	Name	Description
Int32	amount
Boolean	restoreMode

Returns

Type	Description
Int32

SetIncreasedArmorValueModifier(Int32)

Declaration

public void SetIncreasedArmorValueModifier(int amount)

Parameters

Type	Name	Description
Int32	amount

SetIncreasedWeightAllowanceMultiplier(Single)

Declaration

public void SetIncreasedWeightAllowanceMultiplier(float amount)

Parameters

Type	Name	Description
Single	amount

SetMagicka(Int32, Boolean)

Declaration

public virtual int SetMagicka(int amount, bool restoreMode = false)

Parameters

Type	Name	Description
Int32	amount
Boolean	restoreMode

Returns

Type	Description
Int32

SetMaxHealthLimiter(Int32)

Declaration

public void SetMaxHealthLimiter(int amount)

Parameters

Type	Name	Description
Int32	amount

SetResistanceFlag(DFCareer.Elements, Boolean)

Raise or lower a specific resistance flag.

Declaration

public void SetResistanceFlag(DFCareer.Elements elementType, bool value)

Parameters

Type	Name	Description
DFCareer.Elements	elementType	Element type.
Boolean	value	Desired resistance flag.

SetSpell(Int32, EffectBundleSettings)

Declaration

public void SetSpell(int index, EffectBundleSettings spell)

Parameters

Type	Name	Description
Int32	index
EffectBundleSettings	spell

SortSpellsAlpha()

Declaration

public void SortSpellsAlpha()

SortSpellsPointCost()

Declaration

public void SortSpellsPointCost()

SpellbookCount()

Declaration

public int SpellbookCount()

Returns

Type	Description
Int32

SwapSpells(Int32, Int32)

Declaration

public void SwapSpells(int indexA, int indexB)

Parameters

Type	Name	Description
Int32	indexA
Int32	indexB

TallySkill(DFCareer.Skills, Int16)

Tally skill usage.

Declaration

public virtual void TallySkill(DFCareer.Skills skill, short amount)

Parameters

Type	Name	Description
DFCareer.Skills	skill
Int16	amount

Update(DaggerfallEntityBehaviour)

Called by DaggerfallEntityBehaviour each frame.

Declaration

public virtual void Update(DaggerfallEntityBehaviour sender)

Parameters

Type	Name	Description
DaggerfallEntityBehaviour	sender	DaggerfallEntityBehaviour making call.

UpdateEquippedArmorValues(DaggerfallUnityItem, Boolean)

Update armor values after equipping or unequipping a piece of armor.

Declaration

public void UpdateEquippedArmorValues(DaggerfallUnityItem armor, bool equipping)

Parameters

Type	Name	Description
DaggerfallUnityItem	armor
Boolean	equipping

Events

OnDeath

Declaration

public event DaggerfallEntity.OnDeathHandler OnDeath

Event Type

Type	Description
DaggerfallEntity.OnDeathHandler

OnExhausted

Declaration

public event DaggerfallEntity.OnExhaustedHandler OnExhausted

Event Type

Type	Description
DaggerfallEntity.OnExhaustedHandler

OnMagickaDepleted

Declaration

public event DaggerfallEntity.OnMagickaDepletedHandler OnMagickaDepleted

Event Type

Type	Description
DaggerfallEntity.OnMagickaDepletedHandler