Roblox UtilitiesDevlHub Roblox Documentation

Class

FaceControls

Inherits
Instance › Object
Memory category
Animation

The FaceControls object defines a set of properties for controlling the facial expressions of a Dynamic Head.

The FaceControls object defines a set of properties for controlling the facial expressions of a character head capable of animation.

The FaceControls properties are based on the Facial Action Coding System (FACS), a comprehensive system for describing all visually discernible facial movement based on anatomy. FaceControls properties can only be set between 0 and 1. Different combinations of the FaceControls property values create different facial expressions. Recording multiple facial expressions over time creates facial animation.

What is an Animatable Head?#

An animatable head is a MeshPart that implements a facial rig and is capable of playing facial animations and triggering facial expressions. A FaceControls object that is a child of a head MeshPart can change the facial expressions of the head.

A head consists of the following three components:

  • Skinned MeshPart instance for the head geometry with an internal rig that deforms this skinned MeshPart
  • FaceControls instance that drives the internal rig when properties such as FaceControls.JawDrop are changed.
  • Cage WrapTarget instance for tight fitting facial accessories

In a third-party modeling tool, such as Blender or Maya, an artist can create a joint-driven facial rig, pose the joints to match each of the individual FACS controls, and save as an FBX. When a head .FBX is imported in Studio, a facs-to-joint mapping is created. This mapping deforms the mesh geometry when FaceControls properties are changed. The mapping and the facial rig (including Bone instances) are not exposed to developers and can only be accessed through the FaceControls instance. The MeshPart for a Dynamic Head looks and behaves the same as a regular MeshPart except when a FaceControls instance is a child of the MeshPart. Editing the properties of the FaceControls deforms the MeshPart's geometry. These properties are available to animate in the Animation Editor.

See Facial animation for more information on usage and creation of an animatable head.

Animatable Heads in the Marketplace#

If you are publishing your head to the Marketplace, your head asset must include a minimum subset of face controls. Roblox's publishing validation rejects assets without the following required poses:

  • EyesLookDown
  • EyesLookLeft
  • EyesLookRight
  • EyesLookUp
  • JawDrop
  • LeftEyeClosed
  • LeftLipCornerPuller
  • LeftLipStretcher
  • LeftLowerLipDepressor
  • LeftUpperLipRaiser
  • LipsTogether
  • Pucker
  • RightEyeClosed
  • RightLipCornerPuller
  • RightLipStretcher
  • RightLowerLipDepressor
  • RightUpperLipRaiser

See FACS poses reference for more information on usage and creation of an animatable head.

Properties 50#

