Struct PluginLootClassification

A classifier's verdict on one item.

public readonly record struct PluginLootClassification : IEquatable<PluginLootClassification>

Inherited Members: ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

A classifier's verdict on one item.

public PluginLootClassification(bool Matched, PluginLootAction Action, string RuleName = "", int Priority = 0, int KeepCount = 0)

Matched bool: True when a rule matched the item. When it is false no rule applied and the other fields carry no meaning.
Action PluginLootAction: What the matched rule says to do with the item.
RuleName string: The name of the rule that matched, for display or logging; empty when nothing matched.
Priority int: The matched rule's priority. A caller with several candidates can use it to decide which to take first; higher means more wanted.
KeepCount int: How many of the item to keep, for KeepUpTo; zero for every other action.

What the matched rule says to do with the item.

public PluginLootAction Action { get; init; }

How many of the item to keep, for KeepUpTo; zero for every other action.

public int KeepCount { get; init; }

True when a rule matched the item. When it is false no rule applied and the other fields carry no meaning.

public bool Matched { get; init; }

The matched rule's priority. A caller with several candidates can use it to decide which to take first; higher means more wanted.

public int Priority { get; init; }

The name of the rule that matched, for display or logging; empty when nothing matched.

public string RuleName { get; init; }