Skip to main content

Class: 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:52

The id of the user that the client is associated with. Note that the same user can have multiple clients in the same session.

Returns​

UUID

username​

Get Signature​

get username(): string

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

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

Returns​

string

Methods​

getCameraEntities()​

getCameraEntities(): Promise<Entity[]>

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

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:102

Returns the entity that the client's mouse pointer is currently hovering over.

Returns​

Promise<null | Entity>