StandardEnums - adventuregamestudio/ags-manual GitHub Wiki

enum Alignment {
    eAlignNone          = 0,
    eAlignTopLeft       = 1,
    eAlignTopCenter     = 2,
    eAlignTopRight      = 4,
    eAlignMiddleLeft    = 8,
    eAlignMiddleCenter  = 16,
    eAlignMiddleRight   = 32,
    eAlignBottomLeft    = 64,
    eAlignBottomCenter  = 128,
    eAlignBottomRight   = 256,
    eAlignHasLeft       = 73,
    eAlignHasRight      = 292,
    eAlignHasTop        = 7,
    eAlignHasBottom     = 448,
    eAlignHasHorCenter  = 146,
    eAlignHasVerCenter  = 56
};

if (align & eAlignHasLeft)
    // some code here

enum AudioFileType {
    eAudioFileOGG,
    eAudioFileMP3,
    eAudioFileWAV,
    eAudioFileVOC,
    eAudioFileMIDI,
    eAudioFileMOD
};

enum AudioPriority {
    eAudioPriorityVeryLow = 1,
    eAudioPriorityLow = 25,
    eAudioPriorityNormal = 50,
    eAudioPriorityHigh = 75,
    eAudioPriorityVeryHigh = 100
};

enum BlockingStyle {
    eBlock,
    eNoBlock
};

enum eCDAudioFunction {
    eCDIsDriverPresent,
    eCDGetPlayingStatus,
    eCDPlayTrack,
    eCDPausePlayback,
    eCDResumePlayback,
    eCDGetNumTracks,
    eCDEject,
    eCDCloseTray,
    eCDGetCDDriveCount,
    eCDSelectActiveCDDrive
};

enum CharacterDirection {
    eDirectionDown = 0,
    eDirectionLeft,
    eDirectionRight,
    eDirectionUp,
    eDirectionDownRight,
    eDirectionUpRight,
    eDirectionDownLeft,
    eDirectionUpLeft,
    eDirectionNone = SCR_NO_VALUE
};

enum CursorMode {
    eModeXXXX,
    eModeXXXX,
    // ...
};

enum CutsceneSkipType {
    eSkipESCOnly,
    eSkipAnyKey,
    eSkipMouseClick,
    eSkipAnyKeyOrMouseClick,
    eSkipESCOrRightButton,
    eSkipScriptOnly
};

enum DialogOptionSayStyle {
    eSayUseOptionSetting,
    eSayAlways,
    eSayNever
};

enum DialogOptionState {
    eOptionOff,
    eOptionOn,
    eOptionOffForever
};

enum Direction {
    eForwards,
    eBackwards
};

enum EngineValueID
{
    ENGINE_VALUE_UNDEFINED = 0,         // formality...
    ENGINE_VALUE_SI_VALUENAME,          // get engine value's own name, by its index
    ENGINE_VALUE_S_ENGINE_NAME,
    ENGINE_VALUE_S_ENGINE_VERSION,      // N.N.N.N (with an optional custom tag)
    ENGINE_VALUE_S_ENGINE_VERSION_FULL, // full, with bitness, endianess and any tag list
    ENGINE_VALUE_S_DISPLAY_MODE_STR,
    ENGINE_VALUE_S_GFXRENDERER,
    ENGINE_VALUE_S_GFXFILTER,
    ENGINE_VALUE_I_SPRCACHE_MAXNORMAL,  // sprite cache capacity limit (in KB)
    ENGINE_VALUE_I_SPRCACHE_NORMAL,     // sprite cache capacity filled (in KB)
    ENGINE_VALUE_I_SPRCACHE_LOCKED,     // amount of locked sprites (in KB)
    ENGINE_VALUE_I_SPRCACHE_EXTERNAL,   // amount of external sprites, that means dynamic sprites (in KB)
    ENGINE_VALUE_I_TEXCACHE_MAXNORMAL,  // texture cache capacity limit (in KB)
    ENGINE_VALUE_I_TEXCACHE_NORMAL,     // texture cache capacity filled (in KB)
    ENGINE_VALUE_I_FPS_MAX,             // max fps, this is set by SetGameSpeed
    ENGINE_VALUE_I_FPS,                 // real average fps (updates along with the game run)
    ENGINE_VALUE_LAST                   // in case user wants to iterate them
};

enum EventType {
    eEventLeaveRoom,
    eEventEnterRoomBeforeFadein,
    eEventGotScore,
    eEventGUIMouseDown,
    eEventGUIMouseUp,
    eEventAddInventory,
    eEventLoseInventory,
    eEventRestoreGame,
    eEventEnterRoomAfterFadein,
    eEventLeaveRoomAfterFadeout,
    eEventGameSaved
};

enum FileMode {
    eFileRead,
    eFileWrite,
    eFileAppend
};

