Class AimAssistPresetSettingsBeta

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

Hierarchy

  • AimAssistPresetSettings

Constructors

constructor

Properties

defaultItemSettings? handSettings? identifier

Methods

getExcludedTargets getItemSettings getLiquidTargetingItems setExcludedTargets setItemSettings setLiquidTargetingItems

Constructors

constructor

  • Parameters

    • identifier: string

    Returns AimAssistPresetSettings

    Remarks

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

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

Properties

Optional defaultItemSettings

defaultItemSettings?: string

Remarks

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

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

Optional handSettings

handSettings?: string

Remarks

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

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

Readonly identifier

identifier: string

Remarks

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

Methods

getExcludedTargets

  • Returns undefined | string[]

    The array of block/entity Ids.

    Remarks

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

getItemSettings

  • Returns Record<string, string>

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

    Remarks

    Gets the per-item aim-assist category Ids.

getLiquidTargetingItems

  • Returns undefined | string[]

    The array of item Ids.

    Remarks

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

setExcludedTargets

  • Parameters

    • Optional targets: string[]

      An array of block/entity Ids.

    Returns void

    Remarks

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

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

setItemSettings

  • Parameters

    • itemSettings: Record<string, string>

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

    Returns void

    Remarks

    Sets the per-item aim-assist category Ids.

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

setLiquidTargetingItems

  • Parameters

    • Optional items: string[]

      An array of item Ids.

    Returns void

    Remarks

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

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

Settings

Member Visibility

Theme

On This Page