SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias GuardTask

    GuardTask: Message<"soulfire.v1.GuardTask"> & {
        attackRange: number;
        clearSeconds: number;
        completeWhenClear: boolean;
        guardRadius: number;
        maximumAttacks: number;
        maximumPursuitDistance: number;
        maximumTargets: number;
        options?: PathfindOptions;
        restoreSelectedSlot: boolean;
        returnRadius: number;
        selectBestWeapon?: boolean;
        sprinting: boolean;
        subject:
            | { case: "position"; value: BlockPosition }
            | { case: "entity"; value: EntityReference }
            | { case: undefined; value?: undefined };
        threats?: EntitySelector;
        weapon?: ItemSelector;
    }

    Defends a fixed position or live entity from matching threats.

    Type Declaration

    • attackRange: number

      from field: float attack_range = 8;

    • clearSeconds: number

      from field: uint32 clear_seconds = 13;

    • completeWhenClear: boolean

      Completes after the area stays clear for this many seconds.

      from field: bool complete_when_clear = 12;

    • guardRadius: number

      Threat search radius around the protected subject.

      from field: float guard_radius = 4;

    • maximumAttacks: number

      from field: uint32 maximum_attacks = 10;

    • maximumPursuitDistance: number

      Stops chasing when the bot or target exceeds this distance from the subject.

      from field: float maximum_pursuit_distance = 5;

    • maximumTargets: number

      from field: uint32 maximum_targets = 11;

    • Optionaloptions?: PathfindOptions

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

    • restoreSelectedSlot: boolean

      from field: bool restore_selected_slot = 16;

    • returnRadius: number

      Distance from the subject at which the return path completes.

      from field: float return_radius = 6;

    • OptionalselectBestWeapon?: boolean

      from field: optional bool select_best_weapon = 14;

    • sprinting: boolean

      from field: bool sprinting = 9;

    • subject:
          | { case: "position"; value: BlockPosition }
          | { case: "entity"; value: EntityReference }
          | { case: undefined; value?: undefined }

      from oneof soulfire.v1.GuardTask.subject

    • Optionalthreats?: EntitySelector

      from field: soulfire.v1.EntitySelector threats = 3;

    • Optionalweapon?: ItemSelector

      from field: optional soulfire.v1.ItemSelector weapon = 15;

    from message soulfire.v1.GuardTask

    Settings
    Member Visibility