ScummVM API documentation
Nancy Namespace Reference

Classes

struct  AssemblyPuzzleData
 
class  AVFDecoder
 
struct  BeadPuzzleData
 
struct  BrainData
 
struct  BSUM
 
struct  BuildBoardData
 
struct  BuildPuzzleData
 
struct  CapturedPicture
 
struct  CellPhoneData
 
struct  CellPhonePictureData
 
class  CifFile
 
struct  CifInfo
 
class  CifTree
 
struct  CLOK
 
struct  CollectionData
 
struct  ConditionalDialogue
 
struct  CRED
 
class  CursorManager
 
struct  CVTX
 
struct  DecoderData
 
class  Decompressor
 
class  DeferredLoader
 
struct  DragSurfaceData
 
struct  DrivingData
 
struct  EngineData
 
struct  ENVS
 
struct  EquippedItemData
 
struct  EVNT
 
struct  ExitHotspot
 
struct  FlagDescription
 
class  Font
 
struct  FrameBlitDescription
 
struct  GameIdToType
 
struct  Goodbye
 
struct  GoodbyeSceneChange
 
class  GraphicsManager
 
struct  GridMapPuzzleData
 
struct  HangmanData
 
struct  HELP
 
struct  HINT
 
struct  Hint
 
struct  HotspotDescription
 
class  IFF
 
struct  ImageChunk
 
class  InputManager
 
struct  INV
 
struct  INVD
 
struct  InventorySoundOverrideData
 
struct  JournalData
 
struct  LDSN
 
struct  LOAD
 
struct  LogoScreen
 
struct  LVLN
 
struct  MagnetMazePuzzleData
 
struct  MAP
 
struct  MARK
 
struct  MENU
 
struct  MirrorLightData
 
struct  MMIX
 
class  MoviePlayer
 
struct  MultiBuildPuzzleData
 
struct  MultiEventFlagDescription
 
class  NancyConsole
 
class  NancyEngine
 
struct  NancyInput
 
class  PatchTree
 
struct  PCAL
 
struct  PCUI
 
struct  PhoneBookData
 
struct  PlayerCharacterData
 
struct  PUIH
 
struct  PUIV
 
struct  PuzzleData
 
struct  QuizPuzzleData
 
struct  RandomSoundBlock
 
struct  RCLB
 
struct  RCPR
 
class  RenderObject
 
class  ResourceManager
 
struct  RiddlePuzzleData
 
struct  RippedLetterPuzzleData
 
struct  SavedStateData
 
struct  SceneChangeDescription
 
struct  SceneChangeWithFlag
 
struct  ScriptBootData
 
struct  ScriptJournalData
 
struct  ScriptPictureData
 
struct  ScriptSavedData
 
struct  ScriptTextData
 
struct  ScriptValueData
 
struct  SCTB
 
struct  SDLG
 
struct  SearchLink
 
struct  SecondaryVideoDescription
 
struct  SET
 
struct  SHUI
 
struct  SimplePuzzleData
 
struct  SliderPuzzleData
 
struct  SortPuzzleData
 
struct  SoundChannelInfo
 
struct  SoundDescription
 
struct  SoundEffectDescription
 
struct  SoundEqualizerPuzzleData
 
class  SoundManager
 
struct  SPEC
 
struct  SPUZ
 
struct  StaticData
 
struct  StaticDataFlag
 
struct  StreamData
 
struct  TABL
 
struct  TableData
 
struct  TASK
 
struct  TaskbarData
 
struct  TasklistData
 
struct  TBOX
 
struct  Time
 
struct  TimerData
 
struct  TowerPuzzleData
 
struct  TSKL
 
struct  UIButtonRecord
 
struct  UIButtonSlot
 
struct  UIBW
 
struct  UICL
 
struct  UICM
 
struct  UICO
 
struct  UIIV
 
struct  UINB
 
struct  UIPopupHeader
 
struct  UIRC
 
struct  UIResourceData
 
struct  UISliderRecord
 
struct  UIStateData
 
struct  VIEW
 
struct  ViewTransform
 
struct  WordFindPuzzleData
 
struct  XSheetFile
 

Enumerations

enum  UIType { kUITypeInventory = 1 , kUITypeNotebook = 2 , kUITypeCellphone = 3 }
 
enum  MovementDirection : byte {
  kUp = 1 , kDown = 2 , kLeft = 4 , kRight = 8 ,
  kMoveFast = 16
}
 
