ScummVM API documentation
Classes | Macros | Enumerations | Functions | Variables
Game platforms
Common API

Description

API for managing game platforms.

Classes

struct  Common::PlatformDescription
 

Macros

#define GET_ENUM_VAL_IMPL(val, hex)   val
 
#define GET_ENUM_VAL_EXPAND(x)   GET_ENUM_VAL_IMPL x
 
#define GET_ENUM_VAL(name)   GET_ENUM_VAL_EXPAND((name))
 
#define kPlatformApple2GS_VAL   0x00, "\x80"
 
#define kPlatformApple2_VAL   0x01, "\x81"
 
#define kPlatform3DO_VAL   0x02, "\x82"
 
#define kPlatformAcorn_VAL   0x03, "\x83"
 
#define kPlatformAmiga_VAL   0x04, "\x84"
 
#define kPlatformAtari8Bit_VAL   0x05, "\x85"
 
#define kPlatformAtariST_VAL   0x06, "\x86"
 
#define kPlatformC64_VAL   0x07, "\x87"
 
#define kPlatformAmstradCPC_VAL   0x08, "\x88"
 
#define kPlatformDOS_VAL   0x09, "\x89"
 
#define kPlatformPC98_VAL   0x0A, "\x8A"
 
#define kPlatformWii_VAL   0x0B, "\x8B"
 
#define kPlatformCoCo_VAL   0x0C, "\x8C"
 
#define kPlatformCoCo3_VAL   0x0D, "\x8D"
 
#define kPlatformFMTowns_VAL   0x0E, "\x8E"
 
#define kPlatformLinux_VAL   0x0F, "\x8F"
 
#define kPlatformMacintosh_VAL   0x10, "\x90"
 
#define kPlatformPCEngine_VAL   0x11, "\x91"
 
#define kPlatformNES_VAL   0x12, "\x92"
 
#define kPlatformSegaCD_VAL   0x13, "\x93"
 
#define kPlatformWindows_VAL   0x14, "\x94"
 
#define kPlatformPSX_VAL   0x15, "\x95"
 
#define kPlatformPS2_VAL   0x16, "\x96"
 
#define kPlatformPS3_VAL   0x17, "\x97"
 
#define kPlatformXbox_VAL   0x18, "\x98"
 
#define kPlatformCDi_VAL   0x19, "\x99"
 
#define kPlatformIOS_VAL   0x1A, "\x9A"
 
#define kPlatformAndroid_VAL   0x1B, "\x9B"
 
#define kPlatformOS2_VAL   0x1C, "\x9C"
 
#define kPlatformBeOS_VAL   0x1D, "\x9D"
 
#define kPlatformPocketPC_VAL   0x1E, "\x9E"
 
#define kPlatformMegaDrive_VAL   0x1F, "\x9F"
 
#define kPlatformSaturn_VAL   0x20, "\xA0"
 
#define kPlatformPippin_VAL   0x21, "\xA1"
 
#define kPlatformMacintoshII_VAL   0x22, "\xA2"
 
#define kPlatformShockwave_VAL   0x23, "\xA3"
 
#define kPlatformZX_VAL   0x24, "\xA4"
 
#define kPlatformTI994_VAL   0x25, "\xA5"
 
#define kPlatformNintendoSwitch_VAL   0x26, "\xA6"
 

Enumerations

enum  Common::Platform : int8 {
  kPlatformDOS = 0x09, kPlatformAmiga = 0x04, kPlatformAmstradCPC = 0x08, kPlatformAtari8Bit = 0x05,
  kPlatformAtariST = 0x06, kPlatformMacintosh = 0x10, kPlatformFMTowns = 0x0E, kPlatformWindows = 0x14,
  kPlatformNES = 0x12, kPlatformC64 = 0x07, kPlatformCoCo = 0x0C, kPlatformCoCo3 = 0x0D,
  kPlatformLinux = 0x0F, kPlatformAcorn = 0x03, kPlatformSegaCD = 0x13, kPlatform3DO = 0x02,
  kPlatformPCEngine = 0x11, kPlatformApple2 = 0x01, kPlatformApple2GS = 0x00, kPlatformPC98 = 0x0A,
  kPlatformWii = 0x0B, kPlatformPSX = 0x15, kPlatformPS2 = 0x16, kPlatformPS3 = 0x17,
  kPlatformXbox = 0x18, kPlatformCDi = 0x19, kPlatformIOS = 0x1A, kPlatformAndroid = 0x1B,
  kPlatformOS2 = 0x1C, kPlatformBeOS = 0x1D, kPlatformPocketPC = 0x1E, kPlatformMegaDrive = 0x1F,
  kPlatformSaturn = 0x20, kPlatformPippin = 0x21, kPlatformMacintoshII = 0x22, kPlatformShockwave = 0x23,
  kPlatformZX = 0x24, kPlatformTI994 = 0x25, kPlatformNintendoSwitch = 0x26, kPlatformUnknown = -1
}
 

Functions

Platform Common::parsePlatform (const String &str)
 
const char * Common::getPlatformCode (Platform id)
 
const char * Common::getPlatformAbbrev (Platform id)
 
const char * Common::getPlatformDescription (Platform id)
 
const String Common::getGameGUIOptionsDescriptionPlatform (Platform plat)
 
bool Common::checkGameGUIOptionPlatform (Platform plat, const String &str)
 
const String Common::parseGameGUIOptionsPlatforms (const String &str)
 
const String Common::getGameGUIOptionsDescriptionPlatforms (const String &str)
 
List< String > Common::getPlatformList ()
 

Variables

const PlatformDescription Common::g_platforms []
 

Enumeration Type Documentation

◆ Platform

enum Common::Platform : int8

List of game platforms. Specifying a platform for a target can be used to give the game engines a hint for which platform the game data file are. This may be optional or required, depending on the game engine and the game in question.

Function Documentation

◆ parsePlatform()

Platform Common::parsePlatform ( const String &  str)

Convert a string containing a platform name into a Platform enum value.

◆ getGameGUIOptionsDescriptionPlatform()

const String Common::getGameGUIOptionsDescriptionPlatform ( Platform  plat)

Return string containing platform description based on platform enum

◆ checkGameGUIOptionPlatform()

bool Common::checkGameGUIOptionPlatform ( Platform  plat,
const String &  str 
)

Check if given platform option is present in a string

◆ parseGameGUIOptionsPlatforms()

const String Common::parseGameGUIOptionsPlatforms ( const String &  str)

Parse gui options string to GUIO platform literals

◆ getGameGUIOptionsDescriptionPlatforms()

const String Common::getGameGUIOptionsDescriptionPlatforms ( const String &  str)

Return string containing platform(s) description based on gui options string