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

Classes

class  AAHeader
 
struct  ActionDetails
 
struct  ActionSavedFields
 
class  Animation
 
class  AnimationView
 
class  AnimFrameEntry
 
class  AnimMessage
 
class  AnimMiscEntry
 
class  AnimUIEntry
 
struct  ARTHeader
 
class  AudioPlayer
 
class  BaseSurface
 
struct  BGR8
 
class  Camera
 
struct  ConvDialog
 
class  Conversation
 
struct  ConversationConditionals
 
struct  ConversationData
 
struct  ConversationEntry
 
struct  ConversationVar
 
struct  ConvMessage
 
struct  ConvNode
 
class  Debugger
 
class  DepthSurface
 
class  Dialog
 
class  Dialogs
 
class  DialogScript
 
class  DirtyArea
 
class  DirtyAreas
 
struct  DrawRequestX
 
struct  DSREntry
 
class  DynamicHotspot
 
class  DynamicHotspots
 
class  EventsManager
 
class  EventTarget
 
class  FabDecompressor
 
class  Fader
 
class  File
 
class  Font
 
class  FullScreenDialog
 
class  Game
 
class  GameConversations
 
class  Globals
 
class  Hotspot
 
class  Hotspots
 
class  InventoryObject
 
class  InventoryObjects
 
class  KernelMessage
 
class  KernelMessages
 
class  MADSAction
 
class  MADSEngine
 
struct  MADSGameDescription
 
class  MadsPack
 
struct  MadsPackEntry
 
struct  MADSSavegameHeader
 
class  MenuView
 
class  MessageDialog
 
class  MpsInstaller
 
class  MSprite
 
class  MSurface
 
class  Palette
 
struct  PaletteCycle
 
class  PaletteUsage
 
class  Player
 
class  Rails
 
struct  RandomEntry
 
class  RandomMessages
 
struct  RendCell
 
struct  ResIndexEntry
 
struct  ResourceEntry
 
class  Resources
 
struct  RGB6
 
class  RGBList
 
class  Scene
 
class  SceneInfo
 
class  SceneLogic
 
class  Screen
 
class  ScreenObject
 
class  ScreenObjects
 
struct  ScriptEntry
 
class  SectionHandler
 
struct  SequenceEntry
 
class  SequenceList
 
struct  SequenceSubEntries
 
class  SoundManager
 
class  SpriteAsset
 
struct  SpriteAssetFrame
 
struct  SpriteFrameHeader
 
struct  SpriteInfo
 
struct  SpriteSeriesHeader
 
class  SpriteSetCharInfo
 
class  SpriteSets
 
class  SpriteSlot
 
class  SpriteSlots
 
class  SpriteSlotSubset
 
struct  StopWalkerEntry
 
class  StopWalkers
 
class  SynchronizedList
 
class  TextDialog
 
class  TextDisplay
 
class  TextDisplayList
 
struct  TextLine
 
class  TextView
 
class  UISlot
 
class  UISlots
 
class  UserInterface
 
class  VerbInit
 
class  VisitedScenes
 
class  WalkNode
 

Typedefs

typedef Common::Array< WalkNode > WalkNodeList
 

Enumerations

enum  TriggerMode { SEQUENCE_TRIGGER_NONE = -1, SEQUENCE_TRIGGER_PARSER = 0, SEQUENCE_TRIGGER_DAEMON = 1, SEQUENCE_TRIGGER_PREPARE = 2 }
 
enum  InterAwaiting {
  AWAITING_NONE = 0, AWAITING_COMMAND = 1, AWAITING_THIS = 2, AWAITING_THAT = 3,
  AWAITING_RIGHT_MOUSE = 4
}
 
enum  {
  VERB_NONE = 0, VERB_LOOK = 3, VERB_TAKE = 4, VERB_PUSH = 5,
  VERB_OPEN = 6, VERB_PUT = 7, VERB_TALKTO = 8, VERB_GIVE = 9,
  VERB_PULL = 10, VERB_CLOSE = 11, VERB_THROW = 12, VERB_WALKTO = 13
}
 
enum  VerbType { VERB_ONLY, VERB_THIS, VERB_THAT, VERB_INIT }
 
enum  PrepType {
  PREP_NONE, PREP_WITH, PREP_TO, PREP_AT,
  PREP_FROM, PREP_ON, PREP_IN, PREP_UNDER,
  PREP_BEHIND, PREP_RELATIONAL = 0xff
}
 
enum  ScrCategory {
  CAT_NONE = 0, CAT_COMMAND = 1, CAT_INV_LIST = 2, CAT_INV_VOCAB = 3,
  CAT_HOTSPOT = 4, CAT_INV_ANIM = 5, CAT_TALK_ENTRY = 6, CAT_INV_SCROLLER = 7,
  CAT_12 = 12
}
 
