Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members

GameConstantsAndTypes.h File Reference

#include "PlayerNumber.h"
#include "EnumHelper.h"

Go to the source code of this file.

Classes

struct  DisplayBpms

Defines

#define FOREACH_RadarCategory(rc)   FOREACH_ENUM( RadarCategory, NUM_RADAR_CATEGORIES, rc )
#define FOREACH_StepsType(st)   FOREACH_ENUM( StepsType, NUM_STEPS_TYPES, st )
#define FOREACH_PlayMode(pm)   FOREACH_ENUM( PlayMode, NUM_PLAY_MODES, pm )
#define FOREACH_SortOrder(so)   FOREACH_ENUM( SortOrder, NUM_SORT_ORDERS, so )
#define FOREACH_TapNoteScore(tns)   FOREACH_ENUM( TapNoteScore, NUM_TAP_NOTE_SCORES, tns )
#define FOREACH_HoldNoteScore(hns)   FOREACH_ENUM( HoldNoteScore, NUM_HOLD_NOTE_SCORES, hns )
#define FOREACH_ProfileSlot(slot)   FOREACH_ENUM( ProfileSlot, NUM_PROFILE_SLOTS, slot )
#define FOREACH_RankingCategory(rc)   FOREACH_ENUM( RankingCategory, NUM_RANKING_CATEGORIES, rc )
#define GROUP_ALL_MUSIC   CString("--ALL MUSIC--")
#define BG_ANIMS_DIR   CString("BGAnimations/")
#define VISUALIZATIONS_DIR   CString("Visualizations/")
#define RANDOMMOVIES_DIR   CString("RandomMovies/")
#define DATA_DIR   CString("Data/")
#define FOREACH_PerDifficultyAward(pma)   FOREACH_ENUM( PerDifficultyAward, NUM_PER_DIFFICULTY_AWARDS, pma )
#define FOREACH_PeakComboAward(pca)   FOREACH_ENUM( PeakComboAward, NUM_PEAK_COMBO_AWARDS, pca )

Enumerations

