ScummVM API documentation
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Pegasus::Neighborhood Class Referenceabstract
Inheritance diagram for Pegasus::Neighborhood:
Pegasus::IDObject Pegasus::NotificationReceiver Pegasus::InputHandler Pegasus::Idler Pegasus::Caldoria Pegasus::FullTSA Pegasus::Mars Pegasus::Norad Pegasus::Prehistoric Pegasus::TinyTSA Pegasus::WSC Pegasus::NoradAlpha Pegasus::NoradDelta

Public Member Functions

 Neighborhood (InputHandler *nextHandler, PegasusEngine *vm, const Common::String &resName, NeighborhoodID id)
 
virtual void init ()
 
virtual void start ()
 
virtual void moveNavTo (const CoordType, const CoordType)
 
virtual void checkContinuePoint (const RoomID, const DirectionConstant)=0
 
void makeContinuePoint ()
 
void activateHotspots () override
 
void clickInHotspot (const Input &, const Hotspot *) override
 
virtual CanMoveForwardReason canMoveForward (ExitTable::Entry &entry)
 
virtual CanTurnReason canTurn (TurnDirection turn, DirectionConstant &nextDir)
 
virtual CanOpenDoorReason canOpenDoor (DoorTable::Entry &entry)
 
virtual void cantMoveThatWay (CanMoveForwardReason)
 
virtual void cantTurnThatWay (CanTurnReason)
 
virtual void cantOpenDoor (CanOpenDoorReason)
 
virtual void arriveAt (const RoomID room, const DirectionConstant direction)
 
virtual void turnTo (const DirectionConstant)
 
virtual void spotCompleted ()
 
virtual void doorOpened ()
 
virtual void closeDoorOffScreen (const RoomID, const DirectionConstant)
 
virtual void moveForward ()
 
virtual void turn (const TurnDirection)
 
virtual void turnLeft ()
 
virtual void turnRight ()
 
virtual void turnUp ()
 
virtual void turnDown ()
 
virtual void openDoor ()
 
virtual void zoomTo (const Hotspot *)
 
virtual void updateViewFrame ()
 
void requestExtraSequence (const ExtraID, const NotificationFlags, const InputBits interruptionFilter)
 
void requestSpotSound (const TimeValue, const TimeValue, const InputBits interruptionFilter, const NotificationFlags)
 
void playSpotSoundSync (const TimeValue in, const TimeValue out)
 
void requestDelay (const TimeValue, const TimeScale, const InputBits interruptionFilter, const NotificationFlags)
 
Notification * getNeighborhoodNotification ()
 
virtual void getExtraEntry (const uint32 id, ExtraTable::Entry &extraEntry)
 
virtual void startSpotLoop (TimeValue, TimeValue, NotificationFlags=0)
 
virtual bool actionQueueEmpty ()
 
virtual void showViewFrame (TimeValue)
 
virtual void findSpotEntry (const RoomID room, const DirectionConstant direction, SpotFlags flags, SpotTable::Entry &spotEntry)
 
virtual void startExtraSequence (const ExtraID, const NotificationFlags, const InputBits interruptionFilter)
 
bool startExtraSequenceSync (const ExtraID, const InputBits)
 
virtual void loopExtraSequence (const uint32, NotificationFlags=0)
 
int32 getLastExtra () const
 
virtual void scheduleNavCallBack (NotificationFlags)
 
Movie * getNavMovie ()
 
bool navMoviePlaying ()
 
void setCurrentAlternate (const AlternateID alt)
 
AlternateID getCurrentAlternate () const
 
void setCurrentActivation (const HotSpotActivationID a)
 
HotSpotActivationID getCurrentActivation ()
 
virtual void playDeathExtra (ExtraID, DeathReason)
 
virtual void die (const DeathReason)
 
virtual void setSoundFXLevel (const uint16)
 
virtual void setAmbienceLevel (const uint16)
 
void forceStridingStop (const RoomID, const DirectionConstant, const AlternateID)
 
void restoreStriding (const RoomID, const DirectionConstant, const AlternateID)
 
HotspotInfoTable::Entry * findHotspotEntry (const HotSpotID)
 
Push * getTurnPush ()
 
Picture * getTurnPushPicture ()
 
void hideNav ()
 
void showNav ()
 
virtual void loadAmbientLoops ()
 
virtual void flushGameState ()
 
virtual Common::Path getBriefingMovie ()
 
virtual Common::Path getEnvScanMovie ()
 
virtual uint getNumHints ()
 
virtual Common::Path getHintMovie (uint)
 
virtual bool canSolve ()
 
virtual void prepareForAIHint (const Common::Path &)
 
virtual void cleanUpAfterAIHint (const Common::Path &)
 
virtual void doSolve ()
 
virtual bool okayToJump ()
 
virtual AirQuality getAirQuality (const RoomID)
 
