SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias SleepTask

    SleepTask: Message<"soulfire.v1.SleepTask"> & {
        bed?: BlockPosition;
        options?: PathfindOptions;
        retryIntervalTicks: number;
        searchRadius: number;
        waitUntilPossible: boolean;
    }

    Finds, approaches, and enters a bed. A supplied position pins the task to one bed; otherwise the nearest loaded bed is selected.

    Type Declaration

    • Optionalbed?: BlockPosition

      from field: optional soulfire.v1.BlockPosition bed = 1;

    • Optionaloptions?: PathfindOptions

      from field: soulfire.v1.PathfindOptions options = 3;

    • retryIntervalTicks: number

      Delay between rejected sleep attempts. Zero selects the server default.

      from field: uint32 retry_interval_ticks = 5;

    • searchRadius: number

      Search radius used when bed is omitted. Zero selects the server default.

      from field: uint32 search_radius = 2;

    • waitUntilPossible: boolean

      Keeps retrying while sleep is unavailable, such as during daytime.

      from field: bool wait_until_possible = 4;

    from message soulfire.v1.SleepTask

    Settings
    Member Visibility