ScummVM API documentation
Mohawk::RivenHotspot Class Reference

#include <riven_card.h>

Public Member Functions

 RivenHotspot (MohawkEngine_Riven *vm, Common::ReadStream *stream)
 
RivenScriptPtr getScript (uint16 scriptType) const
 
void enable (bool e)
 
bool isEnabled () const
 
bool isZip () const
 
Common::Rect getRect () const
 
bool containsPoint (const Common::Point &point) const
 
void setRect (const Common::Rect &rect)
 
uint16 getMouseCursor () const
 
Common::String getName () const
 
int16 getNameId () const
 
uint16 getIndex () const
 
uint16 getBlstId () const
 
int16 getTransitionOffset () const
 
void dump () const
 
void applyScriptPatches (uint32 cardGlobalId)
 
void applyPropertiesPatches (uint32 cardGlobalId)
 

Detailed Description

A Card Hotspot

Hotspots are named rectangular areas of the view. Hotspots can be interactive through their scripts.

Member Function Documentation

◆ getScript()

RivenScriptPtr Mohawk::RivenHotspot::getScript ( uint16  scriptType) const

Get the one of the hotspot's scripts

◆ enable()

void Mohawk::RivenHotspot::enable ( bool  e)

Enable or disable the hotspot

◆ isEnabled()

bool Mohawk::RivenHotspot::isEnabled ( ) const

Can the hotspot be interacted with?

◆ isZip()

bool Mohawk::RivenHotspot::isZip ( ) const

Is the hotspot's purpose to zip to another card

◆ getRect()

Common::Rect Mohawk::RivenHotspot::getRect ( ) const

Get the hotspot'a rect in Card coordinates

◆ containsPoint()

bool Mohawk::RivenHotspot::containsPoint ( const Common::Point point) const

Does the hotspot contain the specified point?

◆ setRect()

void Mohawk::RivenHotspot::setRect ( const Common::Rect rect)

Override the hotspot's default rect

◆ getMouseCursor()

uint16 Mohawk::RivenHotspot::getMouseCursor ( ) const

Get the default mouse cursor id to be used when hovering the hostpot

◆ getName()

Common::String Mohawk::RivenHotspot::getName ( ) const

Get the hotspot's name from the current stack's name list

◆ getNameId()

int16 Mohawk::RivenHotspot::getNameId ( ) const

Get the hotspot's name id

◆ getIndex()

uint16 Mohawk::RivenHotspot::getIndex ( ) const

Get the hotspot's order in the view

◆ getBlstId()

uint16 Mohawk::RivenHotspot::getBlstId ( ) const

Get the hotspot's enable list id

◆ getTransitionOffset()

int16 Mohawk::RivenHotspot::getTransitionOffset ( ) const

Get the offset used to control overlap during transitions

-1 means no overlap.

◆ dump()

void Mohawk::RivenHotspot::dump ( ) const

Write all of the hotspot's data to standard output

◆ applyScriptPatches()

void Mohawk::RivenHotspot::applyScriptPatches ( uint32  cardGlobalId)

Apply patches to the hotspot's scripts to fix bugs in the original game scripts

◆ applyPropertiesPatches()

void Mohawk::RivenHotspot::applyPropertiesPatches ( uint32  cardGlobalId)

Apply patches to the hotspot's properties to fix bugs in the original game scripts


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