ScummVM API documentation
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Public Member Functions | Public Attributes | Protected Attributes | List of all members
Titanic::CBackground Class Reference
Inheritance diagram for Titanic::CBackground:
Titanic::CGameObject Titanic::CNamedItem Titanic::CTreeItem Titanic::CMessageTarget Titanic::CSaveableObject Titanic::CArbBackground Titanic::CArboretumGate Titanic::CAutoAnimate Titanic::CBomb Titanic::CBridgeView Titanic::CBrokenPellBase Titanic::CCage Titanic::CCaptainsWheel Titanic::CCellPointButton Titanic::CChickenDispensor Titanic::CCloseBrokenPel Titanic::CComputer Titanic::CCreditsButton Titanic::CEjectPhonographButton Titanic::CEmmaControl Titanic::CGamesConsole Titanic::CHammerDispensor Titanic::CHeadSmashEvent Titanic::CHeadSmashLever Titanic::CLemonDispensor Titanic::CLight Titanic::CLightSwitch Titanic::CLittleLiftButton Titanic::CMusicalInstrument Titanic::CMusicControl Titanic::CNoNutBowl Titanic::CPlayMusicButton Titanic::CPlayOnAct Titanic::CRecordPhonographButton Titanic::CReplacementEar Titanic::CSauceDispensor Titanic::CSeasonalAdjustment Titanic::CSeasonBackground Titanic::CSeasonBarrel Titanic::CServiceElevatorWindow Titanic::CSGTStateControl Titanic::CSGTStateRoom Titanic::CShipSetting Titanic::CSpeechDispensor Titanic::CStartAction Titanic::CSTButton Titanic::CStopPhonographButton Titanic::CTelevision Titanic::CThirdClassCanal Titanic::CToggleButton Titanic::CTurnOnObject Titanic::CTurnOnTurnOff Titanic::CWheelButton Titanic::CWheelHotSpot Titanic::CWheelSpin

Public Member Functions

void save (SimpleFile *file, int indent) override
 
void load (SimpleFile *file) override
 
- Public Member Functions inherited from Titanic::CGameObject
void save (SimpleFile *file, int indent) override
 
void load (SimpleFile *file) override
 
const CMovieClipList * getMovieClips () const override
 
void draw (CScreenManager *screenManager) override
 
Rect getBounds () const override
 
void freeSurface () override
 
void draw (CScreenManager *screenManager, const Rect &destRect, const Rect &srcRect)
 
void draw (CScreenManager *screenManager, const Point &destPos)
 
void draw (CScreenManager *screenManager, const Point &destPos, const Rect &srcRect)
 
virtual bool isPet () const
 
bool checkPoint (const Point &pt, bool ignoreSurface=false, bool visibleOnly=false)
 
bool findPoint (Quadrant quadrant, Point &pt)
 
void setPosition (const Point &newPos)
 
Point getControid () const
 
void playMovie (uint flags)
 
void playMovie (int startFrame, int endFrame, uint flags)
 
void playMovie (int startFrame, int endFrame, int initialFrame, uint flags)
 
bool hasActiveMovie () const
 
void stopMovie ()
 
void movieSetPlaying (bool flag)
 
int getMovieFrame () const
 
int getFrameNumber () const
 
void loadFrame (int frameNumber)
 
void loadSurface ()
 
void makeDirty ()
 
void makeDirty (const Rect &r)
 
void setVisible (bool val)
 
PassengerClass getPassengerClass () const
 
PassengerClass getPriorClass () const
 
void setMailDest (uint roomFlags)
 
bool surfaceHasFrame () const
 
Found find (const CString &name, CGameObject **item, int findAreas)
 
CGameObject * getHiddenObject (const CString &name) const
 
void dragMove (const Point &pt)
 
CGameObject * getDraggingObject () const
 
void createCredits ()
 
void setText (const CString &str, int border=0, int borderRight=0)
 
void setTextHasBorders (bool hasBorders)
 
void setTextBounds ()
 
void setTextColor (byte r, byte g, byte b)
 
void setTextFontNumber (int fontNumber)
 
int getTextWidth () const
 
void scrollTextUp ()
 
void scrollTextDown ()
 
CTextCursor * getTextCursor () const
 
Movement getMovement () const
 
CRoomItem * getRoom () const
 
CNodeItem * getNode () const
 
CViewItem * getView () const
 
CString getRoomName () const
 
