/
CavrnusUser (Unity)

CavrnusUser (Unity)

Owned by bert
Last updated: Apr 19, 2024 by Kyle (Unlicensed)
2 min read

- Fields

public bool IsLocalUser;

public string ContainerId;

public CavrnusSpaceConnection SpaceConnection;

 

This represents a user present in a given Space. It can used to create users-list for UI, etc.

IsLocalUser says if this is the local user.

ContainerId can be used to Post/Bind/etc to their properties (see their well-known properties below).

SpaceConnection is a shortcut to get the space the CavrnusUser exist in.

- Well-Known User Properties

Some default properties are provided for a given CavrnusUser. These are readonly, and posting values to them will have no effect.

Instead, these values originate from the user’s profile, and can be modified in the Admin Portal. Afterwards, the values are then passed to the properties system internally.

Any changes to these values will result in normal property update events for Bind calls, etc.

NOTE: These are case-sensitive. Whether you intend to Bind or use them in no-code components ensure precise copying and pasting of these values.

Property Name

Description

name (String Property)

The user’s current Screen Name.

userId (String Property)

The user’s overall unique server identifier. This will never change.

Note: If the same user is logged in & in the space multiple times, those instance will share a userId.

connectionId (String Property)

The unique ID of a user’s connection to a space. This will never change.

Note: If the same user is logged in while being in the space multiple times, those instance will each have a unique connectionId.

Note: When a user re-joins a space they will always get a new connectionId. All values posted to a connectionId should therefore be Transient.

profilePicture (String Property)

The URL value of the user’s profile picture. To display this, use the Unity WWW call.

muted (Bool Property)

Indicates whether the user is presently muted. This status can be set by calling SetLocalUserMutedState.

streaming (Bool Property)

Indicates whether the user is currently streaming. This status can be set by calling SetLocalUserStreamingState.

volume (Float Property)

Returns a float value representing how loudly the user is speaking.

speaking (Bool Property)

Returns true if the user is speaking. This is based on checking if volume < .005.

Related content