@minecraft/server
    Preparing search index...

    Class AimAssistRegistryBeta

    A container for APIs related to the world's aim-assist settings.

    Index

    Properties

    DefaultPresetId

    Methods

    addCategory addPreset getCategories getCategory getPreset getPresets

    Properties

    DefaultPresetId: "minecraft:aim_assist_default" = 'minecraft:aim_assist_default'

    The default aim-assist preset Id that is used when not otherwise specified.

    Methods

    • Beta

      Parameters

      Returns AimAssistPreset

      The created preset handle.

      Adds an aim-assist preset to the registry.

      This function can't be called in read-only mode.

      This function can throw errors.

      minecraftcommon.EngineError

      Error

      minecraftcommon.InvalidArgumentError

      NamespaceNameError

    • Beta

      Returns AimAssistCategory[]

      An array of all available category objects.

      Gets all available categories in the registry.

    • Beta

      Parameters

      • categoryId: string

      Returns undefined | AimAssistCategory

      The category object if it exists, otherwise returns undefined.

      Gets the category associated with the provided Id.

      This function can't be called in read-only mode.

    • Beta

      Parameters

      • presetId: string

        The Id of the preset to retrieve. Must have a namespace.

      Returns undefined | AimAssistPreset

      The preset object if it exists, otherwise returns undefined.

      Gets the preset associated with the provided Id.

      This function can't be called in read-only mode.

    • Beta

      Returns AimAssistPreset[]

      An array of all available preset objects.

      Gets all available presets in the registry.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods