Description
Supported Script Types: Interface Scripts • Client Entity Scripts • Avatar Scripts
TheAvatarManager
API provides information about avatars within the current domain. The avatars available are
those that Interface has displayed and therefore knows about.
Warning: This API is also provided to Interface, client entity, and avatar scripts as the synonym,
"AvatarList
". For assignment client scripts, see the separate AvatarList API.
Methods
Name | Return Value | Summary |
---|---|---|
findParabolaIntersectionVector
|
ParabolaToAvatarIntersectionResult |
Deprecated: This function is deprecated and will be removed. |
findRayIntersection
|
RayToAvatarIntersectionResult |
Find the first avatar intersected by a PickRay. |
findRayIntersectionVector
|
RayToAvatarIntersectionResult |
Deprecated: This function is deprecated and will be removed. |
getAvatar
|
ScriptAvatar |
Gets information about an avatar. |
getAvatarDataRate
|
number |
Gets the amount of avatar mixer data being generated by an avatar other than your own. |
getAvatarIdentifiers
|
Array.<Uuid> |
Gets the IDs of all avatars known about in the domain.
Your own avatar is included in the list as a |
getAvatarSimulationRate
|
number |
Gets the simulation rate of an avatar other than your own. |
getAvatarSortCoefficient
|
number |
Deprecated: This function is deprecated and will be removed. |
getAvatarUpdateRate
|
number |
Gets the update rate of avatar mixer data being generated by an avatar other than your own. |
getAvatarsInRange
|
Array.<Uuid> |
Gets the IDs of all avatars known about within a specified distance from a point. Your own avatar's ID is included in the list if it is in range. |
getPalData
|
Object.<"data", Array.<AvatarManager.PalData>> |
Gets PAL (People Access List) data for one or more avatars. Using this method is faster than iterating over each avatar and obtaining data about each individually. |
isAvatarInRange
|
boolean |
Checks whether there is an avatar within a specified distance from a point. |
processAvatarDataPacket
|
None |
Deprecated: This function is deprecated and will be removed. |
processAvatarIdentityPacket
|
None |
Deprecated: This function is deprecated and will be removed. |
processBulkAvatarTraits
|
None |
Deprecated: This function is deprecated and will be removed. |
processKillAvatar
|
None |
Deprecated: This function is deprecated and will be removed. |
sessionUUIDChanged
|
None |
Deprecated: This function is deprecated and will be removed. |
setAvatarSortCoefficient
|
None |
Deprecated: This function is deprecated and will be removed. |
setEnableDebugDrawOtherSkeletons
|
None |
Displays other avatars skeletons debug graphics. |
updateAvatarRenderStatus
|
None |
Deprecated: This function is deprecated and will be removed. |
Signals
Name | Summary |
---|---|
avatarAddedEvent
|
Triggered when an avatar arrives in the domain. |
avatarRemovedEvent
|
Triggered when an avatar leaves the domain. |
avatarSessionChangedEvent
|
Triggered when an avatar's session ID changes. |
Type Definitions
PalData Type: object |
|||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
PAL (People Access List) data for an avatar. Properties
|
Method Details
(static) findParabolaIntersectionVector( pick, avatarsToInclude, avatarsToDiscard ) → {ParabolaToAvatarIntersectionResult}
Returns: Intersection result. |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Deprecated: This function is deprecated and will be removed. Parameters
|
(static) findRayIntersection( ray, avatarsToIncludeopt, avatarsToDiscardopt, pickAgainstMeshopt ) → {RayToAvatarIntersectionResult}
Returns: The result of the search for the first intersected avatar. |
|||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Find the first avatar intersected by a PickRay. Parameters
Example
|
(static) findRayIntersectionVector( ray, avatarsToInclude, avatarsToDiscard, pickAgainstMesh ) → {RayToAvatarIntersectionResult}
Returns: Intersection result. |
|||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Deprecated: This function is deprecated and will be removed. Parameters
|
(static) getAvatar( avatarID ) → {ScriptAvatar}
Returns: Information about the avatar. |
||||||
---|---|---|---|---|---|---|
Gets information about an avatar. Parameters
|
(static) getAvatarDataRate( sessionID, rateNameopt ) → {number}
Returns: The data rate in kbps; 0 if the avatar is your own.
|
|||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the amount of avatar mixer data being generated by an avatar other than your own. Parameters
|
(static) getAvatarIdentifiers( ) → {Array.<Uuid>}
Returns: The IDs of all known avatars in the domain. |
---|
Gets the IDs of all avatars known about in the domain.
Your own avatar is included in the list as a Example
|
(static) getAvatarSimulationRate( sessionID, rateNameopt ) → {number}
Returns: The simulation rate in Hz; 0 if the avatar is your own.
|
|||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the simulation rate of an avatar other than your own. Parameters
|
(static) getAvatarSortCoefficient( name ) → {number}
Returns: Value. |
||||||
---|---|---|---|---|---|---|
Deprecated: This function is deprecated and will be removed. Parameters
|
(static) getAvatarUpdateRate( sessionID, rateNameopt ) → {number}
Returns: The update rate in Hz; 0 if the avatar is your own.
|
|||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the update rate of avatar mixer data being generated by an avatar other than your own. Parameters
|
(static) getAvatarsInRange( position, range ) → {Array.<Uuid>}
Returns: The IDs of all known avatars within the search distance from the position. |
|||||||||
---|---|---|---|---|---|---|---|---|---|
Gets the IDs of all avatars known about within a specified distance from a point. Your own avatar's ID is included in the list if it is in range. Parameters
Example
|
(static) getPalData( avatarIDsopt ) → {Object.<"data", Array.<AvatarManager.PalData>>}
Returns: An array of objects, each object being the PAL data for an avatar. |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets PAL (People Access List) data for one or more avatars. Using this method is faster than iterating over each avatar and obtaining data about each individually. Parameters
Example
|
(static) isAvatarInRange( position, range ) → {boolean}
Returns: true if there's an avatar within the specified distance of the point, false
if not.
|
|||||||||
---|---|---|---|---|---|---|---|---|---|
Checks whether there is an avatar within a specified distance from a point. Parameters
|
(static) processAvatarDataPacket( message, sendingNode ) | |||||||||
---|---|---|---|---|---|---|---|---|---|
Deprecated: This function is deprecated and will be removed. Parameters
|
(static) processAvatarIdentityPacket( message, sendingNode ) | |||||||||
---|---|---|---|---|---|---|---|---|---|
Deprecated: This function is deprecated and will be removed. Parameters
|
(static) processBulkAvatarTraits( message, sendingNode ) | |||||||||
---|---|---|---|---|---|---|---|---|---|
Deprecated: This function is deprecated and will be removed. Parameters
|
(static) processKillAvatar( message, sendingNode ) | |||||||||
---|---|---|---|---|---|---|---|---|---|
Deprecated: This function is deprecated and will be removed. Parameters
|
(static) sessionUUIDChanged( sessionUUID, oldSessionUUID ) | |||||||||
---|---|---|---|---|---|---|---|---|---|
Deprecated: This function is deprecated and will be removed. Parameters
|
(static) setAvatarSortCoefficient( name, value ) | |||||||||
---|---|---|---|---|---|---|---|---|---|
Deprecated: This function is deprecated and will be removed. Parameters
|
(static) setEnableDebugDrawOtherSkeletons( enabled ) | ||||||
---|---|---|---|---|---|---|
Displays other avatars skeletons debug graphics. Parameters
|
(static) updateAvatarRenderStatus( shouldRenderAvatars ) | ||||||
---|---|---|---|---|---|---|
Deprecated: This function is deprecated and will be removed. Parameters
|
Signal Details
avatarAddedEvent(
sessionUUID
)
Returns: Signal |
||||||
---|---|---|---|---|---|---|
Triggered when an avatar arrives in the domain. Parameters
Example
|
avatarRemovedEvent(
sessionUUID
)
Returns: Signal |
||||||
---|---|---|---|---|---|---|
Triggered when an avatar leaves the domain. Parameters
Example
|
avatarSessionChangedEvent(
newSessionUUID,
oldSessionUUID
)
Returns: Signal |
|||||||||
---|---|---|---|---|---|---|---|---|---|
Triggered when an avatar's session ID changes. Parameters
Example
|