Skip to main content

.SCORE

Dieselbe Instanz ist außerdem erreichbar als: RAGAI.score.

Verwaltet Punktestände für benannte Scores (RAGAI.SCORE, RAGAI.score).

Hintergrund

Jeder Score-Name wird lazily zu einer eigenen Score-Instanz (siehe ./Score.ts), die ihren Zustand selbständig per RAGAI.KEYVAL (Typ passend zum Score-Namen) persistiert - RAGAI.SCORE selbst hält nur die Map der bereits geladenen Scores und delegiert an db() bzw. den namenlosen Default-Score. achieve deaktiviert als Nebeneffekt automatisch den übergebenen skillId per RAGAI.SKILL.disableSkills() (verhindert, dass dieselbe Errungenschaft durch denselben Skill erneut ausgelöst wird) und zeigt bei autoMessage: true automatisch einen Erfolgs-/Fehler-Toast, je nachdem ob value positiv oder negativ ist. Werte werden erst nach WaitForManagerService.varsInit zuverlässig verfügbar sein, da sie asynchron aus dem KeyVal-Speicher nachgeladen werden.

Methoden

.waitForInitials()

Wartet, bis die initialen Punktestände vom Server geladen wurden.

Rückgabewert: Promise<void>

.db(scoreName?)

Gibt den benannten Score-Store zurück (erstellt ihn bei Bedarf).

ParameterTypBeschreibung
scoreNamestring | z.input<typeof scoreDbSchema>Name des Scores, oder ein Objekt gemäß scoreDbSchema. Standard: der unbenannte Default-Score.

Objekt-Form (validiert über scoreDbSchema):

FeldTypPflichtBeschreibung
namestringName des Scores.

Rückgabewert: Score

Der Score-Store.

.achieve(value, skillId?, message?, autoMessage?)

Erhöht den Default-Score und protokolliert eine Errungenschaft (Achievement).

ParameterTypBeschreibung
valuenumber | z.input<typeof scoreAchieveSchema>Anzahl der zu vergebenden Punkte, oder ein Objekt gemäß scoreAchieveSchema.
skillIdstringID des Skills, der die Errungenschaft ausgelöst hat.
messagestringAnzeigetext für die Errungenschaft.
autoMessagebooleantrue, um automatisch eine Standardnachricht zu generieren.

Objekt-Form (validiert über scoreAchieveSchema):

FeldTypPflichtBeschreibung
valuenumberAnzahl der zu vergebenden Punkte.
skillIdstringID des Skills, der die Errungenschaft ausgelöst hat.
messagestringAnzeigetext für die Errungenschaft.
autoMessagebooleantrue, um automatisch eine Standardnachricht zu generieren.

Rückgabewert: void

.getAchieveMents(asJson?)

Gibt alle protokollierten Errungenschaften des Default-Scores zurück.

ParameterTypBeschreibung
asJsonbooleantrue, um das Ergebnis als JSON-String statt als Array zu erhalten.

Rückgabewert: string | AchieveMent[]

Die Errungenschaften.

.add(value)

Erhöht den Default-Score um den angegebenen Wert.

ParameterTypBeschreibung
valuenumber | z.input<typeof scoreValueSchema>Anzahl der hinzuzufügenden Punkte, oder ein Objekt gemäß scoreValueSchema.

Objekt-Form (validiert über scoreValueSchema):

FeldTypPflichtBeschreibung
valuenumberDer Punktwert.

Rückgabewert: void

.get()

Gibt den aktuellen Punktestand des Default-Scores zurück.

Rückgabewert: number

Der aktuelle Punktestand.

.reset()

Setzt den Default-Score auf 0 zurück.

Rückgabewert: Score

Der zurückgesetzte Punktestand.

.set(value)

Setzt den Default-Score auf einen festen Wert.

ParameterTypBeschreibung
valuenumber | z.input<typeof scoreValueSchema>Der neue Punktestand, oder ein Objekt gemäß scoreValueSchema.

Objekt-Form (validiert über scoreValueSchema):

FeldTypPflichtBeschreibung
valuenumberDer Punktwert.

Rückgabewert: void

.sub(value)

Verringert den Default-Score um den angegebenen Wert.

ParameterTypBeschreibung
valuenumber | z.input<typeof scoreValueSchema>Anzahl der abzuziehenden Punkte, oder ein Objekt gemäß scoreValueSchema.

Objekt-Form (validiert über scoreValueSchema):

FeldTypPflichtBeschreibung
valuenumberDer Punktwert.

Rückgabewert: void