ScummVM API documentation
Classes | Typedefs | Enumerations | Variables
Hugo Namespace Reference

Classes

union  Act
 
struct  act0
 
struct  act1
 
struct  act10
 
struct  act11
 
struct  act12
 
struct  act13
 
struct  act14
 
struct  act15
 
struct  act16
 
struct  act17
 
struct  act18
 
struct  act19
 
struct  act2
 
struct  act20
 
struct  act21
 
struct  act22
 
struct  act23
 
struct  act24
 
struct  act25
 
struct  act26
 
struct  act27
 
struct  act28
 
struct  act29
 
struct  act3
 
struct  act30
 
struct  act31
 
struct  act32
 
struct  act33
 
struct  act34
 
struct  act35
 
struct  act36
 
struct  act37
 
struct  act38
 
struct  act39
 
struct  act4
 
struct  act40
 
struct  act41
 
struct  act42
 
struct  act43
 
struct  act44
 
struct  act45
 
struct  act46
 
struct  act47
 
struct  act48
 
struct  act49
 
struct  act5
 
struct  act6
 
struct  act7
 
struct  act8
 
struct  act9
 
struct  Background
 
struct  cmd
 
struct  Config
 
class  EntryDialog
 
struct  Event
 
class  FileManager
 
class  FileManager_v1d
 
class  FileManager_v1w
 
class  FileManager_v2d
 
class  FileManager_v2w
 
class  FileManager_v3d
 
struct  Hotspot
 
struct  hugoBoot
 
class  HugoConsole
 
class  HugoEngine
 
struct  HugoGameDescription
 
class  intro_v1d
 
class  intro_v1w
 
class  intro_v2d
 
class  intro_v2w
 
class  intro_v3d
 
class  intro_v3w
 
class  IntroHandler
 
class  InventoryHandler
 
struct  Maze
 
class  MidiPlayer
 
class  MouseHandler
 
struct  Object
 
class  ObjectHandler
 
class  ObjectHandler_v1d
 
class  ObjectHandler_v1w
 
class  ObjectHandler_v2d
 
class  ObjectHandler_v3d
 
class  Parser
 
class  Parser_v1d
 
class  Parser_v1w
 
class  Parser_v2d
 
class  Parser_v3d
 
struct  Point
 
class  Route
 
class  Scheduler
 
class  Scheduler_v1d
 
class  Scheduler_v1w
 
class  Scheduler_v2d
 
class  Scheduler_v3d
 
class  Screen
 
class  Screen_v1d
 
class  Screen_v1w
 
struct  Segment
 
struct  Seq
 
struct  SeqList
 
class  SoundHandler
 
struct  SoundHdr
 
struct  Status
 
struct  Target
 
class  TextHandler
 
class  TopMenu
 
struct  UifHdr
 
struct  Uses
 

Typedefs

typedef byte * ImagePtr
 
typedef byte * SoundPtr
 
typedef char Command[kMaxLineSize+8]
 
typedef byte Icondib[kXPix *kInvDy]
 
typedef byte Viewdib[(long) kXPix *kYPix]
 
typedef byte Overlay[kOvlSize]
 
typedef Background * ObjectList
 

Enumerations

enum  HugoGameFeatures { GF_PACKED = (1 << 0) }
 
enum  GameType { kGameTypeNone = 0, kGameTypeHugo1, kGameTypeHugo2, kGameTypeHugo3 }
 
enum  GameVariant {
  kGameVariantH1Win = 0, kGameVariantH2Win, kGameVariantH3Win, kGameVariantH1Dos,
  kGameVariantH2Dos, kGameVariantH3Dos, kGameVariantNone
}
 
enum  MenuOption {
  kMenuWhat = 0, kMenuMusic, kMenuSoundFX, kMenuSave,
  kMenuLoad, kMenuRecall, kMenuTurbo, kMenuLook,
  kMenuInventory
}
 
