Fabric Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Adding Player Statistics ======
Statistics track time spend doing something, distance traveled or jumped, and how often the player interacted with blocks or performed certain actions.

To add a custom statistic, create an identifier which will be used to register and increase the stat:
<code java>
public static final Identifier INTERACT_WITH_COOL_BLOCK = Identifier.of("modid", "interact_with_cool_block");
</code>

===== Registration =====

Then register the stat using the identifier:
<code java>
Registry.register(Registries.CUSTOM_STAT, "interact_with_cool_block", INTERACT_WITH_COOL_BLOCK);
</code>

Then add the stat to the statistic screen, where you can also specify the stat formatter. It determines how the number is shown in the stat list. You can use DEFAULT, DIVIDE_BY_TEN, DISTANCE or TIME.

<code java>
Stats.CUSTOM.getOrCreateStat(INTERACT_WITH_COOL_BLOCK, StatFormatter.DEFAULT);
</code>

===== Using The Statistic =====

To increment the statistic, for example when a player interacts with a block, you can use ''PlayerEntity::incrementStat'':

<code java>
@Override
public ActionResult onUse(BlockState state, World world, BlockPos pos, PlayerEntity player, Hand hand, BlockHitResult hit) {
	player.incrementStat(ModClass.INTERACT_WITH_COOL_BLOCK);

	return ActionResult.SUCCESS;
}
</code>

You can also use ''PlayerEntity.increaseStat(stat, amount)'' to increase the stat by an arbitrary amount.

===== Translation =====

To translate the name, add an entry for ''stat.modid.statid'' (see [[tutorial:lang]] for how to translate the statistic.):

<code json>
{
  "stat.modid.interact_with_cool_block": "Interactions with Cool Block"
}
</code>