PlayerAdvancements

Version:

Home Commands Examples Getting Started With Scripts Global Keywords 1.21 Migration Guide

Advancement AdvancementHolder AdvancementProgress AdvancementRequirements AdvancementRewards AdvancementType Criterion CriterionProgress DisplayInfo PlayerAdvancements ServerAdvancementManager

BracketDumpers BracketHandlers BracketValidators ResourceLocationBracketHandler

Importing the class

If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.

import crafttweaker.api.advancement.PlayerAdvancements;

Members

Awards an advancement to the player.

Returns: Whether the advancement was awarded.

// PlayerAdvancements.award(advancement as AdvancementHolder, criteria as string) as bool;
myPlayerAdvancements.award(myAdvancementHolder, myString);

Parameters:

advancement: AdvancementHolder Type: AdvancementHolder - The advancement to award.

criteria: string Type: string - The criteria to award.

Return Type: bool

Updates the advancements on the client

// PlayerAdvancements.flushDirty(player as ServerPlayer);
myPlayerAdvancements.flushDirty(myServerPlayer);

Parameters:

player: ServerPlayer Type: ServerPlayer - The player to flush the dirty state of.

Gets the progress of an advancement.

Returns: The progress of the advancement.

// PlayerAdvancements.getOrStartProgress(advancement as AdvancementHolder) as AdvancementProgress;
myPlayerAdvancements.getOrStartProgress(myAdvancementHolder);

Parameters:

advancement: AdvancementHolder Type: AdvancementHolder - The advancement to get the progress of.

Return Type: AdvancementProgress

Revokes an advancement from the player.

Returns: Whether the advancement was revoked.

// PlayerAdvancements.revoke(advancement as AdvancementHolder, criteria as string) as bool;
myPlayerAdvancements.revoke(myAdvancementHolder, myString);

Parameters:

advancement: AdvancementHolder Type: AdvancementHolder - The advancement to revoke.

criteria: string Type: string - The criteria to revoke.

Return Type: bool