enum  RadarCategory {
  RADAR_STREAM = 0, RADAR_VOLTAGE, RADAR_AIR, RADAR_FREEZE,
  RADAR_CHAOS, RADAR_NUM_TAPS_AND_HOLDS, RADAR_NUM_JUMPS, RADAR_NUM_HOLDS,
  RADAR_NUM_MINES, RADAR_NUM_HANDS, NUM_RADAR_CATEGORIES
}
enum  StepsType {
  STEPS_TYPE_DANCE_SINGLE = 0, STEPS_TYPE_DANCE_DOUBLE, STEPS_TYPE_DANCE_COUPLE, STEPS_TYPE_DANCE_SOLO,
  STEPS_TYPE_PUMP_SINGLE, STEPS_TYPE_PUMP_HALFDOUBLE, STEPS_TYPE_PUMP_DOUBLE, STEPS_TYPE_PUMP_COUPLE,
  STEPS_TYPE_EZ2_SINGLE, STEPS_TYPE_EZ2_DOUBLE, STEPS_TYPE_EZ2_REAL, STEPS_TYPE_PARA_SINGLE,
  STEPS_TYPE_PARA_VERSUS, STEPS_TYPE_DS3DDX_SINGLE, STEPS_TYPE_BM_SINGLE5, STEPS_TYPE_BM_DOUBLE5,
  STEPS_TYPE_BM_SINGLE7, STEPS_TYPE_BM_DOUBLE7, STEPS_TYPE_MANIAX_SINGLE, STEPS_TYPE_MANIAX_DOUBLE,
  STEPS_TYPE_TECHNO_SINGLE4, STEPS_TYPE_TECHNO_SINGLE5, STEPS_TYPE_TECHNO_SINGLE8, STEPS_TYPE_TECHNO_DOUBLE4,
  STEPS_TYPE_TECHNO_DOUBLE5, STEPS_TYPE_PNM_FIVE, STEPS_TYPE_PNM_NINE, STEPS_TYPE_LIGHTS_CABINET,
  NUM_STEPS_TYPES, STEPS_TYPE_INVALID
}
enum  PlayMode {
  PLAY_MODE_REGULAR, PLAY_MODE_NONSTOP, PLAY_MODE_ONI, PLAY_MODE_ENDLESS,
  PLAY_MODE_BATTLE, PLAY_MODE_RAVE, NUM_PLAY_MODES, PLAY_MODE_INVALID
}
enum  SortOrder {
  SORT_PREFERRED, SORT_GROUP, SORT_TITLE, SORT_BPM,
  SORT_MOST_PLAYED, SORT_GRADE, SORT_ARTIST, SORT_EASY_METER,
  SORT_MEDIUM_METER, SORT_HARD_METER, SORT_CHALLENGE_METER, SORT_SORT_MENU,
  SORT_MODE_MENU, SORT_ALL_COURSES, SORT_NONSTOP_COURSES, SORT_ONI_COURSES,
  SORT_ENDLESS_COURSES, SORT_ROULETTE, NUM_SORT_ORDERS, SORT_INVALID
}
enum  TapNoteScore {
  TNS_NONE, TNS_HIT_MINE, TNS_MISS, TNS_BOO,
  TNS_GOOD, TNS_GREAT, TNS_PERFECT, TNS_MARVELOUS,
  NUM_TAP_NOTE_SCORES
}
enum  HoldNoteScore { HNS_NONE, HNS_NG, HNS_OK, NUM_HOLD_NOTE_SCORES }
enum  ProfileSlot {
  PROFILE_SLOT_PLAYER_1, PROFILE_SLOT_PLAYER_2, PROFILE_SLOT_MACHINE, NUM_PROFILE_SLOTS,
  PROFILE_SLOT_INVALID
}
enum  MemoryCardState {
  MEMORY_CARD_STATE_READY, MEMORY_CARD_STATE_TOO_LATE, MEMORY_CARD_STATE_WRITE_ERROR, MEMORY_CARD_STATE_NO_CARD,
  NUM_MEMORY_CARD_STATES, MEMORY_CARD_STATE_INVALID
}
enum  RankingCategory {
  RANKING_A, RANKING_B, RANKING_C, RANKING_D,
  NUM_RANKING_CATEGORIES, RANKING_INVALID
}
enum  PlayerController { PC_HUMAN, PC_CPU, PC_AUTOPLAY, NUM_PLAYER_CONTROLLERS }
enum  StageResult { RESULT_WIN, RESULT_LOSE, RESULT_DRAW }
enum  AttackLevel { ATTACK_LEVEL_1, ATTACK_LEVEL_2, ATTACK_LEVEL_3, NUM_ATTACK_LEVELS }
enum  CoinMode { COIN_HOME, COIN_PAY, COIN_FREE, NUM_COIN_MODES }
enum  Premium { PREMIUM_NONE, PREMIUM_DOUBLES, PREMIUM_JOINT, NUM_PREMIUMS }
enum  PerDifficultyAward {
  AWARD_FULL_COMBO_GREATS, AWARD_SINGLE_DIGIT_GREATS, AWARD_ONE_GREAT, AWARD_FULL_COMBO_PERFECTS,
  AWARD_SINGLE_DIGIT_PERFECTS, AWARD_ONE_PERFECT, AWARD_FULL_COMBO_MARVELOUSES, AWARD_GREATS_80_PERCENT,
  AWARD_GREATS_90_PERCENT, AWARD_GREATS_100_PERCENT, NUM_PER_DIFFICULTY_AWARDS, PER_DIFFICULTY_AWARD_INVALID
}
enum  PeakComboAward {
  AWARD_1000_PEAK_COMBO, AWARD_2000_PEAK_COMBO, AWARD_3000_PEAK_COMBO, AWARD_4000_PEAK_COMBO,
  AWARD_5000_PEAK_COMBO, AWARD_6000_PEAK_COMBO, AWARD_7000_PEAK_COMBO, AWARD_8000_PEAK_COMBO,
  AWARD_9000_PEAK_COMBO, AWARD_10000_PEAK_COMBO, NUM_PEAK_COMBO_AWARDS, PEAK_COMBO_AWARD_INVALID
}
enum  StyleType { ONE_PLAYER_ONE_SIDE, TWO_PLAYERS_TWO_SIDES, ONE_PLAYER_TWO_SIDES, NUM_STYLE_TYPES }

Functions