enum FileSeek {
    eSeekBegin = 0,
    eSeekCurrent = 1,
    eSeekEnd = 2
};

enum FileSortStyle
{
    eFileSort_None,
    eFileSort_Name,
    eFileSort_Time
};

enum eFlipDirection {
    eFlipLeftToRight,
    eFlipUpsideDown,
    eFlipBoth
};

enum FontType {
    eNullFont
    eFontXXXX,
    eFontXXXX,
    // ...
};

enum GUIPopupStyle {
    eGUIPopupNormal = 0,
    eGUIPopupMouseYPos = 1,
    eGUIPopupModal = 2,
    eGUIPopupPersistent = 3
};

enum HorizontalAlignment {
    eAlignLeft          = 1,
    eAlignCenter        = 2,
    eAlignRight         = 4
};

enum InputType
{
    eInputNone     = 0x00000000,
    eInputKeyboard = 0x02000000,
    eInputMouse    = 0x04000000,
    eInputAny      = 0xFF000000
};

if (type & eInputKeyboard)
    // some code here

enum LocationType {
    eLocationNothing,
    eLocationHotspot,
    eLocationCharacter,
    eLocationObject
};

enum LogLevel
{
    eLogAlert = 1,
    eLogFatal = 2,
    eLogError = 3,
    eLogWarn = 4,
    eLogInfo = 5,
    eLogDebug = 6
};

enum MouseButton {
    eMouseLeft,
    eMouseRight,
    eMouseMiddle,
    eMouseLeftInv,
    eMouseMiddleInv,
    eMouseRightInv,
    eMouseWheelNorth,
    eMouseWheelSouth
};

enum eOperatingSystem {
    eOSDOS,
    eOSWindows,
    eOSLinux,
    eOSMacOS,
    eOSAndroid,
    eOSiOS,
    eOSPSP,
    eOSWeb,
    eOSFreeBSD
};

enum RenderLayer {
    eRenderLayerNone      = 0x00000000,
    eRenderLayerEngine    = 0x00000001,
    eRenderLayerCursor    = 0x00000002,
    eRenderLayerUI        = 0x00000004,
    eRenderLayerRoom      = 0x00000008,
    eRenderLayerAll       = 0xFFFFFFFF
};

enum RepeatStyle {
    eOnce,
    eRepeat
};

enum RestoredSaveResult
{
    eRestoredSave_ClearData   = 0x01,
    eRestoredSave_MissingData = 0x08,
    eRestoredSave_ExtraData   = 0x10,
    eRestoredSave_Prescan     = 0x20
};

enum RoundDirection {
    eRoundDown,
    eRoundNearest,
    eRoundUp
};

enum SaveGameSortStyle
{
    eSaveGameSort_None,
    eSaveGameSort_Number,
    eSaveGameSort_Time,
    eSaveGameSort_Description
};

enum SaveComponentSelection
{
    eSaveCmp_None           = 0,
    eSaveCmp_Audio          = 0x00000002,
    eSaveCmp_Dialogs        = 0x00000008,
    eSaveCmp_GUI            = 0x00000010,
    eSaveCmp_Cursors        = 0x00000040,
    eSaveCmp_Views          = 0x00000080,
    eSaveCmp_DynamicSprites = 0x00000100,
    eSaveCmp_Plugins        = 0x00002000
};

enum SkipSpeechStyle {
    eSkipNone         = -1,
    eSkipKeyMouseTime = 0,
    eSkipKeyTime      = 1,
    eSkipTime         = 2,
    eSkipKeyMouse     = 3,
    eSkipMouseTime    = 4,
    eSkipKey          = 5,
    eSkipMouse        = 6
};

enum SortDirection
{
    eSortNoDirection,
    eSortAscending,
    eSortDescending
};

enum SortStyle {
    eNonSorted = 0,
    eSorted = 1
};

enum eSpeechStyle {
    eSpeechLucasarts,
    eSpeechSierra,
    eSpeechSierraWithBackground,
    eSpeechFullScreen
};

enum StopMovementStyle
{
    eKeepMoving = 0,
    eStopMoving = 1
};

enum StringCompareStyle {
    eCaseInsensitive = 0,
    eCaseSensitive = 1
};

enum TransitionStyle {
    eTransitionFade,
    eTransitionInstant,
    eTransitionDissolve,
    eTransitionBoxout,
    eTransitionCrossfade
};

enum VideoSkipStyle {
    eVideoSkipNotAllowed,
    eVideoSkipEscKey,
    eVideoSkipAnyKey,
    eVideoSkipAnyKeyOrMouse
};

enum eVoiceMode {
    eSpeechTextOnly,
    eSpeechVoiceAndText,
    eSpeechVoiceOnly
};

enum WalkWhere {
    eAnywhere,
    eWalkableAreas
};