enum class  StaticDataConditionType { kEvent = 0 , kInventory = 1 , kDifficulty = 2 }
 
enum  UIButtonState { kUIButtonIdle = 0 , kUIButtonHover = 1 , kUIButtonPressed = 2 , kUIButtonDisabled = 3 }
 
enum  GameType {
  kGameTypeNone = 0 , kGameTypeVampire = 1 , kGameTypeNancy1 = 2 , kGameTypeNancy2 = 3 ,
  kGameTypeNancy3 = 4 , kGameTypeNancy4 = 5 , kGameTypeNancy5 = 6 , kGameTypeNancy6 = 7 ,
  kGameTypeNancy7 = 8 , kGameTypeNancy8 = 9 , kGameTypeNancy9 = 10 , kGameTypeNancy10 = 11 ,
  kGameTypeNancy11 = 12 , kGameTypeNancy12 = 13 , kGameTypeNancy13 = 14 , kGameTypeNancy14 = 15 ,
  kGameTypeNancy15 = 16 , kGameTypeNancy16 = 17 , kGameTypeNancy17 = 18 , kGameTypeNancy18 = 19 ,
  kGameTypeNancy19 = 20 , kGameTypeNancyDossier1 = 21 , kGameTypeNancy20 = 22 , kGameTypeNancyDossier2 = 23 ,
  kGameTypeNancy21 = 24 , kGameTypeNancy22 = 25 , kGameTypeNancy1New = 26 , kGameTypeNancy23 = 27 ,
  kGameTypeNancy24 = 28 , kGameTypeNancy25 = 29 , kGameTypeNancy26 = 30 , kGameTypeNancy27 = 31 ,
  kGameTypeNancy28 = 32 , kGameTypeNancy29 = 33 , kGameTypeNancy30 = 34 , kGameTypeNancy31 = 35 ,
  kGameTypeNancy32 = 36
}
 
enum  NancyDebugChannels {
  kDebugEngine = 1 , kDebugActionRecord , kDebugScene , kDebugSound ,
  kDebugVideo , kDebugHypertext
}
 
enum  TaskButton {
  kTaskButtonMenu = 0 , kTaskButtonInventory = 1 , kTaskButtonNotebook = 2 , kTaskButtonCellphone = 3 ,
  kTaskButtonCoinPurse = 4
}
 
enum  FontColorState {
  kFontColorNormal = 0 , kFontColorDisabled = 1 , kFontColorHidden = 2 , kFontColorFocus = 3 ,
  kFontColorMouseOver = 4 , kFontColorPressed = 5 , kNumFontColorStates = 6
}
 

Functions

void readContact (Common::SeekableReadStream &stream, UICL::Contact &c)
 
Common::String formatUIResourceValue (const UIRC::ItemRecord &item, int32 value)
 
bool hasMoneyResource ()
 
uint32 argbToColor (const Graphics::PixelFormat &format, uint32 argb)
 
void blendPixel (Graphics::ManagedSurface &surface, int x, int y, byte a, byte r, byte g, byte b)
 
byte colorChannelToByte (float channel)
 
void argbToChannels (uint32 argb, float *channels)
 
uint32 channelsToArgb (const float *channels)
 
float getBlendAmount (float seconds, float rate)
 
bool blendColor (float *current, uint32 target, float amount)
 
PuzzleData * makePuzzleData (const uint32 tag)
 
Audio::SeekableAudioStream * makeHISVorbisStream (Common::SeekableReadStream *stream, DisposeAfterUse::Flag disposeAfterUse)
 
void readRect (Common::SeekableReadStream &stream, Common::Rect &inRect)
 
void readExclusiveRect (Common::SeekableReadStream &stream, Common::Rect &inRect)
 
void readRect (Common::Serializer &stream, Common::Rect &inRect, Common::Serializer::Version minVersion=0, Common::Serializer::Version maxVersion=Common::Serializer::kLastVersion)
 
void readRectArray (Common::SeekableReadStream &stream, Common::Array< Common::Rect > &inArray, uint num, uint totalNum=0)
 
void readRectArray (Common::Serializer &stream, Common::Array< Common::Rect > &inArray, uint num, uint totalNum=0, Common::Serializer::Version minVersion=0, Common::Serializer::Version maxVersion=Common::Serializer::kLastVersion)
 
