SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias BreedTask

    BreedTask: Message<"soulfire.v1.BreedTask"> & {
        animals?: EntitySelector;
        breedingTimeoutTicks: number;
        center?: BlockPosition;
        completeWhenNoFood: boolean;
        completeWhenNoPair: boolean;
        food?: ItemSelector;
        maximumPairs: number;
        options?: PathfindOptions;
        radius: number;
        rescanIntervalTicks: number;
        restoreSelectedSlot: boolean;
    }

    Feeds compatible adult animals and confirms the server love-mode event for both parents.

    Type Declaration

    • Optionalanimals?: EntitySelector

      Empty selects every observable Animal subtype.

      from field: soulfire.v1.EntitySelector animals = 1;

    • breedingTimeoutTicks: number

      Zero selects the server default.

      from field: uint32 breeding_timeout_ticks = 10;

    • Optionalcenter?: BlockPosition

      from field: optional soulfire.v1.BlockPosition center = 3;

    • completeWhenNoFood: boolean

      from field: bool complete_when_no_food = 7;

    • completeWhenNoPair: boolean

      from field: bool complete_when_no_pair = 6;

    • Optionalfood?: ItemSelector

      Empty accepts any item recognized as food by both selected animals.

      from field: optional soulfire.v1.ItemSelector food = 2;

    • maximumPairs: number

      Zero keeps breeding pairs until cancellation.

      from field: uint32 maximum_pairs = 5;

    • Optionaloptions?: PathfindOptions

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

    • radius: number

      Zero selects the server default.

      from field: uint32 radius = 4;

    • rescanIntervalTicks: number

      Delay between scans when no compatible pair is available. Zero selects the server default.

      from field: uint32 rescan_interval_ticks = 9;

    • restoreSelectedSlot: boolean

      from field: bool restore_selected_slot = 11;

    from message soulfire.v1.BreedTask

    Settings
    Member Visibility