ObjectRule

public sealed class ObjectRule

Namespace MapExpansions

Selects objects by name in one world, optionally limited to an area.

Properties

Id

public string Id { get; set; }

Stable id inside the expansion, which a map layer uses to replace or remove the rule. Empty takes one made of side, names, area and effect.

Side

public WorldSide Side { get; set; }

Type: WorldSide

Name

public string Name { get; set; }

The object’s name starts with this (case-insensitive).

Parent

public string Parent { get; set; }

When set, some ancestor’s name starts with this.

Area

public Bounds Area { get; set; }

When its size is not zero, the object’s bounds must intersect this box. Main-world coordinates for WorldSide.Main, expansion-local ones for WorldSide.Expansion.

Effect

public ObjectEffect Effect { get; set; }

Type: ObjectEffect

Bottom

public float Bottom { get; set; }

For ObjectEffect.Skirt: the height the wall reaches down to, in the same coordinates as Area.

TopShift

public float TopShift { get; set; }

For ObjectEffect.ColliderTop: metres the top face moves up, negative for down.

Openings

public List<Bounds> Openings { get; private set; }

For ObjectEffect.Hollow: doorways left open in the shell, in the same coordinates as Area.

Bands

public List<(float From, string Material)> Bands { get; private set; }

For ObjectEffect.Hollow: wall bands of the inside lining, each from a height above the floor in metres up to the next band or the ceiling, with the name of a loaded material.

CeilingMaterial

public string CeilingMaterial { get; set; }

For ObjectEffect.Hollow: the name of a loaded material for the lining’s ceiling.

FloorMaterial

public string FloorMaterial { get; set; }

For ObjectEffect.Hollow: the name of a loaded material for the lining’s floor, laid 5 mm above the box’s bottom face over whatever floor the model draws there.

Windows

public List<Bounds> Windows { get; private set; }

For ObjectEffect.Hollow: boxes left open in the lining only, such as windows, in the same coordinates as Area.

FrameMaterial

public string FrameMaterial { get; set; }

For ObjectEffect.Hollow: the name of a loaded material for a frame around every hole in the lining’s walls, FrameWidth wide on the wall and as deep as the gap between lining and outer wall. Edges on the floor, the ceiling or a corner, and edges inside another hole, get none.

FrameWidth

public float FrameWidth { get; set; }

For ObjectEffect.Hollow: width of FrameMaterial on the wall in metres.

LiningInset

public float LiningInset { get; set; }

For ObjectEffect.Hollow: metres between the outer walls and the lining’s walls. More than the default keeps sills and frames the outer model draws inward behind the lining.

Methods

In

public static ObjectRule In(
    WorldSide side,
    string name,
    ObjectEffect effect,
    string parent = null)

Types: WorldSide, ObjectEffect

Within

public ObjectRule Within(Vector3 min, Vector3 max)

DownTo

public ObjectRule DownTo(float height)

Sets Bottom.

ShiftTop

public ObjectRule ShiftTop(float metres)

Sets TopShift.

Opening

public ObjectRule Opening(Vector3 min, Vector3 max)

Adds a box to Openings.

Band

public ObjectRule Band(float from, string material)

Adds a wall band to Bands.

Ceiling

public ObjectRule Ceiling(string material)

Sets CeilingMaterial.

Floor

public ObjectRule Floor(string material)

Sets FloorMaterial.

Frame

public ObjectRule Frame(string material, float width = 0.06f)

Sets FrameMaterial and FrameWidth.

Inset

public ObjectRule Inset(float metres)

Sets LiningInset.

Window

public ObjectRule Window(Vector3 min, Vector3 max)

Adds a box to Windows.

ToString

public override string ToString()