Show / Hide Table of Contents

Class IncumbentEffect

Some effects in Daggerfall add to the state an existing like-kind effect (the incumbent) rather than become instantiated as a new effect on the host entity. One example is a drain effect which only adds to the magnitude of incumbent drain for same stat. Another example is an effect which tops up the duration of same effect in progress. This class establishes a base for these incumbent effects to coordinate. NOTES: Unflagged incumbent effects (IsIncumbent == false) do not persist beyond AddState() call. They will never receive a single MagicRound() call and are never saved/loaded. The flagged incumbent (IsIncumbent == true) receives MagicRound() calls and is saved/load as normal.

Inheritance
Object
BaseEntityEffect
IncumbentEffect
Climbing
ComprehendLanguages
ConcealmentEffect
ContinuousDamageFatigue
ContinuousDamageHealth
ContinuousDamageSpellPoints
DetectEffect
DiseaseEffect
DrainEffect
ElementalResistance
FortifyEffect
FreeAction
Jumping
Levitate
LightNormal
Lock
MaceOfMolagBalEffect
MageLight
Open
Paralyze
PassiveSpecialsEffect
PoisonEffect
RacialOverrideEffect
Regenerate
Shield
Silence
Slowfall
SoulTrap
SpellAbsorption
SpellReflection
SpellResistance
VampiricFortifyEffect
WaterBreathing
WaterWalking
Implements
IEntityEffect
IMacroContextProvider
Inherited Members
BaseEntityEffect.properties
BaseEntityEffect.settings
BaseEntityEffect.potionProperties
BaseEntityEffect.caster
BaseEntityEffect.manager
BaseEntityEffect.variantCount
BaseEntityEffect.currentVariant
BaseEntityEffect.bypassSavingThrows
BaseEntityEffect.Properties
BaseEntityEffect.Settings
BaseEntityEffect.EnchantmentParam
BaseEntityEffect.PotionProperties
BaseEntityEffect.Caster
BaseEntityEffect.RoundsRemaining
BaseEntityEffect.ChanceSuccess
BaseEntityEffect.StatMods
BaseEntityEffect.StatMaxMods
BaseEntityEffect.SkillMods
BaseEntityEffect.ResistanceMods
BaseEntityEffect.Key
BaseEntityEffect.GroupName
BaseEntityEffect.SubGroupName
BaseEntityEffect.DisplayName
BaseEntityEffect.SpellMakerDescription
BaseEntityEffect.SpellBookDescription
BaseEntityEffect.ParentBundle
BaseEntityEffect.HasEnded
BaseEntityEffect.VariantCount
BaseEntityEffect.CurrentVariant
BaseEntityEffect.BypassSavingThrows
BaseEntityEffect.SetProperties()
BaseEntityEffect.SetPotionProperties()
BaseEntityEffect.GetEnchantmentSettings()
BaseEntityEffect.GetEnchantmentSettings(EnchantmentParam)
BaseEntityEffect.HasItemMakerFlags(ItemMakerFlags)
BaseEntityEffect.HasEnchantmentPayloadFlags(EnchantmentPayloadFlags)
BaseEntityEffect.EnchantmentPayloadCallback(EnchantmentPayloadFlags, Nullable<EnchantmentParam>, DaggerfallEntityBehaviour, DaggerfallEntityBehaviour, DaggerfallUnityItem, Int32)
BaseEntityEffect.IsEnchantmentExclusiveTo(EnchantmentSettings[], Nullable<EnchantmentParam>)
BaseEntityEffect.GetForcedEnchantments(Nullable<EnchantmentParam>)
BaseEntityEffect.End()
BaseEntityEffect.ConstantEffect()
BaseEntityEffect.MagicRound()
BaseEntityEffect.RemoveRound()
BaseEntityEffect.GetAttributeMod(DFCareer.Stats)
BaseEntityEffect.GetAttributeMaximumMod(DFCareer.Stats)
BaseEntityEffect.GetSkillMod(DFCareer.Skills)
BaseEntityEffect.HealAttributeDamage(DFCareer.Stats, Int32)
BaseEntityEffect.CureAttributeDamage()
BaseEntityEffect.HealSkillDamage(DFCareer.Skills, Int32)
BaseEntityEffect.CureSkillDamage()
BaseEntityEffect.AllAttributesHealed()
BaseEntityEffect.AllSkillsHealed()
BaseEntityEffect.ChanceValue()
BaseEntityEffect.RollChance()
BaseEntityEffect.CompareSettings(IEntityEffect)
BaseEntityEffect.GetPeeredEntityBehaviour(EntityEffectManager)
BaseEntityEffect.GetMagnitude(DaggerfallEntityBehaviour)
BaseEntityEffect.PlayerAggro()
BaseEntityEffect.SetStatMod(DFCareer.Stats, Int32)
BaseEntityEffect.SetStatMaxMod(DFCareer.Stats, Int32)
BaseEntityEffect.ChangeStatMod(DFCareer.Stats, Int32)
BaseEntityEffect.ChangeStatMaxMod(DFCareer.Stats, Int32)
BaseEntityEffect.SetSkillMod(DFCareer.Skills, Int32)
BaseEntityEffect.ChangeSkillMod(DFCareer.Skills, Int32)
BaseEntityEffect.SetResistanceMod(DFCareer.Elements, Int32)
BaseEntityEffect.ChanceResistanceMod(DFCareer.Elements, Int32)
BaseEntityEffect.AssignPotionRecipes(PotionRecipe[])
BaseEntityEffect.DefaultEffectSettings()
BaseEntityEffect.SetEffectDuration(EffectSettings, Int32, Int32, Int32)
BaseEntityEffect.SetEffectChance(EffectSettings, Int32, Int32, Int32)
BaseEntityEffect.SetEffectMagnitude(EffectSettings, Int32, Int32, Int32, Int32, Int32)
BaseEntityEffect.MakeClassicKey(Byte, Byte, BaseEntityEffect.ClassicEffectFamily)
BaseEntityEffect.ReverseClasicKey(Int32, Byte, Byte, BaseEntityEffect.ClassicEffectFamily)
BaseEntityEffect.MakeEffectCosts(Single, Single, Single)
BaseEntityEffect.GetSaveData()
BaseEntityEffect.RestoreSaveData(Object)
BaseEntityEffect.GetMacroDataSource()
Namespace: DaggerfallWorkshop.Game.MagicAndEffects.MagicEffects
Assembly: Assembly-CSharp.dll
Syntax
public abstract class IncumbentEffect : BaseEntityEffect, IEntityEffect, IMacroContextProvider

