Class AimAssistRegistry

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

Index

Properties

DefaultCategoryId DefaultPresetId

Methods

addCategory addPreset getCategories getCategory getPreset getPresets

Properties

`Static` `Readonly`DefaultCategoryId

DefaultCategoryId: "minecraft:default" = 'minecraft:default'

Remarks

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

`Static` `Readonly`DefaultPresetId

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

Remarks

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

Methods

addCategory

addCategory(category: AimAssistCategorySettings): AimAssistCategory
World mutation
Parameters
- category: AimAssistCategorySettings
  The category settings used to create the new category.
Returns AimAssistCategory
The created category handle.

Remarks
Adds an aim-assist category to the registry.

Throws
EngineError

Throws
Error

Throws
InvalidArgumentError

Throws
NamespaceNameError
- Defined in @minecraft/server.d.ts:3883

addPreset

addPreset(preset: AimAssistPresetSettings): AimAssistPreset
World mutation
Parameters
- preset: AimAssistPresetSettings
  The preset settings used to create the new preset.
Returns AimAssistPreset
The created preset handle.

Remarks
Adds an aim-assist preset to the registry.

Throws
EngineError

Throws
Error

Throws
InvalidArgumentError

Throws
NamespaceNameError
- Defined in @minecraft/server.d.ts:3902

getCategories

getCategories(): AimAssistCategory[]
Returns AimAssistCategory[]
An array of all available category objects.

Remarks
Gets all available categories in the registry.
- Defined in @minecraft/server.d.ts:3910

getCategory

getCategory(categoryId: string): AimAssistCategory
World mutation
Parameters
- categoryId: string
Returns AimAssistCategory
The category object if it exists, otherwise returns undefined.

Remarks
Gets the category associated with the provided Id.
- Defined in @minecraft/server.d.ts:3921

getPreset

getPreset(presetId: string): AimAssistPreset
World mutation
Parameters
- presetId: string
  The Id of the preset to retrieve. Must have a namespace.
Returns AimAssistPreset
The preset object if it exists, otherwise returns undefined.

Remarks
Gets the preset associated with the provided Id.
- Defined in @minecraft/server.d.ts:3933

getPresets

getPresets(): AimAssistPreset[]
Returns AimAssistPreset[]
An array of all available preset objects.

Remarks
Gets all available presets in the registry.
- Defined in @minecraft/server.d.ts:3941