Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

AvatarMask

class in UnityEngine

/

Inherits from:Object

/

Implemented in:UnityEngine.AnimationModule

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

Submission failed

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

Close

Cancel

Switch to Manual

Description

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

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

Properties

transformCountNumber of transforms.

Constructors

AvatarMaskCreates a new AvatarMask.

Public Methods

AddTransformPathAdds a transform path into the AvatarMask.
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.
RemoveTransformPathRemoves a transform path from the AvatarMask.
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

Properties

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

Public Methods

GetInstanceIDGets the instance ID of the object.
ToStringReturns the name of the object.

Static Methods

DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindAnyObjectByTypeRetrieves any active loaded object of Type type.
FindFirstObjectByTypeRetrieves the first active loaded object of Type type.
FindObjectsByTypeRetrieves a list of all loaded objects of Type type.
InstantiateClones the object original and returns the clone.
InstantiateAsyncCaptures a snapshot of the original object (that must be related to some GameObject) and returns the AsyncInstantiateOperation.

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.