smse Namespace Reference


Detailed Description

a namespace for all the classes used by smse


Classes

class  App
 The application class and starting point. More...
class  FileIOException
 Exception thrown when File IO goes awry. More...
class  InvalidButtonException
 Exception thrown when an invalid button is detected. More...
class  InvalidSRAMDataException
 Thrown when invalid SRAM data is found. More...
class  InvalidSRAMFileException
 Exception thrown when a file is not a valid SRAM file. More...
class  SRAMFile
 Class to encapsulate a Super Metroid SRAM File. More...
class  Frame
 The main application frame. More...
class  SRAMFileTarget
 Class to implement a drop target for SRAM files on the Frame. More...

Enumerations

enum  {
  SO_CURRENTENERGY, SO_MAXENERGY, SO_CURRENTRESERVE, SO_MAXRESERVE,
  SO_CURRENTMISSILES, SO_MAXMISSILES, SO_CURRENTSMISSILES, SO_MAXSMISSILES,
  SO_CURRENTPBOMBS, SO_MAXPBOMBS, SO_MORPHINGBALL, SO_BOMBS = 13,
  SO_SPRINGBALL = 16, SO_HIGHJUMPBOOTS = 19, SO_VARIASUIT = 22, SO_GRAVITYSUIT = 25,
  SO_SPEEDBOOSTER = 28, SO_SPACEJUMP = 31, SO_SCREWATTACK = 34, SO_CHARGEBEAM = 37,
  SO_ICEBEAM = 40, SO_WAVEBEAM = 43, SO_SPAZER = 46, SO_PLASMABEAM = 49,
  SO_GRAPPLINGBEAM = 52, SO_XRAYSCOPE = 55, SO_SILVERTORIZO = 58, SO_SPORESPAWN,
  SO_KRAID, SO_PHANTOON = 62, SO_BOTWOON = 64, SO_DRAYGON,
  SO_CROCOMIRE = 67, SO_GOLDENTORIZO, SO_RIDLEY, SO_METROIDROOMS = 71,
  SO_ZEBETITES = 75, SO_TOURIANELEVATOR, SO_MARIDIATUBEBROKEN, SO_RESCUEDANIMALS,
  SO_CMISSILEPACKS, SO_BSMISSILEPACKS = 87, SO_NFMISSILEPACKS = 99, SO_WSMISSILEPACKS = 114,
  SO_MMISSILEPACKS = 117, SO_CSMISSILEPACKS = 125, SO_BSSMISSILEPACKS, SO_NFSMISSILEPACKS = 129,
  SO_WSSMISSILEPACKS, SO_MSMISSILEPACKS = 132, SO_CPBOMBPACKS = 135, SO_BSPBOMBPACKS,
  SO_NFPBOMBPACKS = 141, SO_MPBOMBPACKS = 144, SO_CETANKS, SO_BSETANKS = 147,
  SO_NFETANKS = 152, SO_WSETANKS = 156, SO_METANKS, SO_BSRTANK = 159,
  SO_NFRTANK, SO_WSRTANK, SO_MRTANK, SO_CRDOORS,
  SO_BSRDOORS = 166, SO_NFRDOORS = 176, SO_WSRDOORS = 183, SO_MRDOORS,
  SO_TRDOORS = 191, SO_CGDOORS = 193, SO_BSGDOORS = 195, SO_NFGDOORS = 205,
  SO_WSGDOORS = 211, SO_MGDOORS, SO_CYDOORS = 216, SO_BSYDOORS = 222,
  SO_NFYDOORS = 226, SO_CMDOORS = 229, SO_BSMDOORS, SO_NFMDOORS = 246,
  SO_WSMDOORS = 252, SO_MMDOORS = 257, SO_TMDOORS = 264, SO_BSEDOOR = 269,
  SO_NFEDOOR, SO_WSEDOOR, SO_MEDOOR, SO_TEDOOR,
  SO_CMAP, SO_BSMAP, SO_NFMAP, SO_WSMAP,
  SO_MMAP, SO_TMAP, SO_SAVEAREA, SO_SAVEPOINT,
  SO_GAMEHOURS, SO_GAMEMINUTES, SO_SHOTBUTTON, SO_JUMPBUTTON,
  SO_DASHBUTTON, SO_ITEMCANCELBUTTON, SO_ITEMSELECTBUTTON, SO_ANGLEDOWNBUTTON,
  SO_ANGLEUPBUTTON, SO_LANGUAGE, SO_MOONWALK, SO_ICONCANCEL
}
 names for the SRAM offsets More...
