Client

Defined in: livelink.js/sources/session/Client.ts:20

A client in a session.

A client represents an instance of a 3dverse user viewing the session.

A user can have multiple clients in the same session.

Clients must not be instantiated but can be accessed through the Session object.

Accessors

id

Get Signature

get id(): UUID

Defined in: livelink.js/sources/session/Client.ts:44

The unique identifier of the client.

Returns

UUID

---

user_id

Get Signature

get user_id(): UUID

Defined in: livelink.js/sources/session/Client.ts:51

The user that the client is associated with.

Returns

UUID

---

username

Get Signature

get username(): string

Defined in: livelink.js/sources/session/Client.ts:58

The username of the user that the client is associated with.

Returns

string

---

camera_rtids

Get Signature

get camera_rtids(): RTID[]

Defined in: livelink.js/sources/session/Client.ts:65

The RTIDs of the cameras that the client is viewing.

Returns

RTID[]

---

cursor_data

Get Signature

get cursor_data(): null | CursorData

Defined in: livelink.js/sources/session/Client.ts:72

The 3d data under the client's mouse pointer.

Returns

null | CursorData

Methods

getCameraEntities()

getCameraEntities(): Promise<Entity[]>

Defined in: livelink.js/sources/session/Client.ts:79

Returns the camera entities that the client is using.

Returns

Promise<Entity[]>

---

getHoveredEntity()

getHoveredEntity(): Promise<null | Entity>

Defined in: livelink.js/sources/session/Client.ts:107

Returns

Promise<null | Entity>