System functions and properties

AudioChannelCount property

readonly static int System.AudioChannelCount;

This is useful if you want to loop through all the audio channels and check what is playing on them.

Example:

Display("There are %d audio channels.", System.AudioChannelCount);

Compatibility: Supported by AGS 3.2.0 and later versions.

See Also: System.AudioChannels

AudioChannels property

readonly static AudioChannel* System.AudioChannels[];

Example:

AudioChannel *channel = System.AudioChannels[2];
Display("Channel 2's current volume is %d.", channel.Volume);

Compatibility: Supported by AGS 3.2.0 and later versions.

See Also: Audio Channel commands, System.AudioChannelCount

CapsLock property

readonly static bool System.CapsLock;

You might want to use this to warn the player to switch it off before typing a password in, for example.

Example:

if (System.CapsLock)
{
  Display("The CAPS LOCK light is on.");
}

Compatibility: Supported by AGS 3.0.1 and later versions.

See Also: System.NumLock, System.ScrollLock

ColorDepth property (system)

readonly static int System.ColorDepth;

Example:

Display("Game is running at: %d x %d, %d-bit colour", System.ScreenWidth,
                                  System.ScreenHeight, System.ColorDepth);

See Also: System.ScreenHeight, System.ScreenWidth

Gamma property

static int System.Gamma;

System.SupportsGammaControl must return true in order for this property to have any effect.

Because every player's monitor will be different, you should normally use this property linked to a GUI Slider in order to allow the player to adjust it to suit their system.

Example:

if (System.SupportsGammaControl) {
  System.Gamma = 150;
}

See Also: System.SupportsGammaControl

HardwareAcceleration property

readonly static bool System.HardwareAcceleration;

Cross-Platform Support

Windows: Direct3D driver
MS-DOS: No
Linux: No
MacOS: No

Example:

if (System.HardwareAcceleration) {
  Display("Yay, we can draw loads of alpha blended sprites fast!");
}

See Also: AGS Graphics Drivers

NumLock property

readonly static bool System.NumLock;

You might want to use this to warn the player to switch it off before using the numeric keypad arrow keys, for example.

Example:

if (System.NumLock)
{
  Display("The NUM LOCK light is on.");
}

Compatibility: Supported by AGS 3.0.1 and later versions.

See Also: System.CapsLock, System.ScrollLock

OperatingSystem property

readonly static eOperatingSystem System.OperatingSystem;

eOSDOS
eOSWindows
eOSLinux
eOSMacOS

if (System.OperatingSystem == eOSWindows) {
  Display("Running on Windows!");
}
else {
  Display("Not running on Windows!");
}

ScreenHeight property

readonly static int System.ScreenHeight;

NOTE: Do NOT use this to calculate the centre of the screen when working with co-ordinates. Co-ordinates are relative to the viewport, so you should use System.ViewportHeight instead. Use the ScreenHeight property only for reporting purposes.

Example:

Display("Game is running at: %d x %d, %d-bit colour", System.ScreenWidth,
                                  System.ScreenHeight, System.ColorDepth);

See Also: System.ColorDepth, System.ScreenWidth, System.ViewportHeight

ScreenWidth property

readonly static int System.ScreenWidth;

NOTE: Do NOT use this to calculate the centre of the screen when working with co-ordinates. Co-ordinates are relative to the viewport, so you should use System.ViewportWidth instead. Use the ScreenWidth property only for reporting purposes.

Example:

Display("Game is running at: %d x %d, %d-bit colour", System.ScreenWidth,
                                  System.ScreenHeight, System.ColorDepth);

See Also: System.ColorDepth, System.ScreenHeight System.ViewportWidth

ScrollLock property

readonly static bool System.ScrollLock;

Note that when running your game under the debugger, the Scroll Lock key will break out of the game into the debugger, so it is not advised that you use it for any other purpose in your game.

Example:

if (System.ScrollLock)
{
  Display("The SCROLL LOCK light is on.");
}

Compatibility: Supported by AGS 3.0.1 and later versions.

See Also: System.CapsLock, System.NumLock

SupportsGammaControl property

readonly static bool System.SupportsGammaControl;

This must return true before you try and change the System.Gamma property. The situations in which this will be supported are listed below.

Cross-Platform Support

Windows: Full-screen only
MS-DOS: No
Linux: No
MacOS: No

Example:

if (System.SupportsGammaControl) {
  Display("We can change the system gamma level!");
}

See Also: System.Gamma

Version property

readonly static String System.Version;

The string returned is the full version number, for example "2.71.833".

Example:

Display("AGS version: %s", System.Version);

ViewportHeight property

readonly static int System.ViewportHeight;

Example:

Display("Game viewport: %d x %d", System.ViewportWidth, System.ViewportHeight);

See Also: System.ScreenHeight, System.ViewportWidth

ViewportWidth property

readonly static int System.ViewportWidth;

Example:

Display("Game viewport: %d x %d", System.ViewportWidth, System.ViewportHeight);

See Also: System.ScreenWidth, System.ViewportHeight

Volume property (system)

static int System.Volume;

Example:

System.Volume = 80;

Compatibility: Supported by AGS 3.2.0 and later versions.

See Also: AudioChannel.Volume, Game.SetAudioTypeVolume

VSync property

static bool System.VSync;

If you switch this on, it can help to reduce the "tearing" effect that you can get when the screen scrolls. However, doing so will lock the game frame rate to the monitor's refresh rate, which will mean you cannot reliably set a game speed higher than 60 fps.

NOTE: This property has no effect with the Direct3D driver.

Example:

if (System.VSync) {
  Display("Vertical retrace sync is enabled!");
}

Windowed property

readonly static bool System.Windowed;

Example:

if (System.Windowed) {
  Display("Game is running in a window!");
}