ScummVM API documentation
Game platforms

Description

API for managing game platforms.

Classes

struct  Common::PlatformDescription
 

Enumerations

enum  Common::Platform : int8 {
  kPlatformDOS, kPlatformAmiga, kPlatformAmstradCPC, kPlatformAtari8Bit,
  kPlatformAtariST, kPlatformMacintosh, kPlatformFMTowns, kPlatformWindows,
  kPlatformNES, kPlatformC64, kPlatformCoCo, kPlatformCoCo3,
  kPlatformLinux, kPlatformAcorn, kPlatformSegaCD, kPlatform3DO,
  kPlatformPCEngine, kPlatformApple2, kPlatformApple2GS, kPlatformPC98,
  kPlatformWii, kPlatformPSX, kPlatformPS2, kPlatformXbox,
  kPlatformCDi, kPlatformIOS, kPlatformAndroid, kPlatformOS2,
  kPlatformBeOS, kPlatformPocketPC, kPlatformMegaDrive, kPlatformSaturn,
  kPlatformPippin, kPlatformMacintoshII, kPlatformShockwave, kPlatformZX,
  kPlatformTI994, 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)
 
List< StringCommon::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.