FaceFX Documentation and support
In FaceFX, emoticons are sequences of punctuation that represent abbreviated Event Text Tags. Internally, emoticons are converted to their equivalent event text tag prior to analysis, but they are useful for inserting event text tags rapidly when typing. Emoticons can be one of two types: Phrase Events, and Punctuation Events.
Phrase Events are created by sequences of the following punctuation characters:
,.!?
When one of these characters is found in the text, it represents the end of any prior phrase event, and the beginning of new one. Normal use of these characters will result in a useful sequence of events that breaks a line of dialogue into phrases. For example:
INPUT: Quick to type, easy to remember.
OUTPUT: {PhraseEvents|,} Quick to type {/PhraseEvents|,} {PhraseEvents|.} easy to remember {/PhraseEvents|.}
Read Event Text Tags for help understanding the above syntax, but notice that there are opening and closing tags for two events in the PhraseEvents group. Making a character raise her eyebrows when she asks a question is therefore as easy as creating a ? animation in the PhraseEvents group.
The Phrase Event system treats multi-character sequences the same as single-character sequences. As a result, the system can accommodate many different events if multiple phrase-delimiting punctuation characters are used together:
INPUT: No way!! Are you kidding me??
OUTPUT: {PhraseEvents|!!} No way {/PhraseEvents|!!} {PhraseEvents|??} Are you kidding me {/PhraseEvents|??}
Punctuation Events are created by a solitary character from the following set:
~@#$%^&*()-_=+;:’`
Unlike Phrase events, which work together to define the opening and closing of the event text tag, Punctuation Events are independent from each other, and always have duration of 1.0.
INPUT: Very common & animations need # easy emoticons
OUTPUT: Very common {PunctuationEvents|&} animations need {PunctuationEvents|#} easy emoticons
Notice that there are no closing tags for these events. As a result, the duration will be the default value of 1.0
There are a finite number of punctuation characters, and thus a finite number of punctuation events that can be created, so these events should be used for very common animations. Keep in mind that you can always use Emoticon Events with no text in between the opening and closing emoticons to create other animations with duration of 1.
Apostrophe character:The apostrophe character will only create a punctuation event if it is not part of a word. For example the word can’t will not produce an event.
Emoticon Events are created by two or more characters from the following set (the same set as Punctuation Events):
~@#$%^&*()-_=+;:’`
When two or more consecutive punctuation characters are found, a matching sequence must be used later in the text in order to define the event open and close times. Each sequence pair will create a single event.
INPUT: :) I am happy :) :( Now I am sad :(
OUTPUT: {EmoticonEvents|:)} I am happy {/EmoticonEvents|:)} {EmoticonEvents|:(} Now I am sad {/EmoticonEvents|:(}
To achieve a duration scale of 1.0, simply create consecutive tags with a space between them:
INPUT: I like to smile :) :)
OUTPUT: I like to smile {EmoticonEvents|:)}
Note: It is important to note, that while the smiley emoticon is used in the above example, it has no significance to FaceFX other than being recognized as a sequence of punctuation characters that is converted into an event. It is up to the user to define what the smiley emoticon does.
Keep an eye on the console tab in the warnings section if you are troubleshooting an emoticon issue. The Emoticon preprocessor will communicate any issues there.