ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Scroll position for a location. More...

#include <scroll.h>

Inheritance diagram for Stark::Resources::Scroll:
Collaboration diagram for Stark::Resources::Scroll:

List of all members.

Public Member Functions

 Scroll (Object *parent, byte subType, uint16 index, const Common::String &name)
virtual ~Scroll ()
void readData (Formats::XRCReadStream *stream) override
 Deserialize the resource static data and initial state.
void onGameLoop () override
 Called once per game loop.
void saveLoadCurrent (ResourceSerializer *serializer) override
 Persist / restore the resource state.
void start ()
 Start scrolling the location to this position.
void stop ()
 Stop scrolling the location from this object.
bool isActive ()
 Is this scroll currently running?
void applyToLocationImmediate ()
 Scroll the location to this position, with immediate effect.

Static Public Attributes

static const Type::ResourceType TYPE = Type::kScroll

Protected Member Functions

void printData () override

Protected Attributes

uint32 _coordinate
uint32 _field_30
uint32 _field_34
uint32 _bookmarkIndex
bool _active

Detailed Description

Scroll position for a location.

Definition at line 41 of file scroll.h.


Constructor & Destructor Documentation

Stark::Resources::Scroll::Scroll ( Object parent,
byte  subType,
uint16  index,
const Common::String name 
)

Definition at line 35 of file scroll.cpp.

Stark::Resources::Scroll::~Scroll (  )  [virtual]

Definition at line 32 of file scroll.cpp.


Member Function Documentation

void Stark::Resources::Scroll::applyToLocationImmediate (  ) 

Scroll the location to this position, with immediate effect.

Definition at line 45 of file scroll.cpp.

bool Stark::Resources::Scroll::isActive (  ) 

Is this scroll currently running?

Definition at line 61 of file scroll.cpp.

void Stark::Resources::Scroll::onGameLoop (  )  [override, virtual]

Called once per game loop.

Reimplemented from Stark::Resources::Object.

Definition at line 65 of file scroll.cpp.

void Stark::Resources::Scroll::printData (  )  [override, protected, virtual]

Reimplemented from Stark::Resources::Object.

Definition at line 93 of file scroll.cpp.

void Stark::Resources::Scroll::readData ( Formats::XRCReadStream stream  )  [override, virtual]

Deserialize the resource static data and initial state.

Reimplemented from Stark::Resources::Object.

Definition at line 78 of file scroll.cpp.

void Stark::Resources::Scroll::saveLoadCurrent ( ResourceSerializer serializer  )  [override, virtual]

Persist / restore the resource state.

Called only for active locations

Reimplemented from Stark::Resources::Object.

Definition at line 85 of file scroll.cpp.

void Stark::Resources::Scroll::start (  ) 

Start scrolling the location to this position.

Definition at line 50 of file scroll.cpp.

void Stark::Resources::Scroll::stop (  ) 

Stop scrolling the location from this object.

Definition at line 57 of file scroll.cpp.


Member Data Documentation

Definition at line 73 of file scroll.h.

Definition at line 71 of file scroll.h.

Definition at line 68 of file scroll.h.

Definition at line 69 of file scroll.h.

Definition at line 70 of file scroll.h.

const Type::ResourceType Stark::Resources::Scroll::TYPE = Type::kScroll [static]

Definition at line 43 of file scroll.h.


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


Generated on Sat May 18 2019 05:07:36 for ResidualVM by doxygen 1.7.1
curved edge   curved edge