Bonsaibauer: Importing a new version from external source

2026-11-07T01:35:20Z

Importing a new version from external source

New page

<languages />



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

 

Lua रनटाइम से मुख्य मेनू की स्थिति और चुने गए स्थानीय कैरेक्टर नाम को पढ़ें। दोनों प्रश्न Modloader जैसे ही नेटिव डेटा का उपयोग करते हैं और दुनिया तक पहुँच की आवश्यकता नहीं रखते।


== आवश्यकताएँ ==

मॉड सक्षम करें और <code>mod.json</code> में <code>runtime</code> क्षमता घोषित करें:

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

क्लाइंट के इन प्रश्नों के लिए <code>extended.mod.json</code> में <code>targets</code> को <code>["client"]</code> पर सेट करें। फ़ंक्शन को सक्रिय रनटाइम कॉलबैक, जैसे <code>on_load</code> और <code>on_update</code>, से कॉल करें। <code>runtime.phase == "ingame"</code> शुरू हुए मॉड रनटाइम को बताता है, दुनिया में प्रवेश की पुष्टि नहीं करता। किसी भी प्रश्न को निष्पादन प्रोफ़ाइल की आवश्यकता नहीं है। दुनिया से जुड़ी अन्य कार्रवाइयों की अपनी आवश्यकताएँ बनी रहती हैं।


== मुख्य मेनू का पता लगाएँ ==

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

{| class="wikitable"
! लौटाया गया मान !! अर्थ
|-
| <code>true, nil</code> || मुख्य मेनू की पुष्टि हुई है, जिसमें कैरेक्टर, दुनिया और सर्वर चयन शामिल हैं।
|-
| <code>false, nil</code> || गेम की किसी अन्य मूल स्थिति की पुष्टि हुई है।
|-
| <code>nil, reason</code> || स्थिति अज्ञात है, बदल रही है या प्रश्न उपलब्ध नहीं है।
|}

<code>true, nil</code> या <code>false, nil</code> के लिए <code>in_menu</code> को स्पष्ट रूप से जाँचें। <code>nil</code> पुष्टि की गई स्थिति नहीं है। अकेला <code>false</code> भी पढ़ने योग्य दुनिया की पुष्टि नहीं करता। आवश्यक कार्रवाई अलग से जाँचें, जैसे <code>runtime.has("runtime.ecs.read")</code>।


== कैरेक्टर का नाम पढ़ें ==

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

<code>name, nil</code> स्थानीय क्लाइंट के मुख्य मेनू में चुने गए कैरेक्टर का नाम UTF-8 स्ट्रिंग के रूप में लौटाता है। <code>Ikiju 育樹</code> जैसे Unicode अक्षर सुरक्षित रहते हैं। <code>nil, reason</code> का अर्थ है कि नाम अभी उपलब्ध नहीं है या पहुँच उपलब्ध अथवा अनुमत नहीं है।

मॉड अपना fallback नाम स्वयं चुनता है। API कोई डिफ़ॉल्ट नाम नहीं जोड़ती और Modloader की मैन्युअल नाम पसंद का उपयोग नहीं करती। यह मान किसी दूरस्थ खिलाड़ी की पहचान नहीं बताता और न ही SteamID या Steam पर दिखाई देने वाला नाम है। Dedicated Server में स्थानीय क्लाइंट कैरेक्टर नाम नहीं होता।


== साझा कैश ==

Lua और Modloader एक ही नेटिव कैश पढ़ते हैं। मौजूदा रनटाइम टिक मेनू स्थिति को रीफ़्रेश करता है। मौजूदा मेनू इंटीग्रेशन पहली उपलब्ध पसंद पर नाम दर्ज करता है और पसंद या नाम मेटाडेटा बदलने पर फिर दर्ज करता है। Lua प्रश्न अलग खोज शुरू नहीं करते और लॉग नहीं पढ़ते।

दुनिया में प्रवेश करने के बाद भी आखिरी सफलतापूर्वक दर्ज नाम कैश में रहता है। इसलिए कैश में नाम होना यह पुष्टि नहीं करता कि मेनू खुला है। <code>runtime.has("runtime.is_main_menu")</code> और <code>runtime.has("runtime.player.name")</code> हर प्रश्न की उपलब्धता बताते हैं। <code>runtime.status(...)</code> वजह भी देता है।


== <code>src/mod.lua</code> के लिए उदाहरण ==

यह उदाहरण लोड होने पर और उसके बाद हर 500 ms में कैश पढ़ता है। यह fallback नाम चुनता है और केवल बदलाव लॉग करता है:

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

Bonsaibauer: Importing a new version from external source