FaceFX Support

FaceFX Documentation and support

FaceFX Commands

Useful Commands

Below is a list of useful commands.  The list is not complete, but the syntax of most commands can be learned by doing an operation in FaceFX Studio then watching the Console Tab for the executed command. 

• actorxml
• analyze
• anim
• animgroup
• animset
• animtree
• batch
• bonepose
• closeactor
• cook
• currenttime
• curve
• developer
• error
• event
• exec
• execbatch
• exit
• exportframe
• fbx
• fgcollapse 
• flushundo
• get
• graph
• key
• loadactor
• map
• newactor
• nodegroup
• ogre
• phonlist
• play
• previewanim
• print
• publish
• quit
• redo
• rename
• renameactor
• render
• saveactor
• select
• set
• setname
• smooth
• stop
• template
• undo
• warn

Command Interface

FaceFX Studio uses a command system internally to implement undo /redo and to log information about the FaceFX Studio session. Users can take advantage of the command system to perform batch operations. The most recent commands are printed to the Console Tab and an archive of all commands are printed to the FaceFxStudioLog.txt file in the Logs directory of the FaceFX Studio folder in My Documents. Some of the most useful commands are listed above for easy reference.

Entering commands

Commands can be entered in several ways:

1. Directly from the comand prompt at the bottom left of the application. 
2. From the python shell of the Console Tab.  Precede FaceFX commands with %
3. From a python file executed with the exec command or from the DOS prompt by using the FaceFX Studio python module’s issueCommand function.  (See Scripts folder for examples).
4. From an FXL file which is executed with the exec command.
5. From an FXL file which is automatically executed.

Syntax

• Semicolon – Every FaceFX Studio command should end with a semicolon (;).
• Comments – The following characters are used to start a comment line: “//”
• Spaces - Multiple spaces will be reduced to a single space unless the spaces are encapsulated in quotes. no spaces are allowed in between a Flag and the Flag’s argument.
• Case sensitive – FaceFX Studio commands are case sensitive.
• Flags – Most commands can accept one or more flags. Flags are preceded by the dash character: “-“. Flags are used to set options in the command or pass variables to the command. Some flags are optional while others are mandatory. The following example of the select command uses three flags: select -type “node” -names “Happy” -nozoom;
• Strings Separator – The pipe character “|” is used to separate strings in commands. Names of nodes, animation curves, and other objects used by FaceFX Studio can not contain the pipe character to avoid complications with the script interface.
• Brackets - Brackets “[” and “]” can be used to encapsulate native python code inside of an FXL file, or any place where FaceFX commands are called.