sc4/lib/core/building.js

A command line utility for automating SimCity 4 modding tasks & modifying savegames

// # building-file.js
import WriteBuffer from './write-buffer.js';
import FileType from './file-types.js';
import SGProp from './sgprop.js';
import { kFileType, kFileTypeArray } from './symbols.js';
import Box3 from './box-3.js';
import TractInfo from './tract-info.js';
// # Building()
// Represents a single building from the building file.
export default class Building {
    static [kFileType] = FileType.Building;
    static [kFileTypeArray] = true;
    crc = 0x00000000;
    mem = 0x00000000;
    major = 0x0002;
    minor = 0x0004;
    zotWord = 0x0;
    unknown1 = 0x00;
    appearance = 0b00000101;
    tract = new TractInfo();
    sgprops = [];
    unknown2 = 0x00;
    GID = 0x00000000;
    TID = 0x00000000;
    IID = 0x00000000;
    IID1 = 0x00000000;
    bbox = new Box3();
    orientation = 0x00;
    scaffold = 0x01;
    // ## constructor()
    constructor(opts) {
        Object.assign(this, opts);
    }
    // ## move(move)
    // The move vector of the building contains [dx, dy, dz] and should be 
    // given in meters! This is because apparently the min/max values of the 
    // building are given in meters as well.
    move(offset) {
        this.bbox = this.bbox.translate(offset);
        this.tract.update(this);
        return this;
    }
    // ## parse(rs)
    // Parses the building from a buffer wrapper up in a readable stream.
    parse(rs) {
        rs.size();
        this.crc = rs.dword();
        this.mem = rs.dword();
        this.major = rs.word();
        this.minor = rs.word();
        this.zotWord = rs.word();
        this.unknown1 = rs.byte();
        this.appearance = rs.byte();
        // 0x278128A0, always the same.
        rs.dword();
        this.tract = rs.tract();
        this.sgprops = rs.sgprops();
        // There seems to be an error in the Wiki. The unknown byte should 
        // come **after** the IID1, otherwise they're incorrect.
        this.GID = rs.dword();
        this.TID = rs.dword();
        this.IID = rs.dword();
        this.IID1 = rs.dword();
        this.unknown2 = rs.byte();
        this.bbox = rs.bbox();
        this.orientation = rs.byte();
        this.scaffold = rs.float();
        // Make sure the entry was read correctly.
        rs.assert();
        return this;
    }
    // # toBuffer()
    // Creates a buffer for the building.
    toBuffer() {
        let ws = new WriteBuffer();
        ws.dword(this.mem);
        ws.word(this.major);
        ws.word(this.minor);
        ws.word(this.zotWord);
        ws.byte(this.unknown1);
        ws.byte(this.appearance);
        ws.dword(0x278128A0);
        ws.tract(this.tract);
        ws.array(this.sgprops);
        ws.dword(this.GID);
        ws.dword(this.TID);
        ws.dword(this.IID);
        ws.dword(this.IID1);
        ws.byte(this.unknown2);
        ws.bbox(this.bbox);
        ws.byte(this.orientation);
        ws.float(this.scaffold);
        // We're done. Seal the buffer and update our crc.
        let out = ws.seal();
        this.crc = +ws;
        return out;
    }
}