本文へスキップ

interface IRoom

(Niantic.Lightship.SharedAR.Rooms.IRoom)

概要

ルームとは、サーバーを中継したネットワークで複数のピア同士を接続するためのエンティティのことです。 IRoomは、ルームのプロパティとネットワーク接続へのアクセスを提供します。

	interface IRoom:IDisposable {
// プロパティ

RoomParams RoomParams;
INetworking Networking;
IDatastore Datastore;

// メソッド

void Initialize();
void Join();
void Leave();
}

詳細なドキュメント

ルームとは、サーバーを中継したネットワークで複数のピア同士を接続するためのエンティティのことです。 IRoomは、ルームのプロパティとネットワーク接続へのアクセスを提供します。

プロパティ

RoomParams

RoomParams RoomParams

ルームのプロパティ

ネットワーキング

INetworking Networking

INetworkingオブジェクトを取得し、データの送受信やネットワーキングイベントのリスニングを行います。

Datastore

IDatastore Datastore

IDatastoreオブジェクトを取得し、ルームに接続されたリアルタイムのキーバリューストアにアクセスします。

メソッド

Initialize

void initialize()

ネットワーク接続を初期化し、サーバー上のルームに接続する。 INetworkingは、Initialize()が呼び出された後に利用できるようにします。

Join

void Join()

ルームに入る。 入室後、INetworking経由でデータの送受信が可能。

Leave

void Leave()

ルームから退出。 サーバーから切断され、その後データの送受信ができなくなります。