Class AbstractLocation

The base class for all locations. Locations are used by placements to place items.
Usually the location contains raw data and an implementation that may be customizable to an extent by the placement.

Inheritance

object

TaggableObject

AbstractLocation

AutoLocation

ContainerLocation

DualLocation

ExistingContainerLocation

ShopLocation

CostChestLocation

EggShopLocation

Inherited Members

TaggableObject.tags

TaggableObject.LoadTags()

TaggableObject.UnloadTags()

TaggableObject.AddTag<T>()

TaggableObject.AddTag(Tag)

TaggableObject.AddTags(IEnumerable<Tag>)

TaggableObject.GetTag<T>()

TaggableObject.GetTag<T>(out T)

TaggableObject.GetTags<T>()

TaggableObject.GetOrAddTag<T>()

TaggableObject.HasTag<T>()

TaggableObject.RemoveTags<T>()

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: ItemChanger

Assembly: ItemChanger.dll

Syntax

public abstract class AbstractLocation : TaggableObject

Constructors

AbstractLocation()

Declaration

protected AbstractLocation()

Fields

flingType

The flingType of the location, specifying how geo and similar objects are to be flung.

Declaration

public FlingType flingType

Field Value

Type	Description
FlingType

name

The name of the location. Location names are often, but not always, distinct.

Declaration

public string name

Field Value

Type	Description
string

sceneName

The scene name of the location. Locations can however make changes which affect more than one scene, and rarely may choose not to use this field, in which case it can be safely set null.

Declaration

public string? sceneName

Field Value

Type	Description
string

Properties

Placement

The placement holding the location. This is usually set by the placement when the placement loads and before the location loads.

Declaration

public AbstractPlacement Placement { get; set; }

Property Value

Type	Description
AbstractPlacement

UnsafeSceneName

Fetches the sceneName field and produces an error if it is null.

Declaration

public string UnsafeSceneName { get; }

Property Value

Type	Description
string

Exceptions

Type	Condition
NullReferenceException

Methods

Clone()

Performs a deep clone of the location.

Declaration

public virtual AbstractLocation Clone()

Returns

Type	Description
AbstractLocation

Load()

Called on a location by its placement, usually during AbstractPlacement.Load().
Execution order is (modules load -> placement tags load -> items load -> placements load)

Declaration

public void Load()

OnLoad()

Called during Load(). Allows the location to initialize and set up any hooks.

Declaration

protected abstract void OnLoad()

OnUnload()

Called during Unload(). Allows the location to dispose any hooks.

Declaration

protected abstract void OnUnload()

Unload()

Called on a location by its placement, usually during AbstractPlacement.Unload().
Execution order is (modules unload -> placement tags unload -> items unload -> placements unload)

Declaration

public void Unload()

Wrap()

Creates a default placement for this location.

Declaration

public abstract AbstractPlacement Wrap()

Returns

Type	Description
AbstractPlacement

Extension Methods

Extensions.Yield<T>(T)