Type alias PlayerScriptSendablePlayer

PlayerScriptSendable: ExtJSON<PlayerScriptSendablePrims>

PlayerScript.sendToで送信可能な型です。

具体的には、以下の値がPlayerScriptSendableです。

特に、PlayerScriptSendableは undefined を含みません。

PlayerScriptSendableではない値からPlayerScriptSendableへの変換

undefinedなどのPlayerScriptSendableではない値をPlayerScriptSendableを要求するAPIに渡した場合、以下のルールに基づいて取り扱われます。

  • undefinedなどのPlayerScriptSendableではない値を直接渡した場合、APIに応じて例外になるか無視されます。
  • undefinedなどのPlayerScriptSendableではない値を含む配列を渡した場合、PlayerScriptSendableではない値をnullに変換することでPlayerScriptSendableとして扱われます。
  • undefinedなどのPlayerScriptSendableではない値を値として含むobjectを渡した場合、対応するkey-valueを削除することでPlayerScriptSendableとして扱われます。

これらの挙動が発生した場合、スクリプトコンソールに警告メッセージが表示されます。 また、これらの挙動は将来的なアップデートで例外になるように変更される予定です。

PlayerScriptSendableからSendableへの変換

PlayerScriptSendableをItemScriptに送信した場合、Sendableとして扱えない値は以下のルールに基づいてSendableに変換されます。

  • PlayerId は同じプレイヤーを指し示す PlayerHandle になります。
  • ItemId は同じアイテムを指し示す ItemHandle になります。
  • 配列とobjectの中身もそれに応じて変換されます。

Example

_.sendTo(_.sourceItemId, "message1", 10); // numberを送信する
_.sendTo(_.sourceItemId, "message2", "hello"); // stringを送信する
_.sendTo(_.sourceItemId, "message3", true); // booleanを送信する
_.sendTo(_.sourceItemId, "message4", { foo: "bar" }); // objectを送信する
_.sendTo(_.sourceItemId, "message5", [1, 2, 3]); // arrayを送信する
_.sendTo(_.sourceItemId, "message6", { // 複雑なオブジェクトを送信する
array: [1, 2, 3],
object: { foo: "bar" },
});

Generated using TypeDoc