enum  Action {
  ACTION_SHOT, ACTION_JUMP, ACTION_DASH, ACTION_ITEMCANCEL,
  ACTION_ITEMSELECT, ACTION_ANGLEDOWN, ACTION_ANGLEUP
}
 semi-typesafe names for Samus' actions More...
enum  Area {
  AREA_C, AREA_BS, AREA_NF, AREA_WS,
  AREA_M, AREA_T
}
 semi-typesafe names for the areas on Zebes More...
enum  Boss {
  BOSS_SILVERTORIZO = 58, BOSS_SPORESPAWN, BOSS_KRAID, BOSS_PHANTOON = 62,
  BOSS_BOTWOON = 64, BOSS_DRAYGON, BOSS_CROCOMIRE = 67, BOSS_GOLDENTORIZO,
  BOSS_RIDLEY
}
 semi-typesafe names for the bosses More...
enum  Button {
  BUTTON_A, BUTTON_B, BUTTON_X, BUTTON_Y,
  BUTTON_L, BUTTON_R, BUTTON_SELECT
}
 semi-typesafe names for the controller buttons More...
enum  Door {
  RD_C_MAP = 163, RD_C_BOMBS, RD_C_TELEVATOR, RD_BS1,
  RD_BS_MAP, RD_BS2, RD_BS3, RD_BS4,
  RD_BS_RTANK, RD_BS_SPORESPAWN, RD_BS5, RD_BS6,
  RD_BS_XRAYSCOPE, RD_NF1, RD_NF_HJBOOTS, RD_NF2,
  RD_NF3, RD_NF_SPEEDBOOSTER, RD_NF4, RD_NF_WAVEBEAM,
  RD_WS_RTANK, RD_M1, RD_M2, RD_M3,
  RD_M_MAP, RD_M4, RD_M5, RD_M6,
  RD_T1, RD_T_MB, GD_C1, GD_C_WS,
  GD_BS1, GD_BS_SPORESPAWNEXIT, GD_BS2, GD_BS3,
  GD_BS4, GD_BS5, GD_BS6, GD_BS7,
  GD_BS_SPAZER, GD_BS8, GD_NF1, GD_NF_ICEBEAM,
  GD_NF2, GD_NF3, GD_NF_SPEEDBOOSTER, GD_NF4,
  GD_WS, GD_M1, GD_M2, GD_M3,
  GD_M_DRAYGON, YD_C1, YD_C2, YD_C3,
  YD_C4, YD_C5, YD_C6, YD_BS1,
  YD_BS2, YD_BS_XRAYSCOPE, YD_BS3, YD_NF_MAP,
  YD_NF1, YD_NF2, MD_C_BOMBSEXIT, MD_BS_OLDTRIGHT,
  MD_BS_OLDTLEFT, MD_BS_MAPEXIT, MD_BS1, MD_BS2,
  MD_BS3, MD_BS4, MD_BS5, MD_BS6,
  MD_BS7, MD_BS8, MD_BS9, MD_BS_MINIKRAIDRIGHT,
  MD_BS_MINIKRAIDLEFT, MD_BS_VARIASUIT, MD_BS_KRAIDEXIT, MD_NF_CROCOMIREEXIT,
  MD_NF_HJBOOTSEXIT, MD_NF_SCREWATTACK, MD_NF_RIDLEYEXIT, MD_NF_RIDLEYLEFT,
  MD_NF_GOLDSPACEPIRATES, MD_WS1, MD_WS_PHANTOONEXIT, MD_WS2,
  MD_WS3, MD_WS4, MD_M_PLASMAEXIT, MD_M_PLASMA,
  MD_M1, MD_M2, MD_M_BOTWOONEXIT, MD_M_DRAYGONEXIT,
  MD_M_SPACEJUMP, MD_T1, MD_T2, MD_T3,
  MD_T4, MD_T5, ED_KRAID, ED_RIDLEY,
  ED_PHANTOON, ED_DRAYGON, ED_T
}
 names for the doors More...