virtual void checkAirMask ()
 
virtual void checkFlashlight ()
 
virtual void shieldOn ()
 
virtual void shieldOff ()
 
virtual void loadLoopSound1 (const Common::Path &, const uint16 volume=0x100, const TimeValue fadeOut=kDefaultLoopFadeOut, const TimeValue fadeIn=kDefaultLoopFadeIn, const TimeScale fadeScale=kDefaultLoopFadeScale)
 
virtual void loadLoopSound2 (const Common::Path &, const uint16 volume=0x100, const TimeValue fadeOut=kDefaultLoopFadeOut, const TimeValue fadeIn=kDefaultLoopFadeIn, const TimeScale fadeScale=kDefaultLoopFadeScale)
 
bool loop1Loaded (const Common::Path &soundName)
 
bool loop2Loaded (const Common::Path &soundName)
 
void startLoop1Fader (const FaderMoveSpec &)
 
void startLoop2Fader (const FaderMoveSpec &)
 
virtual void takeItemFromRoom (Item *)
 
virtual void dropItemIntoRoom (Item *, Hotspot *)
 
virtual Hotspot * getItemScreenSpot (Item *, DisplayElement *)
 
virtual GameInteraction * makeInteraction (const InteractionID)
 
virtual void requestDeleteCurrentInteraction ()
 
virtual uint16 getDateResID () const =0
 
virtual void showExtraView (uint32)
 
virtual void startExtraLongSequence (const uint32, const uint32, NotificationFlags, const InputBits interruptionFilter)
 
void openCroppedMovie (const Common::Path &, CoordType, CoordType)
 
void loopCroppedMovie (const Common::Path &, CoordType, CoordType)
 
void closeCroppedMovie ()
 
void playCroppedMovieOnce (const Common::Path &, CoordType, CoordType, const InputBits interruptionFilter=kFilterNoInput)
 
void playMovieSegment (Movie *, TimeValue=0, TimeValue=0xffffffff)
 
virtual void recallToTSASuccess ()
 
virtual void recallToTSAFailure ()
 
virtual void pickedUpItem (Item *)
 
void handleInput (const Input &, const Hotspot *) override
 
- Public Member Functions inherited from Pegasus::IDObject
 IDObject (const int32 id)
 
int32 getObjectID () const
 
- Public Member Functions inherited from Pegasus::InputHandler
 InputHandler (InputHandler *)
 
virtual void setNextHandler (InputHandler *nextHandler)
 
virtual InputHandler * getNextHandler ()
 
virtual void updateCursor (const Common::Point, const Hotspot *)
 
virtual bool isClickInput (const Input &, const Hotspot *)
 
virtual bool wantsCursor ()
 
virtual bool releaseInputFocus ()
 
virtual void grabInputFocus ()
 
virtual InputBits getClickFilter ()
 
virtual void allowInput (const bool allow)
 
- Public Member Functions inherited from Pegasus::Idler
virtual void startIdling ()
 
virtual void stopIdling ()
 
bool isIdling () const
 

Protected Member Functions

virtual Common::Path getSoundSpotsName ()=0
 
virtual Common::Path getNavMovieName ()=0
 
void receiveNotification (Notification *, const NotificationFlags) override
 
virtual void getExitEntry (const RoomID room, const DirectionConstant direction, ExitTable::Entry &entry)
 
virtual TimeValue getViewTime (const RoomID room, const DirectionConstant direction)
 
virtual void getDoorEntry (const RoomID room, const DirectionConstant direction, DoorTable::Entry &doorEntry)
 
virtual DirectionConstant getTurnEntry (const RoomID room, const DirectionConstant direction, const TurnDirection turn)
 
virtual void getZoomEntry (const HotSpotID id, ZoomTable::Entry &zoomEntry)
 
virtual void getHotspotEntry (const HotSpotID id, HotspotInfoTable::Entry &hotspotEntry)
 
virtual void startExitMovie (const ExitTable::Entry &)
 
virtual void keepStriding (ExitTable::Entry &)
 
virtual void stopStriding ()
 
virtual void checkStriding ()
 
virtual bool stillMoveForward ()
 
virtual void scheduleStridingCallBack (const TimeValue, NotificationFlags flags)
 
virtual void startZoomMovie (const ZoomTable::Entry &)
 
virtual void startDoorOpenMovie (const TimeValue, const TimeValue)
 
virtual void startTurnPush (const TurnDirection, const TimeValue, const DirectionConstant)
 
virtual void playExtraMovie (const ExtraTable::Entry &, const NotificationFlags, const InputBits interruptionFilter)
 
virtual void activateCurrentView (const RoomID, const DirectionConstant, SpotFlags)
 
virtual void activateOneHotspot (HotspotInfoTable::Entry &, Hotspot *)
 