Properties

| Improve this Doc View Source

IsIncumbent

Declaration
public bool IsIncumbent { get; }
Property Value
Type Description
Boolean

Methods

| Improve this Doc View Source

AddState(IncumbentEffect)

Declaration
protected abstract void AddState(IncumbentEffect incumbent)
Parameters
Type Name Description
IncumbentEffect incumbent
| Improve this Doc View Source

BecomeIncumbent()

Declaration
protected virtual void BecomeIncumbent()
| Improve this Doc View Source

IsLikeKind(IncumbentEffect)

Declaration
protected abstract bool IsLikeKind(IncumbentEffect other)
Parameters
Type Name Description
IncumbentEffect other
Returns
Type Description
Boolean
| Improve this Doc View Source

ResignAsIncumbent()

Resign as incumbent effect. This allows an incumbent to immediately allow for a new incumbent to take over its post. Useful for when incumbent does not want to receive any further AddState() calls and cannot wait for magic round tick to expire.

Declaration
protected void ResignAsIncumbent()
| Improve this Doc View Source

Resume(EntityEffectManager.EffectSaveData_v1, EntityEffectManager, DaggerfallEntityBehaviour)

Declaration
public override void Resume(EntityEffectManager.EffectSaveData_v1 effectData, EntityEffectManager manager, DaggerfallEntityBehaviour caster = null)
Parameters
Type Name Description
EntityEffectManager.EffectSaveData_v1 effectData
EntityEffectManager manager
DaggerfallEntityBehaviour caster
Overrides
BaseEntityEffect.Resume(EntityEffectManager.EffectSaveData_v1, EntityEffectManager, DaggerfallEntityBehaviour)
| Improve this Doc View Source

Start(EntityEffectManager, DaggerfallEntityBehaviour)

Declaration
public override void Start(EntityEffectManager manager, DaggerfallEntityBehaviour caster = null)
Parameters
Type Name Description
EntityEffectManager manager
DaggerfallEntityBehaviour caster
Overrides
BaseEntityEffect.Start(EntityEffectManager, DaggerfallEntityBehaviour)

Implements

IEntityEffect
IMacroContextProvider
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX