index
title: struct RoomParams toc_max_heading_level: 4
struct RoomParams
(Niantic.Lightship.SharedAR.Rooms.RoomParams)
概要
RoomParams 構造体は、ルームのプロパティを含む。
struct RoomParams {
// プロパティ
string RoomID;
RoomVisibility Visibility;
int Capacity;
string Name;
string Description;
string Passcode;
// メソッド
RoomParams(
int capacity,
string name = "",
string description = "",
string passcode = "",
RoomVisibility visibility = RoomVisibility.Public
);
RoomParams(string id, RoomVisibility visibility = RoomVisibility.Public);
};
詳細なドキュメント
RoomParams 構造体は、ルームのプロパティを含む。
プロパティ
RoomID
文字列 RoomID
ルームのID。 RoomManagementServiceによってのみ設定される。
Visibility
RoomVisibility Visibility
ルームの視認性
Capacity
int Capacity
ルームの定員 値は2~32ピアの間でなければならない。
Name
string Name
ルーム の名前 ルームは部屋間で一意である必要はない
Description
string Description
ルームの説明
Passcode
string Passcode
ルームに入るためのパスコード。 visibilityがprivateに設定されている場合は必須。
メソッド
RoomParams
RoomParams(
int capacity,
string name = "",
string description = "",
string passcode = "",
RoomVisibility visibility = RoomVisibility.Public
)
Constructor
パラメーター:
capacity
- ルームの容量。 値は2~32ピアの間でなければならない。
name
- ルームの名前
description
- ルームの説明
passcode
- ルームのパスコード
visibility
- ルームの可視性
RoomParams
RoomParams(string id, RoomVisibility visibility = RoomVisibility.Public)
IDを介した構築のためのコンストラクタ。 通常、必要な文字列IDを返すRoom.GetOrCreateRoomAsyncと組み合わせて使用します。
パラメーター:
id
- バックエンドからの特定の RoomID GUID。
visibility
- ルームの視認性