ScummVM API documentation
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
Titanic::CPetSection Class Reference
Inheritance diagram for Titanic::CPetSection:
Titanic::CPetConversations Titanic::CPetFrame Titanic::CPetInventory Titanic::CPetRealLife Titanic::CPetRemote Titanic::CPetRooms Titanic::CPetStarfield Titanic::CPetTranslation

Public Member Functions

virtual bool setup (CPetControl *petControl)
 
virtual bool reset ()
 
virtual void draw (CScreenManager *screenManager)
 
virtual Rect getBounds () const
 
virtual void changed (int changeType)
 
virtual bool MouseButtonDownMsg (CMouseButtonDownMsg *msg)
 
virtual bool MouseDragStartMsg (CMouseDragStartMsg *msg)
 
virtual bool MouseDragMoveMsg (CMouseDragMoveMsg *msg)
 
virtual bool MouseDragEndMsg (CMouseDragEndMsg *msg)
 
virtual bool MouseButtonUpMsg (CMouseButtonUpMsg *msg)
 
virtual bool MouseDoubleClickMsg (CMouseDoubleClickMsg *msg)
 
virtual bool MouseWheelMsg (CMouseWheelMsg *msg)
 
virtual bool KeyCharMsg (CKeyCharMsg *msg)
 
virtual bool VirtualKeyCharMsg (CVirtualKeyCharMsg *msg)
 
virtual bool checkDragEnd (CGameObject *item)
 
virtual CGameObject * dragEnd (const Point &pt) const
 
virtual void displayMessage (const CString &msg)
 
virtual bool isValid (CPetControl *petControl)
 
virtual void load (SimpleFile *file, int param)
 
virtual void postLoad ()
 
virtual void save (SimpleFile *file, int indent)
 
virtual void enter (PetArea oldArea)
 
virtual void leave ()
 
virtual void proc23 ()
 
virtual void enterRoom (CRoomItem *room)
 
virtual void timerExpired (int val)
 
virtual CTextControl * getText ()
 
virtual void removeText (int duration)
 
virtual void removeText ()
 
virtual void stopTextTimer ()
 
virtual CPetElement * getElement (uint id)
 
virtual CGameObject * getBackground (int index) const
 
virtual void displayNPCName (CGameObject *npc)
 
virtual void proc33 ()
 
virtual void setNPC (const CString &name)
 
virtual void resetNPC ()
 
virtual void showCursor ()
 
virtual void hideCursor ()
 
virtual void highlight (int id)
 
CPetControl * getPetControl () const
 
uint getColor (uint index)
 
const uint * getColorTable (int tableNum=-1)
 

Public Attributes

CPetControl * _petControl
 

Protected Member Functions

void areaChanged (PetArea area)
 
CString getActiveNPCName () const
 
void copyColors (uint tableNum, uint colors[5])
 

Member Function Documentation

◆ areaChanged()

void Titanic::CPetSection::areaChanged ( PetArea  area)
protected

Called when the current area is changed

◆ getActiveNPCName()

CString Titanic::CPetSection::getActiveNPCName ( ) const
protected

Returns the name of the currently active NPC, if any

◆ copyColors()

void Titanic::CPetSection::copyColors ( uint  tableNum,
uint  colors[5] 
)
protected

Create a color table

◆ setup()

virtual bool Titanic::CPetSection::setup ( CPetControl *  petControl)
inlinevirtual

Sets up the section

Reimplemented in Titanic::CPetConversations, Titanic::CPetRemote, Titanic::CPetRooms, Titanic::CPetStarfield, Titanic::CPetInventory, Titanic::CPetFrame, Titanic::CPetRealLife, and Titanic::CPetTranslation.

◆ reset()

virtual bool Titanic::CPetSection::reset ( void  )
inlinevirtual

Reset the section

Reimplemented in Titanic::CPetConversations, Titanic::CPetRemote, Titanic::CPetRooms, Titanic::CPetStarfield, Titanic::CPetInventory, Titanic::CPetFrame, Titanic::CPetRealLife, and Titanic::CPetTranslation.

◆ draw()

virtual void Titanic::CPetSection::draw ( CScreenManager *  screenManager)
inlinevirtual

Draw the section

Reimplemented in Titanic::CPetConversations, Titanic::CPetRemote, Titanic::CPetRooms, Titanic::CPetStarfield, Titanic::CPetInventory, Titanic::CPetRealLife, and Titanic::CPetTranslation.

◆ getBounds()

virtual Rect Titanic::CPetSection::getBounds ( ) const
inlinevirtual

Get the bounds for the section

Reimplemented in Titanic::CPetConversations, Titanic::CPetInventory, and Titanic::CPetRealLife.

◆ changed()

virtual void Titanic::CPetSection::changed ( int  changeType)
inlinevirtual

Called when a general change occurs

Reimplemented in Titanic::CPetInventory.

◆ MouseButtonDownMsg()

virtual bool Titanic::CPetSection::MouseButtonDownMsg ( CMouseButtonDownMsg *  msg)
inlinevirtual

Following are handlers for the various messages that the PET can pass onto the currently active section/area

Reimplemented in Titanic::CPetConversations, Titanic::CPetRemote, Titanic::CPetInventory, Titanic::CPetRooms, Titanic::CPetStarfield, Titanic::CPetRealLife, Titanic::CPetFrame, and Titanic::CPetTranslation.

◆ checkDragEnd()

virtual bool Titanic::CPetSection::checkDragEnd ( CGameObject *  item)
inlinevirtual

Check whether a drag drop can occur

Reimplemented in Titanic::CPetRooms.

◆ dragEnd()

virtual CGameObject* Titanic::CPetSection::dragEnd ( const Point &  pt) const
inlinevirtual

