Struct EnchantedItemForm
Namespace: OblivionMP.SDK.Common.Archetypes
Assembly: OblivionMP.SDK.Common.dll
A dynamic enchanted item (a weapon, armor or clothing a player enchanted): every field of the item plus its enchantment, enough to create the item on a client that has never seen it. Fields a form type does not have stay at their defaults.
[Archetype(Replication = Replication.OwnershipBased)]
public readonly struct EnchantedItemForm : IArchetype, IArchetypeQueryable, IEntityShape
Implements
IArchetype, IArchetypeQueryable, IEntityShape
Inherited Members
object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Properties
ArmorRating
The armor's rating, as the engine stores it.
public ushort ArmorRating { get; set; }
Property Value
AttackDamage
The weapon's base damage.
public ushort AttackDamage { get; set; }
Property Value
BipedFlags
The armor's or clothing's biped flags.
public byte BipedFlags { get; set; }
Property Value
BipedSlots
The body slots the armor or clothing covers.
public ushort BipedSlots { get; set; }
Property Value
BlueprintClassPath
The UE actor class that shows the item in the world and in hand, as a soft object path "/Package.Asset".
public NativeString256 BlueprintClassPath { get; set; }
Property Value
NativeString256
BodyPartActorClassPath
The UE actor class of armor or clothing worn on a body, as an object path; empty for weapons.
public NativeString256 BodyPartActorClassPath { get; set; }
Property Value
NativeString256
EffectsCount
public int EffectsCount { get; }
Property Value
EnchantmentCharge
The enchantment's own charge amount; -1 on enchantments the player made.
public int EnchantmentCharge { get; set; }
Property Value
EnchantmentCost
The enchantment's per-use charge cost, used only when its auto-calculation flag is off; -1 on enchantments the player made.
public int EnchantmentCost { get; set; }
Property Value
EnchantmentFlags
The enchantment's flags; bit 0 turns off the auto-calculated cost.
public byte EnchantmentFlags { get; set; }
Property Value
EnchantmentType
The kind of item the enchantment is made for.
public EnchantmentType EnchantmentType { get; set; }
Property Value
EnchantmentType
FemaleBipedModelBound
The bound radius of the model worn by a female character.
public float FemaleBipedModelBound { get; set; }
Property Value
FemaleBipedModelPath
The model worn by a female character, and its bound radius.
public NativeString256 FemaleBipedModelPath { get; set; }
Property Value
NativeString256
FemaleGroundModelBound
The bound radius of the female ground model.
public float FemaleGroundModelBound { get; set; }
Property Value
FemaleGroundModelPath
The model shown when the female version lies on the ground, and its bound radius.
public NativeString256 FemaleGroundModelPath { get; set; }
Property Value
NativeString256
FemaleIconPath
The path of the female version's inventory icon.
public NativeString256 FemaleIconPath { get; set; }
Property Value
NativeString256
Health
The item's full durability (weapons and armor).
public uint Health { get; set; }
Property Value
IconPath
The path of the weapon's inventory icon.
public NativeString256 IconPath { get; set; }
Property Value
NativeString256
IsValid
public bool IsValid { get; }
Property Value
ItemFormType
The engine form type of the item: armor (0x14), clothing (0x16) or weapon (0x21).
public byte ItemFormType { get; set; }
Property Value
MaleBipedModelBound
The bound radius of the model worn by a male character.
public float MaleBipedModelBound { get; set; }
Property Value
MaleBipedModelPath
The model worn by a male character, and its bound radius.
public NativeString256 MaleBipedModelPath { get; set; }
Property Value
NativeString256
MaleGroundModelBound
The bound radius of the male ground model.
public float MaleGroundModelBound { get; set; }
Property Value
MaleGroundModelPath
The model shown when the male version lies on the ground, and its bound radius.
public NativeString256 MaleGroundModelPath { get; set; }
Property Value
NativeString256
MaleIconPath
The inventory icons of the male and female versions.
public NativeString256 MaleIconPath { get; set; }
Property Value
NativeString256
MaxCharge
The item's full enchantment charge.
public ushort MaxCharge { get; set; }
Property Value
ModelBound
The bound radius of the weapon's model.
public float ModelBound { get; set; }
Property Value
ModelPath
The path of the weapon's 3D model, used in the inventory preview, in hand and when dropped.
public NativeString256 ModelPath { get; set; }
Property Value
NativeString256
Name
The item's display name.
public NativeString256 Name { get; set; }
Property Value
NativeString256
ScriptFormId
The form ID of the script attached to the item, from the game files; 0 when it has none.
public uint ScriptFormId { get; set; }
Property Value
Value
The item's gold value.
public int Value { get; set; }
Property Value
WeaponFlags
The weapon's flags.
public uint WeaponFlags { get; set; }
Property Value
WeaponReach
The weapon's reach.
public float WeaponReach { get; set; }
Property Value
WeaponSpeed
The weapon's speed.
public float WeaponSpeed { get; set; }
Property Value
WeaponType
The weapon's type (blade, blunt, staff, bow, ...).
public uint WeaponType { get; set; }
Property Value
Weight
The item's weight.
public float Weight { get; set; }
Property Value
Methods
AddEffects(in MagicEffectEntry)
[Changes("EnchantedItemForm.Field.Effects")]
public void AddEffects(in MagicEffectEntry value)
Parameters
value MagicEffectEntry
As<T>()
public T As<T>() where T : struct, IArchetypeQueryable
Returns
T
Type Parameters
T
ClearEffects()
[Changes("EnchantedItemForm.Field.Effects")]
public void ClearEffects()
ContainsEffects(in MagicEffectEntry)
public bool ContainsEffects(in MagicEffectEntry value)
Parameters
value MagicEffectEntry
Returns
GetEffects()
public NativeList<MagicEffectEntry>.ReadOnly GetEffects()
Returns
NativeList<MagicEffectEntry>.ReadOnly
GetEffects(int)
public MagicEffectEntry GetEffects(int index)
Parameters
index int
Returns
MagicEffectEntry
InsertEffects(int, in MagicEffectEntry)
[Changes("EnchantedItemForm.Field.Effects")]
public void InsertEffects(int index, in MagicEffectEntry value)
Parameters
index int
value MagicEffectEntry
Is<T>()
public bool Is<T>() where T : struct, IArchetypeQueryable
Returns
Type Parameters
T
Keep()
This entity, which it already is: a loop over this shape hands over the shape itself.
public EnchantedItemForm Keep()
Returns
Remarks
Here so taking something out of a loop reads the same whichever way the loop walks. Whether a shape is walked by chunk follows from what it includes, which the call site cannot see and which changes when an include does.
RemoveAtEffects(int)
[Changes("EnchantedItemForm.Field.Effects")]
public MagicEffectEntry RemoveAtEffects(int index)
Parameters
index int
Returns
MagicEffectEntry
SetEffects(in NativeList<MagicEffectEntry>)
[Changes("EnchantedItemForm.Field.Effects")]
public void SetEffects(in NativeList<MagicEffectEntry> value)
Parameters
value NativeList<MagicEffectEntry>
SetEffects(int, in MagicEffectEntry)
[Changes("EnchantedItemForm.Field.Effects")]
public void SetEffects(int index, in MagicEffectEntry value)
Parameters
index int
value MagicEffectEntry
TryAs<T>(out T)
public bool TryAs<T>(out T archetype) where T : struct, IArchetypeQueryable
Parameters
archetype T
Returns
Type Parameters
T