enum  AnimFlag {
  ANIMFLAG_LOAD_BACKGROUND = 0x0100, ANIMFLAG_LOAD_BACKGROUND_ONLY = 0x0200, ANIMFLAG_DITHER = 0x0001, ANIMFLAG_CUSTOM_FONT = 0x2000,
  ANIMFLAG_ANIMVIEW = 0x4000
}
 
enum  AnimBgType { ANIMBG_ROOM = 1, ANIMBG_FULL_SIZE = 2, ANIMBG_BLACK_SCREEN = 3, ANIMBG_INTERFACE = 4 }
 
enum  AssetFlags { ASSET_TRANSLATE = 1, ASSET_HEADER_ONLY = 2, ASSET_CHAR_INFO = 4, ASSET_SPINNING_OBJECT = 8 }
 
enum  CompressionType { COMPRESS_NONE = 0, COMPRESS_FAB = 1 }
 
enum  ConversationMode {
  CONVMODE_NONE = -1, CONVMODE_NEXT = 0, CONVMODE_WAIT_AUTO = 1, CONVMODE_WAIT_ENTRY = 2,
  CONVMODE_EXECUTE = 3, CONVMODE_REPLY = 4, CONVMODE_5 = 5, CONVMODE_6 = 6,
  CONVMODE_7 = 7, CONVMODE_8 = 8, CONVMODE_9 = 9, CONVMODE_STOP = 10
}
 
enum  DialogCommand {
  CMD_END = 0, CMD_1 = 1, CMD_HIDE = 2, CMD_UNHIDE = 3,
  CMD_MESSAGE1 = 4, CMD_MESSAGE2 = 5, CMD_ERROR = 6, CMD_NODE = 7,
  CMD_GOTO = 8, CMD_ASSIGN = 9, CMD_DIALOG_END = 255
}
 
enum  ConvEntryFlag { ENTRYFLAG_2 = 2, ENTRYFLAG_4000 = 0x4000, ENTRYFLAG_8000 = 0x8000 }
 
enum  ConditionalOperation {
  CONDOP_NONE = 0xff, CONDOP_VALUE = 0, CONDOP_ADD = 1, CONDOP_SUBTRACT = 2,
  CONDOP_MULTIPLY = 3, CONDOP_DIVIDE = 4, CONDOP_MODULUS = 5, CONDOP_LTEQ = 6,
  CONDOP_GTEQ = 7, CONDOP_LT = 8, CONDOP_GT = 9, CONDOP_NEQ = 10,
  CONDOP_EQ = 11, CONDOP_AND = 12, CONDOP_OR = 13, CONDOP_ABORT = 0xff
}
 
enum  { GType_RexNebular = 0, GType_Dragonsphere = 1, GType_Phantom = 2, GType_Forest = 3 }
 
enum  { GF_INSTALLER = 1 }
 
enum  DialogId {
  DIALOG_NONE = 0, DIALOG_GAME_MENU = 1, DIALOG_SAVE = 2, DIALOG_RESTORE = 3,
  DIALOG_OPTIONS = 4, DIALOG_DIFFICULTY = 5, DIALOG_ERROR = 6, DIALOG_MAIN_MENU = 7,
  DIALOG_TEXTVIEW = 8, DIALOG_ANIMVIEW = 9, DIALOG_ADVERT = 10
}
 
enum  CursorType {
  CURSOR_NONE = 0, CURSOR_ARROW = 1, CURSOR_WAIT = 2, CURSOR_GO_DOWN = 3,
  CURSOR_GO_UP = 4, CURSOR_GO_LEFT = 5, CURSOR_GO_RIGHT = 6
}
 
enum  SelectionMode { SELMODE_UNSELECTED = 0, SELMODE_HIGHLIGHTED = 1, SELMODE_SELECTED = 2 }
 
enum  KernelMode {
  KERNEL_GAME_LOAD = 0, KERNEL_SECTION_PRELOAD = 1, KERNEL_SECTION_INIT = 2, KERNEL_ROOM_PRELOAD = 3,
  KERNEL_ROOM_INIT = 4, KERNEL_ACTIVE_CODE = 5
}
 
enum  SyncType { SYNC_SEQ = 1, SYNC_PLAYER = 2, SYNC_ANIM = 3, SYNC_CLOCK = 4 }
 
enum  { PLAYER_INVENTORY = 2, NOWHERE = 1 }
 
enum  MADSActions {
  kActionNone, kActionEscape, kActionGameMenu, kActionSave,
  kActionRestore, kActionScrollUp, kActionScrollDown, kActionStartGame,
  kActionResumeGame, kActionShowIntro, kActionCredits, kActionQuotes,
  kActionRestartAnimation
}
 
enum  MADSDebugChannels { kDebugPath = 1 << 0, kDebugScripts = 1 << 1, kDebugGraphics = 1 << 2 }
 
enum  ScreenFade { SCREEN_FADE_SMOOTH = 0, SCREEN_FADE_MEDIUM = 1, SCREEN_FADE_FAST = 2 }
 