void readRect16 (Common::SeekableReadStream &stream, Common::Rect &inRect)
 
void readRect16 (Common::Serializer &stream, Common::Rect &inRect, Common::Serializer::Version minVersion=0, Common::Serializer::Version maxVersion=Common::Serializer::kLastVersion)
 
void readRectArray16 (Common::SeekableReadStream &stream, Common::Array< Common::Rect > &inArray, uint num, uint totalNum=0)
 
void readRectArray16 (Common::Serializer &stream, Common::Array< Common::Rect > &inArray, uint num, uint totalNum=0, Common::Serializer::Version minVersion=0, Common::Serializer::Version maxVersion=Common::Serializer::kLastVersion)
 
void readFilename (Common::SeekableReadStream &stream, Common::String &inString)
 
void readFilename (Common::Serializer &stream, Common::String &inString, Common::Serializer::Version minVersion=0, Common::Serializer::Version maxVersion=Common::Serializer::kLastVersion)
 
void readFilename (Common::SeekableReadStream &stream, Common::Path &inPath)
 
void readFilename (Common::Serializer &stream, Common::Path &inPath, Common::Serializer::Version minVersion=0, Common::Serializer::Version maxVersion=Common::Serializer::kLastVersion)
 
void readFilenameArray (Common::SeekableReadStream &stream, Common::Array< Common::String > &inArray, uint num)
 
void readFilenameArray (Common::Serializer &stream, Common::Array< Common::String > &inArray, uint num, Common::Serializer::Version minVersion=0, Common::Serializer::Version maxVersion=Common::Serializer::kLastVersion)
 
void readFilenameArray (Common::SeekableReadStream &stream, Common::Array< Common::Path > &inArray, uint num)
 
void readFilenameArray (Common::Serializer &stream, Common::Array< Common::Path > &inArray, uint num, Common::Serializer::Version minVersion=0, Common::Serializer::Version maxVersion=Common::Serializer::kLastVersion)
 
void assembleTextLine (char *rawCaption, Common::String &output, uint size)
 
bool parseSceneName (const Common::String &sceneName, uint16 &sceneID)
 
Common::String resolveSubtitleText (const Common::String &keyOrText, const Common::String &fallback=Common::String(), const char *tableID="AUTOTEXT")
 
Common::String readSubtitleText (Common::SeekableReadStream &stream)
 
void readExitHotspots (Common::SeekableReadStream &stream, Common::Array< ExitHotspot > &hotspots)
 
void readExitHotspot (Common::SeekableReadStream &stream, Common::Rect &hotspot, uint16 &cursorType, SceneChangeDescription &scene, FlagDescription &flag)
 
void showSubtitle (const Common::String &text, bool forceRedraw=false, int overrideFontID=-1)
 
Common::Rect viewportScreenToBackground (const Common::Rect &screenRegion)
 
bool captureViewportPicture (const Common::Rect &backgroundRegion, CapturedPicture &picture)
 
void readUIButton (Common::SeekableReadStream &stream, UIButtonRecord &dst)
 
void readUISlider (Common::SeekableReadStream &stream, UISliderRecord &dst)
 
void readUIPopupHeader (Common::SeekableReadStream &stream, UIPopupHeader &dst)
 
void readUIButtonSlot (Common::SeekableReadStream &stream, UIButtonSlot &dst)
 

Variables

const Graphics::PixelFormat kARGBFormat
 
NancyEngine * g_nancy
 

Detailed Description

This is the namespace of the Nancy engine.

Status of this engine: The Vampire Diaries and all Nancy Drew games up to and including Nancy Drew: The Creature of Kapu Cave are fully completable. Every other game is untested but definitely unplayable.

The engine has the following major versions:

  • v1: TVD, Nancy1-9
  • v2: Nancy10-11 (revamped interface)
  • v2a: Nancy12 (moved hardcoded dialog logic)
  • v2b: Nancy13-14 (32bpp graphics, scene include scripts)
  • v2c: Nancy15 (multiple characters and UI interfaces)
  • v3: Nancy16-17 (revamped interface)
  • v3a: Nancy18 (PNG graphics)
  • v4: Nancy19 and newer (Lua scripting)

Games using this engine:

  • The Vampire Diaries (1996)
  • Almost every mainline Nancy Drew game by HeR Interactive, beginning with Nancy Drew: Secrets can Kill (1998) up to and including Nancy Drew: Sea of Darkness (2015)