Skip to main content

interface ISharedSpaceRoomOptions

(Niantic.Lightship.SharedAR.Colocalization.ISharedSpaceRoomOptions)

Overview

Room settings to use in Shared Space

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();
};

Detailed Documentation

Room settings to use in Shared Space

Methods

CreateVpsRoomOptions

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

Use to create ISharedSpaceRoomOptions when a Lightship Room is associated to a Wayspot

    Parameters:

    trackingVpsLocation - VPS tracking options

    roomTag - A prefix to the room name

    capacity - Capacity of the room

    description - Description of the room

    useNetcode - If true, a Room is assigned to LightshipNetcodeTransport

    Returns:

    Returns ISharedSpaceRoomOptions object

CreateLightshipRoomOptions

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

Use to create ISharedSpaceRoomOptions for mock tracking or image target tracking, which requires to give a custom Room name

    Parameters:

    name - Name of the room

    capacity - Capacity of the room

    description - Description of the room

    useNetcode - If true, a Room is assigned to LightshipNetcodeTransport

    Returns:

    Returns ISharedSpaceRoomOptions object

CreateCustomRoomOptions

static ISharedSpaceRoomOptions CreateCustomRoomOptions()

Use when managing Rooms by application or using custom networking

    Returns:

    Returns ISharedSpaceRoomOptions object