Users

Description

Supported Script Types: Interface Scripts • Client Entity Scripts • Avatar Scripts • Assignment Client Scripts

Properties

Name Type Summary
canKick boolean true if the domain server allows the node or avatar to kick (ban) avatars, otherwise false. Read-only.
requestsDomainListData boolean true if the avatar requests extra data from the mixers (such as positional data of an avatar you've ignored). Read-only.

Methods

Name Return Value Summary
disableIgnoreRadius None Disables the space bubble feature.
enableIgnoreRadius None Enables the space bubble feature.
getAvatarGain number Gets an avatar's gain for you and you only.
getCanKick boolean Returns `true` if the DomainServer will allow this Node/Avatar to make kick.
getIgnoreRadiusEnabled boolean Returns `true` if the space bubble feature is enabled.
getIgnoreStatus boolean Get whether or not you have ignored the node with the given UUID.
ignore None Personally ignore another user, making them disappear for you and you disappear for them.
kick None Kick/ban another user. Removes them from the server and prevents them from returning. Bans by either user name (if available) or machine fingerprint otherwise. This will only do anything if you're an admin of the domain you're in.
mute None Mutes another user's microphone for everyone. Not permanent; the silenced user can unmute themselves with the UNMUTE button in their HUD. This will only do anything if you're an admin of the domain you're in.
personalMute None Mute another user for you and you only. They won't be able to hear you, and you won't be able to hear them.
requestPersonalMuteStatus boolean Get whether or not you have personally muted the node with the given UUID.
requestUsernameFromID None Request the user name and machine fingerprint associated with the given UUID. The user name will be returned in a usernameFromIDReply signal. This will only do anything if you're an admin of the domain you're in.
setAvatarGain None Sets an avatar's gain for you and you only. Units are Decibels (dB)
toggleIgnoreRadius None Toggle the state of the space bubble feature.

Signals

Name Summary
avatarDisconnected Notifies scripts that a user has disconnected from the domain.
canKickChanged
enteredIgnoreRadius Notifies scripts that another user has entered the ignore radius.
ignoreRadiusEnabledChanged
usernameFromIDReply Triggered in response to a requestUsernameFromID call. Provides the user name and machine fingerprint associated with a UUID. Username and machineFingerprint will be their default constructor output if the requesting user isn't an admin.

Method Details

(static) disableIgnoreRadius( )

Disables the space bubble feature.

(static) enableIgnoreRadius( )

Enables the space bubble feature.

(static) getAvatarGain( nodeID ) → {number}
Returns: gain (in dB)

Gets an avatar's gain for you and you only.

Parameters

Name Type Description
nodeID Uuid The node or session ID of the user whose gain you want to get, or null to get the master gain.
(static) getCanKick( ) → {boolean}
Returns: true if the domain server allows the client to kick (ban) other users, otherwise false.

Returns `true` if the DomainServer will allow this Node/Avatar to make kick.

(static) getIgnoreRadiusEnabled( ) → {boolean}
Returns: true if the space bubble is enabled, otherwise false.

Returns `true` if the space bubble feature is enabled.

(static) getIgnoreStatus( nodeID ) → {boolean}
Returns: boolean

Get whether or not you have ignored the node with the given UUID.

Parameters

Name Type Description
nodeID Uuid The node or session ID of the user whose ignore status you want.
(static) ignore( nodeID, enable )

Personally ignore another user, making them disappear for you and you disappear for them.

Parameters

Name Type Description
nodeID Uuid The node or session ID of the user you want to ignore.
enable boolean True for ignored; false for un-ignored.
(static) kick( nodeID )

Kick/ban another user. Removes them from the server and prevents them from returning. Bans by either user name (if available) or machine fingerprint otherwise. This will only do anything if you're an admin of the domain you're in.

Parameters

Name Type Description
nodeID Uuid The node or session ID of the user you want to kick.
(static) mute( nodeID )

Mutes another user's microphone for everyone. Not permanent; the silenced user can unmute themselves with the UNMUTE button in their HUD. This will only do anything if you're an admin of the domain you're in.

Parameters

Name Type Description
nodeID Uuid The node or session ID of the user you want to mute.
(static) personalMute( nodeID, muteEnabled )

Mute another user for you and you only. They won't be able to hear you, and you won't be able to hear them.

Parameters

Name Type Description
nodeID Uuid The node or session ID of the user you want to mute.
muteEnabled boolean True for enabled; false for disabled.
(static) requestPersonalMuteStatus( nodeID ) → {boolean}
Returns: boolean

Get whether or not you have personally muted the node with the given UUID.

Parameters

Name Type Description
nodeID Uuid The node or session ID of the user whose personal mute status you want.
(static) requestUsernameFromID( nodeID )

Request the user name and machine fingerprint associated with the given UUID. The user name will be returned in a usernameFromIDReply signal. This will only do anything if you're an admin of the domain you're in.

Parameters

Name Type Description
nodeID Uuid The node or session ID of the user whose user name you want.
(static) setAvatarGain( nodeID, gain )

Sets an avatar's gain for you and you only. Units are Decibels (dB)

Parameters

Name Type Description
nodeID Uuid The node or session ID of the user whose gain you want to modify, or null to set the master gain.
gain number The gain of the avatar you'd like to set. Units are dB.
(static) toggleIgnoreRadius( )

Toggle the state of the space bubble feature.

Signal Details

avatarDisconnected( nodeID )
Returns: Signal

Notifies scripts that a user has disconnected from the domain.

Parameters

Name Type Description
nodeID Uuid The session ID of the avatar that has disconnected.
canKickChanged( canKick )
Returns: Signal

 

Parameters

Name Type Description
canKick boolean
enteredIgnoreRadius( )
Returns: Signal

Notifies scripts that another user has entered the ignore radius.

ignoreRadiusEnabledChanged( isEnabled )
Returns: Signal

 

Parameters

Name Type Description
isEnabled boolean
usernameFromIDReply( nodeID, userName, machineFingerprint, isAdmin )
Returns: Signal

Triggered in response to a requestUsernameFromID call. Provides the user name and machine fingerprint associated with a UUID. Username and machineFingerprint will be their default constructor output if the requesting user isn't an admin.

Parameters

Name Type Description
nodeID Uuid
userName string
machineFingerprint string
isAdmin boolean