| Available in: | Assignment Client Scripts |
|---|
Note: An
AvatarList API is also provided for Interface and client entity scripts: it is a synonym for the AvatarManager API.
Methods
Signals
Methods
getAvatar(avatarID) → {AvatarData}
Parameters:
| Name | Type | Description |
|---|---|---|
avatarID |
Uuid |
Returns:
- Type: AvatarData
getAvatarIdentifiers() → {Array.<Uuid>}
Returns:
- Type: Array.<Uuid>
getAvatarsInRange(position, range) → {Array.<Uuid>}
Parameters:
| Name | Type | Description |
|---|---|---|
position |
Vec3 | |
range |
number |
Returns:
- Type: Array.<Uuid>
isAvatarInRange(position, range) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
position |
string | |
range |
string |
Returns:
- Type: boolean
processAvatarDataPacket(message, sendingNode)
Parameters:
| Name | Type | Description |
|---|---|---|
message |
||
sendingNode |
processAvatarIdentityPacket(message, sendingNode)
Parameters:
| Name | Type | Description |
|---|---|---|
message |
||
sendingNode |
processBulkAvatarTraits(message, sendingNode)
Parameters:
| Name | Type | Description |
|---|---|---|
message |
||
sendingNode |
processKillAvatar(message, sendingNode)
Parameters:
| Name | Type | Description |
|---|---|---|
message |
||
sendingNode |
sessionUUIDChanged(sessionUUID, oldSessionUUID)
Parameters:
| Name | Type | Description |
|---|---|---|
sessionUUID |
Uuid | |
oldSessionUUID |
Uuid |
Signals
avatarAddedEvent(sessionUUID) → {Signal}
Parameters:
| Name | Type | Description |
|---|---|---|
sessionUUID |
Uuid |
Returns:
- Type: Signal
avatarRemovedEvent(sessionUUID) → {Signal}
Parameters:
| Name | Type | Description |
|---|---|---|
sessionUUID |
Uuid |
Returns:
- Type: Signal
avatarSessionChangedEvent(sessionUUID, oldSessionUUID) → {Signal}
Parameters:
| Name | Type | Description |
|---|---|---|
sessionUUID |
Uuid | |
oldSessionUUID |
Uuid |
Returns:
- Type: Signal