enum  Item {
  ITEM_MORPHINGBALL = 10, ITEM_BOMBS = 13, ITEM_SPRINGBALL = 16, ITEM_HJBOOTS = 19,
  ITEM_VARIASUIT = 22, ITEM_GRAVITYSUIT = 25, ITEM_SPEEDBOOSTER = 28, ITEM_SPACEJUMP = 31,
  ITEM_SCREWATTACK = 34, ITEM_CHARGEBEAM = 37, ITEM_ICEBEAM = 40, ITEM_WAVEBEAM = 43,
  ITEM_SPAZER = 46, ITEM_PLASMA = 49, ITEM_GRAPPLINGBEAM = 52, ITEM_XRAYSCOPE = 55
}
 semi-typesafe names for Samus' equipment More...
enum  MiscBit {
  MB_TELEVATOR = 76, MB_MTUBEBROKEN, MB_RESCUEDANIMALS, MB_LANGUAGE = 291,
  MB_MOONWALK, MB_ICONCANCEL
}
 semi-typesafe names for the miscellaneous bits More...
enum  MetroidRoom { MR1, MR2, MR3, MR4 }
 semi-typesafe names for the Metroid rooms in Tourian More...
enum  Statue { STATUE_KRAID = 61, STATUE_PHANTOON = 63, STATUE_DRAYGON = 66, STATUE_RIDLEY = 70 }
 semi-typesafe names for the boss statues More...

Functions

const wxString APP_NAME (wxT("Super Metroid SRAM Editor"))
const wxString APP_VERSION (wxT("1.0a"))
const wxString APP_COPYRIGHT (wxT("Copyright (C) 2005,2007-2008 emuWorks"))
const wxString APP_URL (wxT("http://games.technoplaza.net/"))

Variables

const wxString APP_NAME
 The application name.
const wxString APP_VERSION
 The current version.
const wxString APP_COPYRIGHT
 The copyright notice.
const wxString APP_URL
 The website URL.
const int C_SAVEPOINTS = 2
 save points in Crateria
const int BS_SAVEPOINTS = 5
 save points in Brinstar
const int NF_SAVEPOINTS = 6
 save points in Norfair
const int WS_SAVEPOINTS = 1
 save points in Wrecked Ship
const int M_SAVEPOINTS = 4
 save points in Maridia
const int T_SAVEPOINTS = 2
 save points in Tourian


Enumeration Type Documentation

anonymous enum

names for the SRAM offsets

Enumerator:
SO_CURRENTENERGY 
SO_MAXENERGY 
SO_CURRENTRESERVE 
SO_MAXRESERVE 
SO_CURRENTMISSILES 
SO_MAXMISSILES 
SO_CURRENTSMISSILES 
SO_MAXSMISSILES 
SO_CURRENTPBOMBS 
SO_MAXPBOMBS 
SO_MORPHINGBALL 
SO_BOMBS 
SO_SPRINGBALL 
SO_HIGHJUMPBOOTS 
SO_VARIASUIT 
SO_GRAVITYSUIT 
SO_SPEEDBOOSTER 
SO_SPACEJUMP 
SO_SCREWATTACK 
SO_CHARGEBEAM 
SO_ICEBEAM 
SO_WAVEBEAM 
SO_SPAZER 
SO_PLASMABEAM 
SO_GRAPPLINGBEAM 
SO_XRAYSCOPE 
SO_SILVERTORIZO 
SO_SPORESPAWN 
SO_KRAID 
SO_PHANTOON 
SO_BOTWOON 
SO_DRAYGON 
SO_CROCOMIRE 
SO_GOLDENTORIZO 
SO_RIDLEY 
SO_METROIDROOMS 
SO_ZEBETITES 
SO_TOURIANELEVATOR 
SO_MARIDIATUBEBROKEN 
SO_RESCUEDANIMALS 
SO_CMISSILEPACKS 
SO_BSMISSILEPACKS 
SO_NFMISSILEPACKS 
SO_WSMISSILEPACKS 
SO_MMISSILEPACKS 
SO_CSMISSILEPACKS 
SO_BSSMISSILEPACKS 
SO_NFSMISSILEPACKS 
SO_WSSMISSILEPACKS 
SO_MSMISSILEPACKS 
SO_CPBOMBPACKS 
SO_BSPBOMBPACKS 
SO_NFPBOMBPACKS 
SO_MPBOMBPACKS 
SO_CETANKS 
SO_BSETANKS 
SO_NFETANKS 
SO_WSETANKS 
SO_METANKS 
SO_BSRTANK 
SO_NFRTANK 
SO_WSRTANK 
SO_MRTANK 
SO_CRDOORS 
SO_BSRDOORS 
SO_NFRDOORS 
SO_WSRDOORS 
SO_MRDOORS 
SO_TRDOORS 
SO_CGDOORS 
SO_BSGDOORS 
SO_NFGDOORS 
SO_WSGDOORS 
SO_MGDOORS 
SO_CYDOORS 
SO_BSYDOORS 
SO_NFYDOORS 
SO_CMDOORS 
SO_BSMDOORS 
SO_NFMDOORS 
SO_WSMDOORS 
SO_MMDOORS 
SO_TMDOORS 
SO_BSEDOOR 
SO_NFEDOOR 
SO_WSEDOOR 
SO_MEDOOR 
SO_TEDOOR 
SO_CMAP 
SO_BSMAP 
SO_NFMAP 
SO_WSMAP 
SO_MMAP 
SO_TMAP 
SO_SAVEAREA 
SO_SAVEPOINT 
SO_GAMEHOURS 
SO_GAMEMINUTES 
SO_SHOTBUTTON 
SO_JUMPBUTTON 
SO_DASHBUTTON 
SO_ITEMCANCELBUTTON 
SO_ITEMSELECTBUTTON 
SO_ANGLEDOWNBUTTON 
SO_ANGLEUPBUTTON 
SO_LANGUAGE 
SO_MOONWALK 
SO_ICONCANCEL 