virtual void startSpotOnceOnly (TimeValue, TimeValue)
 
virtual void startMovieSequence (const TimeValue, const TimeValue, NotificationFlags, bool loopSequence, const InputBits interruptionFilter, const TimeValue strideStop=0xffffffff)
 
virtual void createNeighborhoodSpots ()
 
void resetLastExtra ()
 
virtual void throwAwayInterface ()
 
void popActionQueue ()
 
void serviceActionQueue ()
 
void requestAction (const QueueRequestType, const ExtraID, const TimeValue, const TimeValue, const InputBits, const NotificationFlags)
 
virtual bool prepareExtraSync (const ExtraID)
 
virtual bool waitMovieFinish (Movie *, const InputBits)
 
InputBits getInputFilter () override
 
virtual int16 getStaticCompassAngle (const RoomID, const DirectionConstant dir)
 
virtual void getExitCompassMove (const ExitTable::Entry &, FaderMoveSpec &)
 
virtual void getZoomCompassMove (const ZoomTable::Entry &, FaderMoveSpec &)
 
virtual void getExtraCompassMove (const ExtraTable::Entry &, FaderMoveSpec &)
 
virtual void setUpAIRules ()
 
virtual void setHotspotFlags (const HotSpotID, const HotSpotFlags)
 
virtual void setIsItemTaken (const ItemID)
 
virtual void upButton (const Input &)
 
virtual void leftButton (const Input &)
 
virtual void rightButton (const Input &)
 
virtual void downButton (const Input &)
 
void initOnePicture (Picture *, const Common::Path &, DisplayOrder, CoordType, CoordType, bool)
 
void initOneMovie (Movie *, const Common::Path &, DisplayOrder, CoordType, CoordType, bool)
 
void reinstateMonocleInterface ()
 
virtual void newInteraction (const InteractionID)
 
void useIdleTime () override
 
virtual void bumpIntoWall ()
 
virtual void zoomUpOrBump ()
 
void scheduleEvent (const TimeValue, const TimeScale, const uint32)
 
void cancelEvent ()
 
virtual void timerExpired (const uint32)
 
bool isEventTimerRunning ()
 
uint32 getTimerEvent ()
 
void timerFunction ()
 
void pauseTimer ()
 
void resumeTimer ()
 
bool timerPaused ()
 
- Protected Member Functions inherited from Pegasus::NotificationReceiver
virtual void newNotification (Notification *notification)
 

Protected Attributes

PegasusEngine * _vm
 
Common::String _resName
 
DoorTable _doorTable
 
ExitTable _exitTable
 
ExtraTable _extraTable
 
HotspotInfoTable _hotspotInfoTable
 
SpotTable _spotTable
 
TurnTable _turnTable
 
ViewTable _viewTable
 
ZoomTable _zoomTable
 
AlternateID _currentAlternate
 
HotSpotActivationID _currentActivation
 
ExtraID _lastExtra
 
DeathReason _extraDeathReason
 
Movie _navMovie
 
Picture _pushIn
 
Push _turnPush
 
Notification _neighborhoodNotification
 
NotificationCallBack _navMovieCallBack
 
StriderCallBack _stridingCallBack
 
NotificationCallBack _turnPushCallBack
 
NotificationCallBack _spotSoundCallBack
 
NotificationCallBack _delayCallBack
 
HotspotList _neighborhoodHotspots
 
SoundTimeBase _spotSounds
 
NeighborhoodActionQueue _actionQueue
 
TimeBase _delayTimer
 
InputBits _interruptionFilter
 
bool _isRunning
 
GameInteraction * _currentInteraction
 
bool _doneWithInteraction
 
Movie _croppedMovie
 
Sound _soundLoop1
 
Common::Path _loop1SoundString
 
SoundFader _loop1Fader
 
Sound _soundLoop2
 
Common::Path _loop2SoundString
 
SoundFader _loop2Fader
 
FuseFunction _eventTimer
 
uint32 _timerEvent
 
- Protected Attributes inherited from Pegasus::InputHandler
InputHandler * _nextHandler
 
bool _allowInput
 
- Protected Attributes inherited from Pegasus::Idler
bool _isIdling
 
Idler * _nextIdler
 
Idler * _prevIdler
 

Additional Inherited Members

- Static Public Member Functions inherited from Pegasus::InputHandler
static InputHandler * setInputHandler (InputHandler *)
 
static InputHandler * getCurrentHandler ()
 
static void pollForInput ()
 
static void getInput (Input &, Hotspot *&)
 
static void readInputDevice (Input &)
 
static void invalHotspots ()
 
static InputBits getCurrentFilter ()
 
- Static Protected Attributes inherited from Pegasus::InputHandler
static InputHandler * _inputHandler
 
static bool _invalHotspots
 
static InputBits _lastFilter
 
The documentation for this class was generated from the following file: