Class RoomSpecification

Room specification for HousingCommands. Contains all information about room and may be used for spawn position search methods to ensure there enough space.

Inheritance
System.Object
RoomSpecification
Implements
System.IEquatable<RoomSpecification>
Namespace: Eco.Gameplay.Housing.Internal
Assembly: Eco.Gameplay.dll
Syntax
public class RoomSpecification : Object, IEquatable<RoomSpecification>

Constructors

RoomSpecification()

Declaration
public RoomSpecification()

RoomSpecification(RoomSpecification)

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

Fields

DoorType

Declaration
public Type DoorType
Field Value
Type Description
System.Type

FloorBlock

Declaration
public Type FloorBlock
Field Value
Type Description
System.Type

InteriorSize

Declaration
public Vector3i InteriorSize
Field Value
Type Description
Vector3i

RoofBlock

Declaration
public Type RoofBlock
Field Value
Type Description
System.Type

RoofType

Declaration
public RoofType RoofType
Field Value
Type Description
RoofType

WallBlock

Declaration
public Type WallBlock
Field Value
Type Description
System.Type

WindowBlock

Declaration
public Type WindowBlock
Field Value
Type Description
System.Type

Properties

BuildingSize

Declaration
public Vector3i BuildingSize { get; }
Property Value
Type Description
Vector3i

EqualityContract

Declaration
protected virtual Type EqualityContract { get; }
Property Value
Type Description
System.Type

ExteriorSize

Declaration
public Vector3i ExteriorSize { get; }
Property Value
Type Description
Vector3i

Methods

<Clone>$()

Declaration
public virtual RoomSpecification <Clone>$()
Returns
Type Description
RoomSpecification

Create(Int32, Vector3i, RoofType, Boolean)

Creates RoomSpecification with given tier, size and options.

Declaration
public static ValResult<RoomSpecification> Create(int tier, Vector3i interiorSize, RoofType roofType, bool windows = true)
Parameters
Type Name Description
System.Int32 tier
Vector3i interiorSize
RoofType roofType
System.Boolean windows
Returns
Type Description
ValResult<RoomSpecification>

Create(String, Vector3i, RoofType, Boolean, Int32)

Creates RoomSpecification with given material, size and options.

Declaration
public static ValResult<RoomSpecification> Create(string materialName, Vector3i interiorSize, RoofType roofType, bool windows = true, int doorTier = 0)
Parameters
Type Name Description
System.String materialName
Vector3i interiorSize
RoofType roofType
System.Boolean windows
System.Int32 doorTier
Returns
Type Description
ValResult<RoomSpecification>

Equals(RoomSpecification)

Declaration
public virtual bool Equals(RoomSpecification other)
Parameters
Type Name Description
RoomSpecification other
Returns
Type Description
System.Boolean

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

PrintMembers(StringBuilder)

Declaration
protected virtual bool PrintMembers(StringBuilder builder)
Parameters
Type Name Description
System.Text.StringBuilder builder
Returns
Type Description
System.Boolean

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String

Operators

Equality(RoomSpecification, RoomSpecification)

Declaration
public static bool operator ==(RoomSpecification left, RoomSpecification right)
Parameters
Type Name Description
RoomSpecification left
RoomSpecification right
Returns
Type Description
System.Boolean

Inequality(RoomSpecification, RoomSpecification)

Declaration
public static bool operator !=(RoomSpecification left, RoomSpecification right)
Parameters
Type Name Description
RoomSpecification left
RoomSpecification right
Returns
Type Description
System.Boolean

Implements

System.IEquatable<>

Extension Methods