Users

Available in: Interface Scripts Client Entity Scripts Assignment Client Scripts

Methods

Signals

Properties:
Name Type Description
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

disableIgnoreRadius()
Disables the space bubble feature.
enableIgnoreRadius()
Enables the space bubble feature.
getAvatarGain(nodeID) → {number}
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.
Returns:
gain (in dB)
Type: number
getCanKick() → {boolean}
Returns `true` if the DomainServer will allow this Node/Avatar to make kick.
Returns:
true if the domain server allows the client to kick (ban) other users, otherwise false.
Type: boolean
getIgnoreRadiusEnabled() → {boolean}
Returns `true` if the space bubble feature is enabled.
Returns:
true if the space bubble is enabled, otherwise false.
Type: boolean
getIgnoreStatus(nodeID) → {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.
Returns:
Type: boolean
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.
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.
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.
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.
requestPersonalMuteStatus(nodeID) → {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.
Returns:
Type: boolean
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.
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.
toggleIgnoreRadius()
Toggle the state of the space bubble feature.

Signals

avatarDisconnected(nodeID) → {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.
Returns:
Type: Signal
canKickChanged(canKick) → {Signal}
Parameters:
Name Type Description
canKick boolean
Returns:
Type: Signal
enteredIgnoreRadius() → {Signal}
Notifies scripts that another user has entered the ignore radius.
Returns:
Type: Signal
ignoreRadiusEnabledChanged(isEnabled) → {Signal}
Parameters:
Name Type Description
isEnabled boolean
Returns:
Type: Signal
usernameFromIDReply(nodeID, userName, machineFingerprint, isAdmin) → {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
Returns:
Type: Signal