IdaJS
    Preparing search index...

    Interface Zone

    The Zone object provides the API to read and modify scene zones properties.

    Zones are invisible bounded boxes on the scene, that recognize when player or other actors are inside them. They can be used to interract, trigger events, display text, give items, etc.

    The setters of the zone can only be used in the scene setup phase (see SceneEvents.afterLoadScene event).

    ZoneTypes - to see all possible zone types.

    interface Zone {
        getId(): number;
        getPos1(): number[];
        getPos2(): number[];
        getRegisters(): [
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
        ];
        getType(): ZoneType;
        getZoneValue(): number;
        setPos1(pos: number[]): void;
        setPos2(pos: number[]): void;
        setRegisters(
            registers: [
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
            ],
        ): void;
        setType(type: ZoneType): void;
        setZoneValue(value: number): void;
    }
    Index

    Methods

    • Returns the id of the zone (the index of the zone in the scene).

      Returns number

    • Returns the lowest bounding box corner of the zone as [x, y, z] (West, Down, North)

      Returns number[]

      Array of 3 values representing the position as [x, y, z]

    • Returns the highest bounding box corner of the zone as [x, y, z] (East, Up, South)

      Returns number[]

      Array of 3 values representing the position as [x, y, z]

    • Returns the registers of the zone as an array of 8 numbers.

      The meaning of the registers depends on the zone type.

      This is not documented enough yet. You will need to open the scene in LBArchitect tool, in order to see what each register means for each zone type.

      Returns [number, number, number, number, number, number, number, number]

      setRegisters - to set the zone registers.

    • The zone value is an extra register of the zone, that can have different meaning depending on zone type.

      This is not documented enough yet. You will need to open the scene in LBArchitect tool, in order to see what the zone value means for each zone type.

      Returns number

      setZoneValue - to set the zone value.

    • Sets the lowest bounding box corner of the zone (West, Down, North).

      Parameters

      • pos: number[]

        Array of 3 numbers: [x, y, z].

      Returns void

    • Sets the highest bounding box corner of the zone (East, Up, South).

      Parameters

      • pos: number[]

        Array of 3 numbers: [x, y, z].

      Returns void

    • Sets the registers of the zone. The meaning of the registers depends on the zone type.

      Parameters

      • registers: [number, number, number, number, number, number, number, number]

        Array of 8 numbers representing the zone registers.

      Returns void

      getRegisters - for more information.

    • Sets the zone value, which is an extra register of the zone. The meaning depends on the zone type.

      Parameters

      • value: number

        The zone value to set.

      Returns void

      getZoneValue - for more information.