Definition at line 39 of file SRAMFile.hh.

enum smse::Action

semi-typesafe names for Samus' actions

Enumerator:
ACTION_SHOT 
ACTION_JUMP 
ACTION_DASH 
ACTION_ITEMCANCEL 
ACTION_ITEMSELECT 
ACTION_ANGLEDOWN 
ACTION_ANGLEUP 

Definition at line 107 of file SRAMFile.hh.

enum smse::Area

semi-typesafe names for the areas on Zebes

Enumerator:
AREA_C 
AREA_BS 
AREA_NF 
AREA_WS 
AREA_M 
AREA_T 

Definition at line 113 of file SRAMFile.hh.

enum smse::Boss

semi-typesafe names for the bosses

Enumerator:
BOSS_SILVERTORIZO 
BOSS_SPORESPAWN 
BOSS_KRAID 
BOSS_PHANTOON 
BOSS_BOTWOON 
BOSS_DRAYGON 
BOSS_CROCOMIRE 
BOSS_GOLDENTORIZO 
BOSS_RIDLEY 

Definition at line 118 of file SRAMFile.hh.

enum smse::Button

semi-typesafe names for the controller buttons

Enumerator:
BUTTON_A 
BUTTON_B 
BUTTON_X 
BUTTON_Y 
BUTTON_L 
BUTTON_R 
BUTTON_SELECT 

Definition at line 125 of file SRAMFile.hh.

enum smse::Door

names for the doors

Enumerator:
RD_C_MAP 
RD_C_BOMBS 
RD_C_TELEVATOR 
RD_BS1 
RD_BS_MAP 
RD_BS2 
RD_BS3 
RD_BS4 
RD_BS_RTANK 
RD_BS_SPORESPAWN 
RD_BS5 
RD_BS6 
RD_BS_XRAYSCOPE 
RD_NF1 
RD_NF_HJBOOTS 
RD_NF2 
RD_NF3 
RD_NF_SPEEDBOOSTER 
RD_NF4 
RD_NF_WAVEBEAM 
RD_WS_RTANK 
RD_M1 
RD_M2 
RD_M3 
RD_M_MAP 
RD_M4 
RD_M5 
RD_M6 
RD_T1 
RD_T_MB 
GD_C1 
GD_C_WS 
GD_BS1 
GD_BS_SPORESPAWNEXIT 
GD_BS2 
GD_BS3 
GD_BS4 
GD_BS5 
GD_BS6 
GD_BS7 
GD_BS_SPAZER 
GD_BS8 
GD_NF1 
GD_NF_ICEBEAM 
GD_NF2 
GD_NF3 
GD_NF_SPEEDBOOSTER 
GD_NF4 
GD_WS 
GD_M1 
GD_M2 
GD_M3 
GD_M_DRAYGON 
YD_C1 
YD_C2 
YD_C3 
YD_C4 
YD_C5 
YD_C6 
YD_BS1 
YD_BS2 
YD_BS_XRAYSCOPE 
YD_BS3 
YD_NF_MAP 
YD_NF1 
YD_NF2 
MD_C_BOMBSEXIT 
MD_BS_OLDTRIGHT 
MD_BS_OLDTLEFT 
MD_BS_MAPEXIT 
MD_BS1 
MD_BS2 
MD_BS3 
MD_BS4 
MD_BS5 
MD_BS6 
MD_BS7 
MD_BS8 
MD_BS9 
MD_BS_MINIKRAIDRIGHT 
MD_BS_MINIKRAIDLEFT 
MD_BS_VARIASUIT 
MD_BS_KRAIDEXIT 
MD_NF_CROCOMIREEXIT 
MD_NF_HJBOOTSEXIT 
MD_NF_SCREWATTACK 
MD_NF_RIDLEYEXIT 
MD_NF_RIDLEYLEFT 
MD_NF_GOLDSPACEPIRATES 
MD_WS1 
MD_WS_PHANTOONEXIT 
MD_WS2 
MD_WS3 
MD_WS4 
MD_M_PLASMAEXIT 
MD_M_PLASMA 
MD_M1 
MD_M2 
MD_M_BOTWOONEXIT 
MD_M_DRAYGONEXIT 
MD_M_SPACEJUMP 
MD_T1 
MD_T2 
MD_T3 
MD_T4 
MD_T5 
ED_KRAID 
ED_RIDLEY 
ED_PHANTOON 
ED_DRAYGON 
ED_T 

