SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias AttackEntityTask

    AttackEntityTask: Message<"soulfire.v1.AttackEntityTask"> & {
        attackRange: number;
        maximumAttacks: number;
        options?: PathfindOptions;
        restoreSelectedSlot: boolean;
        selectBestWeapon?: boolean;
        sprinting: boolean;
        target?: EntityReference;
        targetUnavailableTimeoutSeconds: number;
        useOffhandShield: boolean;
        weapon?: ItemSelector;
    }

    Core task input for chasing and attacking one connection-scoped entity.

    Type Declaration

    • attackRange: number

      from field: float attack_range = 3;

    • maximumAttacks: number

      Zero attacks until the target is defeated.

      from field: uint32 maximum_attacks = 5;

    • Optionaloptions?: PathfindOptions

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

    • restoreSelectedSlot: boolean

      Restores the selected hotbar slot when the task stops.

      from field: bool restore_selected_slot = 9;

    • OptionalselectBestWeapon?: boolean

      Defaults to true. Selects the strongest matching melee weapon.

      from field: optional bool select_best_weapon = 7;

    • sprinting: boolean

      from field: bool sprinting = 4;

    • Optionaltarget?: EntityReference

      from field: soulfire.v1.EntityReference target = 1;

    • targetUnavailableTimeoutSeconds: number

      How long the target may remain unobservable before the task completes. Zero selects the server default.

      from field: uint32 target_unavailable_timeout_seconds = 6;

    • useOffhandShield: boolean

      Uses an equipped offhand shield while approaching and between attacks.

      from field: bool use_offhand_shield = 10;

    • Optionalweapon?: ItemSelector

      Restricts automatic weapon selection.

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

    from message soulfire.v1.AttackEntityTask

    Settings
    Member Visibility