Bonsaibauer: Importing a new version from external source

2026-11-07T01:35:26Z

Importing a new version from external source

New page

<languages />



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

 

Läs huvudmenyns status och namnet på den valda lokala karaktären via Lua-runtime. Båda frågorna använder samma inbyggda data som Modloader och kräver ingen åtkomst till världen.


== Förutsättningar ==

Aktivera modden och ange funktionen <code>runtime</code> i <code>mod.json</code>:

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

För de här klientfrågorna ställer du in <code>targets</code> till <code>["client"]</code> i <code>extended.mod.json</code>. Anropa funktionerna från aktiva runtime-callbacks som <code>on_load</code> och <code>on_update</code>. <code>runtime.phase == "ingame"</code> beskriver att moddens runtime har startat och bekräftar inte att en värld har öppnats. Ingen av frågorna behöver en körprofil. Andra världsåtgärder har sina egna krav.


== Känna av huvudmenyn ==

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

{| class="wikitable"
! Returvärde !! Betydelse
|-
| <code>true, nil</code> || Huvudmenyn har bekräftats, inklusive val av karaktär, värld och server.
|-
| <code>false, nil</code> || Ett annat ursprungligt spelläge har verifierats.
|-
| <code>nil, reason</code> || Läget är okänt, håller på att ändras eller frågan är inte tillgänglig.
|}

Kontrollera uttryckligen <code>in_menu == true</code> eller <code>in_menu == false</code>. <code>nil</code> är inte ett bekräftat läge. Enbart <code>false</code> bekräftar inte heller att världen går att läsa. Kontrollera den funktion du behöver separat, till exempel <code>runtime.has("runtime.ecs.read")</code>.


== Läsa karaktärens namn ==

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

<code>name, nil</code> returnerar namnet på karaktären som valts i den lokala huvudmenyn som en UTF-8-sträng. Unicode-tecken, som i <code>Ikiju 育樹</code>, bevaras. <code>nil, reason</code> betyder att namnet inte är tillgängligt ännu eller att åtkomst saknas eller inte är tillåten.

Modden väljer själv ett reservnamn. API:t lägger inte till något standardvärde och använder inte Modloaders manuella namnval. Värdet identifierar ingen fjärrspelare och är varken ett SteamID eller ett Steam-visningsnamn. En dedikerad server har inget lokalt klientkaraktärsnamn.


== Delad cache ==

Lua och Modloader läser samma inbyggda cache. Den befintliga runtime-ticken uppdaterar menystatusen. Den befintliga menyintegreringen hämtar namnet vid det första tillgängliga valet och igen när valet eller namnets metadata ändras. Lua-frågor startar ingen separat sökning och läser inga loggar.

Det senast hämtade namnet finns kvar i cachen efter att du går in i en värld. Ett cachat namn bekräftar därför inte att menyn är öppen. <code>runtime.has("runtime.is_main_menu")</code> och <code>runtime.has("runtime.player.name")</code> visar om respektive fråga är tillgänglig. <code>runtime.status(...)</code> ger också en orsak.


== Exempel för <code>src/mod.lua</code> ==

Exemplet läser cachen vid inläsning och därefter var 500:e ms. Det väljer ett reservnamn och loggar bara ändringar:

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

Bonsaibauer: Importing a new version from external source