const CString & RadarCategoryToString (RadarCategory cat)
CString RadarCategoryToThemedString (RadarCategory cat)
const CString & PlayModeToString (PlayMode pm)
CString PlayModeToThemedString (PlayMode pm)
PlayMode StringToPlayMode (const CString &s)
const CString & SortOrderToString (SortOrder so)
SortOrder StringToSortOrder (const CString &str)
bool IsSongSort (SortOrder so)
const CString & TapNoteScoreToString (TapNoteScore tns)
CString TapNoteScoreToThemedString (TapNoteScore tns)
TapNoteScore StringToTapNoteScore (const CString &str)
const CString & HoldNoteScoreToString (HoldNoteScore hns)
CString HoldNoteScoreToThemedString (HoldNoteScore hns)
HoldNoteScore StringToHoldNoteScore (const CString &str)
const CString & MemoryCardStateToString (MemoryCardState mcs)
const CString & RankingCategoryToString (RankingCategory rc)
RankingCategory StringToRankingCategory (const CString &rc)
bool IsRankingToFillIn (const CString &sName)
RankingCategory AverageMeterToRankingCategory (int iAverageMeter)
const CString & CoinModeToString (CoinMode cm)
const CString & PremiumToString (Premium p)
const CString & PerDifficultyAwardToString (PerDifficultyAward pma)
CString PerDifficultyAwardToThemedString (PerDifficultyAward pma)
PerDifficultyAward StringToPerDifficultyAward (const CString &pma)
const CString & PeakComboAwardToString (PeakComboAward pma)
CString PeakComboAwardToThemedString (PeakComboAward pma)
PeakComboAward StringToPeakComboAward (const CString &pma)
const CString & StyleTypeToString (StyleType s)
StyleType StringToStyleType (const CString &s)

Variables

const int MAX_METER = 13
const int MIN_METER = 1
const SortOrder MAX_SELECTABLE_SORT = (SortOrder)(SORT_ROULETTE-1)
const CString RANKING_TO_FILL_IN_MARKER [NUM_PLAYERS] = {"#P1#","#P2#"}
const int NUM_RANKING_LINES = 5
const int MIN_SKILL = 0
const int MAX_SKILL = 10
const int NUM_INVENTORY_SLOTS = 3
const int NUM_ATTACKS_PER_LEVEL = 3
const int ITEM_NONE = -1


Define Documentation

#define BG_ANIMS_DIR   CString("BGAnimations/")
 

#define DATA_DIR   CString("Data/")
 

#define FOREACH_HoldNoteScore hns   )     FOREACH_ENUM( HoldNoteScore, NUM_HOLD_NOTE_SCORES, hns )
 

#define FOREACH_PeakComboAward pca   )     FOREACH_ENUM( PeakComboAward, NUM_PEAK_COMBO_AWARDS, pca )
 

#define FOREACH_PerDifficultyAward pma   )     FOREACH_ENUM( PerDifficultyAward, NUM_PER_DIFFICULTY_AWARDS, pma )
 

#define FOREACH_PlayMode pm   )     FOREACH_ENUM( PlayMode, NUM_PLAY_MODES, pm )
 

#define FOREACH_ProfileSlot slot   )     FOREACH_ENUM( ProfileSlot, NUM_PROFILE_SLOTS, slot )
 

#define FOREACH_RadarCategory rc   )     FOREACH_ENUM( RadarCategory, NUM_RADAR_CATEGORIES, rc )
 

#define FOREACH_RankingCategory rc   )     FOREACH_ENUM( RankingCategory, NUM_RANKING_CATEGORIES, rc )
 

#define FOREACH_SortOrder so   )     FOREACH_ENUM( SortOrder, NUM_SORT_ORDERS, so )
 

#define FOREACH_StepsType st   )     FOREACH_ENUM( StepsType, NUM_STEPS_TYPES, st )
 

#define FOREACH_TapNoteScore tns   )     FOREACH_ENUM( TapNoteScore, NUM_TAP_NOTE_SCORES, tns )
 

#define GROUP_ALL_MUSIC   CString("--ALL MUSIC--")
 

#define RANDOMMOVIES_DIR   CString("RandomMovies/")
 

#define VISUALIZATIONS_DIR   CString("Visualizations/")
 


Enumeration Type Documentation

enum AttackLevel
 

Enumeration values:
ATTACK_LEVEL_1 
ATTACK_LEVEL_2 
ATTACK_LEVEL_3 
NUM_ATTACK_LEVELS 

enum CoinMode
 

Enumeration values:
COIN_HOME 
COIN_PAY 
COIN_FREE 
NUM_COIN_MODES 

enum HoldNoteScore
 

Enumeration values:
HNS_NONE 
HNS_NG 
HNS_OK 
NUM_HOLD_NOTE_SCORES 

enum MemoryCardState
 

Enumeration values:
MEMORY_CARD_STATE_READY 
MEMORY_CARD_STATE_TOO_LATE 
MEMORY_CARD_STATE_WRITE_ERROR 
MEMORY_CARD_STATE_NO_CARD 
NUM_MEMORY_CARD_STATES 
MEMORY_CARD_STATE_INVALID 

