Legacy Documentation: Version 5.4
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

AvatarMask

class in UnityEditor.Animations

/

Inherits from: Object

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

AvatarMask are used to mask out humanoid body parts and transforms.

They can be used when importing animation or in an animator controller layer.

Variables

transformCountNumber of transforms.

Constructors

AvatarMaskCreates a new AvatarMask.

Public Functions

GetHumanoidBodyPartActiveReturns true if the humanoid body part at the given index is active.
GetTransformActiveReturns true if the transform at the given index is active.
GetTransformPathReturns the path of the transform at the given index.
SetHumanoidBodyPartActiveSets the humanoid body part at the given index to active or not.
SetTransformActiveSets the tranform at the given index to active or not.
SetTransformPathSets the path of the transform at the given index.

Inherited members

Variables

hideFlagsShould the object be hidden, saved with the scene or modifiable by the user?
nameThe name of the object.

Public Functions

GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the game object.

Static Functions

DestroyRemoves a gameobject, component or asset.
DestroyImmediateDestroys the object obj immediately.
DontDestroyOnLoadMakes the object target not be destroyed automatically when loading a new scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateReturns a copy of the object original.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.