Class AimAssistPresetBeta

Handle to an aim-assist preset that exists in the world.aimAssist registry.

Required Experiments:

  • Camera Aim Assist

Hierarchy

  • AimAssistPreset

Constructors

constructor

Properties

defaultItemSettings? handSettings? identifier

Methods

getExcludedTargets getItemSettings getLiquidTargetingItems

Constructors

Private constructor

Properties

Optional Readonly defaultItemSettings

defaultItemSettings?: string

Remarks

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

Throws

This property can throw when used.

Error

Optional Readonly handSettings

handSettings?: string

Remarks

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

Throws

This property can throw when used.

Error

Readonly identifier

identifier: string

Remarks

The unique Id associated with the preset.

Methods

getExcludedTargets

  • Returns string[]

    The array of block/entity Ids.

    Remarks

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

    Throws

    This function can throw errors.

    Error

getItemSettings

  • Returns Record<string, string>

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

    Remarks

    Gets the per-item aim-assist category Ids.

    Throws

    This function can throw errors.

    Error

getLiquidTargetingItems

  • Returns string[]

    The array of item Ids.

    Remarks

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

    Throws

    This function can throw errors.

    Error

Settings

Member Visibility

Theme

On This Page