本文へスキップ

interface ISharedSpaceRoomOptions

(Niantic.Lightship.SharedAR.Colocalization.ISharedSpaceRoomOptions）

概要​

共有スペースで使用するRoomの設定

interface ISharedSpaceRoomOptions {
        // properties
    
        IRoom Room;

        // methods
    
        static ISharedSpaceRoomOptions CreateVpsRoomOptions(
            ISharedSpaceTrackingOptions trackingVpsLocation,
            string roomTag = "",
            int capacity = 10,
            string description = "",
            bool useNetcode = true
        )；
    
        static ISharedSpaceRoomOptions CreateLightshipRoomOptions(
            string name,
            int capacity = 10,
            string description = "",
            bool useNetcode = true
        );
    
        static ISharedSpaceRoomOptions CreateCustomRoomOptions();
}；

詳細資料​

共有スペースで使用するRoomの設定

メソッド​

CreateVpsRoomOptions​

static ISharedSpaceRoomOptions CreateVpsRoomOptions(
        ISharedSpaceTrackingOptions trackingVpsLocation,
        string roomTag = "",
        int capacity = 10,
        string description = "",
        bool useNetcode = true
)

Lightship RoomをWayspotに関連付ける際、 [ISharedSpaceRoomOptions]（./index.mdx）を作成するために使用します。

    Parameters:

    trackingVpsLocation - VPSトラッキングオプション

    roomTag - Room名のプレフィックス。

    capacity`` - 部屋の収容人数

    description - Roomの説明。

    useNetcode - true の場合、Roomは LightshipNetcodeTransport に割り当てられます。

    戻り値:

     ISharedSpaceRoomOptions オブジェクトを返します。

CreateLightshipRoomOptions​

static ISharedSpaceRoomOptions CreateLightshipRoomOptions(
        string name,
        int capacity = 10,
        string description = "",
        bool useNetcode = true
)

[ISharedSpaceRoomOptions]（./index.mdx）を作成し、モック・トラッキングやイメージ・ターゲット・トラッキングに使用する。

    Parameters:

    name - Roomの名前

    capacity - Roomのキャパシティ

    description - Roomの説明。

    useNetcode - true の場合、Roomは LightshipNetcodeTransport に割り当てられます。

    戻り値:

     ISharedSpaceRoomOptions オブジェクトを返します。

CreateCustomRoomOptions​

static ISharedSpaceRoomOptions CreateCustomRoomOptions()

Roomsをアプリケーションで管理する場合、またはカスタムネットワークを使用する場合に使用します。

    戻り値:

     ISharedSpaceRoomOptions オブジェクトを返します。