オックスプレーヤー

• charId：number
• 識別子string
• ペダルnumber
• ソースnumber
• stateId：string
• userId：number
• ユーザー名string

OxPlayer.addLicense

選手にライセンスを与える。

player.addLicense(licenseName)

パラメータ

• ライセンス名string

リターン

• boolean

OxPlayer.addStatus

ステータスの値を増加させる。

player.addStatus(statusName, value)

パラメータ

• statusName：string
• 値である：number

リターン

• boolean

OxPlayer.createCharacter

まだキャラクターを選択していないプレイヤーに新しいキャラクターを登録する。

player.createCharacter(data)

パラメータ

• のデータがある：object
  • firstName：string
  • ラストネームstring
  • 性別string
  • 日付が変わった：number

リターン

• number
  • プレイヤーが所有するすべてのキャラクタの配列における、新しいキャラクタのインデックス。

OxPlayer.deleteCharacter

指定された charId を持つキャラクターを削除します。

player.deleteCharacter(charId)

パラメータ

• charId：number

リターン

• boolean

OxPlayer.emit

プレーヤーのクライアントイベントをトリガーします。

player.emit(eventName, ...args)

パラメータ

• イベント名string
• …args：any

OxPlayer.get

プレーヤーのメタデータから特定のキーの値を取得します。

player.get(key)

パラメータ

• キーだ：string

リターン

• unknown

OxPlayer.getAccount

プレーヤーのデフォルトのOxAccountオブジェクトを返します。

player.getAccount()

リターン

• OxAccount

OxPlayer.getCoords

プレーヤーの現在の座標を返します。

player.getCoords()

リターン

• vector3

OxPlayer.getGroup

指定されたグループ名の選手の成績、またはフィルターで最初にマッチした名前と成績を返します。

player.getGroup(filter)

パラメータ

• フィルターにかける：string|string[]|{ [string]: number }

リターン

• number|string
• number?

OxPlayer.getGroupByType

型が一致するグループの選手名と成績を返します。

player.getGroupByType(type)

パラメータ

• タイプだ：string

リターン

• string?
• number?

OxPlayer.getGroups

グループ名をキーとして、プレーヤーが現在所属しているすべてのグループのオブジェクトを返します。

player.getGroups()

リターン

• { [string]: number }

OxPlayer.getLicense

指定したライセンスの情報を含むオブジェクトを返します。

player.getLicense(licenseName: string): object

パラメータ

• ライセンス名string

リターン

• object
  • issued: number
  • suspended?: [number, number]
  • [key: string]: any

OxPlayer.getLicenses

すべてのライセンスの情報を含むオブジェクトを返します。

player.getLicenses()

リターン

• object
  • { [string]: object }
    • issued: number
    • suspended?: [number, number]
    • [key: string]: any

OxPlayer.getStatus

ステータスの値を返す。

player.getStatus(statusName)

パラメータ

• statusName：string

リターン

• 値である：number

OxPlayer.getStatuses

ステータス名をキーとして、すべてのステータスを含むオブジェクトを返します。

player.getStatuses()

リターン

• { [string]: number }

OxPlayer.hasPermission

ユーザがグループの1つからパーミッションを付与されているかどうかをチェックする。

player.hasPermission(permission)

パラメータ

• を許可した：string

リターン

• boolean

例

-- Adding a permission to a group
Ox.SetGroupPermission('police', 1, 'handcuff', 'allow')
 
-- Checking if a player has the 'handcuff' permission
if player.hasPermission('group.police.handcuff') then
    -- Do something
end

OxPlayer.logout

アクティブなキャラクターのデータをクリアし、有効な場合はキャラクター選択に移行します。

player.logout(save, dropped)

パラメータ

• 節約？boolean
  • 有効文字データをデータベースに保存する場合、デフォルトはtrue.
• を落としたのか？boolean
  • プレイヤーがサーバーから切断された場合。

OxPlayer.payInvoice

指定された invoiceId を持つ口座請求書を支払います。

player.payInvoice(invoiceId)

パラメータ

• invoiceId：number

リターン

• object
  • 成功した：boolean
  • メッセージは？"no_charId"|"no_permission"|"no_balance"|"no_invoice"|"invoice_paid"|"insufficient_balance"

OxPlayer.removeLicense

選手からライセンスを剥奪する。

player.removeLicense(licenseName)

パラメータ

• ライセンス名string

リターン

• boolean

OxPlayer.removeStatus

ステータスの価値を下げる。

player.removeStatus(statusName, value)

パラメータ

• statusName：string
• 値である：number

リターン

• boolean

OxPlayer.save

アクティブな文字をデータベースに保存する。

player.save()

OxPlayer.set

プレーヤーのメタデータに値を保存し、オプションでクライアントと同期させることができます。

player.set(key, value, replicated)

パラメータ

• キーだ：string
• 値である：any
• 複製？boolean

OxPlayer.setActiveCharacter

プレイヤーのアクティブなキャラクターとしてキャラクターをロードして設定します。charIdまたは新しいキャラクターデータを含むオブジェクトを受け取ります。

player.setActiveCharacter(data)

パラメータ

• のデータがある：number|object
  • firstName：string
  • ラストネームstring
  • 性別string
  • 日付が変わった：number

リターン

• object
  • charId：number
  • stateId：string
  • firstName：string
  • ラストネームstring
  • x?:number
  • y?:number
  • z?:number
  • ヘディング？number
  • lastPlayed?string
  • 健康？number
  • アーマー？number
  • isNew?boolean

OxPlayer.setActiveGroup

プレーヤーが所属しているグループをアクティブまたは「プライマリ」グループとして設定します。引数が渡されない場合、アクティブなグループは設定されません。

player.setActiveGroup(groupName?: string, temporary?: boolean)

パラメータ

• グループ名：string
• 一時的な？boolean
  • もしtrueセッション中も持続しない。

リターン

• boolean

OxPlayer.setGroup

グループ内のプレーヤーのグレードを設定します。グレードが未定義または0の場合、グループから除外されます。

player.setGroup(groupName, grade)

パラメータ

• グループ名：string
• グレード？number

リターン

• boolean

OxPlayer.setStatus

ステータスの値を設定する。

player.setStatus(statusName, value)

パラメータ

• statusName：string
• 値である：number

リターン

• boolean

OxPlayer.updateLicense

選手ライセンスの情報を設定します。

player.updateLicense(licenseName, key, value)

パラメータ

• ライセンス名string
• キーだ：string
• 値である：unknown

リターン

• boolean