Contents
Copyright and terms of use
Introduction
System Requirements
The run-time engine
The demo game
Run-time engine setup
The Wavetable Synth MIDI driver
Tutorial
Starting off
Setting up the game
Palette setup
Inventory
Importing your own sprite graphics
Global Messages
Introduction sequences
Animations
Characters
Conversations
Game options
Cursors
Fonts
Advanced room features
Character scaling
Scrolling
Importing a file as the walkable area mask
Animating background scenes
Lighting effects
Exact palette import
Other Features
Music and sound
Voice speech
Editing the GUIs
GUI buttons
Interface text
Customized Text Windows
Custom inventory
Sliders
Text Boxes
List Boxes
Distributing your game
Custom icon
Splitting resource files
Advanced information for game distribution
Backing up your game
Dumping text to file
The text parser
Translations
Custom Properties
Plugins
Lip sync
New Game templates
Debugging features
Advanced features
Scripting
Scripting tutorial part 1
Scripting tutorial part 2
Upgrading to AGS 2.7
Pointers in AGS
Pointers for programming newbies
Pointers for people who know C or C++
Calling global functions from local scripts
The script header
String formatting
Script modules
Understanding blocking scripts
Script language keywords
Data types
Operators
Constants
if, else statements
while
function
enum
import
export
Character functions and properties
AddInventory
AddWaypoint
Animate (character)
ChangeRoom
ChangeView
FaceCharacter
FaceLocation
FaceObject
FollowCharacter
GetAtScreenXY (character)
GetProperty (character)
GetPropertyText (character)
IsCollidingWithChar
IsCollidingWithObject (character)
LockView
LockViewAligned
LockViewFrame
LockViewOffset
LoseInventory
PlaceOnWalkableArea
RemoveTint (character)
RunInteraction (character)
Say
SayAt
SayBackground
SetAsPlayer
SetIdleView
SetWalkSpeed
StopMoving (character)
Think
Tint (character)
UnlockView
Walk
WalkStraight
ActiveInventory property
Animating property (character)
AnimationSpeed property
Baseline property (character)
BlinkInterval property
BlinkView property
BlinkWhileThinking property
BlockingHeight property (character)
BlockingWidth property (character)
Clickable property (character)
DiagonalLoops property
Frame property
ID property (character)
IdleView property
IgnoreLighting property
IgnoreScaling property
IgnoreWalkbehinds property (character)
InventoryQuantity property
Loop property
Moving property (character)
NormalView property
PreviousRoom property
Room property
ScaleMoveSpeed property
Solid property (character)
Speaking property
SpeechColor property
SpeechView property
ThinkView property
Transparency property (character)
TurnBeforeWalking property
View property (character)
WalkSpeedX property
WalkSpeedY property
x property (character)
y property (character)
z property (character)
SetCharacterProperty
DateTime functions and properties
Now property
DayOfMonth property
Hour property
Minute property
Month property
RawTime property
Second property
Year property
DynamicSprite functions and properties
CreateFromFile
CreateFromSaveGame
CreateFromScreenShot
Delete (dynamic sprite)
Graphic property (dynamic sprite)
File functions and properties
Open
Close
ReadString
ReadInt
ReadRawChar
ReadRawInt
ReadRawLine
WriteString
WriteInt
WriteRawChar
WriteRawLine
EOF property
Error property
Game / Global functions
AbortGame
CallRoomScript
ClaimEvent
Debug
DeleteSaveSlot
DisableInterface
EnableInterface
EndCutscene
GetGameOption
GetGameParameter
GetGameSpeed
GetGlobalInt
GetGlobalString
GetGraphicalVariable
GetLocationName
GetLocationType
GetSaveSlotDescription
GetTextHeight
GetTextWidth
GetTranslation
GetTranslationName
GiveScore
InputBox
InventoryScreen
IsGamePaused
IsInterfaceEnabled
IsInteractionAvailable
IsKeyPressed
IsTimerExpired
IsTranslationAvailable
MoveCharacterToHotspot
MoveCharacterToObject
PauseGame
ProcessClick
QuitGame
Random
RestartGame
RestoreGameDialog
RestoreGameSlot
RunAGSGame
SaveGameDialog
SaveGameSlot
SaveScreenShot
SetAmbientTint
SetGameOption
SetGameSpeed
SetGlobalInt
SetGlobalString
SetGraphicalVariable
SetMultitaskingMode
SetNormalFont
SetRestartPoint
SetTextWindowGUI
SetTimer
SkipUntilCharacterStops
StartCutscene
UpdateInventory
UnPauseGame
Wait
WaitKey
WaitMouseKey
GUI functions and properties
Centre
GetAtScreenXY (GUI)
SetPosition (GUI)
SetSize (GUI)
BackgroundGraphic property
Clickable property (GUI)
ControlCount property
Controls property (GUI)
Height property (GUI)
ID property (GUI)
Transparency property (GUI)
Visible property (GUI)
Width property (GUI)
X property (GUI)
Y property (GUI)
ZOrder property
GUI control functions and properties
GetAtScreenXY (GUI control)
AsType properties (GUI controls)
Enabled property (GUI controls)
Height property (GUI controls)
ID property (GUI controls)
OwningGUI property (GUI controls)
SetPosition (GUI controls)
SetSize (GUI controls)
Visible property (GUI controls)
Width property (GUI controls)
X property (GUI controls)
Y property (GUI controls)
GUI Button functions and properties
Animate (button)
GetText (button)
SetText (button)
ClipImage property
Graphic property (button)
MouseOverGraphic property (button)
NormalGraphic property (button)
PushedGraphic property (button)
TextColor property (button)
GUI InvWindow functions and properties
ScrollDown
ScrollUp
CharacterToUse property
ItemAtIndex property
ItemCount property (inv window)
ItemHeight property
ItemWidth property
ItemsPerRow property
RowCount property
TopItem property (inv window)
GUI Label functions and properties
GetText (label)
SetText (label)
Font property (label)
TextColor property (label)
GUI List Box functions and properties
AddItem
Clear
FillDirList
FillSaveGameList
GetItemAtLocation
GetItemText
RemoveItem
SetItemText
ItemCount property (list box)
SelectedIndex property
TopItem property (list box)
GUI Slider properties
Value property
GUI Text Box functions and properties
GetText (text box)
SetText (text box)
Font property (text box)
Hotspot functions and properties
GetAtScreenXY (hotspot)
GetName (hotspot)
GetProperty (hotspot)
GetPropertyText (hotspot)
RunInteraction (hotspot)
Enabled property (hotspot)
ID property (hotspot)
WalkToX property
WalkToY property
Inventory item functions and properties
GetAtScreenXY (inventory)
GetName (inventory)
GetProperty (inventory)
GetPropertyText (inventory)
IsInteractionAvailable (inventory)
RunInteraction (inventory)
SetName (inventory)
Graphic property (inventory)
ID property (inventory)
Maths functions and properties
FloatToInt
IntToFloat
ArcCos
ArcSin
ArcTan
Cos
DegreesToRadians
RadiansToDegrees
RaiseToPower
Sin
Sqrt
Tan
Pi property
Mouse functions and properties
ChangeModeGraphic
ChangeModeHotspot
ChangeModeView
DisableMode
EnableMode
IsButtonDown
SaveCursorUntilItLeaves
SelectNextMode
SetBounds
SetPosition (mouse)
Update
UseDefaultGraphic
UseModeGraphic
Mode property (mouse)
Visible property (mouse)
Multimedia functions
CDAudio
GetCurrentMusic
GetMIDIPosition
GetMP3PosMillis
IsChannelPlaying
IsMusicPlaying
IsMusicVoxAvailable
IsSoundPlaying
IsSpeechVoxAvailable
PlayAmbientSound
PlayFlic
PlayMP3File
PlayMusic
PlayMusicQueued
PlaySilentMIDI
PlaySound
PlaySoundEx
PlayVideo
SeekMIDIPosition
SeekMODPattern
SeekMP3PosMillis
SetChannelVolume
SetDigitalMasterVolume
SetFrameSound
SetMusicMasterVolume
SetMusicRepeat
SetMusicVolume
SetSoundVolume
SetSpeechVolume
SetVoiceMode
StopAmbientSound
StopChannel
StopMusic
Object functions and properties
Animate (object)
GetAtScreenXY (object)
GetName (object)
GetProperty (object)
GetPropertyText (object)
IsCollidingWithObject (object)
MergeIntoBackground
Move (object)
RemoveTint (object)
RunInteraction (object)
SetPosition (object)
SetView
StopAnimating (object)
StopMoving (object)
Tint (object)
Animating property (object)
Baseline property (object)
BlockingHeight property (object)
BlockingWidth property (object)
Clickable property (object)
Graphic property (object)
ID property (object)
IgnoreWalkbehinds property (object)
Moving property (object)
Solid property (object)
Transparency property (object)
View property (object)
Visible property (object)
X property (object)
Y property (object)
Overlay functions and properties
CreateGraphical
CreateTextual
Remove (overlay)
SetText (overlay)
Valid property (overlay)
X property (overlay)
Y property (overlay)
Palette functions
CyclePalette
SetPalRGB
UpdatePalette
Parser functions
ParseText
Said
SaidUnknownWord
Region functions and properties
GetAtRoomXY (region)
RunInteraction (region)
Tint (region)
Enabled property (region)
ID property (region)
LightLevel property
Room / Screen functions
AreThingsOverlapping
DisableGroundLevelAreas
EnableGroundLevelAreas
FadeIn
FadeOut
FlipScreen
GetBackgroundFrame
GetPlayerCharacter
GetRoomProperty
GetRoomPropertyText
GetScalingAt
GetViewportX
GetViewportY
GetWalkableAreaAt
HasPlayerBeenInRoom
RawClearScreen
RawDrawCircle
RawDrawFrameTransparent
RawDrawImage
RawDrawImageResized
RawDrawImageTransparent
RawDrawLine
RawDrawRectangle
RawDrawTriangle
RawPrint
RawPrintMessageWrapped
RawRestoreScreen
RawSaveScreen
RawSetColor
RawSetColorRGB
ReleaseViewport
RemoveWalkableArea
ResetRoom
RestoreWalkableArea
SetAreaScaling
SetBackgroundFrame
SetFadeColor
SetNextScreenTransition
SetScreenTransition
SetViewport
SetWalkBehindBase
ShakeScreen
ShakeScreenBackground
TintScreen
String functions
GetMessageText
StrCat
StrCaseComp
StrComp
StrContains
StrCopy
StrFormat
StrGetCharAt
StringToInt
StrLen
StrSetCharAt
StrToLowerCase
StrToUpperCase
Text display / Speech functions
Display
DisplayAt
DisplayAtY
DisplayMessage
DisplayMessageAtY
DisplayTopBar
GetDialogOption
RunDialog
SetDialogOption
SetSkipSpeech
SetSpeechFont
SetSpeechStyle
StopDialog
Reference
Interaction events
Hotspot interactions
Object interactions
Room interactions
Inventory item interactions
Character interactions
Region interactions
Scripting global variables
Scripting event reference
Built-in enumerated types
System limits
ASCII code table
FAQ and Troubleshooting
Frequently Asked Questions
Game creation problems
Contacting the author
Credits