Gob::SEQFile Class Reference

#include <seqfile.h>

Inheritance diagram for Gob::SEQFile:

Public Member Functions
	SEQFile (GobEngine *vm, const Common::String &fileName)
void	play (bool abortable=true, uint16 endFrame=0xFFFF, uint16 frameRate=0)

Protected Member Functions
uint16	getFrame () const
void	seekFrame (uint16 frame)
uint	addLoop (uint16 startFrame, uint16 endFrame, uint16 loopCount)
void	skipLoop (uint loopID)
void	delLoop (uint loopID)
void	abortPlay ()
virtual void	handleFrameEvent ()
virtual void	handleInput (int16 key, int16 mouseX, int16 mouseY, MouseButtons mouseButtons)

Protected Attributes
GobEngine *	_vm

Detailed Description

A SEQ file, describing a complex animation sequence.

Used in early hardcoded gob games. The principle is similar to the Mult class (see mult.h), but instead of depending on all the externally loaded animations, backgrounds and objects, a SEQ file references animation and background directly by filename.

Member Function Documentation

play()

void Gob::SEQFile::play	(	bool	abortable = true,
		uint16	endFrame = 0xFFFF,
		uint16	frameRate = 0
	)

Play the SEQ.

Parameters

abortable	If true, end playback on any user input.
endFrame	The frame on where to end, or 0xFFFF for infinite playback.
frameRate	The frame rate at which to play the SEQ, or 0 for playing at the speed the SEQ itself wants to.

getFrame()

uint16 Gob::SEQFile::getFrame ( ) const

protected

Returns the current frame number.

seekFrame()

void Gob::SEQFile::seekFrame ( uint16  frame )

protected

Seek to a specific frame.

addLoop()

uint Gob::SEQFile::addLoop ( uint16  startFrame, uint16  endFrame, uint16  loopCount  )

protected

Add a frame loop.

skipLoop()

void Gob::SEQFile::skipLoop ( uint  loopID )

protected

Skip a frame loop.

delLoop()

void Gob::SEQFile::delLoop ( uint  loopID )

protected

Delete a frame loop.

abortPlay()

void Gob::SEQFile::abortPlay ( )

protected

Ends SEQ playback.

handleFrameEvent()

virtual void Gob::SEQFile::handleFrameEvent ( )

protectedvirtual

Callback for special frame events.

Reimplemented in Gob::OnceUpon::Parents, and Gob::OnceUpon::Title.

handleInput()

virtual void Gob::SEQFile::handleInput ( int16  key, int16  mouseX, int16  mouseY, MouseButtons  mouseButtons  )

protectedvirtual

Callback for special user input handling.

Reimplemented in Gob::OnceUpon::Parents.

---

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

• engines/gob/pregob/seqfile.h