ScummVM API documentation
Sherlock::Sprite Class Referenceabstract
Inheritance diagram for Sherlock::Sprite:
Sherlock::BaseObject Sherlock::Person Sherlock::Scalpel::ScalpelPerson Sherlock::Tattoo::TattooPerson

Public Member Functions

void clear ()
 
void setImageFrame ()
 
void checkSprite ()
 
void setObjTalkSequence (int seq) override
 
int frameWidth () const
 
int frameHeight () const
 
const Common::Rect getOldBounds () const
 
virtual void adjustSprite ()=0
 
virtual void gotoStand ()=0
 
virtual void setWalking ()=0
 
- Public Member Functions inherited from Sherlock::BaseObject
bool hasAborts () const
 
void checkObject ()
 
int checkNameForCodes (const Common::String &name, FixedTextActionId fixedTextActionId=kFixedTextAction_Invalid)
 

Static Public Member Functions

static void setVm (SherlockEngine *vm)
 
- Static Public Member Functions inherited from Sherlock::BaseObject
static void setVm (SherlockEngine *vm)
 

Public Attributes

Common::String _name
 
Common::String _examine
 
Common::String _pickUp
 
WalkSequences _walkSequences
 
Common::Point _noShapeSize
 
int _status
 
int8 _misc
 
ImageFrame_stopFrames [8]
 
ImageFile_altImages
 
int _altSeq
 
int _centerWalk
 
Common::Point _adjust
 
int _oldWalkSequence
 
- 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 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

◆ clear()

void Sherlock::Sprite::clear ( )

Reset the data for the sprite

◆ setImageFrame()

void Sherlock::Sprite::setImageFrame ( )

Updates the image frame poiner for the sprite

◆ checkSprite()

void Sherlock::Sprite::checkSprite ( )

Checks the sprite's position to see if it's collided with any special objects

◆ setObjTalkSequence()

void Sherlock::Sprite::setObjTalkSequence ( int  seq)
inlineoverridevirtual

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.

Reimplemented in Sherlock::Tattoo::TattooPerson.

◆ frameWidth()

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

Return frame width

◆ frameHeight()

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

Return frame height

◆ getOldBounds()

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

Returns the old bounsd for the sprite from the previous frame

◆ adjustSprite()

virtual void Sherlock::Sprite::adjustSprite ( )
pure virtual

This adjusts the sprites position, as well as it's animation sequence:

Implemented in Sherlock::Tattoo::TattooPerson, and Sherlock::Scalpel::ScalpelPerson.

◆ gotoStand()

virtual void Sherlock::Sprite::gotoStand ( )
pure virtual

Bring a moving character using the sprite to a standing position

Implemented in Sherlock::Tattoo::TattooPerson, and Sherlock::Scalpel::ScalpelPerson.

◆ setWalking()

virtual void Sherlock::Sprite::setWalking ( )
pure virtual

Set the variables for moving a character from one poisition to another in a straight line

Implemented in Sherlock::Tattoo::TattooPerson, and Sherlock::Scalpel::ScalpelPerson.


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