Show / Hide Table of Contents

Class ItemTreeTag

Tag which carries ordered lists of predecessors and successors item names.
Hooks AbstractItem.ModifyItem, and returns the first item in the sequence which is not redundant.
Note that unlike ItemChainTag, this does not recursively check tags of the predecessors and successors.

Inheritance
object
Tag
ItemTreeTag
Implements
IItemModifierTag
Inherited Members
Tag.Clone()
Tag.LoadOnce(TaggableObject)
Tag.UnloadOnce(TaggableObject)
Tag.Loaded
Tag.TagHandlingProperties
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: ItemChanger.Tags
Assembly: ItemChanger.dll
Syntax
[ItemTag]
public class ItemTreeTag : Tag, IItemModifierTag

Constructors

View Source

ItemTreeTag()

Declaration
public ItemTreeTag()

Fields

View Source

predecessors

Declaration
public string[]? predecessors
Field Value
Type Description
string[]
View Source

strictEvaluation

If true, the first nonredundant item starting from the first element in the list will be chosen.
Otherwise, the search will begin at the parent item, and will assume that predecessors of a redundant item are redundant.
Only relevant when predecessors is nonempty.

Declaration
public bool strictEvaluation
Field Value
Type Description
bool
View Source

successors

Declaration
public string[]? successors
Field Value
Type Description
string[]

Methods

View Source

GetItem(string)

Declaration
protected virtual AbstractItem GetItem(string name)
Parameters
Type Name Description
string name
Returns
Type Description
AbstractItem
View Source

Load(object)

Virtual method called on tags when their parent loads. The base method checks and throws an exception if the tag is already loaded.
This should not be called directly. Instead, use "LoadOnce" to load and set the Loaded property.

Declaration
public override void Load(object parent)
Parameters
Type Name Description
object parent
Overrides
Tag.Load(object)
Exceptions
Type Condition
InvalidOperationException

The tag is already loaded.

View Source

ModifyItem(GiveEventArgs)

Declaration
public void ModifyItem(GiveEventArgs args)
Parameters
Type Name Description
GiveEventArgs args
View Source

Unload(object)

Virtual method called on tags when their parent unloads. The base method checks and throws an exception if the tag is not loaded.
This should not be called directly. Instead, use "UnloadOnce" to unload and set the Loaded property.

Declaration
public override void Unload(object parent)
Parameters
Type Name Description
object parent
Overrides
Tag.Unload(object)
Exceptions
Type Condition
InvalidOperationException

The tag is not loaded.

Implements

IItemModifierTag

Extension Methods

Extensions.Yield<T>(T)
  • View Source
In this article
Back to top Generated by DocFX