ChinRaiserfloatRaises the chin up; moves the lower lip upwards.ReadSafeNotReplicated
ChinRaiserUpperLipfloatMoves the upper lip when ChinRaiser is engaged and touching the upper lip.ReadSafeNotReplicated
CorrugatorfloatBrings the left and right brows inward together.ReadSafeNotReplicated
EyesLookDownfloatMoves gaze down. This is a required pose for avatars.ReadSafeNotReplicated
EyesLookLeftfloatMoves gaze left. This is a required pose for avatars.ReadSafeNotReplicated
EyesLookRightfloatMoves gaze right. This is a required pose for avatars.ReadSafeNotReplicated
EyesLookUpfloatMoves gaze up. This is a required pose for avatars.ReadSafeNotReplicated
FlatPuckerfloatAlso known as lip tightener; brings the corners of the mouth inward and pressing the lips back against the teeth.ReadSafeNotReplicated
FunnelerfloatMakes a 'O' shape with the mouth.ReadSafeNotReplicated
JawDropfloatLowers the jaw downward opening the mouth. This is a required pose for avatars.ReadSafeNotReplicated
JawLeftfloatMoves mouth and jaw to the left (character left).ReadSafeNotReplicated
JawRightfloatMoves mouth and jaw to the right (character right).ReadSafeNotReplicated
LeftBrowLowererfloatLowers the left brow down.ReadSafeNotReplicated
LeftCheekPufffloatPuffs up the left cheek.ReadSafeNotReplicated
LeftCheekRaiserfloatSquints the left eye.ReadSafeNotReplicated
LeftDimplerfloatMoves the corners of the mouth back in Z.ReadSafeNotReplicated
LeftEyeClosedfloatCloses the left eyelid. This is a required pose for avatars.ReadSafeNotReplicated
LeftEyeUpperLidRaiserfloatRaises the left eyelid upwards to reveal more of the eye white above the iris.ReadSafeNotReplicated
LeftInnerBrowRaiserfloatRaises the interior half of the left brow upwards.ReadSafeNotReplicated
LeftLipCornerDownfloatLowers the corners of the mouth downwards in a frown.ReadSafeNotReplicated
LeftLipCornerPullerfloatRaises the corners of the mouth upwards in a smile. This is a required pose for avatars.ReadSafeNotReplicated
LeftLipStretcherfloatStretches the corners of the mouth apart. This is a required pose for avatars.ReadSafeNotReplicated
LeftLowerLipDepressorfloatLowers the lower lip down away from the upper lip revealing the lower teeth. This is a required pose for avatars.ReadSafeNotReplicated
LeftNoseWrinklerfloatRaise the left nostril, pulls the brow down slightly, and wrinkles on the side of the nose.ReadSafeNotReplicated
LeftOuterBrowRaiserfloatRaises the outer part of the left brow upwards.ReadSafeNotReplicated
LeftUpperLipRaiserfloatRaises the left upper lip away from the lower lip revealing the upper teeth. This is a required pose for avatars.ReadSafeNotReplicated
LipPresserfloatPresses the lips together.ReadSafeNotReplicated
LipsTogetherfloatBrings the lips together relative to JawDrop. This is a required pose for avatars.ReadSafeNotReplicated
LowerLipSuckfloatRolls the lower lip up over the teeth.ReadSafeNotReplicated
MouthLeftfloatMoves the mouth left.ReadSafeNotReplicated
MouthRightfloatMoves the mouth right.ReadSafeNotReplicated
PuckerfloatMakes a kiss-like shape with the mouth. This is a required pose for avatars.ReadSafeNotReplicated
RightBrowLowererfloatLowers the right brow down.ReadSafeNotReplicated
RightCheekPufffloatPuffs up the right cheek.ReadSafeNotReplicated
RightCheekRaiserfloatSquints the right eye.ReadSafeNotReplicated
RightDimplerfloatMoves the corners of the mouth back in Z.ReadSafeNotReplicated
RightEyeClosedfloatCloses the right eyelid. This is a required pose for avatars.ReadSafeNotReplicated
RightEyeUpperLidRaiserfloatRaises the right eyelid upwards to reveal more of the eye white above the iris.ReadSafeNotReplicated
RightInnerBrowRaiserfloatRaises the interior half of the right brow upwards.ReadSafeNotReplicated
RightLipCornerDownfloatLowers the corners of the mouth downwards in a frown.ReadSafeNotReplicated
RightLipCornerPullerfloatRaises the corners of the mouth upwards in a smile. This is a required pose for avatars.ReadSafeNotReplicated
RightLipStretcherfloatStretches the corners of the mouth apart. This is a required pose for avatars.ReadSafeNotReplicated
RightLowerLipDepressorfloatLowers the lower lip down away from the upper lip revealing the lower teeth. This is a required pose for avatars.ReadSafeNotReplicated
RightNoseWrinklerfloatRaises the right nostril, pulls the brow down slightly, and wrinkles on the side of the nose.ReadSafeNotReplicated
RightOuterBrowRaiserfloatRaises the outer part of the right brow upwards.ReadSafeNotReplicated
RightUpperLipRaiserfloatRaises the right upper lip away from the lower lip revealing the upper teeth. This is a required pose for avatars.ReadSafeNotReplicated
TongueDownfloatBends the tongue down.ReadSafeNotReplicated
TongueOutfloatExtends the tip of the tongue out of the mouth.ReadSafeNotReplicated
TongueUpfloatBends the tongue up.ReadSafeNotReplicated
UpperLipSuckfloatRolls the upper lip around the teeth.ReadSafeNotReplicated

ChinRaiser: float#

NotReplicatedReadSafe

Raises the chin up; moves the lower lip upwards

ChinRaiserUpperLip: float#

NotReplicatedReadSafe

Moves the upper lip when ChinRaiser is engaged and touching the upper lip

Corrugator: float#

NotReplicatedReadSafe

Brings the left and right brows inward together

EyesLookDown: float#

NotReplicatedReadSafe

Moves gaze down. This is a required pose for avatars.

EyesLookLeft: float#

NotReplicatedReadSafe

Moves gaze left. This is a required pose for avatars.

EyesLookRight: float#

NotReplicatedReadSafe

Moves gaze right. This is a required pose for avatars.

EyesLookUp: float#

NotReplicatedReadSafe

Moves gaze up. This is a required pose for avatars.

FlatPucker: float#

NotReplicatedReadSafe

Also known as lip tightener; brings the corners of the mouth inward and pressing the lips back against the teeth

Funneler: float#

NotReplicatedReadSafe

Makes a 'O' shape with the mouth

JawDrop: float#

NotReplicatedReadSafe

Lowers the jaw downward opening the mouth. This is a required pose for avatars.

JawLeft: float#

NotReplicatedReadSafe

Moves the mouth and jaw to the character's left. Like all FaceControls properties, this value is clamped between 0 and 1 and defaults to 0, meaning no displacement. FaceControls.JawRight applies the opposite displacement, moving the mouth and jaw to the character's right.