Returns item a drag-drop operation has dropped on, if any

Reimplemented in Titanic::CPetInventory, and Titanic::CPetRealLife.

◆ displayMessage()

virtual void Titanic::CPetSection::displayMessage ( const CString &  msg)
virtual

Display a message

Reimplemented in Titanic::CPetConversations, and Titanic::CPetRooms.

◆ isValid()

virtual bool Titanic::CPetSection::isValid ( CPetControl *  petControl)
inlinevirtual

Returns true if the object is in a valid state

Reimplemented in Titanic::CPetConversations, Titanic::CPetRemote, Titanic::CPetRooms, Titanic::CPetInventory, Titanic::CPetStarfield, Titanic::CPetRealLife, Titanic::CPetFrame, and Titanic::CPetTranslation.

◆ load()

virtual void Titanic::CPetSection::load ( SimpleFile *  file,
int  param 
)
inlinevirtual

Load the data for the class from file

Reimplemented in Titanic::CPetConversations, Titanic::CPetRooms, Titanic::CPetInventory, Titanic::CPetStarfield, Titanic::CPetRealLife, and Titanic::CPetTranslation.

◆ postLoad()

virtual void Titanic::CPetSection::postLoad ( )
inlinevirtual

Called after a game has been loaded

Reimplemented in Titanic::CPetConversations, Titanic::CPetRemote, Titanic::CPetRooms, Titanic::CPetInventory, Titanic::CPetStarfield, Titanic::CPetRealLife, Titanic::CPetTranslation, and Titanic::CPetFrame.

◆ save()

virtual void Titanic::CPetSection::save ( SimpleFile *  file,
int  indent 
)
inlinevirtual

Save the data for the class to file

Reimplemented in Titanic::CPetConversations, Titanic::CPetRooms, Titanic::CPetInventory, Titanic::CPetStarfield, Titanic::CPetRealLife, and Titanic::CPetTranslation.

◆ enter()

virtual void Titanic::CPetSection::enter ( PetArea  oldArea)
inlinevirtual

Called when a section is switched to

Reimplemented in Titanic::CPetConversations, Titanic::CPetRooms, Titanic::CPetInventory, Titanic::CPetRemote, and Titanic::CPetRealLife.

◆ leave()

virtual void Titanic::CPetSection::leave ( )
inlinevirtual

Called when a section is being left, to switch to another area

Reimplemented in Titanic::CPetConversations, Titanic::CPetInventory, and Titanic::CPetRealLife.

◆ enterRoom()

virtual void Titanic::CPetSection::enterRoom ( CRoomItem *  room)
inlinevirtual

Called when a new room is entered

Reimplemented in Titanic::CPetRooms, Titanic::CPetRemote, Titanic::CPetRealLife, and Titanic::CPetInventory.

◆ timerExpired()

virtual void Titanic::CPetSection::timerExpired ( int  val)
virtual

Called when a previously set up PET timer expires

Reimplemented in Titanic::CPetConversations.

◆ getText()

virtual CTextControl* Titanic::CPetSection::getText ( )
inlinevirtual

Get a reference to the tooltip text associated with the section

Reimplemented in Titanic::CPetRooms, Titanic::CPetInventory, Titanic::CPetRemote, Titanic::CPetRealLife, and Titanic::CPetTranslation.

◆ removeText() [1/2]

virtual void Titanic::CPetSection::removeText ( int  duration)
virtual

Removes text after a given duration

◆ removeText() [2/2]

virtual void Titanic::CPetSection::removeText ( )
virtual

Removes text after a given duration

◆ stopTextTimer()

virtual void Titanic::CPetSection::stopTextTimer ( )
virtual

Stops the text removal timer

◆ getElement()

virtual CPetElement* Titanic::CPetSection::getElement ( uint  id)
inlinevirtual

Get an element from the section by a designated Id

Reimplemented in Titanic::CPetRemote.

◆ getBackground()

virtual CGameObject* Titanic::CPetSection::getBackground ( int  index) const
inlinevirtual

Special retrieval of glyph background image

Reimplemented in Titanic::CPetRooms, and Titanic::CPetInventory.

◆ displayNPCName()

virtual void Titanic::CPetSection::displayNPCName ( CGameObject *  npc)
inlinevirtual

Display a title for an NPC

Reimplemented in Titanic::CPetConversations.

◆ setNPC()

virtual void Titanic::CPetSection::setNPC ( const CString &  name)
inlinevirtual

Sets the NPC to use

Reimplemented in Titanic::CPetConversations.

◆ resetNPC()

virtual void Titanic::CPetSection::resetNPC ( )
inlinevirtual

Resets the active NPC

Reimplemented in Titanic::CPetConversations.

◆ showCursor()

virtual void Titanic::CPetSection::showCursor ( )
inlinevirtual

Show the text cursor

Reimplemented in Titanic::CPetConversations.

◆ hideCursor()

virtual void Titanic::CPetSection::hideCursor ( )
inlinevirtual

Hide the text cursor

Reimplemented in Titanic::CPetConversations.

◆ highlight()

virtual void Titanic::CPetSection::highlight ( int  id)
inlinevirtual

Highlights a glyph item in the section, if applicable

Reimplemented in Titanic::CPetRemote.

◆ getPetControl()

CPetControl* Titanic::CPetSection::getPetControl ( ) const
inline

Get the PET control

◆ getColor()

uint Titanic::CPetSection::getColor ( uint  index)

Get a specified color in the currently active UI color table

◆ getColorTable()

const uint* Titanic::CPetSection::getColorTable ( int  tableNum = -1)

Get one of the game's three UI color tables. If the default tableNum of -1 is used, the table is taken from the game state

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