enum PeakComboAward
 

Enumeration values:
AWARD_1000_PEAK_COMBO 
AWARD_2000_PEAK_COMBO 
AWARD_3000_PEAK_COMBO 
AWARD_4000_PEAK_COMBO 
AWARD_5000_PEAK_COMBO 
AWARD_6000_PEAK_COMBO 
AWARD_7000_PEAK_COMBO 
AWARD_8000_PEAK_COMBO 
AWARD_9000_PEAK_COMBO 
AWARD_10000_PEAK_COMBO 
NUM_PEAK_COMBO_AWARDS 
PEAK_COMBO_AWARD_INVALID 

enum PerDifficultyAward
 

Enumeration values:
AWARD_FULL_COMBO_GREATS 
AWARD_SINGLE_DIGIT_GREATS 
AWARD_ONE_GREAT 
AWARD_FULL_COMBO_PERFECTS 
AWARD_SINGLE_DIGIT_PERFECTS 
AWARD_ONE_PERFECT 
AWARD_FULL_COMBO_MARVELOUSES 
AWARD_GREATS_80_PERCENT 
AWARD_GREATS_90_PERCENT 
AWARD_GREATS_100_PERCENT 
NUM_PER_DIFFICULTY_AWARDS 
PER_DIFFICULTY_AWARD_INVALID 

enum PlayerController
 

Enumeration values:
PC_HUMAN 
PC_CPU 
PC_AUTOPLAY 
NUM_PLAYER_CONTROLLERS 

enum PlayMode
 

Enumeration values:
PLAY_MODE_REGULAR 
PLAY_MODE_NONSTOP 
PLAY_MODE_ONI 
PLAY_MODE_ENDLESS 
PLAY_MODE_BATTLE 
PLAY_MODE_RAVE 
NUM_PLAY_MODES 
PLAY_MODE_INVALID 

enum Premium
 

Enumeration values:
PREMIUM_NONE 
PREMIUM_DOUBLES 
PREMIUM_JOINT 
NUM_PREMIUMS 

enum ProfileSlot
 

Enumeration values:
PROFILE_SLOT_PLAYER_1 
PROFILE_SLOT_PLAYER_2 
PROFILE_SLOT_MACHINE 
NUM_PROFILE_SLOTS 
PROFILE_SLOT_INVALID 

enum RadarCategory
 

Enumeration values:
RADAR_STREAM 
RADAR_VOLTAGE 
RADAR_AIR 
RADAR_FREEZE 
RADAR_CHAOS 
RADAR_NUM_TAPS_AND_HOLDS 
RADAR_NUM_JUMPS 
RADAR_NUM_HOLDS 
RADAR_NUM_MINES 
RADAR_NUM_HANDS 
NUM_RADAR_CATEGORIES 

enum RankingCategory
 

Enumeration values:
RANKING_A 
RANKING_B 
RANKING_C 
RANKING_D 
NUM_RANKING_CATEGORIES 
RANKING_INVALID 

enum SortOrder
 

Enumeration values:
SORT_PREFERRED 
SORT_GROUP 
SORT_TITLE 
SORT_BPM 
SORT_MOST_PLAYED 
SORT_GRADE 
SORT_ARTIST 
SORT_EASY_METER 
SORT_MEDIUM_METER 
SORT_HARD_METER 
SORT_CHALLENGE_METER 
SORT_SORT_MENU 
SORT_MODE_MENU 
SORT_ALL_COURSES 
SORT_NONSTOP_COURSES 
SORT_ONI_COURSES 
SORT_ENDLESS_COURSES 
SORT_ROULETTE 
NUM_SORT_ORDERS 
SORT_INVALID 

enum StageResult
 

Enumeration values:
RESULT_WIN 
RESULT_LOSE 
RESULT_DRAW 

enum StepsType
 

