ParaScripting::ParaMovieCtrler Class Reference

ParaMovieCtrler object: it is used to control time based movie of character object. More...

#include <ParaScriptingCharacter.h>

Public Member Functions
bool	IsValid ()
	check if the object is valid
	ParaMovieCtrler (CMovieCtrler *pObj)
string	GetTime (const char *sFormat)
	get the local time of a module of the character More...
void	SetTime (float fTime)
	set the current time of the movie More...
void	Suspend ()
	suspend the movie
void	Resume ()
	resume the movie
void	Play ()
	play the movie
void	Record ()
	record the movie from its current position. More...
void	RecordNewDialog (const char *sDialog)
	add a new dialog record to the current time. More...
bool	RecordNewAction (const char *sActionName)
	add a new action record to the current time. More...
bool	RecordNewAction_ (const char *sActionName, float fTime)
	add a new action record to the current time. More...
void	RecordNewEffect (int effectID, const char *sTarget)
	add a new effect record to the current time. More...
void	GetOffsetPosition (float *x, float *y, float *z)
	get the offset position of the movie. More...
void	SetOffsetPosition (float x, float y, float z)
	set the offset position of the movie. More...
void	SaveMovie (const char *filename)
	save recorded movie to file. More...
void	LoadMovie (const char *filename)
	load a recorded movie from file. More...

Public Attributes
CMovieCtrler *	m_pMovieCtrler

Detailed Description

ParaMovieCtrler object: it is used to control time based movie of character object.

Member Function Documentation

GetOffsetPosition()

void ParaScripting::ParaMovieCtrler::GetOffsetPosition	(	float *	x,
		float *	y,
		float *	z
	)

get the offset position of the movie.

All movie's position key are relative to it. if there is no position key, 0,0,0 is returned e.g. x,y,z = movieCtrler:GetOffsetPosition();

GetTime()

string ParaScripting::ParaMovieCtrler::GetTime

(

const char *

sFormat

)

get the local time of a module of the character

Parameters

sFormat

the format of the time in the returning string "": in seconds Formated: The format argument consists of one or more codes; as in printf, the formatting codes are preceded by a percent sign (%). Characters that do not begin with % are copied unchanged. H : Hour in 24-hour format (00 "C 23) %M : Minute as decimal number (00 "C 59) S : Second as decimal number (00 "C 59) e.g.: GetTime("movie", "time elapsed: H:M:S");

LoadMovie()

void ParaScripting::ParaMovieCtrler::LoadMovie

(

const char *

filename

)

load a recorded movie from file.

Parameters

filename:file

path to load the movie

Record()

void ParaScripting::ParaMovieCtrler::Record

(

)

record the movie from its current position.

all movies behind will be erased.

RecordNewAction()

bool ParaScripting::ParaMovieCtrler::RecordNewAction

(

const char *

sActionName

)

add a new action record to the current time.

All trailing dialog will be removed.

RecordNewAction_()

bool ParaScripting::ParaMovieCtrler::RecordNewAction_	(	const char *	sActionName,
		float	fTime
	)

add a new action record to the current time.

All trailing dialog will be removed.

RecordNewDialog()

void ParaScripting::ParaMovieCtrler::RecordNewDialog

(

const char *

sDialog

)

add a new dialog record to the current time.

All trailing dialog will be removed.

RecordNewEffect()

void ParaScripting::ParaMovieCtrler::RecordNewEffect	(	int	effectID,
		const char *	sTarget
	)

add a new effect record to the current time.

All trailing dialog will be removed.

SaveMovie()

void ParaScripting::ParaMovieCtrler::SaveMovie

(

const char *

filename

)

save recorded movie to file.

Parameters

filename:file

path to save the movie

SetOffsetPosition()

void ParaScripting::ParaMovieCtrler::SetOffsetPosition	(	float	x,
		float	y,
		float	z
	)

set the offset position of the movie.

All movie's position key are relative to it.

SetTime()

void ParaScripting::ParaMovieCtrler::SetTime

(

float

fTime

)

set the current time of the movie

Parameters

fTime

in seconds. 0 is the beginning of the movie

---

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

• Client/trunk/ParaEngineClient/ParaScriptBindings/ParaScriptingCharacter.h
• Client/trunk/ParaEngineClient/ParaScriptBindings/ParaScriptingCharacter.cpp