Interface IEntityEffect

Interface to an entity effect.

Inherited Members

IMacroContextProvider.GetMacroDataSource()

Namespace: DaggerfallWorkshop.Game.MagicAndEffects

Assembly: Assembly-CSharp.dll

Syntax

public interface IEntityEffect : IMacroContextProvider

Properties

BypassSavingThrows

True if spell effect always lands regardless of saving throws.

Declaration

bool BypassSavingThrows { get; }

Property Value

Type	Description
Boolean

Caster

Gets the caster entity behaviour of this effect (can return null).

Declaration

DaggerfallEntityBehaviour Caster { get; }

Property Value

Type	Description
DaggerfallEntityBehaviour

ChanceSuccess

Gets flag stating if effect passed a chance check on start. If always false if effect does not support chance component.

Declaration

bool ChanceSuccess { get; }

Property Value

Type	Description
Boolean

CurrentVariant

Sets current variant for multi-effects.

Declaration

int CurrentVariant { get; set; }

Property Value

Type	Description
Int32

DisplayName

Gets display name from properties or construct one from Group+SubGroup text in properties. This allows effects to set a custom display name or just roll with automatic names. Daggerfall appears to use first token of spellmaker/spellbook description, but we want more control for effect mods.

Declaration

string DisplayName { get; }

Property Value

Type	Description
String

EnchantmentParam

Gets or sets enchantment param for enchantment effects. If this property is null then effect is not a live enchantment.

Declaration

EnchantmentParam? EnchantmentParam { get; set; }

Property Value

Type	Description
Nullable<EnchantmentParam>

GroupName

Group display name (used by crafting stations).

Declaration

string GroupName { get; }

Property Value

Type	Description
String

HasEnded

True if effect has ended by calling End();

Declaration

bool HasEnded { get; }

Property Value

Type	Description
Boolean

Key

Gets key from properties.

Declaration

string Key { get; }

Property Value

Type	Description
String

ParentBundle

Gets or sets parent bundle for this effect. Will be null for template effects.

Declaration

LiveEffectBundle ParentBundle { get; set; }

Property Value

Type	Description
LiveEffectBundle

PotionProperties

Gets effect potion properties (if any).

Declaration

PotionProperties PotionProperties { get; }

Property Value

Type	Description
PotionProperties

Properties

Gets effect properties.

Declaration

EffectProperties Properties { get; }

Property Value

Type	Description
EffectProperties

ResistanceMods

Gets array DaggerfallResistances.Count items wide. Array items represent Fire, Cold, Poison/Disease, Shock, Magic. Effect implementation should set modifier values for resistances when part of payload. For example, a "Resist Fire" effect would set the current modifier for Fire resistance (such as +30 to Fire resistance). Use (int)DFCareer.Resistances.ResistanceName to get index.

Declaration

int[] ResistanceMods { get; }

Property Value

Type	Description
Int32[]

RoundsRemaining

Gets or sets number of magic rounds remaining.

Declaration

int RoundsRemaining { get; set; }

Property Value

Type	Description
Int32

Settings

Gets or sets current effect settings.

Declaration

EffectSettings Settings { get; set; }

Property Value

Type	Description
EffectSettings

SkillMods

Get array DaggerfallSkills.Count items wide. Array items represent Medical, Etiquette, Streetwise, etc. Effect implementation should set modifier values for skills when part of payload. For example, a "Tongues" effect would set the current modifier for all language skills (such as +5 to Dragonish, +5 to Giantish, and so on). Use (int)DFCareer.Skills.SkillName to get index.

Declaration

int[] SkillMods { get; }

Property Value

Type	Description
Int32[]

SpellBookDescription

Description for spellbook.

Declaration

TextFile.Token[] SpellBookDescription { get; }

Property Value

Type	Description
TextFile.Token[]

SpellMakerDescription

Description for spellmaker.

Declaration

TextFile.Token[] SpellMakerDescription { get; }

Property Value

Type	Description
TextFile.Token[]

StatMaxMods

Gets array DaggerfallStats.Count items wide. Array items represent Strength, Intelligence, Willpower, etc. Allows an effect to temporarily override stat maximum value.

Declaration

int[] StatMaxMods { get; }

Property Value

Type	Description
Int32[]

StatMods

Gets array DaggerfallStats.Count items wide. Array items represent Strength, Intelligence, Willpower, etc. Effect implementation should set modifier values for stats when part of payload. For example, a "Damage Strength" effect would set the current modifier for Strength (such as -5 to Strength). Use (int)DFCareer.State.StatName to get index.

Declaration

int[] StatMods { get; }

Property Value

Type	Description
Int32[]

SubGroupName

SubGroup display name (used by crafting stations).

Declaration

string SubGroupName { get; }

Property Value

Type	Description
String

VariantCount

Gets total number of variants for multi-effects.

Declaration

int VariantCount { get; }

Property Value

Type	Description
Int32

Methods

ConstantEffect()

Use this for work performed every frame.

Declaration

void ConstantEffect()