enum  ResyncMode { NEVER, ALWAYS, BEGINNING }
 
enum  KernelMessageFlags {
  KMSG_QUOTED = 1, KMSG_PLAYER_TIMEOUT = 2, KMSG_SEQ_ENTRY = 4, KMSG_SCROLL = 8,
  KMSG_RIGHT_ALIGN = 0x10, KMSG_CENTER_ALIGN = 0x20, KMSG_EXPIRE = 0x40, KMSG_ACTIVE = 0x80,
  KMSG_ANIM = 0x100
}
 
enum  {
  PALFLAG_BACKGROUND = 0x8000, PALFLAG_RESERVED = 0x4000, PALFLAG_ANY_TO_CLOSEST = 0x2000, PALFLAG_ALL_TO_CLOSEST = 0x1000,
  PALFLAG_TOP_COLORS = 0x0800, PALFLAG_DEFINE_RESERVED = 0x0400, PALFLAG_MASK = 0xfc00
}
 
enum  Facing {
  FACING_NORTH = 8, FACING_SOUTH = 2, FACING_EAST = 6, FACING_WEST = 4,
  FACING_NORTHEAST = 9, FACING_SOUTHEAST = 3, FACING_SOUTHWEST = 1, FACING_NORTHWEST = 7,
  FACING_NONE = 5, FACING_DUMMY = 0
}
 
enum  RESPREFIX { RESPREFIX_GL = 1, RESPREFIX_SC = 2, RESPREFIX_RM = 3 }
 
enum  EXTTYPE {
  EXT_NONE = -1, EXT_SS = 1, EXT_AA = 2, EXT_DAT = 3,
  EXT_HH = 4, EXT_ART = 5, EXT_INT = 6
}
 
enum  { RETURNING_FROM_DIALOG = -2, RETURNING_FROM_LOADING = -1 }
 
enum  { SCENEFLAG_DITHER = 0x01, SCENEFLAG_LOAD_SHADOW = 0x10, SCENEFLAG_TRANSLATE = 0x10000 }
 
enum  ScreenMode { SCREENMODE_VGA = 19 }
 
enum  ScreenTransition {
  kTransitionNone = 0, kTransitionFadeIn, kTransitionFadeOutIn, kTransitionBoxInBottomLeft,
  kTransitionBoxInBottomRight, kTransitionBoxInTopLeft, kTransitionBoxInTopRight, kTransitionPanLeftToRight,
  kTransitionPanRightToLeft, kTransitionCircleIn1, kTransitionCircleIn2, kTransitionCircleIn3,
  kTransitionCircleIn4, kVertTransition1, kVertTransition2, kVertTransition3,
  kVertTransition4, kVertTransition5, kVertTransition6, kVertTransition7,
  kNullPaletteCopy
}
 
enum  InputMode { kInputBuildingSentences = 0, kInputConversation = 1, kInputLimitedSentences = 2 }
 
enum  ThroughBlack { THROUGH_BLACK1 = 1, THROUGH_BLACK2 = 2 }
 
enum  SequenceTrigger { SEQUENCE_TRIGGER_EXPIRE = 0, SEQUENCE_TRIGGER_LOOP = 1, SEQUENCE_TRIGGER_SPRITE = 2 }
 
enum  SpriteAnimType { ANIMTYPE_NONE = 0, ANIMTYPE_CYCLED = 1, ANIMTYPE_PING_PONG = 2, ANIMTYPE_STAMP = 9 }
 
enum  SpriteFlags {
  IMG_STATIC = 0, IMG_UPDATE = 1, IMG_ERASE = -1, IMG_REFRESH = -2,
  IMG_OVERPRINT = -3, IMG_DELTA = -4, IMG_FULL_UPDATE = -5, IMG_UPDATE_ONLY = -20
}
 
enum  { IMG_SPINNING_OBJECT = 200, IMG_TEXT_UPDATE = 201 }
 
enum  ScrollbarActive {
  SCROLLBAR_NONE = 0, SCROLLBAR_UP = 1, SCROLLBAR_DOWN = 2, SCROLLBAR_ELEVATOR = 3,
  SCROLLBAR_THUMB = 4
}
 

Variables

const char *const kArticleList [9]
 
const char *const kCheatingEnabledDesc [3]
 
const char *const kLookAroundStr
 
const char *const kToStr
 
const char *const kUseStr
 
const char *const kWalkToStr
 
const char *const kFenceStr
 
const char *const kOverStr
 
const char *const kGameReleaseInfoStr
 
const char *const kGameReleaseTitleStr
 
const uint32 DEFAULT_VGA_LOW_PALETTE [16]
 
const uint32 DEFAULT_VGA_HIGH_PALETTE [16]
 

Detailed Description

This is the namespace of the MADS engine.

Status of this engine: In Development

Games using this engine:

  • Rex Nebular and the Cosmic Gender Bender

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Palette mapping options

◆ Facing

enum MADS::Facing

Player facings