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.
Assembly: ItemChanger.dll
Syntax
public abstract record Deployer : IDeployer, IEquatable<Deployer>
Constructors
View Source
Deployer()
Declaration
View Source
Deployer(Deployer)
Declaration
protected Deployer(Deployer original)
Parameters
Properties
View Source
EqualityContract
Declaration
protected virtual Type EqualityContract { get; }
Property Value
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
View Source
Test
Optional property. If non-null and evaluates false, the GameObject is not deployed.
Declaration
public IBool? Test { get; init; }
Property Value
View Source
X
Declaration
public float X { get; init; }
Property Value
View Source
Y
Declaration
public float Y { get; init; }
Property Value
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
View Source
Equals(Deployer?)
Declaration
public virtual bool Equals(Deployer? other)
Parameters
Returns
View Source
Equals(object?)
Declaration
public override bool Equals(object? obj)
Parameters
| Type |
Name |
Description |
| object |
obj |
|
Returns
Overrides
View Source
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Overrides
View Source
Instantiate()
Declaration
public abstract GameObject Instantiate()
Returns
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
Returns
View Source
ToString()
Declaration
public override string ToString()
Returns
Overrides
Operators
View Source
operator ==(Deployer?, Deployer?)
Declaration
public static bool operator ==(Deployer? left, Deployer? right)
Parameters
Returns
View Source
operator !=(Deployer?, Deployer?)
Declaration
public static bool operator !=(Deployer? left, Deployer? right)
Parameters
Returns
Implements
Extension Methods