Bonsaibauer: Importing a new version from external source

2026-11-07T01:35:22Z

Importing a new version from external source

New page

<languages />



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

 

Lees de status van het hoofdmenu en de geselecteerde lokale personagenaam via de Lua-runtime. Beide query's gebruiken dezelfde native gegevens als Modloader en hebben geen toegang tot de wereld nodig.


== Vereisten ==

Schakel de mod in en geef de <code>runtime</code>-mogelijkheid op in <code>mod.json</code>:

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

Stel voor deze clientquery's <code>targets</code> in <code>extended.mod.json</code> in op <code>["client"]</code>. Roep de functies aan vanuit actieve runtime-callbacks zoals <code>on_load</code> en <code>on_update</code>. <code>runtime.phase == "ingame"</code> geeft aan dat de modruntime is gestart en bevestigt niet dat de gamewereld is betreden. Geen van beide query's vereist een uitvoeringsprofiel. Andere wereldbewerkingen hebben hun eigen vereisten.


== Het hoofdmenu detecteren ==

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

{| class="wikitable"
! Retourwaarde !! Betekenis
|-
| <code>true, nil</code> || Het hoofdmenu is bevestigd, inclusief de selectie van personage, wereld en server.
|-
| <code>false, nil</code> || Een andere oorspronkelijke gamestatus is gevalideerd.
|-
| <code>nil, reason</code> || De status is onbekend, verandert of de query is niet beschikbaar.
|}

Controleer expliciet of <code>in_menu == true</code> of <code>in_menu == false</code>. <code>nil</code> is geen bevestigde status. Alleen <code>false</code> bevestigt ook niet dat een wereld leesbaar is. Controleer de benodigde bewerking afzonderlijk, bijvoorbeeld <code>runtime.has("runtime.ecs.read")</code>.


== De personagenaam lezen ==

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

<code>name, nil</code> retourneert de naam van het personage dat in het lokale hoofdmenu is geselecteerd als UTF-8-tekenreeks. Unicode-tekens, zoals in <code>Ikiju 育樹</code>, blijven behouden. <code>nil, reason</code> betekent dat er nog geen naam beschikbaar is, of dat toegang niet beschikbaar of niet toegestaan is.

De mod kiest zelf een terugvalnaam. De API voegt geen standaardwaarde toe en gebruikt niet de handmatige naamselectie van Modloader. De waarde identificeert geen externe speler en is geen SteamID of Steam-weergavenaam. Een dedicated server heeft geen lokale clientpersonagenaam.


== Gedeelde cache ==

Lua en Modloader lezen dezelfde native cache. De bestaande runtimetick vernieuwt de menustatus. De bestaande menu-integratie legt de naam vast zodra de eerste selectie beschikbaar is en opnieuw wanneer de selectie of naammetadata verandert. Lua-query's starten geen aparte detectie en lezen geen logboeken.

De laatst succesvol vastgelegde naam blijft in de cache nadat je een wereld bent binnengegaan. Een naam in de cache bevestigt dus niet dat het menu open is. <code>runtime.has("runtime.is_main_menu")</code> en <code>runtime.has("runtime.player.name")</code> geven de beschikbaarheid van elke query aan. <code>runtime.status(...)</code> geeft ook een reden.


== Voorbeeld voor <code>src/mod.lua</code> ==

Dit voorbeeld leest de cache bij het laden en daarna elke 500 ms. Het kiest een terugvalnaam en registreert alleen wijzigingen:

<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/nl - Revision history

Bonsaibauer: Importing a new version from external source