Small World Engine API Reference - v0.78.00
    Preparing search index...

    Interface LoadPropOptions

    Options controlling one registry.loadProp call.

    interface LoadPropOptions {
        applyRecommendedScale?: boolean;
        lightOverrides?: KitPropLightOverrides;
        materialOverrides?: KitMaterialOverride;
        position?: [number, number, number];
        rotation?: [number, number, number];
        scale?: number | [number, number, number];
    }
    Index
    applyRecommendedScale?: boolean

    Apply meta.recommendedScale automatically (default true).

    lightOverrides?: KitPropLightOverrides

    Per-socket light overrides. false disables that socket's light entirely.

    materialOverrides?: KitMaterialOverride

    Material-level PBR overrides applied to every material on the prop.

    position?: [number, number, number]

    Absolute placement override. When omitted, the prop keeps identity transform.

    rotation?: [number, number, number]
    scale?: number | [number, number, number]

    Explicit scale override (a scalar or per-axis [x,y,z]). Overrides recommendedScale.