Class Container

Base class for types which implement creating and fsm-editing item containers.

Inheritance

System.Object

Container

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: ItemChanger

Assembly: ItemChanger.dll

Syntax

public abstract class Container

Fields

| Improve this Doc View Source

Bluggsac

Declaration

public const string Bluggsac = "Bluggsac"

Field Value

Type	Description
System.String

| Improve this Doc View Source

Chest

Declaration

public const string Chest = "Chest"

Field Value

Type	Description
System.String

| Improve this Doc View Source

Enemy

Declaration

public const string Enemy = "Enemy"

Field Value

Type	Description
System.String

| Improve this Doc View Source

GeoRock

Declaration

public const string GeoRock = "GeoRock"

Field Value

Type	Description
System.String

| Improve this Doc View Source

GrubJar

Declaration

public const string GrubJar = "GrubJar"

Field Value

Type	Description
System.String

| Improve this Doc View Source

Mimic

Declaration

public const string Mimic = "Mimic"

Field Value

Type	Description
System.String

| Improve this Doc View Source

Shiny

Declaration

public const string Shiny = "Shiny"

Field Value

Type	Description
System.String

| Improve this Doc View Source

Shop

Declaration

public const string Shop = "Shop"

Field Value

Type	Description
System.String

| Improve this Doc View Source

Tablet

Declaration

public const string Tablet = "Tablet"

Field Value

Type	Description
System.String

| Improve this Doc View Source

Totem

Declaration

public const string Totem = "Totem"

Field Value

Type	Description
System.String

| Improve this Doc View Source

Unknown

Declaration

public const string Unknown = "Unknown"

Field Value

Type	Description
System.String

Properties

| Improve this Doc View Source

Name

The unique name of the container.

Declaration

public abstract string Name { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

SupportsCost

Returns true if the container has a natural way to present a cost. For example, Container.Shiny supports cost through the YN dialogue box.

Declaration

public virtual bool SupportsCost { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

SupportsDrop

Returns true if the container has a natural way to be dropped from midair.

Declaration

public virtual bool SupportsDrop { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

SupportsInstantiate

Returns true if the container can be instantiated. For some containers, this value is variable in which objects were preloaded.

Declaration

public virtual bool SupportsInstantiate { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

SupportsSceneChange

Returns true if the container has a natural way to start a scene transition after giving items.

Declaration

public virtual bool SupportsSceneChange { get; }

Property Value

Type	Description
System.Boolean

Methods

| Improve this Doc View Source

AddChangeSceneToFsm(PlayMakerFSM, ChangeSceneInfo)

Called during the container fsm hook to set up the container to change scene.

Declaration

public virtual void AddChangeSceneToFsm(PlayMakerFSM fsm, ChangeSceneInfo info)

Parameters

Type	Name	Description
PlayMakerFSM	fsm
ChangeSceneInfo	info

| Improve this Doc View Source

AddCostToFsm(PlayMakerFSM, CostInfo)

Called during the container fsm hook to set up the container to have a cost.

Declaration

public virtual void AddCostToFsm(PlayMakerFSM fsm, CostInfo info)

Parameters

Type	Name	Description
PlayMakerFSM	fsm
CostInfo	info

| Improve this Doc View Source

AddGiveEffectToFsm(PlayMakerFSM, ContainerGiveInfo)

Called during the container fsm hook to set up the container to give items.

Declaration

public virtual void AddGiveEffectToFsm(PlayMakerFSM fsm, ContainerGiveInfo info)

Parameters

Type	Name	Description
PlayMakerFSM	fsm
ContainerGiveInfo	info

| Improve this Doc View Source

ApplyTargetContext(GameObject, GameObject, Single)

Puts the container in the same position and hierarchy of the target, up to the elevation correction in y.

Declaration

public virtual void ApplyTargetContext(GameObject obj, GameObject target, float elevation)

Parameters

Type	Name	Description
GameObject	obj
GameObject	target
System.Single	elevation

| Improve this Doc View Source

ApplyTargetContext(GameObject, Single, Single, Single)

Puts the container in the specified position, up to the elevation correction in y.

Declaration

public virtual void ApplyTargetContext(GameObject obj, float x, float y, float elevation)

Parameters

Type	Name	Description
GameObject	obj
System.Single	x
System.Single	y
System.Single	elevation

| Improve this Doc View Source

DefineContainer(Container)

Adds or overwrites the container definition in the internal dictionary.

Declaration

public static void DefineContainer(Container container)

Parameters

Type	Name	Description
Container	container

| Improve this Doc View Source

DefineContainer<T>()

Adds or overwrites the container definition in the internal dictionary.

Declaration

public static Container DefineContainer<T>()
    where T : Container, new()

Returns

Type	Description
Container

Type Parameters

Name	Description
T

| Improve this Doc View Source

GetContainer(String)

Gets the container definition for the given string. Returns null if no such container has been defined.

Declaration

public static Container GetContainer(string containerType)

Parameters

Type	Name	Description
System.String	containerType

Returns

Type	Description
Container

| Improve this Doc View Source

GetNewContainer(ContainerInfo)

Produces a new object of this container type.

Declaration

public virtual GameObject GetNewContainer(ContainerInfo info)

Parameters

Type	Name	Description
ContainerInfo	info

Returns

Type	Description
GameObject

| Improve this Doc View Source

OnEnable(PlayMakerFSM)

Fsm hook for all container edits. Called on an item with the ContainerInfo component at the start and end of ItemChanger's PlayMakerFSM.OnEnable hook.

Declaration

public static void OnEnable(PlayMakerFSM fsm)

Parameters

Type	Name	Description
PlayMakerFSM	fsm

| Improve this Doc View Source

SupportsAll(String, Boolean, Boolean, Boolean)

Declaration

public static bool SupportsAll(string containerName, bool mustSupportInstantiate, bool mustSupportCost, bool mustSupportSceneChange)

Parameters

Type	Name	Description
System.String	containerName
System.Boolean	mustSupportInstantiate
System.Boolean	mustSupportCost
System.Boolean	mustSupportSceneChange

Returns

Type	Description
System.Boolean

Extension Methods

Extensions.Yield<T>(T)