api.settings

SettingsApi

The settings dialogs' tables, read-only; document.update writes them.

What the settings dialogs show, read without a transaction: the same views document.update's tx.players … tx.techs hand out. Every list is empty and every single read null when no map is open.

players
player
forces
unitType
unitTypes
upgrade
upgrades
tech
techs
sounds
unitAvailable
cuwpSlots
cuwpSlot
version

Members

players

players(): PlayerSlotView[];

player

player(slot: number): PlayerSlotView | null;

forces

forces(): ForceView[];

unitType

unitType(unitId: number): UnitTypeView | null;

unitTypes

unitTypes(): UnitTypeView[];

Every type with a name, in id order.

upgrade

upgrade(upgradeId: number): UpgradeView | null;

upgrades

upgrades(): UpgradeView[];

tech

tech(techId: number): TechView | null;

techs

techs(): TechView[];

sounds

sounds(): SoundRow[];

unitAvailable

unitAvailable(player: number, unitId: number): boolean;

Whether a player (0-based) may build a unit type — PUNI's per-player byte resolved against its global default.

cuwpSlots

cuwpSlots(): CuwpSlotView[];

The Create Unit with Properties slots, 0-based, with how many actions name each.

cuwpSlot

cuwpSlot(index: number): CuwpSlotView | null;

version

version(): MapVersionView | null;

Types

Declarations only this group names.

MapVersionViewinterface

interface MapVersionView

`version: MapVersion`
`label: string`
`fileVersion: number`	The VER word.
`type: string`
`extendedStrings: boolean`	Whether the string table is STRx.
`extension: string`	The file extension StarEdit would give it.