ScummVM API documentation
Stark::StaticProvider Class Reference

#include <staticprovider.h>

Public Types

enum  UIElement {
  kInventoryScrollUpArrow = 1, kInventoryScrollDownArrow = 2, kImages = 4, kActionMenuBg = 5,
  kTextScrollUpArrow = 6, kTextScrollDownArrow = 7, kQuit = 8, kCheckMark = 13,
  kVolume = 14, kDiaryNormal = 15, kInventory = 16, kExitArrow = 17,
  kExitArrowLeft = 18, kExitArrowRight = 19, kTextBackgroundActive = 20, kTextBackgroundPassive = 21,
  kDiaryTabbed = 22
}
 
enum  UIImage { kInventoryBg = 0, kDialogOptionBullet = 4 }
 
enum  UISound { kActionMouthHover = 0, kActionHover = 1, kInventoryNewItem = 2 }
 

Public Member Functions

 StaticProvider (ArchiveLoader *archiveLoader)
 
void init ()
 
void onGameLoop ()
 
void shutdown ()
 
Resources::LevelgetLevel () const
 
VisualImageXMGgetCursorImage (uint32 cursor) const
 
VisualImageXMGgetUIElement (UIElement element) const
 
VisualImageXMGgetUIElement (UIElement element, uint32 index) const
 
VisualImageXMGgetUIImage (UIImage image) const
 
Resources::SoundgetUISound (UISound sound) const
 
void goToAnimScriptStatement (UIElement stockUIElement, int animScriptItemIndex)
 
Resources::LocationloadLocation (const char *locationName)
 
bool isStaticLocation () const
 
Resources::LocationgetLocation () const
 
Resources::SoundgetLocationSound (uint16 index) const
 
void unloadLocation (Resources::Location *location)
 

Detailed Description

Static Resource provider.

Maintains the static resource trees. Maintained trees are the level and the location ones.

Member Function Documentation

◆ init()

void Stark::StaticProvider::init ( )

Load the static level archive

◆ onGameLoop()

void Stark::StaticProvider::onGameLoop ( )

State update loop

◆ shutdown()

void Stark::StaticProvider::shutdown ( )

Release the static resources

◆ getLevel()

Resources::Level* Stark::StaticProvider::getLevel ( ) const
inline

Obtain the static level

◆ getCursorImage()

VisualImageXMG* Stark::StaticProvider::getCursorImage ( uint32  cursor) const

Get an image for a static cursor

◆ getUIElement()

VisualImageXMG* Stark::StaticProvider::getUIElement ( UIElement  element) const

Get an image for a static UI element

◆ getUIImage()

VisualImageXMG* Stark::StaticProvider::getUIImage ( UIImage  image) const

Get an image for a static UI element

◆ getUISound()

Resources::Sound* Stark::StaticProvider::getUISound ( UISound  sound) const

Get a static UI sound resource

◆ goToAnimScriptStatement()

void Stark::StaticProvider::goToAnimScriptStatement ( UIElement  stockUIElement,
int  animScriptItemIndex 
)

Move execution of a static UI element anim script to the specified item

◆ loadLocation()

Resources::Location* Stark::StaticProvider::loadLocation ( const char *  locationName)

Load a static location and set it as current

◆ isStaticLocation()

bool Stark::StaticProvider::isStaticLocation ( ) const

Is a static location currently loaded?

◆ getLocation()

Resources::Location* Stark::StaticProvider::getLocation ( ) const

Obtain the currently loaded static location, if any

◆ getLocationSound()

Resources::Sound* Stark::StaticProvider::getLocationSound ( uint16  index) const

Look up a sound resource in the current static location by its index

◆ unloadLocation()

void Stark::StaticProvider::unloadLocation ( Resources::Location location)

Unload the current static location


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