ScummVM API documentation
Nancy::State::Scene Class Reference
Inheritance diagram for Nancy::State::Scene:
Nancy::State::State Common::Singleton< Scene > Common::NonCopyable

Classes

struct  SceneSummary
 
struct  Timers
 

Public Types

enum  State { kInit, kLoad, kStartSound, kRun }
 

Public Member Functions

void process () override
 
void onStateEnter (const NancyState::NancyState prevState) override
 
bool onStateExit (const NancyState::NancyState nextState) override
 
void setDestroyOnExit ()
 
void loadSecondChance ()
 
void setMoviePlaylist (const Common::String &name, const Common::Array< Common::String > &movies)
 
bool takeMoviePlaylist (const Common::String &name, Common::Array< Common::String > &movies)
 
bool isRunningAd () const
 
void changeScene (const SceneChangeDescription &sceneDescription)
 
SceneStreamManager & getStreams ()
 
void addSceneVisit (uint16 sceneID)
 
void pushScene (int16 itemID=-1)
 
void viewInventoryItem (int16 itemID)
 
void returnViewedInventoryItem ()
 
void popScene (bool inventory=false)
 
int16 getPushedInvItemID () const
 
void startUIPrepScene (int16 uiType, int16 prepSceneID)
 
void finishUIPrepScene ()
 
bool isUIPrepActive () const
 
uint16 getSceneCounts (int16 hours) const
 
void setPlayerTime (Time time, byte relative)
 
Time getPlayerTime () const
 
Time getTimerTime () const
 
uint getPlayerTimeMinutes () const
 
byte getPlayerTOD () const
 
void requestSleep ()
 
void setPlayerDay (int16 day)
 
void addItemToInventory (int16 id)
 
void removeItemFromInventory (int16 id, bool pickUp=true)
 
void addItemToCharacterInventory (uint characterIndex, int16 id)
 
void removeItemFromCharacterInventory (uint characterIndex, int16 id, bool pickUp=false)
 
byte hasCharacterItem (uint characterIndex, int16 id)
 
void setCharacterItemDisabledState (uint characterIndex, int16 id, byte state)
 
void giveItemToCharacter (uint characterIndex, int16 id, bool intoHand, bool forceIntoHand)
 
int32 getCharacterUIResource (uint characterIndex, uint index)
 
int16 getHeldItem () const
 
void setHeldItem (int16 id)
 
void setNoHeldItem ()
 
byte hasItem (int16 id) const
 
byte getItemDisabledState (int16 id) const
 
void setItemDisabledState (int16 id, byte state)
 
void installInventorySoundOverride (byte command, const SoundDescription &sound, const Common::String &caption, uint16 itemID, byte characterIndex=kPlayerCharacterActive)
 
void playItemCantSound (int16 itemID=-1, bool notHoldingSound=false)
 
void setEventFlag (int16 label, byte flag)
 
void setEventFlag (FlagDescription eventFlag)
 
bool getEventFlag (int16 label, byte flag) const
 
bool getEventFlag (FlagDescription eventFlag) const
 
bool isSoftwareTimerActive (uint16 index) const
 
int32 getSoftwareTimerState (uint16 index) const
 
uint32 getSoftwareTimerElapsed (uint16 index) const
 
int32 getSoftwareTimerPercentLeft (uint16 index) const
 
int32 getUIResource (uint index, byte characterIndex=kPlayerCharacterActive)
 
void setUIResource (uint index, int32 value, byte characterIndex=kPlayerCharacterActive)
 
void setLogicCondition (int16 label, byte flag)
 
bool getLogicCondition (int16 label, byte flag) const
 
void clearLogicConditions ()
 
Time getLogicConditionTimestamp (int16 label) const
 
void setDifficulty (uint difficulty)
 
uint16 getDifficulty () const
 
byte getHintsRemaining () const
 
void useHint (uint16 characterID, uint16 hintID)
 
void requestStateChange (NancyState::NancyState state)
 
void resetStateToInit ()
 
void resetAndStartTimer ()
 
void stopTimer ()
 
Time getMovementTimeDelta (bool fast) const
 
void setPlayerScrolling (bool enabled)
 
bool getPlayerScrolling () const
 
void registerGraphics ()
 
bool changePlayerCharacter (uint characterIndex)
 
void setPlayerCharacterDesign (uint characterIndex, const Common::String &designName)
 
void changeSceneVideo (const Common::Path &videoFile)
 
void synchronize (Common::Serializer &serializer)
 
UI::FullScreenImage & getFrame ()
 
UI::Viewport & getViewport ()
 
UI::Textbox & getTextbox ()
 
UI::InventoryBox & getInventoryBox ()
 
UI::InventoryPopup & getInventoryPopup ()
 
UI::NotebookPopup & getNotebookPopup ()
 
UI::CellPhonePopup & getCellPhonePopup ()
 
UI::ConversationPopup & getConversationPopup ()
 
UI::Clock * getClock ()
 
UI::Camera * getCamera ()
 
UI::Taskbar * getTaskbar ()
 
Action::ActionManager & getActionManager ()
 
Action::ActionManager & getMainActionManager ()
 
void processMainStream ()
 
double getFrameSeconds () const
 
SceneChangeDescription & getSceneInfo ()
 
const SceneChangeDescription & getMainSceneInfo () const
 
Common::String getMainSceneName () const
 
SceneChangeDescription & getNextSceneInfo ()
 
const SceneSummary & getSceneSummary () const
 
void setActiveMovie (Action::PlaySecondaryMovie *activeMovie)
 
Action::PlaySecondaryMovie * getActiveMovie ()
 
void notifyRandomMovieARLoaded ()
 
void setActiveConversation (Action::ConversationSound *activeConversation)
 
Action::ConversationSound * getActiveConversation ()
 
Graphics::ManagedSurface & getLastScreenshot ()
 
void beginLightning (int16 distance, uint16 pulseTime, int16 rgbPercent)
 
Misc::ViewportFader * getViewportFader ()
 
UI::NDUI::Manager * getNDUI ()
 
void specialEffect (byte type, uint16 fadeToBlackTime, uint16 frameTime)
 
void specialEffect (byte type, uint16 totalTime, uint16 fadeToBlackTime, Common::Rect rect)
 
PuzzleData * getPuzzleData (const uint32 tag)
 
State getState () const
 
void setState (State state)
 
void closeActivePopups ()
 

Public Attributes

Timers _timers
 
RenderObject _hotspotDebug
 

Additional Inherited Members

- Static Public Member Functions inherited from Common::Singleton< Scene >
static bool hasInstance ()
 
static Scene & instance ()
 
static void destroy ()
 
- Protected Types inherited from Common::Singleton< Scene >
typedef Scene SingletonBaseType
 
- Static Protected Attributes inherited from Common::Singleton< Scene >
static Scene * _singleton
 

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