Avatar
info
- This class is only available on LocalAvatarScripts and LocalScripts
The Avatar class provides information on a Player's current Avatar. It can provide information on the child Items, parameters, etc.
Methods
| Method Name | Return Type | Parameters | Description |
|---|---|---|---|
| GetAvatarObject | Item | HumanBodyBones | Returns the Item of a specific Avatar bone |
| GetAvatarObjectByPath | Item | string | Returns a descendant of the Avatar by path |
| GetPlayerRoot | Item | none | Returns the Player's Root |
| IsAvatarItem | bool | Item | Returns true if the Item is a descendant of the Avatar |
| GetAvatarParameters | AvatarParameter[] | none | Returns all Parameters on an Avatar |
| GetAvatarParameter | AvatarParameter | string | Gets an Avatar's parameter by name |
| Scale | void | float | Scales an Avatar |
Properties
| Property Name | Type | Description |
|---|---|---|
| IsLocalAvatar | bool | Returns true if the current Avatar is owned by the LocalPlayer |
| OwnerId | string | Returns the PlayerId of the Avatar's owner |