enum  {
  kMenuWidth = 320, kMenuHeight = 24, kMenuX = 5, kMenuY = 1,
  kButtonWidth = 20, kButtonHeight = 20, kButtonPad = 1, kButtonSpace = 5
}
 
enum  {
  kCmdWhat = 'WHAT', kCmdMusic = 'MUZK', kCmdSoundFX = 'SOUN', kCmdSave = 'SAVE',
  kCmdLoad = 'LOAD', kCmdRecall = 'RECL', kCmdTurbo = 'TURB', kCmdLook = 'LOOK',
  kCmdInvent = 'INVT', kCmdButton = 'BTNP', kCmdFinishEdit = 'FNSH'
}
 
enum  OverlayState { kOvlUndef, kOvlForeground, kOvlBackground }
 
enum  OvlType { kOvlBoundary, kOvlOverlay, kOvlBase }
 
enum  { LOOK_NAME = 1, TAKE_NAME }
 
enum  { LOOK = 1, TAKE = 2, DROP = 4, LOOK_S = 8 }
 
enum  TEXTCOLORS {
  _TBLACK, _TBLUE, _TGREEN, _TCYAN,
  _TRED, _TMAGENTA, _TBROWN, _TWHITE,
  _TGRAY, _TLIGHTBLUE, _TLIGHTGREEN, _TLIGHTCYAN,
  _TLIGHTRED, _TLIGHTMAGENTA, _TLIGHTYELLOW, _TBRIGHTWHITE
}
 
enum  Uif {
  U_FONT5, U_FONT6, U_FONT8, UIF_IMAGES,
  NUM_UIF_ITEMS
}
 
enum  Cycle {
  kCycleInvisible, kCycleAlmostInvisible, kCycleNotCycling, kCycleForward,
  kCycleBackward
}
 
enum  { SEQ_RIGHT, SEQ_LEFT, SEQ_DOWN, SEQ_UP }
 
enum  Font {
  LARGE_ROMAN, MED_ROMAN, NUM_GDI_FONTS, INIT_FONTS,
  DEL_FONTS
}
 
enum  Path {
  kPathUser, kPathAuto, kPathQuiet, kPathChase,
  kPathChase2, kPathWander, kPathWander2
}
 
enum  HUGOAction {
  kActionNone, kActionEscape, kActionMoveTop, kActionMoveBottom,
  kActionMoveLeft, kActionMoveRight, kActionMoveTopRight, kActionMoveTopLeft,
  kActionMoveBottomRight, kActionMoveBottomLeft, kActionUserHelp, kActionToggleSound,
  kActionRepeatLine, kActionSaveGame, kActionRestoreGame, kActionNewGame,
  kActionInventory, kActionToggleTurbo
}
 
enum  HugoDebugChannels {
  kDebugSchedule = 1 << 0, kDebugEngine = 1 << 1, kDebugDisplay = 1 << 2, kDebugMouse = 1 << 3,
  kDebugParser = 1 << 4, kDebugFile = 1 << 5, kDebugRoute = 1 << 6, kDebugInventory = 1 << 7,
  kDebugObject = 1 << 8, kDebugMusic = 1 << 9
}
 
enum  HugoRegistered { kRegShareware = 0, kRegRegistered, kRegFreeware }
 
enum  Istate { kInventoryOff, kInventoryUp, kInventoryDown, kInventoryActive }
 
enum  Vstate {
  kViewIdle, kViewIntroInit, kViewIntro, kViewPlay,
  kViewInvent, kViewExit
}
 
enum  { kPriorityForeground, kPriorityBackground, kPriorityFloating, kPriorityOverOverlay }
 
enum  Dupdate { kDisplayInit, kDisplayAdd, kDisplayDisplay, kDisplayRestore }
 
enum  Priority { kSoundPriorityLow, kSoundPriorityMedium, kSoundPriorityHigh }
 
enum  seqTextEngine { kEsAdvertise = 0 }
 
enum  seqTextIntro { kIntro1 = 0, kIntro2 = 1, kIntro3 = 2 }
 
