Built-in enumerated types

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.Walk, Character.WalkStraight, Object.Animate, Object.Move

enum Direction {
  eForwards,
  eBackwards
};

Used by: Character.Animate, Object.Animate

enum WalkWhere {
  eAnywhere,
  eWalkableAreas
};

Used by: Character.Walk, Object.Move

enum RepeatStyle {
  eOnce,
  eRepeat
};

Used by: Button.Animate, Character.Animate, Object.Animate

enum Alignment {
  eAlignLeft,
  eAlignCentre,
  eAlignRight
};

Used by: Character.LockViewAligned

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

Used by: SetScreenTransition, SetNextScreenTransition

enum MouseButton {
  eMouseLeft,
  eMouseRight,
  eMouseMiddle,
  eMouseLeftInv,
  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: SetSpeechStyle

enum eVoiceMode {
  eSpeechTextOnly,
  eSpeechVoiceAndText,
  eSpeechVoiceOnly
};

Used by: SetVoiceMode

enum DialogOptionState {
  eOptionOff,
  eOptionOn,
  eOptionOffForever
};

Used by: GetDialogOption, SetDialogOption

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

Used by: StartCutscene

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, ProcessClick, Mouse.ChangeModeGraphic, Mouse.ChangeModeHotspot, Mouse.DisableMode, Mouse.EnableMode, Mouse.UseModeGraphic, Mouse.Mode, InventoryItem.IsInteractionAvailable, InventoryItem.RunInteraction, Hotspot.RunInteraction, Object.RunInteraction, Character.RunInteraction

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

Returned by: GetLocationType

enum FileMode {
  eFileRead,
  eFileWrite,
  eFileAppend
};

Used by: File.Open

Browser Based Help. Published by chm2web software.