ScummVM API documentation
Stark::Button Class Reference

Public Types

enum  HintAlign { kAlignLeft, kAlignRight }
 

Public Member Functions

 Button (const Common::String &text, StaticProvider::UIElement stockElement, const Common::Point &pos, HintAlign align, const Common::Point &hintPos)
 
void setPosition (const Common::Point &pos)
 
void setUIElement (const StaticProvider::UIElement &stockElement)
 
void showButtonHint ()
 
void render ()
 
bool containsPoint (const Common::Point &point)
 
void resetHintVisual ()
 
void goToAnimStatement (int animScriptItemIndex)
 
void startImageExplosion (VisualImageXMG *image)
 
void stopImageExplosion ()
 
void startImageFlashing (VisualImageXMG *image)
 
void stopImageFlashing ()
 

Member Function Documentation

◆ showButtonHint()

void Stark::Button::showButtonHint ( )

Set hint to render for one frame

◆ resetHintVisual()

void Stark::Button::resetHintVisual ( )

Reset the hint text visual so it is rebuilt with the appropriate size

◆ goToAnimStatement()

void Stark::Button::goToAnimStatement ( int  animScriptItemIndex)

Move execution of the button's icon anim script to the specified item

◆ startImageExplosion()

void Stark::Button::startImageExplosion ( VisualImageXMG image)

Start overlaying an explosion animation of an image on top of the button

◆ stopImageExplosion()

void Stark::Button::stopImageExplosion ( )

Remove the currently playing exploding image animation, if any

◆ startImageFlashing()

void Stark::Button::startImageFlashing ( VisualImageXMG image)

Start a flash animation of an image button

◆ stopImageFlashing()

void Stark::Button::stopImageFlashing ( )

Remove the currently playing flash image animation, if any


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