ScummVM API documentation
Classes | Typedefs | Enumerations | Functions | Variables
ZVision Namespace Reference

Classes

class  ActionAdd
 
class  ActionAssign
 
class  ActionAttenuate
 
class  ActionChangeLocation
 
class  ActionCrossfade
 
class  ActionCursor
 
class  ActionDelayRender
 
class  ActionDisableControl
 
class  ActionDisplayMessage
 
class  ActionDissolve
 
class  ActionDistort
 
class  ActionEnableControl
 
class  ActionFlushMouseEvents
 
class  ActionInventory
 
class  ActionKill
 
class  ActionMenuBarEnable
 
class  ActionMusic
 
class  ActionPanTrack
 
class  ActionPlayAnimation
 
class  ActionPlayPreloadAnimation
 
class  ActionPreferences
 
class  ActionPreloadAnimation
 
class  ActionQuit
 
class  ActionRandom
 
class  ActionRegion
 
class  ActionRestoreGame
 
class  ActionRotateTo
 
class  ActionSetPartialScreen
 
class  ActionSetScreen
 
class  ActionStop
 
class  ActionStreamVideo
 
class  ActionSyncSound
 
class  ActionTimer
 
class  ActionTtyText
 
class  ActionUnloadAnimation
 
class  AnimationEffect
 
class  Clock
 
class  Console
 
class  Control
 
class  CursorManager
 
class  DistortNode
 
struct  EffectMapUnit
 
class  FistControl
 
class  FogFx
 
struct  FontStyle
 
class  GraphicsEffect
 
class  HotMovControl
 
class  InputControl
 
class  LeverControl
 
class  LightFx
 
struct  Location
 
class  LzssReadStream
 
class  MenuHandler
 
class  MenuNemesis
 
class  MenuZGI
 
class  MidiManager
 
class  MusicMidiNode
 
class  MusicNode
 
class  MusicNodeBASE
 
class  PaintControl
 
class  PanTrackNode
 
class  PushToggleControl
 
struct  Puzzle
 
class  RawChunkStream
 
class  RawZorkStream
 
class  RegionNode
 
class  RenderManager
 
class  RenderTable
 
class  ResultAction
 
class  RLFDecoder
 
class  SafeControl
 
class  SaveControl
 
struct  SaveGameHeader
 
class  SaveManager
 
class  ScriptingEffect
 
class  ScriptManager
 
class  SearchManager
 
class  SlotControl
 
struct  SoundParams
 
class  StringManager
 
class  StyledTTFont
 
class  Subtitle
 
class  SyncSoundNode
 
class  TextRenderer
 
class  TextStyleState
 
class  TimerNode
 
class  TitlerControl
 
class  ttyTextNode
 
class  ValueSlot
 
class  WaveFx
 
class  ZfsArchive
 
struct  ZfsEntryHeader
 
struct  ZfsHeader
 
class  ZorkAVIDecoder
 
class  ZorkCursor
 
class  ZVision
 
struct  ZVisionGameDescription
 

Typedefs

typedef Common::HashMap< Common::String, ZfsEntryHeader *, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo > ZfsEntryHeaderMap
 
typedef Common::List< EffectMapUnit > EffectMap
 
typedef Common::List< Puzzle * > PuzzleList
 
typedef Common::Queue< Puzzle * > PuzzleQueue
 
typedef Common::List< Control * > ControlList
 
typedef Common::HashMap< uint32, int32 > StateMap
 
typedef Common::List< ScriptingEffect * > SideFXList
 
typedef Common::List< Common::Event > EventList
 

Enumerations

enum  ZVisionGameId { GID_NONE = 0, GID_NEMESIS = 1, GID_GRANDINQUISITOR = 2 }
 
enum  ZVisionFeatures { GF_DVD = (1 << 0) }
 
enum  CursorIndex {
  CursorIndex_Active = 0, CursorIndex_DownArr = 3, CursorIndex_HandPu = 6, CursorIndex_Idle = 11,
  CursorIndex_Left = 12, CursorIndex_Right = 13, CursorIndex_UpArr = 17, CursorIndex_ItemIdle = 18,
  CursorIndex_ItemAct = 19
}
 
enum  menuBar {
  kMenubarExit = 0x1, kMenubarSettings = 0x2, kMenubarRestore = 0x4, kMenubarSave = 0x8,
  kMenubarItems = 0x100, kMenubarMagic = 0x200
}
 