CString getRoomNodeName () const
 
void addMail (uint destRoomFlags)
 
void sendMail (uint currRoomFlags, uint newRoomFlags)
 
CString getFullViewName ()
 
CPetControl * getPetControl () const
 
void petAddToCarryParcel (CGameObject *obj)
 
void petAddToInventory ()
 
CTreeItem * petContainerRemove (CGameObject *obj)
 
bool petCheckNode (const CString &name)
 
bool petDismissBot (const CString &name)
 
bool petDoorOrBellbotPresent () const
 
void petDisplayMessage (int unused, StringId stringId)
 
void petDisplayMessage (int unused, const CString &str)
 
void petDisplayMessage (StringId stringId, int param=0)
 
void petDisplayMessage (const CString &str, int param=0)
 
int petGetRoomsWellEntry () const
 
void petHide ()
 
void petHideCursor ()
 
void petHighlightGlyph (int id)
 
void petInvChange ()
 
void petMoveToHiddenRoom ()
 
void petReassignRoom (PassengerClass passClassNum)
 
void petSetArea (PetArea newArea) const
 
void petSetRemoteTarget ()
 
void petSetRoomsWellEntry (int entryNum)
 
void petSetRoomsElevatorBroken (bool flag)
 
void petShow ()
 
void petIncAreaLocks ()
 
void petDecAreaLocks ()
 
void petShowCursor ()
 
void petOnSummonBot (const CString &name, int val)
 
CStarControl * getStarControl () const
 
void starFn (StarControlAction action)
 
bool starIsSolved () const
 
void startTalking (CTrueTalkNPC *npc, uint id, CViewItem *view=nullptr)
 
void startTalking (const CString &name, uint id, CViewItem *view=nullptr)
 
void setTalking (CTrueTalkNPC *npc, bool viewFlag, CViewItem *view=nullptr)
 
void talkSetDialRegion (const CString &name, int dialNum, int regionNum)
 
int talkGetDialRegion (const CString &name, int dialNum)
 
void movieEvent (int frameNumber)
 
void movieEvent ()
 
void stateSetSoundMakerAllowed (bool flag)
 
void stateChangeSeason ()
 
Season stateGetSeason () const
 
void stateSetParrotMet ()
 
bool stateGetParrotMet () const
 
void incParrotResponse ()
 
int getParrotResponse () const
 
uint getNodeChangedCtr () const
 
uint getNodeEnterTicks () const
 
- Public Member Functions inherited from Titanic::CNamedItem
CString dumpItem (int indent) const override
 
void save (SimpleFile *file, int indent) override
 
void load (SimpleFile *file) override
 
const CString getName () const override
 
bool isEquals (const CString &name, bool startsWith=false) const override
 
virtual CViewItem * findView () const
 
virtual CNodeItem * findNode () const
 
virtual CRoomItem * findRoom () const
 
- Public Member Functions inherited from Titanic::CTreeItem
void dump (int indent)
 
void save (SimpleFile *file, int indent) override
 
void load (SimpleFile *file) override
 
virtual CGameManager * getGameManager () const
 
virtual bool isFileItem () const
 
virtual bool isRoomItem () const
 
virtual bool isNodeItem () const
 
virtual bool isViewItem () const
 
virtual bool isLinkItem () const
 
virtual bool isPlaceHolderItem () const
 
virtual bool isNamedItem () const
 
virtual bool isGameObject () const
 
virtual bool isGameObjectDescItem () const
 
virtual int compareTo (const CString &name, int maxLen=0) const
 
virtual bool connectsTo (CViewItem *destView) const
 
CTreeItem * getParent () const
 
CProjectItem * getRoot () const
 
CTreeItem * getNextSibling () const
 
CTreeItem * getPriorSibling () const
 
CTreeItem * getLastSibling ()
 
CTreeItem * getFirstChild () const
 
CTreeItem * getLastChild () const
 
CTreeItem * scan (CTreeItem *item) const
 
CTreeItem * findChildInstanceOf (ClassDef *classDef) const
 
CTreeItem * findNextInstanceOf (ClassDef *classDef, CTreeItem *startItem) const
 
void addUnder (CTreeItem *newParent)
 
void setParent (CTreeItem *newParent)
 
void addSibling (CTreeItem *item)
 
void moveUnder (CTreeItem *newParent)
 
void destroyAll ()
 
int destroyChildren ()
 
void detach ()
 
