Developer API

Timeline stellt öffentliche API-Helfer unter org.z2six.rpgtimeline.api.RPGTimelineApi bereit.

TLDR

Verwenden Sie die API, um:

Aktuelle Kalenderdaten lesen/formatieren
Server-/persönliche Notizen hinzufügen
Native Fortschritte aufzeichnen
Externe förderungsähnliche Ereignisse aufzeichnen

Date-Helfer

import org.z2six.rpgtimeline.api.RPGTimelineApi;

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

Nützliche Methoden:

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

Notizen programmgesteuert hinzufügen

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);

Fortschritte aufzeichnen

Natives Weiterentwicklungsobjekt

RPGTimelineApi.recordAdvancement(player, advancementHolder);

Externes förderungsähnliches Ereignis

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"
);

DEEP DIVE: Weltweit erste Identität

sourceId ist die Identität, die für das weltweit erste Tracking verwendet wird. Halten Sie es pro Leistungskonzept stabil und einzigartig.

Fehlermodell

API-Aufrufe sind defensiv:

Null-Eingaben werden, soweit möglich, sicher ignoriert
Interne Fehler werden protokolliert und geschluckt, um einen Absturz von Caller-Mods zu vermeiden

Serverseitige Nutzung

Hilfsprogramme zum Schreiben von Chroniken sollten aus serverseitigen Kontexten aufgerufen werden (ServerPlayer).