ScummVM API documentation
Sherlock::Object Class Reference
Inheritance diagram for Sherlock::Object:
Sherlock::BaseObject

Public Member Functions

void load (Common::SeekableReadStream &s, bool isRoseTattoo)
 
void load3DO (Common::SeekableReadStream &s)
 
void toggleHidden ()
 
void setFlagsAndToggles ()
 
void adjustObject ()
 
int pickUpObject (FixedTextActionId fixedTextActionId=kFixedTextAction_Invalid)
 
int frameWidth () const
 
int frameHeight () const
 
const Common::Rect getNewBounds () const
 
const Common::Rect getNoShapeBounds () const
 
const Common::Rect getOldBounds () const
 
void setObjTalkSequence (int seq) override
 
- Public Member Functions inherited from Sherlock::BaseObject
bool hasAborts () const
 
void checkObject ()
 
int checkNameForCodes (const Common::String &name, FixedTextActionId fixedTextActionId=kFixedTextAction_Invalid)
 

Public Attributes

Common::String _name
 
Common::String _examine
 
int _sequenceOffset
 
int _pickup
 
int _defaultCommand
 
int _pickupFlag
 
ActionType _aOpen
 
ActionType _aClose
 
ActionType _aMove
 
- Public Attributes inherited from Sherlock::BaseObject
SpriteType _type
 
Common::String _description
 
byte * _sequences
 
ImageFile_images
 
ImageFrame_imageFrame
 
int _sequenceNumber
 
int _startSeq
 
int _walkCount
 
int _allow
 
int _frameNumber
 
Point32 _position
 
Point32 _delta
 
Common::Point _oldPosition
 
Common::Point _oldSize
 
Point32 _goto
 
int _lookFlag
 
int _requiredFlag [2]
 
Common::Point _noShapeSize
 
int _status
 
int8 _misc
 
int _maxFrames
 
int _flags
 
AType _aType
 
int _lookFrames
 
int _seqCounter
 
PositionFacing _lookPosition
 
int _lookcAnim
 
int _seqStack
 
int _seqTo
 
uint _descOffset
 
int _seqCounter2
 
uint _seqSize
 
UseType _use [6]
 
int _quickDraw
 
int _scaleVal
 
int _gotoSeq
 
int _talkSeq
 
int _restoreSlot
 

Additional Inherited Members

- Static Public Member Functions inherited from Sherlock::BaseObject
static void setVm (SherlockEngine *vm)
 
- Static Public Attributes inherited from Sherlock::BaseObject
static bool _countCAnimFrames
 
- Protected Member Functions inherited from Sherlock::BaseObject
bool checkEndOfSequence ()
 
void setObjSequence (int seq, bool wait)
 
- Static Protected Attributes inherited from Sherlock::BaseObject
static SherlockEngine_vm
 

Member Function Documentation

◆ load()

void Sherlock::Object::load ( Common::SeekableReadStream s,
bool  isRoseTattoo 
)

Load the data for the object

◆ toggleHidden()

void Sherlock::Object::toggleHidden ( )

Toggle the type of an object between hidden and active

◆ setFlagsAndToggles()

void Sherlock::Object::setFlagsAndToggles ( )

Handle setting any flags associated with the object

◆ adjustObject()

void Sherlock::Object::adjustObject ( )

Adjusts the sprite's position and animation sequence, advancing by 1 frame. If the end of the sequence is reached, the appropriate action is taken.

◆ pickUpObject()

int Sherlock::Object::pickUpObject ( FixedTextActionId  fixedTextActionId = kFixedTextAction_Invalid)

Handles trying to pick up an object. If allowed, plays an y necessary animation for picking up the item, and then adds it to the player's inventory

◆ frameWidth()

int Sherlock::Object::frameWidth ( ) const
inline

Return the frame width

◆ frameHeight()

int Sherlock::Object::frameHeight ( ) const
inline

Return the frame height

◆ getNewBounds()

const Common::Rect Sherlock::Object::getNewBounds ( ) const

Returns the current bounds for the sprite

◆ getNoShapeBounds()

const Common::Rect Sherlock::Object::getNoShapeBounds ( ) const

Returns the bounds for a sprite without a shape

◆ getOldBounds()

const Common::Rect Sherlock::Object::getOldBounds ( ) const

Returns the old bounsd for the sprite from the previous frame

◆ setObjTalkSequence()

void Sherlock::Object::setObjTalkSequence ( int  seq)
overridevirtual

Adjusts the frame and sequence variables of a sprite that corresponds to the current speaker so that it points to the beginning of the sequence number's talk sequence in the object's sequence buffer

Parameters
seqWhich sequence to use (if there's more than 1)
Remarks
1: First talk seq, 2: second talk seq, etc.

Reimplemented from Sherlock::BaseObject.


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