void attach (CTreeItem *item)
 
CNamedItem * findByName (const CString &name, bool subMatch=false)
 
- Public Member Functions inherited from Titanic::CSaveableObject
virtual ClassDef * getType () const
 
bool isInstanceOf (const ClassDef *classDef) const
 
virtual void saveHeader (SimpleFile *file, int indent)
 
virtual void saveFooter (SimpleFile *file, int indent)
 

Public Attributes

 CLASSDEF
 
- Public Attributes inherited from Titanic::CGameObject
Rect _bounds
 
bool _isPendingMail
 
uint _destRoomFlags
 
uint _roomFlags
 
bool _handleMouseFlag
 
CursorId _cursorId
 
bool _visible
 
 CLASSDEF
 
- Public Attributes inherited from Titanic::CNamedItem
CString _name
 
 CLASSDEF
 
- Public Attributes inherited from Titanic::CTreeItem
 CLASSDEF
 
- Public Attributes inherited from Titanic::CMessageTarget
 CLASSDEF
 

Protected Attributes

int _startFrame
 
int _endFrame
 
CString _string1
 
CString _string2
 
bool _isBlocking
 
- Protected Attributes inherited from Titanic::CGameObject
double _unused1
 
double _unused2
 
double _unused3
 
bool _nonvisual
 
byte _toggleR
 
byte _toggleG
 
byte _toggleB
 
CMovieClipList _movieClips
 
int _initialFrame
 
CMovieRangeInfoList _movieRangeInfoList
 
int _frameNumber
 
CTextControl * _text
 
uint _textBorder
 
uint _textBorderRight
 
Common::Point _savedPos
 
CVideoSurface * _surface
 
CString _resource
 
int _unused4
 

Additional Inherited Members

- Static Public Member Functions inherited from Titanic::CGameObject
static void init ()
 
static void deinit ()
 
static bool compareRoomFlags (RoomFlagsComparison compareType, uint flags1, uint flags2)
 
- Static Public Member Functions inherited from Titanic::CSaveableObject
static void initClassList ()
 
static void freeClassList ()
 
static CSaveableObject * createInstance (const Common::String &name)
 
- Static Public Attributes inherited from Titanic::CSaveableObject
static ClassDef * _type
 
- Protected Member Functions inherited from Titanic::CGameObject
void savePosition ()
 
void resetPosition ()
 
bool checkStartDragging (CMouseDragStartMsg *msg)
 
void gotoView (const CString &viewName, const CString &clipName)
 
CViewItem * parseView (const CString &viewString)
 
void loadMovie (const CString &name, bool pendingFlag=true)
 
void loadImage (const CString &name, bool pendingFlag=true)
 
void incTransitions ()
 
void decTransitions ()
 
void lockMouse ()
 
void unlockMouse ()
 
void hideMouse ()
 
void showMouse ()
 
void disableMouse ()
 
void enableMouse ()
 
void mouseDisableControl ()
 
void mouseEnableControl ()
 
void mouseSetPosition (const Point &pt, double rate)
 
void lockInputHandler ()
 
void unlockInputHandler ()
 
void loadSound (const CString &name)
 
int playSound (const CString &name, uint volume=100, int balance=0, bool repeated=false)
 
int playSound (const CString &name, CProximity &prox)
 
int queueSound (const CString &name, uint priorHandle, uint volume=100, int balance=0, bool repeated=false, Audio::Mixer::SoundType soundType=Audio::Mixer::kPlainSoundType)
 
void stopSound (int handle, uint seconds=0)
 
bool isSoundActive (int handle) const
 
void setSoundVolume (int handle, uint percent, uint seconds)
 
void playAmbientSound (const CString &resName, VolumeMode mode, bool initialMute, bool repeated, int handleIndex, Audio::Mixer::SoundType soundType=Audio::Mixer::kMusicSoundType)
 
void stopAmbientSound (bool transition, int handleIndex)
 
void setAmbientSoundVolume (VolumeMode mode, uint seconds, int handleIndex)
 
void stopSoundChannel (bool channel3)
 
int addTimer (int endVal, uint firstDuration, uint repeatDuration)
 
int addTimer (uint firstDuration, uint repeatDuration=0)
 
void stopTimer (int id)
 
int startAnimTimer (const CString &action, uint firstDuration, uint repeatDuration=0)
 
void stopAnimTimer (int id)
 
void sleep (uint milli)
 
