Package net.ixdarklord.folios.api.client

Class GuideObjectives

java.lang.Object

net.ixdarklord.folios.api.client.GuideObjectives

public final class GuideObjectives
extends Object

Values a mod reports for books to follow: an objective {"source": "mymod:mana", "goal": 100} is as far along as the source's value is towards its goal. The value is asked whenever the objective is drawn or checked, so keep it cheap (read it from what the client already has).

 GuideObjectives.register(MyMod.id("mana"), player -> ManaClient.current());
 GuideObjectives.register(MyMod.id("spells_known"), player -> ClientSpells.known().size());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GuideObjectives.Source	A value to follow, for the local player.

Method Summary

Modifier and Type	Method	Description
static @Nullable GuideObjectives.Source	get(net.minecraft.resources.ResourceLocation id)
static void	register(net.minecraft.resources.ResourceLocation id, GuideObjectives.Source source)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

register

public static void register(net.minecraft.resources.ResourceLocation id,
 GuideObjectives.Source source)

get

@Nullable
public static @Nullable GuideObjectives.Source get(net.minecraft.resources.ResourceLocation id)