サーバーエクスポート

作成ジョブ

指定されたジョブを追加または上書きする。

::警告 これは実行時のみの変更である。これは再起動しても持続せず、ファイルも変更しません。 :::

exports.qbx_core:CreateJob(jobName, job)

• ジョブ名string
• 仕事だ：table<Job>

リターンズ

• 成功した：boolean
• というメッセージを送った：string

求人情報作成

指定されたジョブを追加または上書きする。

::警告 これは実行時のみの変更である。これは再起動しても持続せず、ファイルも変更しません。 :::

exports.qbx_core:CreateJobs(jobs)

• 仕事だ：table<string, Job>

リターンズ

• 成功した：boolean
• というメッセージを送った：string

ジョブ削除

指定されたジョブを削除します。

::警告 これは実行時のみの変更である。これは再起動しても持続せず、ファイルも変更しません。 :::

exports.qbx_core:RemoveJob(jobName)

• ジョブ名string

リターンズ

• 成功した：boolean
• というメッセージを送った：'success' | 'invalid_job_name' | 'job_not_exists'

CreateGangs（クリエイト ギャングス

指定されたギャングを追加または上書きする。

::警告 これは実行時のみの変更である。これは再起動しても持続せず、ファイルも変更しません。 :::

exports.qbx_core:CreateGangs(gangs)

• ギャングだ：table<string, Gang>

暴力団排除

指定されたギャングを削除する。

::警告 これは実行時のみの変更である。これは再起動しても持続せず、ファイルも変更しません。 :::

exports.qbx_core:RemoveGang(gangName)

• gangName：string

リターンズ

• 成功した：boolean
• というメッセージを送った：'success' | 'invalid_gang_name' | 'gang_not_exists'

GetCoreVersion

の現在のバージョンを返す。qbx_coreをfxmanifestに設定する。

exports.qbx_core:GetCoreVersion(InvokingResource)

• InvokingResource：string

リターンズstring

エクスプロイト禁止

指定されたプレーヤーを指定された理由で禁止する。

exports.qbx_core:ExploitBan(playerId, origin)

• playerId：integer
• 原点だ：string

ゲッツソース

指定された識別子を持つプレーヤーのIDを返し、そのプレーヤーがサーバーにいない場合は0を返します。

exports.qbx_core:GetSource(identifier)

• 識別子string

リターンズinteger

GetUserId

与えられた識別子を持つプレーヤーのuserId、またはプレーヤーがサーバーにいない場合は0を返します。

exports.qbx_core:GetUserId(identifier)

• 識別子string

リターンズinteger

ゲットプレーヤー

与えられたプレーヤーIDまたは識別子のPlayerオブジェクトを返します。

exports.qbx_core:GetPlayer(source)

• ソースinteger

リターンズPlayer?

GetPlayerByCitizenId

与えられたcitizensidのPlayerオブジェクトを返します。

exports.qbx_core:GetPlayerByCitizenId(citizenid)

• 市民IDstring

リターンズPlayer?

GetPlayerByUserId

与えられた userId の Player オブジェクトを返します。

exports.qbx_core:GetPlayerByUserId(citizenid)

• userId：string

リターンズPlayer?

GetPlayerByPhone（ゲット・プレイヤー・バイ・フォン

与えられた電話番号のPlayerオブジェクトを返します。

exports.qbx_core:GetPlayerByPhone(number)

• という数字になる：string

リターンズPlayer?

GetQBPlayers

ログインしているプレイヤーのPlayerオブジェクトマップにプレイヤーIDを返します。

exports.qbx_core:GetQBPlayers()

リターンズtable<integer, Player>

選手データ

すべてのアクティブなプレーヤーのすべてのPlayerDataテーブルを返します。

exports.qbx_core:GetPlayersData()

リターンズPlayerData[]

SetPlayerData

特定のプレーヤーのPlayerDataキーを新しい値に設定する。

exports.qbx_core:SetPlayerData(identifier, key, value)

• 識別子source | citizenid
• キーだ：string
• 値である：any

選手データの更新

選手のPlayerDataを更新するトリガー。

exports.qbx_core:UpdatePlayerData(identifier)

• 識別子source | citizenid

GetMetadata

特定の選手のメタデータ値を取得します。

exports.qbx_core:GetMetadata(identifier, metadata)

• 識別子source | citizenid
• というメタデータがある：string

セットメタデータ

特定のプレーヤーのメタデータキーを新しい値に設定する。

