Appearance
status+me.virmesh.success.worldInstanceResolved
world instance が正常に解決されたことを示します。
Description
me.virmesh.worldInstance.getInstance が正常終了し、指定された instance を返したことを示します。
When this happens
- 指定された
query.instanceIdの instance が見つかった
Payload
解決された instance です。
References obj+me.virmesh.worldInstance.instance : WorldServer 上で稼働している world instance を表す object です。
idstringRequiredWorldServer が割り当てる instance identifier です。不透明な文字列として扱います。
worldIdstringRequiredこの instance が属する world identifier です。形式は medi:world:<scheme>:<publicKey> です。
endpointstringRequiredこの instance を管理する WorldServer の absolute URL です。
namestringOptional表示用の instance 名です。
statestringRequiredopen, full, closed のいずれかです。
playerCountintegerRequired現在参加している player 数です。
capacityintegerRequired参加可能な最大 player 数です。
joinPolicystringRequiredpublic, invite, private のいずれかです。
createdAtintegerRequiredinstance を作成した epoch second です。
updated_atintegerRequiredinstance metadata を更新した epoch second です。
worldProtocolsobject[]Requiredこの instance に接続するための protocol 一覧です。各要素は name, version, information を持ちます。
worldProtocols[].namestringRequiredprotocol identifier です。例: me.virmesh.world.websocket。
worldProtocols[].versionstringRequiredprotocol version です。
worldProtocols[].informationobjectRequired当該プロトコルがこの instance への接続に必要とするパラメータです。キー・型・意味は worldProtocols[].name で識別されるプロトコル仕様が定義します。
Client handling
- 返された
stateとworldProtocolsを使ってライブセッション接続を判断する
Referenced by
| HTTP | API | Action |
|---|---|---|
200 | me.virmesh.worldInstance.getInstance | me.virmesh.worldInstance.getInstance |