Back to Details

qbcore-framework

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

QBCore Framework Development

QBCore Framework开发

This skill provides guidelines and patterns for developing resources using the QBCore Framework.
本技能提供了使用QBCore Framework开发资源的指南和模式。

1. Core Object Retrieval

1. Core Object 获取

To interact with QBCore, you must retrieve the Core Object. Always cache this in a local variable at the top of your scripts.
Client & Server:
lua
local QBCore = exports['qb-core']:GetCoreObject()
要与QBCore进行交互，你必须获取Core Object。请始终在脚本顶部将其缓存到局部变量中。
客户端与服务器端通用：
lua
local QBCore = exports['qb-core']:GetCoreObject()

2. Key Concepts

2. 核心概念

Player Data (Server-side)

玩家数据（服务器端）

  • Identify players by Source temporarily, but use CitizenID for database persistence.
  • QBCore.Functions.GetPlayer(source): Returns the Player object with all data.
  • Player.PlayerData: Contains 
    job
    , 
    gang
    , 
    money
    , 
    items
    , 
    metadata
    , etc.
  • 临时使用Source标识玩家，但在数据库持久化时使用CitizenID。
  • QBCore.Functions.GetPlayer(source): 返回包含所有数据的Player对象。
  • Player.PlayerData: 包含
    job
    、
    gang
    、
    money
    、
    items
    、
    metadata
    等信息。

Callbacks (Server -> Client Data)

Callbacks（服务器→客户端数据）

  • Use QBCore.Functions.CreateCallback (Server) to send data to client.
  • Use QBCore.Functions.TriggerCallback (Client) to request data from server.
  • Rule: Never trust client data blindly in callbacks. Always validate on server.
  • 使用QBCore.Functions.CreateCallback（服务器端）向客户端发送数据。
  • 使用QBCore.Functions.TriggerCallback（客户端）从服务器请求数据。
  • 规则： 在回调中切勿盲目信任客户端数据，务必在服务器端进行验证。

Items

物品

  • Use QBCore.Functions.CreateUseableItem (Server) to register items.
  • Items are defined in 
    qb-core/shared/items.lua
    (or 
    qb-inventory
    ).
  • 使用QBCore.Functions.CreateUseableItem（服务器端）注册物品。
  • 物品定义在
    qb-core/shared/items.lua
    （或
    qb-inventory
    ）中。

Database

数据库

  • QBCore uses oxmysql by default.
  • Use 
    MySQL.query
    , 
    MySQL.insert
    , 
    MySQL.update
    , 
    MySQL.scalar
    .
  • QBCore默认使用oxmysql。
  • 使用
    MySQL.query
    、
    MySQL.insert
    、
    MySQL.update
    、
    MySQL.scalar
    方法。

3. Standard Resource Structure

3. 标准资源结构

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

4. Best Practices

4. 最佳实践

  1. Cache Core Object: Do not call 
    exports['qb-core']:GetCoreObject()
    inside loops.
  2. Use Callbacks for Data: Avoid 
    TriggerClientEvent
    for data retrieval if a callback is cleaner.
  3. Validate Inputs: Client can send any data. Verify job, money, and ownership on server.
  4. Optimized Loops: Use dynamic sleep (Wait) based on distance.
  5. Localization: Use 
    qb-core/shared/locale.lua
    or standard 
    Lang
    object if available.
  1. 缓存Core Object： 不要在循环内调用
    exports['qb-core']:GetCoreObject()
    。
  2. 使用回调获取数据： 如果回调方式更简洁，避免使用
    TriggerClientEvent
    进行数据检索。
  3. 验证输入： 客户端可能发送任意数据，需在服务器端验证职业、金钱和所有权。
  4. 优化循环： 根据距离使用动态休眠（Wait）。
  5. 本地化： 使用
    qb-core/shared/locale.lua
    或可用的标准
    Lang
    对象。

5. Documentation

5. 文档