EnchantmentPayloadCallback(EnchantmentPayloadFlags, Nullable<EnchantmentParam>, DaggerfallEntityBehaviour, DaggerfallEntityBehaviour, DaggerfallUnityItem, Int32)

Enchantment payload callback for enchantment to perform custom execution based on context. These callbacks are performed directly from template, not from a live instance of effect. Do not store state in effect during callbacks. Not used by EnchantmentPayloadFlags.Held - rather, an effect instance bundle is assigned to entity's effect manager to execute as normal.

Declaration

PayloadCallbackResults? EnchantmentPayloadCallback(EnchantmentPayloadFlags context, EnchantmentParam? param = null, DaggerfallEntityBehaviour sourceEntity = null, DaggerfallEntityBehaviour targetEntity = null, DaggerfallUnityItem sourceItem = null, int sourceDamage = 0)

Parameters

Type	Name	Description
EnchantmentPayloadFlags	context
Nullable<EnchantmentParam>	param
DaggerfallEntityBehaviour	sourceEntity
DaggerfallEntityBehaviour	targetEntity
DaggerfallUnityItem	sourceItem
Int32	sourceDamage

Returns

Type	Description
Nullable<PayloadCallbackResults>

End()

Called when bundle lifetime is at an end. Use this for any wrap-up work.

Declaration

void End()

GetEnchantmentSettings()

Gets array of enchantment settings supported by this effect. Can return a null or empty array, especially if effect not an enchantment.

Declaration

EnchantmentSettings[] GetEnchantmentSettings()

Returns

Type	Description
EnchantmentSettings[]

GetEnchantmentSettings(EnchantmentParam)

Helper to get a specific enchantment setting based on param. Can return null if enchantment with param not found.

Declaration

EnchantmentSettings? GetEnchantmentSettings(EnchantmentParam param)

Parameters

Type	Name	Description
EnchantmentParam	param

Returns

Type	Description
Nullable<EnchantmentSettings>

GetForcedEnchantments(Nullable<EnchantmentParam>)

Gets related enchantments that will be forced onto item along with this enchantment. Only used by Soul Bound in classic gameplay.

Declaration

ForcedEnchantmentSet? GetForcedEnchantments(EnchantmentParam? param = null)

Parameters

Type	Name	Description
Nullable<EnchantmentParam>	param

Returns

Type	Description
Nullable<ForcedEnchantmentSet>

GetSaveData()

Get effect state data to serialize.

Declaration

object GetSaveData()

Returns

Type	Description
Object

HasEnchantmentPayloadFlags(EnchantmentPayloadFlags)

Helper to check if properties contain the specified enchantment payload flags

Declaration

bool HasEnchantmentPayloadFlags(EnchantmentPayloadFlags flags)

Parameters

Type	Name	Description
EnchantmentPayloadFlags	flags

Returns

Type	Description
Boolean

HasItemMakerFlags(ItemMakerFlags)

Helper to check if properties contain the specified item maker flags.

Declaration

bool HasItemMakerFlags(ItemMakerFlags flags)

Parameters

Type	Name	Description
ItemMakerFlags	flags

Returns

Type	Description
Boolean

IsEnchantmentExclusiveTo(EnchantmentSettings[], Nullable<EnchantmentParam>)

Enchantment can flag that it is exclusive to one or more enchantments in array provided. Used by enchanting window to prevent certain enchantments from being selected together.

Declaration

bool IsEnchantmentExclusiveTo(EnchantmentSettings[] settingsToTest, EnchantmentParam? comparerParam = null)

Parameters

Type	Name	Description
EnchantmentSettings[]	settingsToTest
Nullable<EnchantmentParam>	comparerParam

Returns

Type	Description
Boolean

MagicRound()

Use this for any work performed every magic round.

Declaration

void MagicRound()

RestoreSaveData(Object)

Restore effect state from serialized data.

Declaration

void RestoreSaveData(object dataIn)

Parameters

Type	Name	Description
Object	dataIn

Resume(EntityEffectManager.EffectSaveData_v1, EntityEffectManager, DaggerfallEntityBehaviour)

Called by an EntityEffect manage when parent bundle is resumed from save.

Declaration

void Resume(EntityEffectManager.EffectSaveData_v1 effectData, EntityEffectManager manager, DaggerfallEntityBehaviour caster = null)

Parameters

Type	Name	Description
EntityEffectManager.EffectSaveData_v1	effectData
EntityEffectManager	manager
DaggerfallEntityBehaviour	caster

RollChance()

Perform a chance roll on this effect based on chance settings. Can be used by custom chance effects that need to roll chance other than at start.

Declaration

bool RollChance()

Returns

Type	Description
Boolean

Start(EntityEffectManager, DaggerfallEntityBehaviour)

Called by an EntityEffectManager when parent bundle is attached to host entity. Use this for setup or immediate work performed only once.

Declaration

void Start(EntityEffectManager manager, DaggerfallEntityBehaviour caster = null)

Parameters

Type	Name	Description
EntityEffectManager	manager
DaggerfallEntityBehaviour	caster