Stark::Resources::Scroll Class Reference

#include <scroll.h>

Inheritance diagram for Stark::Resources::Scroll:

Public Member Functions
	Scroll (Object *parent, byte subType, uint16 index, const Common::String &name)
void	readData (Formats::XRCReadStream *stream) override
void	onGameLoop () override
void	saveLoadCurrent (ResourceSerializer *serializer) override
void	start ()
void	stop ()
bool	isActive ()
void	applyToLocationImmediate ()
Public Member Functions inherited from Stark::Resources::Object
Type	getType () const
byte	getSubType () const
uint16	getIndex () const
Common::String	getIndexAsString () const
Common::String	getName () const
virtual void	saveLoad (ResourceSerializer *serializer)
virtual void	onPostRead ()
virtual void	onAllLoaded ()
virtual void	onEnterLocation ()
virtual void	onEnginePause (bool pause)
virtual void	onExitLocation ()
virtual void	onPreDestroy ()
template<class T >
T *	findParent ()
Object *	findChildWithIndex (Type type, uint16 index, int subType=-1) const
Object *	findChildWithOrder (Type type, uint16 order, int subType=-1) const
Object *	findChildWithName (Type type, const Common::String &name, int subType=-1) const
template<class T >
T *	findChild (bool mustBeUnique=true) const
template<class T >
T *	findChildWithSubtype (int subType, bool mustBeUnique=true) const
template<class T >
T *	findChildWithIndex (uint16 index, int subType=-1) const
template<class T >
T *	findChildWithOrder (uint16 order, int subType=-1) const
template<class T >
T *	findChildWithName (const Common::String &name, int subType=-1) const
template<class T >
Common::Array< T * >	listChildren (int subType=-1) const
template<class T >
Common::Array< T * >	listChildrenRecursive (int subType=-1)
void	addChild (Object *child)
virtual void	print (uint depth=0)
template<>
Object *	cast (Object *resource)
template<>
Object *	findParent ()
template<>
Common::Array< Object * >	listChildren (int subType) const

Static Public Attributes
static const Type::ResourceType	TYPE = Type::kScroll

Protected Member Functions
void	printData () override
Protected Member Functions inherited from Stark::Resources::Object
	Object (Object *parent, byte subType, uint16 index, const Common::String &name)
void	printWithDepth (uint depth, const Common::String &string) const
void	printDescription (uint depth) const

Protected Attributes
uint32	_coordinate
uint32	_field_30
uint32	_field_34
uint32	_bookmarkIndex
bool	_active
Protected Attributes inherited from Stark::Resources::Object
Type	_type
byte	_subType
uint16	_index
Common::String	_name
Object *	_parent
Common::Array< Object * >	_children

Additional Inherited Members
Static Public Member Functions inherited from Stark::Resources::Object
template<class T >
static T *	cast (Object *resource)

Detailed Description

Scroll position for a location

Member Function Documentation

readData()

void Stark::Resources::Scroll::readData ( Formats::XRCReadStream *  stream )

overridevirtual

Deserialize the resource static data and initial state.

Reimplemented from Stark::Resources::Object.

onGameLoop()

void Stark::Resources::Scroll::onGameLoop ( )

overridevirtual

Called once per game loop

Reimplemented from Stark::Resources::Object.

saveLoadCurrent()

void Stark::Resources::Scroll::saveLoadCurrent ( ResourceSerializer *  serializer )

overridevirtual

Persist / restore the resource state

Called only for active locations

Reimplemented from Stark::Resources::Object.

start()

void Stark::Resources::Scroll::start

(

)

Start scrolling the location to this position

stop()

void Stark::Resources::Scroll::stop

(

)

Stop scrolling the location from this object

isActive()

bool Stark::Resources::Scroll::isActive

(

)

Is this scroll currently running?

applyToLocationImmediate()

void Stark::Resources::Scroll::applyToLocationImmediate

(

)

Scroll the location to this position, with immediate effect

---

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

• engines/stark/resources/scroll.h