Skip to content

@minecraft/server


@minecraft/server / PlayerAimAssist

Class: PlayerAimAssist ​

Defined in: @minecraft/server/index.d.ts:16916

A container for APIs related to player aim-assist.

Properties ​

settings? ​

readonly optional settings?: PlayerAimAssistSettings

Defined in: @minecraft/server/index.d.ts:16924

Remarks ​

The player's currently active aim-assist settings, or undefined if not active.

Methods ​

set() ​

set(settings?): void

Defined in: @minecraft/server/index.d.ts:16948

Parameters ​

settings? ​

PlayerAimAssistSettings

Aim-assist settings to activate for the player, if undefined aim-assist will be disabled.

Returns ​

void

Remarks ​

Sets the player's aim-assist settings.

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

Throws ​

This function can throw errors.

minecraftcommon.ArgumentOutOfBoundsError

minecraftcommon.EngineError

Error

minecraftcommon.InvalidArgumentError

InvalidEntityError

NamespaceNameError