Script API - v26.50.24
    Preparing search index...

    Class AimAssistPresetSettings

    Settings used with AimAssistRegistry.addPreset for creation of the AimAssistPreset.

    import { AimAssistPresetSettings, world } from "@minecraft/server";

    // Example of creating aim assist preset settings object
    // This demonstrates the structure needed for aim assist preset configuration
    const presetSettings = new AimAssistPresetSettings("custom:my_preset");

    presetSettings.setExcludedTargets(["minecraft:item_frame", "minecraft:painting"]);
    presetSettings.setItemSettings({
       "minecraft:bow": "custom:ranged_category",
       "minecraft:crossbow": "custom:ranged_category",
       "minecraft:sword": "custom:melee_category",
    });
    presetSettings.setLiquidTargetingItems(["minecraft:bucket", "minecraft:water_bucket", "minecraft:lava_bucket"]);

    world.getAimAssist().addPreset(presetSettings);

    export class AimAssistPresetSettings {
        defaultItemSettings?: string;
        handSettings?: string;
        readonly identifier: string;
        constructor(identifier: string);
        getExcludedBlockTagTargets(): string[] | undefined;
        getExcludedBlockTargets(): string[] | undefined;
        getExcludedEntityTargets(): string[] | undefined;
        getExcludedEntityTypeFamilyTargets(): string[] | undefined;
        getItemSettings(): Record<string, string>;
        getLiquidTargetingItems(): string[] | undefined;
        setExcludedBlockTagTargets(blockTagTargets?: string[]): void;
        setExcludedBlockTargets(blockTargets?: string[]): void;
        setExcludedEntityTargets(entityTargets?: string[]): void;
        setExcludedEntityTypeFamilyTargets(entityTypeFamilyTargets?: string[]): void;
        setItemSettings(itemSettings: Record<string, string>): void;
        setLiquidTargetingItems(items?: string[]): void;
    }
    Index

    Constructors

    constructor

    Properties

    defaultItemSettings? handSettings? identifier

    Methods

    getExcludedBlockTagTargets getExcludedBlockTargets getExcludedEntityTargets getExcludedEntityTypeFamilyTargets getItemSettings getLiquidTargetingItems setExcludedBlockTagTargets setExcludedBlockTargets setExcludedEntityTargets setExcludedEntityTypeFamilyTargets setItemSettings setLiquidTargetingItems

    Constructors

    • Parameters

      • identifier: string

      Returns AimAssistPresetSettings

      Constructor that takes a unique Id to associate with the created AimAssistPreset. Must have a namespace.

    Properties

    defaultItemSettings?: string

    Optional. Default aim-assist category Id used for items not provided to setItemSettings.

    restricted-execution-read-only - This property can't be edited in restricted-execution mode.

    This property can't be read in early-execution mode.

    handSettings?: string

    Optional. Aim-assist category Id used for an empty hand.

    restricted-execution-read-only - This property can't be edited in restricted-execution mode.

    This property can't be read in early-execution mode.

    identifier: string

    The unique Id used to register the preset with. Must have a namespace.

    This property can't be read in early-execution mode.

    Methods

    • Returns string[] | undefined

      The array of block tags.

      Gets the list of block tags to exclude from aim assist targeting.

      This function can't be called in early-execution mode.

    • Returns string[] | undefined

      The array of block Ids.

      Gets the list of block Ids to exclude from aim assist targeting.

      This function can't be called in early-execution mode.

    • Returns string[] | undefined

      The array of entity Ids.

      Gets the list of entity Ids to exclude from aim assist targeting.

      This function can't be called in early-execution mode.

    • Returns string[] | undefined

      The array of entity type families.

      Gets the list of entity type families to exclude from aim assist targeting.

      This function can't be called in early-execution mode.

    • Returns Record<string, string>

      The record mapping item Ids to aim-assist category Ids.

      Gets the per-item aim-assist category Ids.

      This function can't be called in early-execution mode.

    • Returns string[] | undefined

      The array of item Ids.

      Gets the list of item Ids that will target liquid blocks with aim-assist when being held.

      This function can't be called in early-execution mode.

    • Parameters

      • OptionalblockTagTargets: string[]

      Returns void

      Sets the list of block tags to exclude from aim assist targeting.

      no-restricted-execution - This function can't be called in restricted-execution mode.

      This function can't be called in early-execution mode.

    • Parameters

      • OptionalblockTargets: string[]

      Returns void

      Sets the list of block Ids to exclude from aim assist targeting.

      no-restricted-execution - This function can't be called in restricted-execution mode.

      This function can't be called in early-execution mode.

    • Parameters

      • OptionalentityTargets: string[]

      Returns void

      Sets the list of entity Ids to exclude from aim assist targeting.

      no-restricted-execution - This function can't be called in restricted-execution mode.

      This function can't be called in early-execution mode.

    • Parameters

      • OptionalentityTypeFamilyTargets: string[]

      Returns void

      Sets the list of entity type families to exclude from aim assist targeting.

      no-restricted-execution - This function can't be called in restricted-execution mode.

      This function can't be called in early-execution mode.

    • Parameters

      • itemSettings: Record<string, string>

        A record mapping item Ids to aim-assist category Ids. Category Ids must have a namespace.

      Returns void

      Sets the per-item aim-assist category Ids.

      no-restricted-execution - This function can't be called in restricted-execution mode.

      This function can't be called in early-execution mode.

    • Parameters

      • Optionalitems: string[]

        An array of item Ids.

      Returns void

      Sets the list of item Ids that will target liquid blocks with aim-assist when being held.

      no-restricted-execution - This function can't be called in restricted-execution mode.

      This function can't be called in early-execution mode.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods