PixelCrushers.DialogueSystem.FaceFX.FaceFXPlayer Class Reference

FaceFXPlayer provides a simplified interface to Doug Perkowski's FaceFXControllerScript. More...

Inheritance diagram for PixelCrushers.DialogueSystem.FaceFX.FaceFXPlayer:

Collaboration diagram for PixelCrushers.DialogueSystem.FaceFX.FaceFXPlayer:

Public Member Functions
void	Play (string animName)
	Play a FaceFX animation without audio. More...
void	Play (string animName, string audioName)
	Play a FaceFX animation and corresponding audio. More...
void	Stop ()
	Stops the currently playing FaceFX line. More...

Static Public Attributes
const int	FACEFX_ANIMATION_LAYER = 9
const int	FACEFX_READY = 0

Properties
bool	IsPlaying [get]
	Indicates whether the FaceFXPlayer is currently playing a FaceFX line. More...

Detailed Description

FaceFXPlayer provides a simplified interface to Doug Perkowski's FaceFXControllerScript.

It's based on Doug's sample script.

Member Function Documentation

Play() [1/2]

void PixelCrushers.DialogueSystem.FaceFX.FaceFXPlayer.Play

(

string

animName

)

Play a FaceFX animation without audio.

Parameters

animName

Animation name.

Play() [2/2]

void PixelCrushers.DialogueSystem.FaceFX.FaceFXPlayer.Play	(	string	animName,
		string	audioName
	)

Play a FaceFX animation and corresponding audio.

Parameters

animName	Animation name.
audioName	Audio name.

Stop()

void PixelCrushers.DialogueSystem.FaceFX.FaceFXPlayer.Stop

(

)

Stops the currently playing FaceFX line.

Member Data Documentation

FACEFX_ANIMATION_LAYER

const int PixelCrushers.DialogueSystem.FaceFX.FaceFXPlayer.FACEFX_ANIMATION_LAYER = 9

static

FACEFX_READY

const int PixelCrushers.DialogueSystem.FaceFX.FaceFXPlayer.FACEFX_READY = 0

static

Property Documentation

IsPlaying

bool PixelCrushers.DialogueSystem.FaceFX.FaceFXPlayer.IsPlaying

get

Indicates whether the FaceFXPlayer is currently playing a FaceFX line.

true if playing; otherwise, false.

---

The documentation for this class was generated from the following file:

• D:/Documents/Unity Projects/Dialogue System/Dev/Integration/FaceFX Integration/Assets/Dialogue System/Third Party Support/FaceFX/Scripts/FaceFXPlayer.cs