Pulse Phone のドキュメント
Pulse Phone 開発者 API
Pulse Phone は、ほかのリソース向けにサーバーとクライアントの API を提供します。プレイヤーの番号の取得、テキスト、メール、通知の送信、通話の発信、スマホで起きたことへの反応、そして独自アプリの追加ができます。このページの内容はすべて Pulse Phone 1.5.0 の phone リソースに基づいています。引数を含む完全な一覧はExports とイベントにあります。
API の場所
リソース名は phone なので、呼び出しはすべて exports.phone:... になります。使う前にスマホの準備完了を待ってください。IsReady() は、データベースが応答し、スマホがリクエストを受け付けられるようになると true になります。
CreateThread(function()
while GetResourceState('phone') ~= 'started' or not exports.phone:IsReady() do Wait(500) end
print('Pulse Phone is ready')
end)サーバーコンソールで phone_api を実行すると、アプリ API の簡単な概要が表示されます。
よく使うサーバー exports
| Export | 内容 |
|---|---|
GetPhoneNumber(src) |
プレイヤーが持っているスマホの番号。読み込みが終わるまでは nil |
SourceOfNumber(number) |
その番号を持つオンラインのプレイヤー。いなければ nil |
Notify(src, { title, body, app?, actions? }) |
そのプレイヤーのスマホへの通知(ボタンは最大3つ) |
SendMessage(src, number, text) |
そのプレイヤーから番号宛てのテキスト |
SendMail(address, sender, subject, body) |
アドレス宛てのメール |
Call(src, number, video?) |
そのプレイヤーとして通話を発信する |
SetPhoneDisabled(src, bool) |
プレイヤーのスマホの電源をオフ/オンにする(刑務所、カットシーンなど) |
RecordTransaction(number, 'sent' or 'received', amount, party, note?) |
ウォレットの明細行。お金は動きません |
ほかのスマホ向けに書かれたスクリプトは、そのスマホの exports の代わりに次を呼び出します:
| Export | 内容 |
|---|---|
ResolvePhone(target[, cb]) |
{ source }、{ number }、{ email }、{ identifier }、{ imei } のいずれかでスマホを探す |
DeliverMailTo(target, mail[, cb]) |
そのスマホへのメール:{ sender, subject, body } |
SendText(from, to, body[, opts][, cb]) |
スマホ、または名前を付けたサービスからのテキスト |
DispatchAlert(jobs, { title, body, coords? }) |
それらのジョブの勤務中のメンバー全員への通知。届いた人数を返す |
例:強盗スクリプトが、マップのピン付きで警察に通知する。
local reached = exports.phone:DispatchAlert({ 'police', 'sheriff' }, {
title = 'Store robbery',
body = 'Alarm at the 24/7 on Innocence Blvd.',
coords = vector3(25.7, -1345.6, 29.5),
})サーバーイベント
サーバースクリプトで AddEventHandler を使って受け取ります。発生させるのはスマホだけで、クライアントが偽造することはできません。
| イベント | 引数 |
|---|---|
phone:numberChanged |
src, number, oldNumber |
phone:callStarted |
callId, fromNumber, toNumber, fromSrc, toSrc, video |
phone:callEnded |
fromNumber, toNumber, reason, durationMs, fromSrc, toSrc, callId |
phone:messageSent |
fromNumber, toNumber, body |
phone:emergencyCall |
src, service, reason, coords |
phone:wallet:transfer |
fromNumber, toNumber, amount, note |
phone:notification:action |
src, app, notificationId, actionId:Notify が表示したボタンが押された |
クライアント exports
| Export | 内容 |
|---|---|
Open(), Close(), IsOpen() |
スマホを開閉する。Open は以下のブロックをすべて尊重する |
AddOpenCheck(fn) |
fn() が false を返すとスマホが開かなくなる。リソースが停止すると削除される |
SetRestriction(key, mode) |
独自のプレイヤー状態:'block'、'emergency-only'、またはクリアする場合は nil |
SetCarAudio(state) |
車の画面である Pulse Drive に、自分のカーステレオを表示する |
GetPhoneNumber(), IsInCall(), GetBattery() |
このプレイヤー自身のスマホ |
例:プレイヤーが刑務所にいる間はスマホを使えなくする。
exports.phone:SetRestriction('myjail', 'block') -- on entering the cell
exports.phone:SetRestriction('myjail', nil) -- on releaseState bag
サーバーは、ほかのスマホ用リソースと同じ名前でこれらを Player(src).state に書き込むため、HUD やディスパッチのスクリプトはそのまま読み取れます:phoneNumber、phoneOpen、inCall、onCallWith、phoneBattery、phoneDead。クライアントは自分の分を LocalPlayer.state.phoneOpen として読み取ります。
config の例
スマホの設定は phone/config/ にあります。ほかのスクリプトが依存するものを3つ挙げます:
Config.Item = {
required = false, -- true: the player needs the phone item
name = 'phone',
}
Config.Public = {
numberState = true, -- publish Player(src).state.phoneNumber
}
Config.Open = {
blockWhenNuiFocused = true, -- no phone while another menu holds the cursor
}独自のアプリ
exports.phone:RegisterApp({ id, name, colour, icon, page = { kind = 'frame', url = 'ui/index.html' } }) で、ホーム画面と App Hub にアプリを追加します。ページは専用のフレーム内で動き、スマホ経由でサーバーとやり取りします。権限、通知、言語、App Hub への掲載は任意の項目です。詳しい手順はカスタムアプリにあります。
連携のメモ
- Pulse Phone は lb-phone、qb-phone、NPWD のイベント名に自分で応答するため、その方法でメール、テキスト、通知を送るスクリプトはそのまま動きます。ほかのスマホの exports を呼び出すスクリプトは、
exports.phoneに1か所変更する必要があります。詳しくはスマホの乗り換えをご覧ください。 - 自分のサーバーイベントから、本物の
sourceを渡してください。クライアントのメッセージからプレイヤー ID を取得してはいけません。 - 銀行、ガレージ、住居、ディスパッチは、起動時に選ばれるスマホのブリッジ経由で接続されます。自作スクリプトをプロバイダーとして追加することもできます:高度な連携。
よくある質問
Pulse Phone のリソース名は何ですか?
phone です。すべての export は exports.phone:Name(...) の形です。ほかのスクリプトやインベントリのアイテムフックがこの名前で呼び出すため、フォルダー名は変えないでください。
lb-phone や qb-phone 向けに作られたスクリプトは Pulse Phone で動きますか?
それらのスマホのイベント(メール、テキスト、通知、電話番号)を使うスクリプトは、編集なしで動きます。それらの exports を呼び出すスクリプトは、代わりに exports.phone を使う必要があります。
Pulse Phone に独自のアプリを追加できますか?
はい。リソースから RegisterApp で登録します。App Hub に表示されます。ページ、権限、通知については、ガイドで説明しています。