exports.qbx_core:SetMetadata(identifier, metadata, value)

• 識別子source | citizenid
• というメタデータがある：string
• 値である：any

SetCharInfo

特定のプレーヤーのキャラクター情報を設定します。

exports.qbx_core:SetCharInfo(identifier, charInfo, value)

• 識別子source | citizenid
• charInfo：string
• 値である：any

GetDutyCountJob

指定されたジョブで当番であるプレーヤーの数と、そのIDのリストを返します。

exports.qbx_core:GetDutyCountJob(job)

• 仕事だ：string

リターンズ

• カウントする：integer
• の選手だ：integer[]

GetDutyCountType

指定された職種に就いているプレーヤーの数と、そのIDのリストを返します。

exports.qbx_core:GetDutyCountType(jobType)

• ジョブタイプstring

リターンズ

• カウントする：integer
• の選手だ：integer[]

GetBucketObjects

プレイヤーからバケツ、エンティティからバケツへのマップを返します。

exports.qbx_core:GetBucketObjects()

リターンズ

• プレイヤーバケットtable<integer, integer>
• エンティティバケット：table<integer, integer>

セットプレーヤーバケット

指定された選手を指定されたバケツにセットします。
リターンfalseパラメータの1つがnilの場合はtrueそうでなければ

exports.qbx_core:SetPlayerBucket(source, bucket)

• ソースinteger
• バケツinteger

リターンズboolean

セット・エンティティ・バケット

指定されたバケツに、指定されたエンティティ（例：ペッド、ビークル、プロップなど）をセットする。
リターンfalseパラメータの1つがnilの場合はtrueそうでなければ

exports.qbx_core:SetEntityBucket(entity, bucket)

• 実体を持つ：integer
• バケツinteger

リターンズboolean

GetPlayersInバケット

与えられたバケツ内の全選手のリストを返す。false既知の選手バケットがない場合。

exports.qbx_core:GetPlayersInBucket(bucket)

• バケツinteger

リターンズinteger[] | false

GetEntitiesInBucket

与えられたバケツ内のすべてのエンティティのリストを返す。false既知のエンティティバケットがない場合。

exports.qbx_core:GetEntitiesInBucket(bucket)

• バケツinteger

リターンズinteger[] | false

使用可能アイテムの作成

与えられたアイテムが使われたときに実行されるように、与えられた関数を登録する。

exports.qbx_core:CreateUseableItem(item, data)

• アイテム：string
• のデータがある：fun(source: integer, item: unknown)

アイテムの使用

与えられた項目が使われたときに実行されるデータセットを返す。nilもし存在しなければ

exports.qbx_core:CanUseItem(item)

• アイテム：string

リターンズunknown

ホワイトリスト入り

指定された選手がホワイトリストに登録されているかどうかを返します。

exports.qbx_core:IsWhitelisted(source)

• ソースinteger

リターンズboolean

~~パーミッションの追加

::警告 v1.8.0で非推奨。代わりに ox_lib ACE パーミッションを使ってください。 :::

指定されたパーミッションを指定されたプレーヤーに追加します。

exports.qbx_core:AddPermission(source, permission)

• ソースinteger
• を許可した：string

~~パーミッションの削除

::警告 v1.8.0で非推奨。代わりに ox_lib ACE パーミッションを使ってください。 :::

指定された権限を指定されたプレーヤーから削除します。

exports.qbx_core:RemovePermission(source, permission)

• ソースinteger
• を許可した：string

~~許可がある

::警告 v1.8.0で非推奨。代わりにACEパーミッションを使用してください。 :::

指定されたプレーヤーが指定されたパーミッションを持っているかどうかを返します。

exports.qbx_core:HasPermission(source, permission)

• ソースinteger
• を許可した：string

リターンズboolean

~~許可を得る

::警告 v1.8.0で非推奨。代わりにACEパーミッションを使用してください。 :::

指定されたプレーヤーのパーミッションを取得します。

exports.qbx_core:GetPermission(source)

• ソースinteger

リターンズtable<string, boolean>

イズオプチン

指定されたプレーヤーが管理者レポートにオプトインしているかどうかを返します。

exports.qbx_core:IsOptin(source)

• ソースinteger

リターンズboolean

トグルオプチン

指定されたプレーヤーをアドミンレポートに出入りさせる。

exports.qbx_core:ToggleOptin(source)

• ソースinteger

IsPlayerBanned

