Bonsaibauer: Importing a new version from external source

2026-11-07T01:06:33Z

Importing a new version from external source

New page

<languages />



[[File:ShroudForge-Wiki-modding.svg|thumb|left|600px|Modding]]

 

Lies den Hauptmenüzustand und den ausgewählten lokalen Charakternamen mit der Lua-Runtime. Beide Abfragen nutzen dieselben nativen Daten wie der Modloader und benötigen keinen Weltzugriff.


== Voraussetzungen ==

Aktiviere die Mod und deklariere in <code>mod.json</code> die Berechtigung <code>runtime</code>:

<pre>
{
"capabilities": ["runtime"]
}
</pre>

Setze für diese Client-Abfragen in <code>extended.mod.json</code> das Feld <code>targets</code> auf <code>["client"]</code>. Verwende die Funktionen in aktiven Laufzeit-Callbacks wie <code>on_load</code> und <code>on_update</code>. <code>runtime.phase == "ingame"</code> bezeichnet die gestartete Mod-Laufzeit und bestätigt keinen Weltbeitritt. Für diese beiden Abfragen ist kein Ausführungsprofil nötig. Andere Weltoperationen behalten ihre eigenen Voraussetzungen.


== Hauptmenü erkennen ==

<pre>
local in_menu, reason = runtime.is_main_menu()
</pre>

{| class="wikitable"
! Rückgabe !! Bedeutung
|-
| <code>true, nil</code> || Das Hauptmenü einschließlich Charakter-, Welt- und Serverauswahl wurde bestätigt.
|-
| <code>false, nil</code> || Ein anderer ursprünglicher Spielzustand wurde bestätigt.
|-
| <code>nil, reason</code> || Der Zustand ist unbekannt, wechselt gerade oder die Abfrage ist nicht verfügbar.
|}

Prüfe ausdrücklich <code>in_menu == true</code> oder <code>in_menu == false</code>. <code>nil</code> ist kein bestätigter Zustand. Auch <code>false</code> bestätigt für sich allein keinen lesbaren Weltzustand. Prüfe dafür die benötigte Operation, zum Beispiel <code>runtime.has("runtime.ecs.read")</code>.


== Charakternamen lesen ==

<pre>
local name, reason = runtime.player.name()
local display_name = name or "Flameborn"
</pre>

<code>name, nil</code> liefert den im lokalen Hauptmenü ausgewählten Charakternamen als UTF-8-String. Unicode-Zeichen wie in <code>Ikiju 育樹</code> bleiben erhalten. <code>nil, reason</code> bedeutet, dass noch kein Name vorliegt oder der Zugriff nicht verfügbar beziehungsweise nicht erlaubt ist.

Die Mod bestimmt ihren Ersatznamen selbst. Die API setzt keinen Standardnamen ein und übernimmt nicht die manuelle Namenswahl des Modloaders. Der Wert bezeichnet keinen entfernten Spieler, keine SteamID und keinen Steam-Anzeigenamen. Ein Dedicated Server besitzt keinen lokalen Client-Charakternamen.


== Gemeinsamer Cache ==

Lua und Modloader lesen denselben nativen Cache. Der vorhandene Runtime-Tick aktualisiert den Menüstatus. Die bestehende Menüanbindung erfasst den Namen bei der ersten verfügbaren Auswahl und erneut bei einer geänderten Auswahl oder geänderten Namensmetadaten. Lua-Abfragen starten keine eigene Suche und lesen keine Logs.

Der zuletzt erfolgreich erfasste Name bleibt beim Weltbeitritt im Cache. Ein vorhandener Name bestätigt daher keinen Menüaufenthalt. <code>runtime.has("runtime.is_main_menu")</code> und <code>runtime.has("runtime.player.name")</code> melden die jeweilige Verfügbarkeit. <code>runtime.status(...)</code> ergänzt eine Begründung.


== Beispiel für <code>src/mod.lua</code> ==

Das Beispiel liest den Cache beim Laden und danach alle 500 ms. Es verwendet einen eigenen Ersatznamen und protokolliert nur Änderungen:

<pre>
runtime.require("runtime.lifecycle")

local previous_message = nil

local function refresh()
local in_menu = runtime.is_main_menu()
local name = runtime.player.name()
local state = "unknown"
if in_menu == true then
state = "menu"
elseif in_menu == false then
state = "other"
end

local message = state .. ": " .. (name or "Flameborn")
if message ~= previous_message then
previous_message = message
shroudforge.log.info(message)
end
end

return {
on_load = refresh,
on_update = function()
refresh()
end,
update_interval_ms = 500,
}
</pre>

[[Category:guide:Shroudforge]]

Modding/de-at - Revision history

Bonsaibauer: Importing a new version from external source