Point getMousePos () const
 
bool compareViewNameTo (const CString &name) const
 
bool compareRoomNameTo (const CString &name)
 
CGameObject * getMailManFirstObject () const
 
CGameObject * getMailManNextObject (CGameObject *prior) const
 
CGameObject * findMailByFlags (RoomFlagsComparison compareType, uint roomFlags)
 
CGameObject * getNextMail (CGameObject *prior)
 
CGameObject * findRoomObject (const CString &name) const
 
CGameObject * findInRoom (const CString &name)
 
void moveToView ()
 
void moveToView (const CString &name)
 
bool changeView (const CString &viewName, const CString &clipName)
 
bool changeView (const CString &viewName)
 
void playClip (const CString &name, uint flags=0)
 
void playClip (uint startFrame, uint endFrame)
 
bool playCutscene (uint startFrame, uint endFrame)
 
void playRandomClip (const char *const *names, uint flags=0)
 
CString getViewFullName () const
 
bool clipExistsByStart (const CString &name, int startFrame=0) const
 
bool clipExistsByEnd (const CString &name, int endFrame=0) const
 
void petClear () const
 
CMailMan * getMailMan () const
 
CDontSaveFileItem * getDontSave () const
 
CTreeItem * getDontSaveChild (ClassDef *classDef) const
 
CRoomItem * getHiddenRoom () const
 
CRoomItem * locateRoom (const CString &name) const
 
CTreeItem * findUnder (CTreeItem *parent, const CString &name) const
 
CRoomItem * findRoomByName (const CString &name)
 
CMusicRoom * getMusicRoom () const
 
void setPassengerClass (PassengerClass newClass)
 
void setToggleColor (byte r, byte g, byte b)
 
int getClipDuration (const CString &name, int frameRate=14) const
 
uint32 getTicksCount ()
 
Common::SeekableReadStream * getResource (const CString &name)
 
bool mailExists (uint roomFlags) const
 
CGameObject * findMail (uint roomFlags) const
 
void resetMail ()
 
void petLockInput ()
 
void petUnlockInput ()
 
void quitGame ()
 
void setMovieFrameRate (double rate)
 
int getRandomNumber (int max, int *oldVal=nullptr)
 
bool isBotDisallowedLocation ()
 
- Protected Member Functions inherited from Titanic::CMessageTarget
virtual const MSGMAP * getMessageMap () const
 
- Static Protected Member Functions inherited from Titanic::CMessageTarget
static const MSGMAP * getThisMessageMap ()
 
- Static Protected Attributes inherited from Titanic::CGameObject
static CCreditText * _credits
 

Member Function Documentation

◆ save()

void Titanic::CBackground::save ( SimpleFile *  file,
int  indent 
)
overridevirtual

Save the data for the class to file

Reimplemented from Titanic::CSaveableObject.

Reimplemented in Titanic::CArboretumGate, Titanic::CBedhead, Titanic::CSGTStateRoom, Titanic::CTelevision, Titanic::CBomb, Titanic::CLight, Titanic::CCellPointButton, Titanic::CLightSwitch, Titanic::CHammerDispensorButton, Titanic::CSauceDispensor, Titanic::CCaptainsWheel, Titanic::CChickenDispensor, Titanic::CSTButton, Titanic::CLemonDispensor, Titanic::CSpeechDispensor, Titanic::CodeWheel, Titanic::CSeasonalAdjustment, Titanic::CShipSetting, Titanic::CSliderButton, Titanic::CSeasonBackground, Titanic::CWheelHotSpot, Titanic::CTurnOnTurnOff, Titanic::CBridgeView, Titanic::CBrokenPellerator, Titanic::CBrokenPelleratorFroz, Titanic::CEmmaControl, Titanic::CHammerDispensor, Titanic::CHeadSmashLever, Titanic::CServiceElevatorWindow, Titanic::CSGTStateControl, Titanic::CMusicControl, Titanic::CAutoAnimate, Titanic::CBrokenPellBase, Titanic::CCage, Titanic::CEjectPhonographButton, Titanic::CWheelButton, Titanic::CComputer, Titanic::CStartAction, Titanic::CTurnOnPlaySound, Titanic::CArbBackground, Titanic::CPlayMusicButton, Titanic::CSeasonBarrel, Titanic::CDrawer, Titanic::CTurnOnObject, Titanic::CCreditsButton, Titanic::CGamesConsole, Titanic::CLittleLiftButton, Titanic::CMusicRoomStopPhonographButton, Titanic::CRecordPhonographButton, Titanic::CWheelSpin, Titanic::CMoveObjectButton, Titanic::CDeskchair, Titanic::CWheelSpinHorn, Titanic::CCloseBrokenPel, Titanic::CNoNutBowl, Titanic::CArmchair, Titanic::CBasin, Titanic::CChestOfDrawers, Titanic::CDesk, Titanic::CSGTTV, Titanic::CToilet, Titanic::CVase, Titanic::CWashstand, Titanic::CMusicSliderPitch, Titanic::CMusicSliderSpeed, Titanic::CMusicSwitchInversion, Titanic::CMusicSwitchReverse, Titanic::CMusicVoiceMute, Titanic::CToggleButton, Titanic::CHeadSmashEvent, Titanic::CPlayOnAct, Titanic::CBedfoot, Titanic::SGTNav, Titanic::CStopPhonographButton, Titanic::CUselessLever, Titanic::CActButton, Titanic::CChangesSeasonButton, Titanic::CStatusChangeButton, Titanic::CReplacementEar, Titanic::CThirdClassCanal, Titanic::CElevatorButton, Titanic::CMusicalInstrument, Titanic::CMusicSlider, and Titanic::CMusicSwitch.

