Show / Hide Table of Contents

Class DrainEffect

Drain effect base. Provides functionality common to all Drain effects which vary only by properties and stat. This effect uses an incumbent pattern where future applications of same effect type will only add to total magnitude of first effect of this type. Incumbent drain effect persists indefinitely until player heals stat enough for magnitude to reach 0.

Inheritance
Object
BaseEntityEffect
IncumbentEffect
DrainEffect
DrainAgility
DrainEndurance
DrainIntelligence
DrainLuck
DrainPersonality
DrainSpeed
DrainStrength
DrainWillpower
TransferEffect
Implements
IEntityEffect
IMacroContextProvider
Inherited Members
IncumbentEffect.Resume(EntityEffectManager.EffectSaveData_v1, EntityEffectManager, DaggerfallEntityBehaviour)
IncumbentEffect.IsIncumbent
IncumbentEffect.ResignAsIncumbent()
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.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.GetAttributeMod(DFCareer.Stats)
BaseEntityEffect.GetAttributeMaximumMod(DFCareer.Stats)
BaseEntityEffect.GetSkillMod(DFCareer.Skills)
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.GetMacroDataSource()
Namespace: DaggerfallWorkshop.Game.MagicAndEffects.MagicEffects
Assembly: Assembly-CSharp.dll
Syntax
public abstract class DrainEffect : IncumbentEffect, IEntityEffect, IMacroContextProvider

Fields

| Improve this Doc View Source

drainStat

Declaration
protected DFCareer.Stats drainStat
Field Value
Type Description
DFCareer.Stats
| Improve this Doc View Source

lastMagnitudeIncreaseAmount

Declaration
protected int lastMagnitudeIncreaseAmount
Field Value
Type Description
Int32
| Improve this Doc View Source

magnitude

Declaration
protected int magnitude
Field Value
Type Description
Int32

Properties

| Improve this Doc View Source

DrainStat

Declaration
public DFCareer.Stats DrainStat { get; }
Property Value
Type Description
DFCareer.Stats
| Improve this Doc View Source

Magnitude

Declaration
public int Magnitude { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

RoundsRemaining

Declaration
public override int RoundsRemaining { get; }
Property Value
Type Description
Int32
Overrides
BaseEntityEffect.RoundsRemaining

Methods

| Improve this Doc View Source

AddState(IncumbentEffect)

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

BecomeIncumbent()

Declaration
protected override void BecomeIncumbent()
Overrides
IncumbentEffect.BecomeIncumbent()
| Improve this Doc View Source

DecreaseMagnitude(Int32)

Declaration
public int DecreaseMagnitude(int amount)
Parameters
Type Name Description
Int32 amount
Returns
Type Description
Int32
| Improve this Doc View Source

GetSaveData()

Declaration
public override object GetSaveData()
Returns
Type Description
Object
Overrides
BaseEntityEffect.GetSaveData()
| Improve this Doc View Source

HealAttributeDamage(DFCareer.Stats, Int32)

Declaration
public override void HealAttributeDamage(DFCareer.Stats stat, int amount)
Parameters
Type Name Description
DFCareer.Stats stat
Int32 amount
Overrides
BaseEntityEffect.HealAttributeDamage(DFCareer.Stats, Int32)
| Improve this Doc View Source

IncreaseMagnitude(Int32)

Declaration
public void IncreaseMagnitude(int amount)
Parameters
Type Name Description
Int32 amount
| Improve this Doc View Source

IsLikeKind(IncumbentEffect)

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

RemoveRound()

Declaration
protected override int RemoveRound()
Returns
Type Description
Int32
Overrides
BaseEntityEffect.RemoveRound()
| Improve this Doc View Source

RestoreSaveData(Object)

Declaration
public override void RestoreSaveData(object dataIn)
Parameters
Type Name Description
Object dataIn
Overrides
BaseEntityEffect.RestoreSaveData(Object)
| 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
IncumbentEffect.Start(EntityEffectManager, DaggerfallEntityBehaviour)

Implements

IEntityEffect
IMacroContextProvider
  • Improve this Doc
  • View Source
In This Article
  • Fields
    • drainStat
    • lastMagnitudeIncreaseAmount
    • magnitude
  • Properties
    • DrainStat
    • Magnitude
    • RoundsRemaining
  • Methods
    • AddState(IncumbentEffect)
    • BecomeIncumbent()
    • DecreaseMagnitude(Int32)
    • GetSaveData()
    • HealAttributeDamage(DFCareer.Stats, Int32)
    • IncreaseMagnitude(Int32)
    • IsLikeKind(IncumbentEffect)
    • RemoveRound()
    • RestoreSaveData(Object)
    • Start(EntityEffectManager, DaggerfallEntityBehaviour)
  • Implements
Back to top Generated by DocFX