Enumeration values:
STEPS_TYPE_DANCE_SINGLE 
STEPS_TYPE_DANCE_DOUBLE 
STEPS_TYPE_DANCE_COUPLE 
STEPS_TYPE_DANCE_SOLO 
STEPS_TYPE_PUMP_SINGLE 
STEPS_TYPE_PUMP_HALFDOUBLE 
STEPS_TYPE_PUMP_DOUBLE 
STEPS_TYPE_PUMP_COUPLE 
STEPS_TYPE_EZ2_SINGLE 
STEPS_TYPE_EZ2_DOUBLE 
STEPS_TYPE_EZ2_REAL 
STEPS_TYPE_PARA_SINGLE 
STEPS_TYPE_PARA_VERSUS 
STEPS_TYPE_DS3DDX_SINGLE 
STEPS_TYPE_BM_SINGLE5 
STEPS_TYPE_BM_DOUBLE5 
STEPS_TYPE_BM_SINGLE7 
STEPS_TYPE_BM_DOUBLE7 
STEPS_TYPE_MANIAX_SINGLE 
STEPS_TYPE_MANIAX_DOUBLE 
STEPS_TYPE_TECHNO_SINGLE4 
STEPS_TYPE_TECHNO_SINGLE5 
STEPS_TYPE_TECHNO_SINGLE8 
STEPS_TYPE_TECHNO_DOUBLE4 
STEPS_TYPE_TECHNO_DOUBLE5 
STEPS_TYPE_PNM_FIVE 
STEPS_TYPE_PNM_NINE 
STEPS_TYPE_LIGHTS_CABINET 
NUM_STEPS_TYPES 
STEPS_TYPE_INVALID 

enum StyleType
 

Enumeration values:
ONE_PLAYER_ONE_SIDE 
TWO_PLAYERS_TWO_SIDES 
ONE_PLAYER_TWO_SIDES 
NUM_STYLE_TYPES 

enum TapNoteScore
 

Enumeration values:
TNS_NONE 
TNS_HIT_MINE 
TNS_MISS 
TNS_BOO 
TNS_GOOD 
TNS_GREAT 
TNS_PERFECT 
TNS_MARVELOUS 
NUM_TAP_NOTE_SCORES 


Function Documentation

RankingCategory AverageMeterToRankingCategory int  iAverageMeter  ) 
 

const CString& CoinModeToString CoinMode  cm  ) 
 

const CString& HoldNoteScoreToString HoldNoteScore  hns  ) 
 

CString HoldNoteScoreToThemedString HoldNoteScore  hns  ) 
 

bool IsRankingToFillIn const CString &  sName  )  [inline]
 

bool IsSongSort SortOrder  so  )  [inline]
 

const CString& MemoryCardStateToString MemoryCardState  mcs  ) 
 

const CString& PeakComboAwardToString PeakComboAward  pma  ) 
 

CString PeakComboAwardToThemedString PeakComboAward  pma  ) 
 

const CString& PerDifficultyAwardToString PerDifficultyAward  pma  ) 
 

CString PerDifficultyAwardToThemedString PerDifficultyAward  pma  ) 
 

const CString& PlayModeToString PlayMode  pm  ) 
 

CString PlayModeToThemedString PlayMode  pm  ) 
 

const CString& PremiumToString Premium  p  ) 
 

const CString& RadarCategoryToString RadarCategory  cat  ) 
 

CString RadarCategoryToThemedString RadarCategory  cat  ) 
 

const CString& RankingCategoryToString RankingCategory  rc  ) 
 

const CString& SortOrderToString SortOrder  so  ) 
 

HoldNoteScore StringToHoldNoteScore const CString &  str  ) 
 

PeakComboAward StringToPeakComboAward const CString &  pma  ) 
 

PerDifficultyAward StringToPerDifficultyAward const CString &  pma  ) 
 

PlayMode StringToPlayMode const CString &  s  ) 
 

RankingCategory StringToRankingCategory const CString &  rc  ) 
 

SortOrder StringToSortOrder const CString &  str  ) 
 

StyleType StringToStyleType const CString &  s  ) 
 

TapNoteScore StringToTapNoteScore const CString &  str  ) 
 

const CString& StyleTypeToString StyleType  s  ) 
 

const CString& TapNoteScoreToString TapNoteScore  tns  ) 
 

CString TapNoteScoreToThemedString TapNoteScore  tns  ) 
 


Variable Documentation

const int ITEM_NONE = -1
 

const int MAX_METER = 13
 

const SortOrder MAX_SELECTABLE_SORT = (SortOrder)(SORT_ROULETTE-1)
 

const int MAX_SKILL = 10
 

const int MIN_METER = 1
 

const int MIN_SKILL = 0
 

const int NUM_ATTACKS_PER_LEVEL = 3
 

const int NUM_INVENTORY_SLOTS = 3
 

const int NUM_RANKING_LINES = 5
 

const CString RANKING_TO_FILL_IN_MARKER[NUM_PLAYERS] = {"#P1#","#P2#"}
 


Generated on Thu Jan 27 20:57:37 2005 for StepMania by doxygen 1.3.7