enum  StateKey {
  StateKey_World = 3, StateKey_Room = 4, StateKey_Node = 5, StateKey_View = 6,
  StateKey_ViewPos = 7, StateKey_KeyPress = 8, StateKey_InventoryItem = 9, StateKey_LMouse = 10,
  StateKey_NotSet = 11, StateKey_Rounds = 12, StateKey_Venus = 13, StateKey_RMouse = 18,
  StateKey_MenuState = 19, StateKey_RestoreFlag = 20, StateKey_Quitting = 39, StateKey_LastWorld = 40,
  StateKey_LastRoom = 41, StateKey_LastNode = 42, StateKey_LastView = 43, StateKey_LastViewPos = 44,
  StateKey_Menu_LastWorld = 45, StateKey_Menu_LastRoom = 46, StateKey_Menu_LastNode = 47, StateKey_Menu_LastView = 48,
  StateKey_Menu_LastViewPos = 49, StateKey_KbdRotateSpeed = 50, StateKey_Subtitles = 51, StateKey_StreamSkipKey = 52,
  StateKey_RotateSpeed = 53, StateKey_Volume = 56, StateKey_Qsound = 57, StateKey_VenusEnable = 58,
  StateKey_HighQuality = 59, StateKey_VideoLineSkip = 65, StateKey_Platform = 66, StateKey_InstallLevel = 67,
  StateKey_CountryCode = 68, StateKey_CPU = 69, StateKey_MovieCursor = 70, StateKey_NoTurnAnim = 71,
  StateKey_WIN958 = 72, StateKey_ShowErrorDlg = 73, StateKey_DebugCheats = 74, StateKey_JapanFonts = 75,
  StateKey_ExecScopeStyle = 76, StateKey_Brightness = 77, StateKey_MPEGMovies = 78, StateKey_EF9_R = 91,
  StateKey_EF9_G = 92, StateKey_EF9_B = 93, StateKey_EF9_Speed = 94, StateKey_Inv_Cnt_Slot = 100,
  StateKey_Inv_1_Slot = 101, StateKey_Inv_49_Slot = 149, StateKey_Inv_TotalSlots = 150, StateKey_Inv_StartSlot = 151,
  StateKey_Spell_1 = 191, StateKey_Active_Spell = 205, StateKey_Reversed_Spellbooc = 206
}
 
enum  TextJustification { TEXT_JUSTIFY_CENTER = 0, TEXT_JUSTIFY_LEFT = 1, TEXT_JUSTIFY_RIGHT = 2 }
 
enum  TextChange {
  TEXT_CHANGE_NONE = 0x0, TEXT_CHANGE_FONT_TYPE = 0x1, TEXT_CHANGE_FONT_STYLE = 0x2, TEXT_CHANGE_NEWLINE = 0x4,
  TEXT_CHANGE_HAS_STATE_BOX = 0x8
}
 
enum  {
  WINDOW_WIDTH = 640, WINDOW_HEIGHT = 480, HIRES_WINDOW_WIDTH = 800, HIRES_WINDOW_HEIGHT = 600,
  ZNM_WORKING_WINDOW_WIDTH = 512, ZNM_WORKING_WINDOW_HEIGHT = 320, ZGI_WORKING_WINDOW_WIDTH = 640, ZGI_WORKING_WINDOW_HEIGHT = 344,
  ROTATION_SCREEN_EDGE_OFFSET = 60, MAX_ROTATION_SPEED = 400, KEYBUF_SIZE = 20
}
 
enum  ZVisionAction {
  kZVisionActionNone, kZVisionActionUp, kZVisionActionDown, kZVisionActionLeft,
  kZVisionActionRight, kZVisionActionSave, kZVisionActionRestore, kZVisionActionQuit,
  kZVisionActionPreferences, kZVisionActionShowFPS, kZVisionActionSkipCutscene, kZVisionActionCount
}
 

Functions

bool operator== (const Location &lhs, const Location &rhs)
 
bool operator== (const Location &lhs, const char *rhs)
 
bool operator!= (const Location &lhs, const Location &rhs)
 
bool operator!= (const Location &lhs, const char *rhs)
 
Audio::RewindableAudioStream * makeRawZorkStream (Common::SeekableReadStream *stream, int rate, bool stereo, DisposeAfterUse::Flag disposeAfterUse=DisposeAfterUse::YES)
 
Audio::RewindableAudioStream * makeRawZorkStream (const Common::Path &filePath, ZVision *engine)
 
Common::String readWideLine (Common::SeekableReadStream &stream)
 
int8 getUtf8CharSize (char chr)
 
uint16 readUtf8Char (const char *chr)
 

Variables

const char * mainKeymapId
 
const char * gameKeymapId
 
const char * cutscenesKeymapId
 

Detailed Description

This is the namespace of the ZVision engine.

Status of this engine: complete

Games using this engine:

  • Zork Nemesis: The Forbidden Lands
  • Zork: Grand Inquisitor

Enumeration Type Documentation

◆ CursorIndex

enum ZVision::CursorIndex

Mostly usable cursors

Function Documentation

◆ makeRawZorkStream()

Audio::RewindableAudioStream* ZVision::makeRawZorkStream ( Common::SeekableReadStream *  stream,
int  rate,
bool  stereo,
DisposeAfterUse::Flag  disposeAfterUse = DisposeAfterUse::YES 
)

Creates an audio stream, which plays from the given stream.

Parameters
streamStream object to play from.
rateRate of the sound data.
disposeAfterUse Whether to delete the stream after use.
Returns
The new SeekableAudioStream (or 0 on failure).