----------------------------------------------------------------
-- 星々の幻境
-- 開発向けLuaスクリプト補完用スタブ
-- 
-- バージョン: 1.0.0
-- 作成日: 2026.10.17
-- 作成者: Chloe
----------------------------------------------------------------

概要
　本ファイルは「星々の幻境」の Lua API を、Lua Language Server（LuaLS）で利用するためのスタブファイルです。

　星々の幻境が提供する Script API、Game API、UI API、Enum、ライフサイクルイベントなどを型定義として提供し、
　VSCode 等のエディタで「コード補完」「型チェック」「関数説明の表示」などの機能を利用できるようにします。


対応範囲
　Ver7.1 で提供されている Lua API


注意事項
　本ファイルは補完専用です
　　本スタブは LuaLS 向けの型定義ファイルです。

　　ゲーム実行時の処理は含まれていません。

　　function script:GetParam(paramName) end

　　のような定義は補完のための宣言であり、実際の処理は星々の幻境側が提供します。

　　そのため、本スタブを星々の幻境のクライアントスクリプトへマッピングしたり、
　　実行用スクリプトとして使用したりしないでください。

　API仕様との相違について
　　本スタブは公開されているドキュメントをもとに作成されています。

　　ゲームのアップデートにより API の追加・変更・削除が行われた場合、
　　本スタブの内容が実際の実装と一致しなくなる可能性があります。

　型情報について
　　ドキュメント上で型が明示されていない項目については、LuaLS で利用しやすいよう推定型を使用している場合があります。

　　そのため、実際のランタイム挙動と完全に一致することを保証するものではありません。

　補完精度について
　　一部のAPIは実行時に派生クラス(ClientUIImageControl、ClientUITextBoxControl等)を返却しますが、
　　LuaLSは返却型を自動判定できません。
　　※対象APIは、【★】が頭についています。

　　そのため、必要に応じて呼出側で型を指定してください。
　　(例)
　　local image = game.InstantiateClientUIControl(...)

    ---@cast image ClientUIImageControl

　不具合について
　　本スタブは個人で作成・保守している非公式の補完支援ツールです。

　　可能な限り公式ドキュメントに沿って作成していますが、定義漏れや型の誤り、コメントの誤記などが含まれている可能性があります。

　　不具合や不足しているAPIを発見した場合は、作成者までご連絡いただけると幸いです。


免責事項
　本スタブは非公式の補完支援ツールです。

　本スタブの利用によって発生した問題について、作成者は責任を負いません。