rednode API - v0.50.0
    Preparing search index...

    Interface SpawnOptions

    What world.spawn places.

    interface SpawnOptions {
        appearance?: string;
        components?: GameRef[];
        keep?: boolean;
        mesh?: string;
        meshAppearance?: string;
        npc?: boolean | { friendly?: boolean; hold?: boolean };
        orientation?: WorldRotation;
        position: WorldPoint;
        record?: string;
        scale?: WorldPoint;
        tags?: string[];
        template?: string;
        timeoutMs?: number;
        yaw?: number;
    }
    Index
    appearance? components? keep? mesh? meshAppearance? npc? orientation? position record? scale? tags? template? timeoutMs? yaw?
    appearance?: string

    The appearance to use.

    components?: GameRef[]

    Components to attach while the entity assembles, made with api.$new.

    keep?: boolean

    Keep it in the save: it comes back when that save loads (about 8 s after). Default false.

    mesh?: string

    A mesh's depot path (.mesh): a prop with just that mesh, on a bare entity. One of template, record and mesh; with template, the mesh is added to it.

    meshAppearance?: string

    The mesh's own appearance, for mesh. Default "default".

    npc?: boolean | { friendly?: boolean; hold?: boolean }

    For a person: stand where placed (a hold command) and stay friendly to V. On by default for a Character.* record; false leaves the game's own behaviour.

    orientation?: WorldRotation

    A quaternion; or use yaw. Default: facing north.

    position: WorldPoint
    record?: string

    A TweakDB record, such as "Character.Panam". One of template, record and mesh.

    scale?: WorldPoint

    The mesh's size, for mesh. Default 1 on each axis.

    tags?: string[]

    More tags for the entity, for your own bookkeeping.

    template?: string

    An entity template's depot path (.ent), or its hash. One of template, record and mesh.

    timeoutMs?: number

    How long to wait for the entity to be in the world. Default 10 seconds.

    yaw?: number

    Turn around the vertical axis, in degrees, when orientation is not given.

    Settings
    Member Visibility

    On This Page
    Properties