JawRight: float#

NotReplicatedReadSafe

Moves mouth and jaw to the right (character right)

LeftBrowLowerer: float#

NotReplicatedReadSafe

Lowers the left brow down

LeftCheekPuff: float#

NotReplicatedReadSafe

Puffs up the left cheek

LeftCheekRaiser: float#

NotReplicatedReadSafe

Squints the left eye

LeftDimpler: float#

NotReplicatedReadSafe

Moves the corners of the mouth back in Z

LeftEyeClosed: float#

NotReplicatedReadSafe

Closes the left eyelid. This is a required pose for avatars.

LeftEyeUpperLidRaiser: float#

NotReplicatedReadSafe

Raises the left eyelid upwards to reveal more of the eye white above the iris

LeftInnerBrowRaiser: float#

NotReplicatedReadSafe

Raises the interior half of the left brow upwards

LeftLipCornerDown: float#

NotReplicatedReadSafe

Lowers the corners of the mouth downwards in a frown

LeftLipCornerPuller: float#

NotReplicatedReadSafe

Raises the corners of the mouth upwards in a smile. This is a required pose for avatars.

LeftLipStretcher: float#

NotReplicatedReadSafe

Stretches the corners of the mouth apart. This is a required pose for avatars.

LeftLowerLipDepressor: float#

NotReplicatedReadSafe

Lowers the lower lip down away from the upper lip revealing the lower teeth. This is a required pose for avatars.

LeftNoseWrinkler: float#

NotReplicatedReadSafe

Raise the left nostril, pulls the brow down slightly, and wrinkles on the side of the nose

LeftOuterBrowRaiser: float#

NotReplicatedReadSafe

Raises the outer part of the left brow upwards

LeftUpperLipRaiser: float#

NotReplicatedReadSafe

Raises the left upper lip away from the lower lip revealing the upper teeth. This is a required pose for avatars.

LipPresser: float#

NotReplicatedReadSafe

Presses the lips together

LipsTogether: float#

NotReplicatedReadSafe

Brings the lips together relative to JawDrop. This is a required pose for avatars.

LowerLipSuck: float#

NotReplicatedReadSafe

Rolls the lower lip up over the teeth

MouthLeft: float#

NotReplicatedReadSafe

Moves the mouth left

MouthRight: float#

NotReplicatedReadSafe

Moves the mouth right

Pucker: float#

NotReplicatedReadSafe

Makes a kiss-like shape with the mouth. This is a required pose for avatars.

RightBrowLowerer: float#

NotReplicatedReadSafe

Lowers the right brow down

RightCheekPuff: float#

NotReplicatedReadSafe

Puffs up the right cheek

RightCheekRaiser: float#

NotReplicatedReadSafe

Squints the right eye

RightDimpler: float#

NotReplicatedReadSafe

Moves the corners of the mouth back in Z

RightEyeClosed: float#

NotReplicatedReadSafe

Closes the right eyelid. This is a required pose for avatars.

RightEyeUpperLidRaiser: float#

NotReplicatedReadSafe

Raises the right eyelid upwards to reveal more of the eye white above the iris

RightInnerBrowRaiser: float#

NotReplicatedReadSafe

Raises the interior half of the right brow upwards

RightLipCornerDown: float#

NotReplicatedReadSafe

Lowers the corners of the mouth downwards in a frown

RightLipCornerPuller: float#

NotReplicatedReadSafe

Raises the corners of the mouth upwards in a smile. This is a required pose for avatars.

RightLipStretcher: float#

NotReplicatedReadSafe

Stretches the corners of the mouth apart. This is a required pose for avatars.

RightLowerLipDepressor: float#

NotReplicatedReadSafe

Lowers the lower lip down away from the upper lip revealing the lower teeth. This is a required pose for avatars.

RightNoseWrinkler: float#

NotReplicatedReadSafe

Raises the right nostril, pulls the brow down slightly, and wrinkles on the side of the nose

RightOuterBrowRaiser: float#

NotReplicatedReadSafe

Raises the outer part of the right brow upwards

RightUpperLipRaiser: float#

NotReplicatedReadSafe

Raises the right upper lip away from the lower lip revealing the upper teeth. This is a required pose for avatars.

TongueDown: float#

NotReplicatedReadSafe

Bends the tongue down

TongueOut: float#

NotReplicatedReadSafe

Extends the tip of the tongue out of the mouth

TongueUp: float#

NotReplicatedReadSafe

Bends the tongue up

UpperLipSuck: float#

NotReplicatedReadSafe

Rolls the upper lip around the teeth

Inherited members#

Inherited from Instance 58
Inherited from Object 6
Properties (2)

ClassName, className

Events (1)

Changed