General Gameplay

Enhance your Minecraft server by tapping into the General Gameplay features provided by the Enchanted API. Plugins can extend the Api class to use these functionalities that offer more interaction with the game mechanics. In this section, we cover the advancement and attribute methods to manipulate player advancements and attributes.

The advancement Model

The advancement method allows plugins to grant or revoke an advancement or its criterion from players to track or reward player progress.

Method

advancement(action: string, target: string, advancement?: string, criterion?: string): Promise<string | undefined>

Parameters

The attribute Model

Attributes define various properties of entities, such as health or armor. These methods are used for getting, setting, and modifying attributes programmatically.

Methods

Get Total Attribute Value

getAttribute(target: string, attribute: string, scale?: number): Promise<string | undefined>

Get Base Attribute Value

getAttributeBase(target: string, attribute: string, scale?: number): Promise<string | undefined>

Set Base Attribute Value

setAttributeBase(target: string, attribute: string, value: number): Promise<Promise<string> | undefined>

Add Attribute Modifier

addAttributeModifier(
    target: string,
    attribute: string,
    uuid: string,
    name: string,
    value: number,
    operation: string
): Promise<Promise<string> | undefined>

Remove Attribute Modifier

removeAttributeModifier(target: string, attribute: string, uuid: string): Promise<Promise<string> | undefined>

Get Attribute Modifier Value

getAttributeModifierValue(
    target: string,
    attribute: string,
    uuid: string,
    scale?: number
): Promise<Promise<string> | undefined>

Parameters for Attribute Methods