Show / Hide Table of Contents

Class Deployer

Abstract IDeployer which creates an object and places it at the specified coordinates. Inheritors must specify how the object is instantiated; the base class handles positioning and activation.

Inheritance
object
Deployer
EnemyBlockerDeployer
HintBoxDeployer
SoulTotemDeployer
TabletDeployer
SmallPlatform
Implements
IDeployer
IEquatable<Deployer>
Inherited Members
object.GetType()
object.MemberwiseClone()
object.Equals(object, object)
object.ReferenceEquals(object, object)
Namespace: ItemChanger
Assembly: ItemChanger.dll
Syntax
public abstract record Deployer : IDeployer, IEquatable<Deployer>

Constructors

View Source

Deployer()

Declaration
protected Deployer()
View Source

Deployer(Deployer)

Declaration
protected Deployer(Deployer original)
Parameters
Type Name Description
Deployer original

Properties

View Source

EqualityContract

Declaration
protected virtual Type EqualityContract { get; }
Property Value
Type Description
Type
View Source

SceneName

The scene in which the IDeployer acts. Used as a key for the scene change event, and thus should not mutate.

Declaration
public string SceneName { get; init; }
Property Value
Type Description
string
View Source

Test

Optional property. If non-null and evaluates false, the GameObject is not deployed.

Declaration
public IBool? Test { get; init; }
Property Value
Type Description
IBool
View Source

X

Declaration
public float X { get; init; }
Property Value
Type Description
float
View Source

Y

Declaration
public float Y { get; init; }
Property Value
Type Description
float

Methods

View Source

Deploy()

Method which calls Instantiate, and then appropriately places the new object. Returns the object to allow further action by overriders.
The base implementation sets position, gives the object a safe position-based name, and updates any PersistentBoolItem, PersistentIntItem, or GeoRock components with the new name.

Declaration
public virtual GameObject Deploy()
Returns
Type Description
GameObject
View Source

Equals(Deployer?)

Declaration
public virtual bool Equals(Deployer? other)
Parameters
Type Name Description
Deployer other
Returns
Type Description
bool
View Source

Equals(object?)

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
object.Equals(object)
View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
object.GetHashCode()
View Source

Instantiate()

Declaration
public abstract GameObject Instantiate()
Returns
Type Description
GameObject
View Source

OnSceneChange(Scene)

Action to perform when SceneName becomes the active scene.

Declaration
public virtual void OnSceneChange(Scene to)
Parameters
Type Name Description
Scene to
View Source

PrintMembers(StringBuilder)

Declaration
protected virtual bool PrintMembers(StringBuilder builder)
Parameters
Type Name Description
StringBuilder builder
Returns
Type Description
bool
View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
object.ToString()

Operators

View Source

operator ==(Deployer?, Deployer?)

Declaration
public static bool operator ==(Deployer? left, Deployer? right)
Parameters
Type Name Description
Deployer left
Deployer right
Returns
Type Description
bool
View Source

operator !=(Deployer?, Deployer?)

Declaration
public static bool operator !=(Deployer? left, Deployer? right)
Parameters
Type Name Description
Deployer left
Deployer right
Returns
Type Description
bool

Implements

IDeployer
IEquatable<T>

Extension Methods

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