Contents Up Previous Next

Built-in enumerated types

AGS has several enumerated types built in. These are used in calls to various commands, and will usually pop up automatically in autocomplete. However, for times where autocomplete doesn't do the job, having a manual reference is invaluable:
enum BlockingStyle {
  eBlock,
  eNoBlock
};
Used by: Character.Animate, Character.FaceCharacter, Character.FaceLocation, Character.FaceObject, Character.Move, Character.Walk, Character.WalkStraight, Object.Animate, Object.Move
enum CharacterDirection {
  eDirectionDown = 0,
  eDirectionLeft,
  eDirectionRight,
  eDirectionUp,
  eDirectionDownRight,
  eDirectionUpRight,
  eDirectionDownLeft,
  eDirectionUpLeft,
  eDirectionNone = SCR_NO_VALUE
};
Used by: Character.ChangeRoom, Character.FaceDirection
enum Direction {
  eForwards,
  eBackwards
};
Used by: Character.Animate, Object.Animate
enum WalkWhere {
  eAnywhere,
  eWalkableAreas
};
Used by: Character.Move, Character.Walk, Object.Move
enum StopMovementStyle
{
  eKeepMoving = 0,
  eStopMoving = 1
};
Used by: Character.LockView, Character.LockViewFrame, Object.UnlockView (REF NOT FOUND)
enum RepeatStyle {
  eOnce,
  eRepeat
};
Used by: Button.Animate, Character.Animate, Object.Animate
enum Alignment {
  eAlignLeft,
  eAlignCentre,
  eAlignRight
};
Used by: Character.LockViewAligned
enum eFlipDirection {
  eFlipLeftToRight,
  eFlipUpsideDown,
  eFlipBoth
};
Used by: DynamicSprite.Flip
enum TransitionStyle {
  eTransitionFade,
  eTransitionInstant,
  eTransitionDissolve,
  eTransitionBoxout,
  eTransitionCrossfade
};
Used by: SetScreenTransition, SetNextScreenTransition
enum MouseButton {
  eMouseLeft,
  eMouseRight,
  eMouseMiddle,
  eMouseLeftInv,
  eMouseMiddleInv,
  eMouseRightInv,
  eMouseWheelNorth,
  eMouseWheelSouth
};
Used by: Mouse.IsButtonDown
Passed into: on_mouse_click
enum EventType {
  eEventLeaveRoom,
  eEventEnterRoom,
  eEventGotScore,
  eEventGUIMouseDown,
  eEventGUIMouseUp,
  eEventAddInventory,
  eEventLoseInventory,
  eEventRestoreGame
};
Passed into: on_event
enum RoundDirection {
  eRoundDown,
  eRoundNearest,
  eRoundUp
};
Used by: FloatToInt
enum eSpeechStyle {
  eSpeechLucasarts,
  eSpeechSierra,
  eSpeechSierraWithBackground,
  eSpeechFullScreen
};
Used by: Speech.Style
enum SkipSpeechStyle {
  eSkipKeyMouseTime = 0,
  eSkipKeyTime      = 1,
  eSkipTime         = 2,
  eSkipKeyMouse     = 3,
  eSkipMouseTime    = 4,
  eSkipKey          = 5,
  eSkipMouse        = 6
};
Used by: Speech.SkipStyle
enum eVoiceMode {
  eSpeechTextOnly,
  eSpeechVoiceAndText,
  eSpeechVoiceOnly
};
Used by: Speech.VoiceMode
enum DialogOptionState {
  eOptionOff,
  eOptionOn,
  eOptionOffForever
};
Used by: Dialog.GetOptionState, Dialog.SetOptionState
enum CutsceneSkipType {
  eSkipESCOnly,
  eSkipAnyKey,
  eSkipMouseClick,
  eSkipAnyKeyOrMouseClick,
  eSkipESCOrRightButton
};
Used by: StartCutscene
enum eOperatingSystem {
  eOSDOS,
  eOSWindows,
  eOSLinux,
  eOSMacOS,
  eOSAndroid,
  eOSiOS,
  eOSPSP
};
Used by: System.OperatingSystem
enum eCDAudioFunction {
  eCDIsDriverPresent,
  eCDGetPlayingStatus,
  eCDPlayTrack,
  eCDPausePlayback,
  eCDResumePlayback,
  eCDGetNumTracks,
  eCDEject,
  eCDCloseTray,
  eCDGetCDDriveCount,
  eCDSelectActiveCDDrive
};
Used by: CDAudio
enum CursorMode {
  eModeXXXX,
  eModeXXXX,
  ...
};
The CursorMode enumeration is generated automatically based on your mouse cursors. The cursor mode name is taken, all its spaces are removed, and eMode is added to the front.
Used by: IsInteractionAvailable, Room.ProcessClick, Mouse.ChangeModeGraphic, Mouse.ChangeModeHotspot, Mouse.DisableMode, Mouse.EnableMode, Mouse.IsModeEnabled (REF NOT FOUND), Mouse.UseModeGraphic, Mouse.Mode, InventoryItem.IsInteractionAvailable, InventoryItem.RunInteraction, Hotspot.IsInteractionAvailable, Hotspot.RunInteraction, Object.IsInteractionAvailable, Object.RunInteraction, Character.IsInteractionAvailable, Character.RunInteraction
enum FontType {
  eFontXXXX,
  eFontXXXX,
  ...
};
The FontType enumeration is generated automatically based on your fonts. The font name is taken, all its spaces are removed, and eFont is added to the front.
Used by: Button.Font, DrawingSurface.DrawMessageWrapped, DrawingSurface.DrawString, DrawingSurface.DrawStringWrapped, Game.NormalFont, Game.SpeechFont, GetTextHeight, GetTextWidth, Label.Font, ListBox.Font, TextBox.Font, Overlay.CreateTextual, Overlay.SetText
enum LocationType {
  eLocationNothing,
  eLocationHotspot,
  eLocationCharacter,
  eLocationObject
};
Returned by: GetLocationType
enum FileMode {
  eFileRead,
  eFileWrite,
  eFileAppend
};
Used by: File.Open
enum FileSeek {
  eSeekBegin = 0,
  eSeekCurrent = 1,
  eSeekEnd = 2
};
Used by: File.Seek
enum DialogOptionSayStyle {
  eSayUseOptionSetting,
  eSayAlways,
  eSayNever
};
Used by: Dialog.DisplayOptions
enum VideoSkipStyle {
  eVideoSkipNotAllowed,
  eVideoSkipEscKey,
  eVideoSkipAnyKey,
  eVideoSkipAnyKeyOrMouse
};
Used by: PlayVideo
enum AudioFileType {
  eAudioFileOGG,
  eAudioFileMP3,
  eAudioFileWAV,
  eAudioFileVOC,
  eAudioFileMIDI,
  eAudioFileMOD
};
Used by: AudioClip.FileType
enum AudioPriority {
  eAudioPriorityVeryLow = 1,
  eAudioPriorityLow = 25,
  eAudioPriorityNormal = 50,
  eAudioPriorityHigh = 75,
  eAudioPriorityVeryHigh = 100
};
Used by: AudioClip.Play, AudioClip.PlayFrom, AudioClip.PlayQueued
Converted from CHM to HTML with chm2web Standard 2.85 (unicode)