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 と同じネイティブデータを使用し、ワールドへのアクセスは必要ありません。


== 前提条件 ==

Mod を有効にし、<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> は Mod のランタイムが起動したことを示しますが、ワールドへの参加は確認しません。どちらのクエリにも実行プロファイルは必要ありません。ワールドを操作するその他の機能には、それぞれ別の要件があります。


== メインメニューを検出する ==

<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>in_menu == true</code> または <code>in_menu == false</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> は、名前がまだ取得できない、またはアクセスできない、許可されていないことを示します。

フォールバック名は Mod が独自に選びます。API はデフォルト名を挿入せず、Modloader の手動選択名も使用しません。この値はリモートプレイヤーを識別するものではなく、SteamID や Steam の表示名でもありません。Dedicated Server にはローカルクライアントのキャラクター名はありません。


== 共有キャッシュ ==

Lua と Modloader は同じネイティブキャッシュを読み取ります。既存のランタイム tick がメニュー状態を更新します。既存のメニュー連携は、最初に選択可能になったときと、選択または名前のメタデータが変化したときに名前を取得します。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 ごとにキャッシュを読み取ります。フォールバック名を選び、変更があった場合だけログに記録します。

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

Bonsaibauer: Importing a new version from external source