指定されたプレーヤーが禁止されているかどうかと、プレーヤーに表示されるメッセージを返します。

exports.qbx_core:IsPlayerBanned(source)

• ソースinteger

リターンズ

• 禁止されている：boolean
• playerMessage：string
  • 選手に見せるために書かれたメッセージ。

通知

指定されたプレーヤーのテキストボックスのポップアップで、指定された時間が経過すると消えます。

exports.qbx_core:Notify(source, text, notifyType, duration, subTitle, notifyPosition, notifyStyle, notifyIcon, notifyIconColor)

• ソースinteger
• テキストtable | string
  • 通知文。
  • 文字列、またはテーブル：
    • テキスト？string
    • キャプションは？string
• notifyType？'inform' | 'error' | 'success' | 'warning'
  • デフォルト：'inform'
• 期間？integer
  • 通知が画面に表示され続ける時間をミリ秒単位で指定します。
  • デフォルト：5000
• subTitle?string
  • タイトルの下に追加テキスト。
• notifyPosition?'top' | 'top-right' | 'top-left' | 'bottom' | 'bottom-right' | 'bottom-left' | 'center-right' | 'center-left'
  • デフォルト：top-right(コンフィグで変更可能）
• notifyStyle？table
  • カスタムスタイリング。参照lib.notify.
• notifyIcon？string
  • Font Awesome 6 アイコン名。
• notifyIconColor？string
  • カスタムカラーnotifyIcon.

ログイン

既存のキャラクターにログインするか、新しいキャラクターを作成し、それが成功したかどうかを返す。
これは、所有するプレーヤーがオンラインである場合に、キャラクターを作成するための好ましい機能である。

exports.qbx_core:Login(source, citizenid, newData)

• ソースinteger
• citizensid？string
• newData?PlayerEntity

リターンズboolean

ゲットオフラインプレーヤー

与えられたcitizensidを使用してプレイヤーオブジェクトを取得し、それを返します。nil何も見つからなければ

exports.qbx_core:GetOfflinePlayer(citizenid)

• 市民IDstring

リターンズPlayer?

ログアウト

指定されたプレイヤーを現在のキャラクターからログアウトします。

exports.qbx_core:Logout(source)

• ソースinteger

プレイヤー作成

新しい文字を作成し、データベースに保存します。

exports.qbx_core:CreatePlayer(playerData, offline)

• playerData：PlayerData
• オフラインでboolean

リターンズPlayer

セーブ

指定された選手の情報をデータベースに保存する。

exports.qbx_core:Save(source)

• ソースinteger

セーブオフライン

与えられたPlayerDataをデータベースに保存する。

exports.qbx_core:SaveOffline(playerData)

• playerData：PlayerEntity

削除文字

与えられたcitizensidによって永久に文字を削除する。

::警告 このアクションは元に戻せない。 :::

exports.qbx_core:DeleteCharacter(citizenid)

• 市民IDstring

固有識別子の生成

選手識別子の一意な値を返します。

exports.qbx_core:GenerateUniqueIdentifier(type)

• タイプだ：'citizenid' | 'AccountNumber' | 'PhoneNumber' | 'FingerId' | 'WalletId' | 'SerialNumber'

リターンズstring | number

アップサートジョブデータ

指定されたジョブのフィールドを一時的に挿入または上書きします。

::警告 これは実行時のみの変更である。これは再起動しても持続せず、ファイルも変更しません。 :::

exports.qbx_core:UpsertJobData(jobName, data)

• ジョブ名string
• のデータがある：JobData

アップサートギャングデータ

与えられたギャングのフィールドを一時的に挿入または上書きする。

::警告 これは実行時のみの変更である。これは再起動しても持続せず、ファイルも変更しません。 :::

exports.qbx_core:UpsertGangData(gangName, data)

• gangName：string
• のデータがある：GangData

アップサートジョブグレード

指定されたジョブのグレードのフィールドを一時的に挿入または上書きします。

::警告 これは実行時のみの変更である。これは再起動しても持続せず、ファイルも変更しません。 :::

exports.qbx_core:UpsertJobGrade(jobName, grade, data)

• ジョブ名string
• のグレードである：integer
• のデータがある：JobGradeData

アップサート・ガングレード

指定されたギャングのグレードのフィールドを一時的に挿入または上書きします。

::警告 これは実行時のみの変更である。これは再起動しても持続せず、ファイルも変更しません。 :::

exports.qbx_core:UpsertGangGrade(gangName, grade, data)

• gangName：string
• のグレードである：integer
• のデータがある：GangGradeData

ジョブグレードの削除

指定されたジョブのグレードを一時的に削除します。

::警告 これは実行時のみの変更である。これは再起動しても持続せず、ファイルも変更しません。 :::

exports.qbx_core:RemoveJobGrade(jobName, grade)

• ジョブ名string
• のグレードである：integer

ギャンググレードの削除

指定されたギャングのグレードを一時的に削除する。

::警告 これは実行時のみの変更である。これは再起動しても持続せず、ファイルも変更しません。 :::

exports.qbx_core:RemoveGangGrade(gangName, grade)

• gangName：string
• のグレードである：integer

セットジョブ

現在のプライマリジョブを新しいジョブで上書きする。プレーヤーを現在のプライマリジョブから外す。

exports.qbx_core:SetJob(identifier, jobName, grade)

• 識別子source | citizenid
• ジョブ名string
• のグレードである：integer

セットジョブデューティ

選手の勤務状態を設定する。

exports.qbx_core:SetJobDuty(identifier, onDuty)

• 識別子source | citizenid
• 勤務中：boolean

セットプレーヤープライマリジョブ

指定されたプレーヤーの主な仕事を、すでに持っている場合にのみ、指定された仕事に設定します。

exports.qbx_core:SetPlayerPrimaryJob(citizenid, jobName)

• 市民IDstring
• ジョブ名string

AddPlayerToJob

指定されたプレーヤーを指定された仕事に追加するか、すでにその仕事に就いている場合はその成績を上書きします。

exports.qbx_core:AddPlayerToJob(citizenid, jobName, grade)

• 市民IDstring
• ジョブ名string
• のグレードである：integer

ジョブから選手を削除する

指定されたプレーヤーを指定されたジョブから削除します。 また、指定されたジョブがプレーヤーのプライマリ・ジョブである場合は、指定されたプレーヤーのプライマリ・ジョブをunemployedに更新します。

exports.qbx_core:RemovePlayerFromJob(citizenid, jobName)

• 市民IDstring
• ジョブ名string

セットギャング

現在のプライマリーギャングを新しいジョブで上書きする。プレイヤーを現在のプライマリーギャングから外す。

exports.qbx_core:SetGang(identifier, gangName, grade)

• 識別子source | citizenid
• gangName：string
• のグレードである：integer

SetPlayerPrimaryGang

指定されたプレイヤーの主ギャングを、すでに持っている場合に限り、指定されたギャングに設定する。

exports.qbx_core:SetPlayerPrimaryGang(citizenid, gangName)

• 市民IDstring
• gangName：string

AddPlayerToGang

指定されたプレーヤーを指定されたギャングに追加するか、すでにそのギャングにいる場合はその評点を上書きする。

exports.qbx_core:AddPlayerToGang(citizenid, gangName, grade)

• 市民IDstring
• gangName：string
• のグレードである：integer

暴力団から選手を排除する

指定されたプレーヤーを指定されたギャングから削除します。 また、指定されたギャングがプレーヤーのプライマリギャングである場合、指定されたプレーヤーのプライマリギャングをギャングなしに更新する。

exports.qbx_core:RemovePlayerFromGang(citizenid, gangName)

• 市民IDstring
• gangName：string

ハス・プライマリー・グループ

与えられたプレーヤーの現在のJob/Gangまたはcitizenidが、単一のグループ、グループの配列、またはグループ/グレード、またはcitizenidのリストと一致するかどうかをチェックします。プレーヤーが勤務中か非勤務中かはチェックしません。

exports.qbx_core:HasPrimaryGroup(source, filter)

• ソースinteger
• フィルターにかける：stringまたはstring[]またはtable<string, number>
  • チェックをパスするために必要なグループ/シチズンID、グループ/シチズンIDの配列、またはグループとグレードのペア。

リターンズ

• 成功した：boolean

ハスグループ

与えられたプレーヤーのグループ(Jobs/Gangs)またはcitizenidのリストが、単一のグループ、グループの配列、グループ/グレード、またはcitizenidのリストと一致するかどうかをチェックします。特定のフィルタに対して、プレーヤーが勤務中か非勤務中かはチェックしません。

exports.qbx_core:HasGroup(source, filter)

• ソースinteger
• フィルターにかける：stringまたはstring[]またはtable<string, number>
  • チェックをパスするために必要なグループ/シチズンID、グループ/シチズンIDの配列、またはグループとグレードのペア。

リターンズ

• 成功した：boolean

GetGroups

指定された選手が現在持っているすべてのグループを結合した表を返します。

exports.qbx_core:GetGroups(source)

• ソースinteger

リターンズ

• table<string, number>

IsGradeBoss

与えられたグループと等級の組み合わせがボス等級であるかどうかをブール値で返します。現在のところ、これはisboss成績定義で真である

exports.qbx_core:IsGradeBoss(group, grade)

• グループである：string
• のグレードである：integer

リターンズ

• 成功した：boolean

GetGroupMembers

指定されたグループとタイプのすべてのシチズンIDと関連するグレードのテーブルを返します。

exports.qbx_core:GetGroupMembers(group, type)

• グループである：string
• タイプだ：job | gang

リターンズ

• table<citizenid, number>

車両削除

ゲームの世界から車両のエンティティを削除します。DeleteVehicleは、車両から永続性を削除して削除できるようにするので、ネイティブのDeleteEntity関数よりも好ましい。

exports.qbx_core:DeleteVehicle(entity)

• 実体を持つ：number

パーシステンスを有効にする

サーバーによって削除された場合、同じプロパティで車両をリスポーンします。べき乗。

exports.qbx_core:EnablePersistence(entity)

• 実体を持つ：number

パーシステンスを無効にする

乗り物から永続属性を削除し、リスポーンせずに削除できるようにする。べき等。車両がまだ永続化されていない場合は、何もしない。

exports.qbx_core:DisablePersistence(entity)

• 実体を持つ：number

GetVehicleClass

に相当する。GetVehicleClass クライアントネイティブだが、サーバー用。ランダムにクライアントに全車両モデルとそのクラスを問い合わせ、サーバーがオンラインである間これをキャッシュすることで動作します。 このため、クエリーを実行するクライアントがいない場合は動作しないことがあります。

exports.qbx_core:GetVehicleClass(hash)

• ハッシュnumber

サーチプレーヤー

オンラインとオフラインの両方のプレーヤーを一連のフィルターで検索し、すべてのフィルター値に一致するプレーヤーを返します。

フィルター

• license?：ライセンス文字列。
• job?
• ギャング？
• メタデータ？table<string, number|string|boolean>
  • 厳しい？booleanもしtrueなら、メタデータの数値は完全に等価である場合にマッチし、そうでなければ、数値がfilterより大きいか等しい場合にマッチする。

exports.qbx_core:SearchPlayers(filters)

• フィルターがある：table<string, any>

リターンズ

• Player[]

使用例

ネストされたメタデータ・キーの値の検索

local licensedDrivers = exports.qbx_core:SearchPlayers({
  metadata = {
    ['licences.driver'] = true
  }
})

セッションIDの作成

エンティティの sessionId ステートバッグを一意の番号に設定します。 SessionIdsは、エンティティが削除されたり再作成されたりする可能性があるが、車両の永続化など安定した識別子が必要な場合に便利です。

exports.qbx_core:CreateSessionId(entity)

• 実体を持つ：integer

リターンズ

• sessionId：integer

ゲットマネー

選手の特定のマネータイプを取得します。

exports.qbx_core:GetMoney(identifier, moneyType)

• 識別子source | citizenid
• moneyType：'cash' | 'bank' | 'crypto'

リターンズ

• の量だ：number無効なマネー・タイプまたはプレーヤーが見つからない場合は偽

アドマネー

特定のマネータイプをプレーヤーに追加する。

exports.qbx_core:AddMoney(identifier, moneyType, amount, reason)

• 識別子source | citizenid
• moneyType：'cash' | 'bank' | 'crypto'
• の量だ：number
• 理由は？string

リターンズ

• 成功した：boolean

お金を取り除く

プレーヤーから特定のマネータイプを削除します。

exports.qbx_core:RemoveMoney(identifier, moneyType, amount, reason)

• 識別子source | citizenid
• moneyType：'cash' | 'bank' | 'crypto'
• の量だ：number
• 理由は？string

リターンズ

• 成功した：boolean

セットマネー

選手の特定のマネータイプを設定します。

exports.qbx_core:SetMoney(identifier, moneyType, amount, reason)

• 識別子source | citizenid
• moneyType：'cash' | 'bank' | 'crypto'
• の量だ：number
• 理由は？string

リターンズ

• 成功した：boolean