Developer API

La línea de tiempo expone los asistentes de API públicos en org.z2six.rpgtimeline.api.RPGTimelineApi.

TLDR

Utilice la API para:

leer/formatear las fechas actuales del calendario
agregar servidor/notas personales
registrar avances nativos
registrar eventos externos similares a avances

Ayudantes de citas

import org.z2six.rpgtimeline.api.RPGTimelineApi;

long gameTime = serverLevel.getDayTime();
String dateText = RPGTimelineApi.buildDateStringFromGameTime(gameTime);
long dayIndex = RPGTimelineApi.getDayIndexForGameTime(gameTime);

Métodos útiles:

getCalendarDefinition()
getCalendarDayOffsetDays()
fromGameTime(long gameTime)
formatDate(long gameTime)
buildDateMessage(long dayIndex)

Agregar notas mediante programación

import org.z2six.rpgtimeline.api.RPGTimelineApi;

RPGTimelineApi.addServerNote(player, "Server Arc Begins", "The kingdom enters a new age.");
RPGTimelineApi.addPersonalNote(player, "My Journal", "Reached the obsidian gate.");

// Explicit day index version
RPGTimelineApi.addServerNote(player, "Coronation", "The crown was claimed.", 512L);

Avances récord

Objeto de avance nativo

RPGTimelineApi.recordAdvancement(player, advancementHolder);

Evento externo similar a un avance

import net.minecraft.network.chat.Component;

RPGTimelineApi.recordExternalAdvancement(
    player,
    "mymod:slay_lich",
    Component.literal("Lich Vanquisher"),
    Component.literal("Defeated the Lich beneath the catacombs."),
    "minecraft:nether_star"
);

BUCEO PROFUNDO: primera identidad mundial

sourceId es la identidad utilizada para el seguimiento por primera vez en el mundo. Mantenlo estable y único según el concepto de logro.

Modelo de error

Las llamadas API son defensivas:

las entradas nulas se ignoran de forma segura siempre que sea posible
Las fallas internas se registran y se tragan para evitar fallas en los mods de las personas que llaman.

Uso del lado del servidor

Los ayudantes de redacción de crónicas deben llamarse desde contextos del lado del servidor (ServerPlayer).