lua-basics

Lua の基本

FiveM 向けの、慣用的でパフォーマンスに優れた Lua のパターン：関数、テーブル、変数、条件分岐、エラー。

有効化の条件

FiveM リソースで Lua を記述またはレビューするとき、あるいはユーザーが Lua の命名規則、構成、パフォーマンス、テーブル、エラー処理について質問したときに、このスキルを読み込みます。

厳守ルール

• 命名規則：定数は ALL_CAPS、ローカル変数は camelCase、グローバル変数は PascalCase、未使用の変数には _ を使用します。
• local を優先します。ローカル変数は初めて使う箇所のできるだけ近くで宣言し、ファイルレベルのグローバル変数は単一のクライアント／サーバーファイルの先頭にまとめます。
• table.insert は使用しません。t[#t + 1] = v で追加するか、独自のサイズカウンターを管理します。
• 配列は数値インデックスの for i = 1, #t で反復処理します。インデックスを明示せず、暗黙の配列インデックス（{ a, b }）を使用します。
• テーブルの参照を繰り返す場合はローカル変数に取り出します。固定キーには t.key、動的キーには t[var] を使用します。
• ガード節と早期リターンを使用します。if x then return true else return false end は決して記述しません。
• 肯定形のブール式を優先します。デフォルト値は value = value or default で設定します。
• 前提条件の検証には if not x then error() end ではなく assert を使用します。予期しない状態では明確に失敗させ、想定される失敗は値としてエラーを返します。
• パラメーターの数を抑え、API ではブール値のパラメーターを避けます（列挙型を使用します）。インライン関数ではなく、名前付きのローカル関数を渡します。
• 関数は小さく保ち、抽象度を統一し、エクスポートを文書化します。

判断基準

状況	パターン
想定される失敗（見つからない、入力が無効）	nil, err または false を返す
プログラマーのミス／不可能な状態	assert ／ error
2 つを超える意味を持つフラグ	ブール値ではなく列挙型のテーブル
引数として複数回使用する関数	local function を定義してから、名前で渡す
配列への追加	t[#t + 1] = v

実行手順

1. すべての識別子に命名規則とスコープのルールを適用します。
2. ネストされた if をガード節に置き換えます。
3. table.insert と、配列に対する pairs をインデックスへの代入と数値ループに置き換えます。
4. 関数の先頭に assert による前提条件の検証を追加します。
5. 関数の規模を見直します。高レベルと低レベルのコードが混在する関数は分割します。

出力の条件

上記の命名、ローカル変数、テーブル、エラー処理のルールに従った Lua を返します。意図的にルールから逸脱する場合は、その旨を注記します。

参考資料

• rules/functions.md — 関数の規模、命名、パラメーター、エクスポート、ガード節。
• rules/tables.md — インデックス、参照、table.insert、反復処理、サイズ。
• rules/variables.md — 命名、ブール値と列挙型の使い分け、宣言位置。
• rules/conditionals.md — デフォルト値、ブール式、読みやすさ。
• rules/errors.md — assert、前提条件、値としてのエラー、明確な失敗。
• rules/reference-links.md — Lua と FiveM の公式ドキュメント。

上流のドキュメント：https://www.lua.org/manual/5.4/