Description
Supported Script Types: Interface Scripts • Client Entity Scripts • Avatar Scripts • Assignment Client Scripts
TheUsers
API provides features to regulate your interaction with other users.Properties
Name | Type | Summary |
---|---|---|
canKick | boolean |
|
requestsDomainListData | boolean |
|
NO_BAN | BanFlags |
Do not ban user. Read-only. |
BAN_BY_USERNAME | BanFlags |
Ban user by username. Read-only. |
BAN_BY_FINGERPRINT | BanFlags |
Ban user by fingerprint. Read-only. |
BAN_BY_IP | BanFlags |
Ban user by IP address. Read-only. |
Methods
Name | Return Value | Summary |
---|---|---|
disableIgnoreRadius
|
None |
Disables the privacy shield. |
enableIgnoreRadius
|
None |
Enables the privacy shield. |
getAvatarGain
|
number |
Gets an avatar's gain (volume) for you and you only, or gets the primary gain. |
getCanKick
|
boolean |
Gets whether the client can kick and ban users in the domain. |
getIgnoreRadiusEnabled
|
boolean |
Gets the status of the privacy shield. |
getIgnoreStatus
|
boolean |
Gets whether or not you have ignored a particular avatar. |
getPersonalMuteStatus
|
boolean |
Gets whether or not you have muted a particular avatar. |
ignore
|
None |
Ignores or un-ignores another avatar. Ignoring an avatar makes them disappear for you and you disappear for them. |
kick
|
None |
Kicks and bans a user. This removes them from the server and prevents them from returning. The ban is by user name (if available) and by machine fingerprint. The ban functionality can be controlled with flags. This function only works if you're an administrator of the domain you're in. |
mute
|
None |
Mutes a user's microphone for everyone. The mute is not permanent: the user can unmute themselves. This function only works if you're an administrator of the domain you're in. |
personalMute
|
None |
Mutes or un-mutes another avatar. Muting makes you unable to hear them and them unable to hear you. |
requestUsernameFromID
|
None |
Requests the user name and machine fingerprint associated with the given UUID. The user name is returned via a usernameFromIDReply signal. This function only works if you're an administrator of the domain you're in. |
setAvatarGain
|
None |
Sets an avatar's gain (volume) for you and you only, or sets the primary gain. |
toggleIgnoreRadius
|
None |
Toggles the state of the privacy shield. |
Signals
Name | Summary |
---|---|
avatarDisconnected
|
Triggered when a client has disconnected from the domain. |
canKickChanged
|
Triggered when your ability to kick and ban users changes. |
enteredIgnoreRadius
|
Triggered when another user enters the privacy shield. |
ignoreRadiusEnabledChanged
|
Triggered when the privacy shield status changes. |
usernameFromIDReply
|
Triggered in response to a requestUsernameFromID call. Provides the user name and machine fingerprint associated with a UUID. |
Method Details
(static) disableIgnoreRadius( ) |
---|
Disables the privacy shield. |
(static) enableIgnoreRadius( ) |
---|
Enables the privacy shield. |
(static) getAvatarGain( nodeID ) → {number}
Returns: The gain, in dB. |
||||||
---|---|---|---|---|---|---|
Gets an avatar's gain (volume) for you and you only, or gets the primary gain. Parameters
|
(static) getCanKick( ) → {boolean}
Returns: true if the domain server allows the client to kick and ban users, otherwise
false .
|
---|
Gets whether the client can kick and ban users in the domain. |
(static) getIgnoreRadiusEnabled( ) → {boolean}
Returns: true if the privacy shield is enabled, false if it is disabled.
|
---|
Gets the status of the privacy shield. |
(static) getIgnoreStatus( sessionID ) → {boolean}
Returns: true if the avatar is being ignored, false if it isn't.
|
||||||
---|---|---|---|---|---|---|
Gets whether or not you have ignored a particular avatar. Parameters
|
(static) getPersonalMuteStatus( sessionID ) → {boolean}
Returns: true if the avatar is muted, false if it isn't.
|
||||||
---|---|---|---|---|---|---|
Gets whether or not you have muted a particular avatar. Parameters
|
(static) ignore( sessionID, enableopt ) | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Ignores or un-ignores another avatar. Ignoring an avatar makes them disappear for you and you disappear for them. Parameters
Example
|
(static) kick( sessionID ) | |||||||||
---|---|---|---|---|---|---|---|---|---|
Kicks and bans a user. This removes them from the server and prevents them from returning. The ban is by user name (if available) and by machine fingerprint. The ban functionality can be controlled with flags. This function only works if you're an administrator of the domain you're in. Parameters
|
(static) mute( sessionID ) | ||||||
---|---|---|---|---|---|---|
Mutes a user's microphone for everyone. The mute is not permanent: the user can unmute themselves. This function only works if you're an administrator of the domain you're in. Parameters
|
(static) personalMute( sessionID, muteEnabledopt ) | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Mutes or un-mutes another avatar. Muting makes you unable to hear them and them unable to hear you. Parameters
|
(static) requestUsernameFromID( sessionID ) | ||||||
---|---|---|---|---|---|---|
Requests the user name and machine fingerprint associated with the given UUID. The user name is returned via a usernameFromIDReply signal. This function only works if you're an administrator of the domain you're in. Parameters
Example
|
(static) setAvatarGain( nodeID, gain ) | |||||||||
---|---|---|---|---|---|---|---|---|---|
Sets an avatar's gain (volume) for you and you only, or sets the primary gain. Parameters
|
(static) toggleIgnoreRadius( ) |
---|
Toggles the state of the privacy shield. |
Signal Details
avatarDisconnected(
sessionID
)
Returns: Signal |
||||||
---|---|---|---|---|---|---|
Triggered when a client has disconnected from the domain. Parameters
|
canKickChanged(
canKick
)
Returns: Signal |
||||||
---|---|---|---|---|---|---|
Triggered when your ability to kick and ban users changes. Parameters
|
enteredIgnoreRadius(
)
Returns: Signal |
---|
Triggered when another user enters the privacy shield. |
ignoreRadiusEnabledChanged(
isEnabled
)
Returns: Signal |
||||||
---|---|---|---|---|---|---|
Triggered when the privacy shield status changes. Parameters
|
usernameFromIDReply(
sessionID,
userName,
machineFingerprint,
isAdmin
)
Returns: Signal |
|||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Triggered in response to a requestUsernameFromID call. Provides the user name and machine fingerprint associated with a UUID. Parameters
|