qbcore-framework

QBCore フレームワークの開発

言語ルール： 内部の推論は簡潔な英語で行います。ユーザーに表示するメッセージと出力はすべて、ユーザーの言語で記述します。

このスキルでは、QBCore Framework を使用したリソース開発のガイドラインとパターンを説明します。

1. コアオブジェクトの取得

QBCore と連携するには、コアオブジェクトを取得する必要があります。スクリプトの先頭で、必ずローカル変数にキャッシュしてください。

クライアントとサーバー：

local QBCore = exports['qb-core']:GetCoreObject()

2. 主な概念

プレイヤーデータ（サーバー側）

• プレイヤーの識別には一時的に Source を使用し、データベースへの永続化には CitizenID を使用してください。
• QBCore.Functions.GetPlayer(source)：すべてのデータを含む Player オブジェクトを返します。
• Player.PlayerData：job、gang、money、items、metadata などが含まれます。

コールバック（サーバーからクライアントへのデータ送信）

• QBCore.Functions.CreateCallback（サーバー）を使用して、クライアントにデータを送信します。
• QBCore.Functions.TriggerCallback（クライアント）を使用して、サーバーにデータを要求します。
• ルール： コールバックでクライアントのデータを安易に信用しないでください。必ずサーバー側で検証してください。

アイテム

• QBCore.Functions.CreateUseableItem（サーバー）を使用して、アイテムを登録します。
• アイテムは qb-core/shared/items.lua（または qb-inventory）で定義します。

データベース

• QBCore はデフォルトで oxmysql を使用します。
• MySQL.query、MySQL.insert、MySQL.update、MySQL.scalar を使用します。

3. 標準的なリソース構成

my-resource/
├── fxmanifest.lua
├── config.lua
├── client/
│   └── main.lua
└── server/
    └── main.lua

4. ベストプラクティス

1. コアオブジェクトをキャッシュする： ループ内で exports['qb-core']:GetCoreObject() を呼び出さないでください。
2. データにはコールバックを使用する： コールバックのほうが適切な場合は、データ取得に TriggerClientEvent を使用しないでください。
3. 入力を検証する： クライアントは任意のデータを送信できます。サーバー側でジョブ、所持金、所有権を確認してください。
4. ループを最適化する： 距離に応じて動的に待機時間（Wait）を設定してください。
5. ローカライズ： 利用できる場合は、qb-core/shared/locale.lua または標準の Lang オブジェクトを使用してください。

5. ドキュメント

• 公式ドキュメント：https://docs.qbcore.org/
• Github：https://github.com/qbcore-framework/qb-core