Interface Options

Construction options for a BodyZone instance.

interface Options {
    index: number;
    locations: Indexed<sohl.entity.body.BodyLocation.Data>[];
    parent: SohlLogic<any>;
    parts: Indexed<sohl.entity.body.BodyPart.Data>[];
    startZoneNumber: number;
    structure: sohl.entity.body.BodyStructure;
}

Hierarchy (View Summary)

sohl.entity.SohlEntity.Options
- Options

Index

Properties

index locations parent parts startZoneNumber structure

Properties

index

index: number

Zero-based index of this zone within the flat zones array.

locations

locations: Indexed<sohl.entity.body.BodyLocation.Data>[]

Every location in the body, each paired with its flat locations index.

parent

parent: SohlLogic<any>

The Logic that owns the entity. Required (the constructor throws without it) and transient — held in memory, never written to JSON.

parts

parts: Indexed<sohl.entity.body.BodyPart.Data>[]

This zone's parts, each paired with its flat parts index.

startZoneNumber

startZoneNumber: number

The first zone number allocated to this zone.

structure

structure: sohl.entity.body.BodyStructure

Owning body structure (supplies actor and body-owner logic).