◆ load()

void Titanic::CBackground::load ( SimpleFile *  file)
overridevirtual

Load the data for the class from file

Reimplemented from Titanic::CSaveableObject.

Reimplemented in Titanic::CArboretumGate, Titanic::CBedhead, Titanic::CSGTStateRoom, Titanic::CTelevision, Titanic::CBomb, Titanic::CLight, Titanic::CCellPointButton, Titanic::CLightSwitch, Titanic::CHammerDispensorButton, Titanic::CSauceDispensor, Titanic::CCaptainsWheel, Titanic::CChickenDispensor, Titanic::CSTButton, Titanic::CLemonDispensor, Titanic::CSpeechDispensor, Titanic::CodeWheel, Titanic::CSeasonalAdjustment, Titanic::CShipSetting, Titanic::CSliderButton, Titanic::CSeasonBackground, Titanic::CWheelHotSpot, Titanic::CTurnOnTurnOff, Titanic::CBridgeView, Titanic::CBrokenPellerator, Titanic::CBrokenPelleratorFroz, Titanic::CEmmaControl, Titanic::CHammerDispensor, Titanic::CHeadSmashLever, Titanic::CServiceElevatorWindow, Titanic::CSGTStateControl, Titanic::CMusicControl, Titanic::CAutoAnimate, Titanic::CBrokenPellBase, Titanic::CCage, Titanic::CEjectPhonographButton, Titanic::CWheelButton, Titanic::CComputer, Titanic::CStartAction, Titanic::CTurnOnPlaySound, Titanic::CArbBackground, Titanic::CPlayMusicButton, Titanic::CSeasonBarrel, Titanic::CDrawer, Titanic::CMusicVoiceMute, Titanic::CTurnOnObject, Titanic::CCreditsButton, Titanic::CGamesConsole, Titanic::CLittleLiftButton, Titanic::CMusicRoomStopPhonographButton, Titanic::CRecordPhonographButton, Titanic::CWheelSpin, Titanic::CMoveObjectButton, Titanic::CDeskchair, Titanic::CWheelSpinHorn, Titanic::CCloseBrokenPel, Titanic::CNoNutBowl, Titanic::CArmchair, Titanic::CBasin, Titanic::CChestOfDrawers, Titanic::CDesk, Titanic::CSGTTV, Titanic::CToilet, Titanic::CVase, Titanic::CWashstand, Titanic::CMusicSliderPitch, Titanic::CMusicSliderSpeed, Titanic::CMusicSwitchInversion, Titanic::CMusicSwitchReverse, Titanic::CToggleButton, Titanic::CHeadSmashEvent, Titanic::CPlayOnAct, Titanic::CBedfoot, Titanic::SGTNav, Titanic::CStopPhonographButton, Titanic::CUselessLever, Titanic::CActButton, Titanic::CChangesSeasonButton, Titanic::CStatusChangeButton, Titanic::CReplacementEar, Titanic::CThirdClassCanal, Titanic::CElevatorButton, Titanic::CMusicalInstrument, Titanic::CMusicSlider, and Titanic::CMusicSwitch.

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