Class EntityEffectBundle
Stores effect settings for transport to an entity.
Namespace: DaggerfallWorkshop.Game.MagicAndEffects
Assembly: Assembly-CSharp.dll
Syntax
public class EntityEffectBundle
Constructors
| Improve this Doc View SourceEntityEffectBundle()
Default constructor.
Declaration
public EntityEffectBundle()
EntityEffectBundle(EffectBundleSettings, DaggerfallEntityBehaviour)
Settings + caster constructor.
Declaration
public EntityEffectBundle(EffectBundleSettings settings, DaggerfallEntityBehaviour casterEntityBehaviour = null)
Parameters
Type | Name | Description |
---|---|---|
EffectBundleSettings | settings | Settings of this effect bundle. |
DaggerfallEntityBehaviour | casterEntityBehaviour | Caster of this effect bundle (optional). |
Properties
| Improve this Doc View SourceCastByItem
Declaration
public DaggerfallUnityItem CastByItem { get; set; }
Property Value
Type | Description |
---|---|
DaggerfallUnityItem |
CasterEntityBehaviour
Gets or sets caster entity (sender) of effect bundle where one is present. Example of caster entity is an enemy mage or monster.
Declaration
public DaggerfallEntityBehaviour CasterEntityBehaviour { get; set; }
Property Value
Type | Description |
---|---|
DaggerfallEntityBehaviour |
FromEquippedItem
Gets or sets the equipped item providing this bundle.
Declaration
public DaggerfallUnityItem FromEquippedItem { get; set; }
Property Value
Type | Description |
---|---|
DaggerfallUnityItem |
IsFromEquippedItem
True if bundle is from an equipped source item. These bundles will last until player unequips or item breaks (which also unequips item).
Declaration
public bool IsFromEquippedItem { get; }
Property Value
Type | Description |
---|---|
Boolean |
ReflectedCount
Gets the number of times this bundle has been reflected.
Declaration
public int ReflectedCount { get; }
Property Value
Type | Description |
---|---|
Int32 |
Settings
Gets or sets effect bundle settings.
Declaration
public EffectBundleSettings Settings { get; set; }
Property Value
Type | Description |
---|---|
EffectBundleSettings |
Methods
| Improve this Doc View SourceAddRuntimeFlags(BundleRuntimeFlags)
Declaration
public void AddRuntimeFlags(BundleRuntimeFlags flags)
Parameters
Type | Name | Description |
---|---|---|
BundleRuntimeFlags | flags |
HasMatchForClassicEffect(SpellRecord.EffectRecordData)
Checks if effect bundle contains an effect matching a classic effect record.
Declaration
public bool HasMatchForClassicEffect(SpellRecord.EffectRecordData effectRecord)
Parameters
Type | Name | Description |
---|---|---|
SpellRecord.EffectRecordData | effectRecord | Effect record to compare with native bundle effects. |
Returns
Type | Description |
---|---|
Boolean | True if bundle contains effect matching classic effect record. |
IncrementReflectionCount()
Increments reflection count.
Declaration
public void IncrementReflectionCount()
RemoveRuntimeFlags(BundleRuntimeFlags)
Declaration
public void RemoveRuntimeFlags(BundleRuntimeFlags flags)
Parameters
Type | Name | Description |
---|---|---|
BundleRuntimeFlags | flags |