Definition at line 131 of file SRAMFile.hh.

enum smse::Item

semi-typesafe names for Samus' equipment

Enumerator:
ITEM_MORPHINGBALL 
ITEM_BOMBS 
ITEM_SPRINGBALL 
ITEM_HJBOOTS 
ITEM_VARIASUIT 
ITEM_GRAVITYSUIT 
ITEM_SPEEDBOOSTER 
ITEM_SPACEJUMP 
ITEM_SCREWATTACK 
ITEM_CHARGEBEAM 
ITEM_ICEBEAM 
ITEM_WAVEBEAM 
ITEM_SPAZER 
ITEM_PLASMA 
ITEM_GRAPPLINGBEAM 
ITEM_XRAYSCOPE 

Definition at line 204 of file SRAMFile.hh.

enum smse::MetroidRoom

semi-typesafe names for the Metroid rooms in Tourian

Enumerator:
MR1 
MR2 
MR3 
MR4 

Definition at line 220 of file SRAMFile.hh.

enum smse::MiscBit

semi-typesafe names for the miscellaneous bits

Enumerator:
MB_TELEVATOR 
MB_MTUBEBROKEN 
MB_RESCUEDANIMALS 
MB_LANGUAGE 
MB_MOONWALK 
MB_ICONCANCEL 

Definition at line 214 of file SRAMFile.hh.

enum smse::Statue

semi-typesafe names for the boss statues

Enumerator:
STATUE_KRAID 
STATUE_PHANTOON 
STATUE_DRAYGON 
STATUE_RIDLEY 

Definition at line 225 of file SRAMFile.hh.


Function Documentation

const wxString smse::APP_COPYRIGHT ( wxT("Copyright (C) 2005,2007-2008 emuWorks")   ) 

const wxString smse::APP_NAME ( wxT("Super Metroid SRAM Editor")   ) 

const wxString smse::APP_URL ( wxT("http://games.technoplaza.net/")   ) 

const wxString smse::APP_VERSION ( wxT("1.0a")   ) 


Variable Documentation

const wxString smse::APP_COPYRIGHT

The copyright notice.

const wxString smse::APP_NAME

The application name.

const wxString smse::APP_URL

The website URL.

const wxString smse::APP_VERSION

The current version.

const int smse::BS_SAVEPOINTS = 5

save points in Brinstar

Definition at line 234 of file SRAMFile.hh.

const int smse::C_SAVEPOINTS = 2

save points in Crateria

Definition at line 231 of file SRAMFile.hh.

const int smse::M_SAVEPOINTS = 4

save points in Maridia

Definition at line 243 of file SRAMFile.hh.

const int smse::NF_SAVEPOINTS = 6

save points in Norfair

Definition at line 237 of file SRAMFile.hh.

const int smse::T_SAVEPOINTS = 2

save points in Tourian

Definition at line 246 of file SRAMFile.hh.

const int smse::WS_SAVEPOINTS = 1

save points in Wrecked Ship

Definition at line 240 of file SRAMFile.hh.


Generated on Mon Dec 29 01:15:57 2008 for Super Metroid SRAM Editor by  doxygen 1.5.4