Struct MagicItemEffectSummary

Namespace

SkyrimForge.Game

Assembly

SkyrimForge.Game.dll

The values the game derives from a magic item's effects.

public readonly struct MagicItemEffectSummary : IEquatable<MagicItemEffectSummary>

Implements

IEquatable<MagicItemEffectSummary>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

MagicItemEffectSummary(Effect?, int, Effect?, float, uint, bool, IReadOnlyList<Effect>)

The values the game derives from a magic item's effects.

public MagicItemEffectSummary(Effect? CostliestEffect, int MaxCost, Effect? LargestAreaEffect, float HighestArea, uint Flags, bool SummonsExtraLargeCreature, IReadOnlyList<Effect> ProjectileEffects)

Parameters

CostliestEffect Effect?

The effect costing the most, or null where the item has none.

MaxCost int

The cost of CostliestEffect, or -1 where that is null.

LargestAreaEffect Effect?

The effect covering the largest area, or null where none does.

HighestArea float

The area of LargestAreaEffect.

Flags uint

The flags of the game's MagicItemDataCollector, whose bits CommonLib names kSkipCostiest, kSkipProjectiles, kSkipArea, and kOnlyFirstEffect. The collector's constructor sets them, so they do not describe the effects. An ingredient has kOnlyFirstEffect, and any other item has none.

SummonsExtraLargeCreature bool

Whether an effect of the item summons a creature the game classes as extra large.

ProjectileEffects IReadOnlyList<Effect>

The effects the game counts as projectiles.

Properties

CostliestEffect

The effect costing the most, or null where the item has none.

public Effect? CostliestEffect { get; init; }

Property Value

Effect?

Flags

The flags of the game's MagicItemDataCollector, whose bits CommonLib names kSkipCostiest, kSkipProjectiles, kSkipArea, and kOnlyFirstEffect. The collector's constructor sets them, so they do not describe the effects. An ingredient has kOnlyFirstEffect, and any other item has none.

public uint Flags { get; init; }

Property Value

uint

HighestArea

The area of LargestAreaEffect.

public float HighestArea { get; init; }

Property Value

float

LargestAreaEffect

The effect covering the largest area, or null where none does.

public Effect? LargestAreaEffect { get; init; }

Property Value

Effect?

MaxCost

The cost of CostliestEffect, or -1 where that is null.

public int MaxCost { get; init; }

Property Value

int

ProjectileEffects

The effects the game counts as projectiles.

public IReadOnlyList<Effect> ProjectileEffects { get; init; }

Property Value

IReadOnlyList<Effect>

SummonsExtraLargeCreature

Whether an effect of the item summons a creature the game classes as extra large.

public bool SummonsExtraLargeCreature { get; init; }

Property Value

bool

Methods

Deconstruct(out Effect?, out int, out Effect?, out float, out uint, out bool, out IReadOnlyList<Effect>)

public void Deconstruct(out Effect? CostliestEffect, out int MaxCost, out Effect? LargestAreaEffect, out float HighestArea, out uint Flags, out bool SummonsExtraLargeCreature, out IReadOnlyList<Effect> ProjectileEffects)

Parameters

CostliestEffect Effect?

MaxCost int

LargestAreaEffect Effect?

HighestArea float

Flags uint

SummonsExtraLargeCreature bool

ProjectileEffects IReadOnlyList<Effect>

Equals(MagicItemEffectSummary)

public bool Equals(MagicItemEffectSummary other)

Parameters

other MagicItemEffectSummary

Returns

bool

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(MagicItemEffectSummary, MagicItemEffectSummary)

public static bool operator ==(MagicItemEffectSummary left, MagicItemEffectSummary right)

Parameters

left MagicItemEffectSummary

right MagicItemEffectSummary

Returns

bool

operator !=(MagicItemEffectSummary, MagicItemEffectSummary)

public static bool operator !=(MagicItemEffectSummary left, MagicItemEffectSummary right)

Parameters

left MagicItemEffectSummary

right MagicItemEffectSummary

Returns

bool