Class ExistingFsmContainerLocation

A location for modifying an object with an fsm in-place with the specified Container.

Inheritance
object
TaggableObject
AbstractLocation
ExistingContainerLocation
ExistingFsmContainerLocation
DivineLocation
Implements
Inherited Members
Namespace: ItemChanger.Locations
Assembly: ItemChanger.dll
Syntax
public class ExistingFsmContainerLocation : ExistingContainerLocation, ILocalHintLocation

Constructors

View Source

ExistingFsmContainerLocation()

Declaration
public ExistingFsmContainerLocation()

Fields

View Source

elevation

Declaration
public float elevation
Field Value
Type Description
float
View Source

fsmName

Declaration
public string fsmName
Field Value
Type Description
string
View Source

objectName

Declaration
public string? objectName
Field Value
Type Description
string
View Source

replacePath

The path to find the object on active scene change, if it is to be replaced. If this is null, replacement happens when the fsm is enabled instead.

Declaration
public string? replacePath
Field Value
Type Description
string

Properties

View Source

HintActive

Creates a HintBox at the transform of the existing container or its replacement.

Declaration
public bool HintActive { get; set; }
Property Value
Type Description
bool

Methods

View Source

AsContainerLocation()

Converts the location to a ContainerLocation. The new location will always replace its container, instead of conditionally modifying it in place.

Declaration
public override ContainerLocation AsContainerLocation()
Returns
Type Description
ContainerLocation
Overrides
Exceptions
Type Condition
InvalidOperationException

The location is nonreplaceable.
View Source

OnEnable(PlayMakerFSM)

Declaration
public void OnEnable(PlayMakerFSM fsm)
Parameters
Type Name Description
PlayMakerFSM fsm
View Source

OnLoad()

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

Declaration
protected override void OnLoad()
Overrides
View Source

OnReplace(GameObject, Container)

Declaration
protected virtual void OnReplace(GameObject obj, Container c)
Parameters
Type Name Description
GameObject obj
Container c
View Source

OnUnload()

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

Declaration
protected override void OnUnload()
Overrides
View Source

ReplaceOnSceneChange(Scene)

Declaration
public void ReplaceOnSceneChange(Scene to)
Parameters
Type Name Description
Scene to

Implements

Extension Methods