Bonsaibauer: Importing a new version from external source

2026-11-07T01:35:23Z

Importing a new version from external source

New page

<languages />



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

 

Odczytuj stan menu głównego i nazwę wybranej lokalnej postaci za pomocą runtime'u Lua. Oba zapytania korzystają z tych samych danych natywnych co Modloader i nie wymagają dostępu do świata.


== Wymagania wstępne ==

Włącz mod i zadeklaruj możliwość <code>runtime</code> w pliku <code>mod.json</code>:

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

W przypadku tych zapytań klienta ustaw <code>targets</code> na <code>["client"]</code> w pliku <code>extended.mod.json</code>. Wywołuj funkcje z aktywnych callbacków runtime'u, takich jak <code>on_load</code> i <code>on_update</code>. <code>runtime.phase == "ingame"</code> oznacza uruchomiony runtime moda, ale nie potwierdza wejścia do świata. Żadne z tych zapytań nie wymaga profilu wykonania. Pozostałe operacje dotyczące świata zachowują własne wymagania.


== Wykrywanie menu głównego ==

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

{| class="wikitable"
! Zwracana wartość !! Znaczenie
|-
| <code>true, nil</code> || Potwierdzono menu główne, w tym wybór postaci, świata i serwera.
|-
| <code>false, nil</code> || Zweryfikowano inny pierwotny stan gry.
|-
| <code>nil, reason</code> || Stan jest nieznany, zmienia się lub zapytanie jest niedostępne.
|}

Jawnie sprawdzaj <code>in_menu == true</code> lub <code>in_menu == false</code>. <code>nil</code> nie jest potwierdzonym stanem. Samo <code>false</code> również nie potwierdza dostępności świata do odczytu. Osobno sprawdź wymaganą operację, na przykład <code>runtime.has("runtime.ecs.read")</code>.


== Odczyt nazwy postaci ==

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

<code>name, nil</code> zwraca jako ciąg UTF-8 nazwę postaci wybranej w lokalnym menu głównym. Znaki Unicode, na przykład w <code>Ikiju 育樹</code>, są zachowywane. <code>nil, reason</code> oznacza, że nazwa nie jest jeszcze dostępna albo dostęp jest niedostępny lub niedozwolony.

Mod sam wybiera nazwę zastępczą. API nie dodaje wartości domyślnej i nie używa ręcznego wyboru nazwy z Modloadera. Ta wartość nie identyfikuje zdalnego gracza i nie jest SteamID ani nazwą wyświetlaną przez Steam. Serwer dedykowany nie ma lokalnej nazwy postaci klienta.


== Wspólna pamięć podręczna ==

Lua i Modloader odczytują tę samą pamięć podręczną natywną. Istniejący tick runtime'u odświeża stan menu. Istniejąca integracja menu zapisuje nazwę przy pierwszym dostępnym wyborze, a następnie ponownie po zmianie wyboru lub metadanych nazwy. Zapytania Lua nie uruchamiają osobnego wykrywania ani nie odczytują logów.

Ostatnia poprawnie odczytana nazwa pozostaje w pamięci podręcznej po wejściu do świata. Dlatego sama obecność nazwy w pamięci nie potwierdza, że menu jest otwarte. <code>runtime.has("runtime.is_main_menu")</code> i <code>runtime.has("runtime.player.name")</code> informują o dostępności poszczególnych zapytań. <code>runtime.status(...)</code> również podaje przyczynę.


== Przykład dla <code>src/mod.lua</code> ==

Ten przykład odczytuje pamięć podręczną przy ładowaniu, a następnie co 500 ms. Wybiera nazwę zastępczą i zapisuje w logu tylko zmiany:

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

Bonsaibauer: Importing a new version from external source