enum  InvAct { kInventoryActionInit, kInventoryActionLeft, kInventoryActionRight, kInventoryActionGet }
 
enum  seqTextParser {
  kTBExit = 0, kTBMaze, kTBNoPoint, kTBNoun,
  kTBVerb, kTBEh, kTBUnusual, kTBHave,
  kTBNoUse, kTBDontHave, kTBNeed, kTBOk,
  kCmtAny1, kCmtAny2, kCmtAny3, kCmtClose,
  kTBIntro, kTBOutro, kTBUnusual_1d, kCmtAny4,
  kCmtAny5, kTBExit_1d, kTBEh_1d, kTBEh_2d,
  kTBNoUse_2d
}
 
enum  RouteType { kRouteSpace, kRouteExit, kRouteLook, kRouteGet }
 
enum  Action {
  ANULL = 0xff, ASCHEDULE = 0, START_OBJ, INIT_OBJXY,
  PROMPT, BKGD_COLOR, INIT_OBJVXY, INIT_CARRY,
  INIT_HF_COORD, NEW_SCREEN, INIT_OBJSTATE, INIT_PATH,
  COND_R, TEXT, SWAP_IMAGES, COND_SCR,
  AUTOPILOT, INIT_OBJ_SEQ, SET_STATE_BITS, CLEAR_STATE_BITS,
  TEST_STATE_BITS, DEL_EVENTS, GAMEOVER, INIT_HH_COORD,
  EXIT, BONUS, COND_BOX, SOUND,
  ADD_SCORE, SUB_SCORE, COND_CARRY, INIT_MAZE,
  EXIT_MAZE, INIT_PRIORITY, INIT_SCREEN, AGSCHEDULE,
  REMAPPAL, COND_NOUN, SCREEN_STATE, INIT_LIPS,
  INIT_STORY_MODE, WARN, COND_BONUS, TEXT_TAKE,
  YESNO, STOP_ROUTE, COND_ROUTE, INIT_JUMPEXIT,
  INIT_VIEW, INIT_OBJ_FRAME, OLD_SONG = 49
}
 
enum  seqTextUtil { kGameOver = 0 }
 

Variables

struct Hugo::hugoBoot PACKED_STRUCT
 

Detailed Description

This is the namespace of the Hugo engine.

Status of this engine: ???

Games using this engine:

  • Hugo's House of Horror
  • Whodunit?
  • Jungle of Doom
  • Hugo's Horrific Adventure
  • Hugo's Mystery Adventure
  • Hugo's Amazon Adventure

Typedef Documentation

◆ ImagePtr

typedef byte* Hugo::ImagePtr

Game specific type definitions

Enumeration Type Documentation

◆ OvlType

enum Hugo::OvlType

Enumerate overlay file types

◆ Cycle

enum Hugo::Cycle

Enumerate ways of cycling a sequence of frames

◆ anonymous enum

anonymous enum

Enumerate sequence index matching direction of travel

◆ Path

enum Hugo::Path

Enumerate the different path types for an object

◆ Istate

enum Hugo::Istate

Inventory icon bar states

◆ Vstate

enum Hugo::Vstate

Game view state machine

◆ anonymous enum

anonymous enum

Enumerate whether object is foreground, background or 'floating' If floating, HERO can collide with it and fore/back ground is determined by relative y-coord of object base. This is the general case. If fore or background, no collisions can take place and object is either behind or in front of all others, although can still be hidden by the the overlay plane. OVEROVL means the object is FLOATING (to other objects) but is never hidden by the overlay plane

◆ Dupdate

enum Hugo::Dupdate

Display list functions

◆ Priority

enum Hugo::Priority

Priority for sound effect

◆ InvAct

enum Hugo::InvAct

Actions for Process_inventory()

◆ RouteType

enum Hugo::RouteType

Purpose of an automatic route

◆ Action

enum Hugo::Action

Following defines the action types and action list