Scripting

Scripting API

AGS provides a scripting system, where engine functionalities are exposed through the AGS Script API, allowing you to write a mini-program, giving you great control over your game. You can read and modify room elements by using the structs Room, Object, Hotspot, Region, and the Global functions for Room. If you need your character to say things, receive or lose an inventory item, or walk somewhere, you can find these in the Character struct. AGS camera system is available through the use of Viewport, Camera, and Screen. You can also draw directly with Dynamic Sprites, Drawing Surface and use Overlays to have these sprites shown on screen.

Some predefined callbacks are available for redefinition like repeatedly execute and other predefined script functions. Browse around the script listing below, as there's much more available to the script API. In the Editor General Settings, you can use Script API level to configure which is the latest API for the functions and structs available for usage. Additionally, Script compatibility level allows to enable previous Script API entries along to the latest defined ones. These switches are useful when upgrading from one version of AGS to another, allowing to build a game written in a previous version of AGS with a newer Editor, allowing you to upgrade the Script API version you are working with without having to do it in one go.

• Predefined global script functions
• repeatedly_execute / repeatedly_execute_always
• Custom dialog options rendering
• Standard Enumerated Types
• Standard Types
• GameState variables
• Global functions: general
• Global functions: multimedia actions
• Global functions: palette operations
• Global functions: room actions
• Global functions: screen effects
• Global functions: message display
• AudioChannel functions and properties
• AudioClip functions and properties
• Camera functions and properties
• Character functions and properties
• DateTime functions and properties
• Dialog functions and properties
• DialogOptionsRenderingInfo functions and properties
• Dictionary functions and properties
• DrawingSurface functions and properties
• DynamicSprite functions and properties
• File functions and properties
• Game functions and properties
• GUI functions and properties
• GUI control functions and properties
• GUI Button functions and properties
• GUI InvWindow functions and properties
• GUI Label functions and properties
• GUI List Box functions and properties
• GUI Slider properties
• GUI Text Box functions and properties
• Hotspot functions and properties
• Inventory item functions and properties
• Maths functions and properties
• Mouse functions and properties
• Object functions and properties
• Overlay functions and properties
• Parser functions
• Region functions and properties
• Room functions and properties
• Screen functions and properties
• Set functions and properties
• Speech functions and properties
• String functions
• System functions and properties
• TextWindowGUI functions and properties
• ViewFrame functions and properties
• Viewport functions and properties