Interface IRuntimeSettings

Game settings.

Inherited Members

IGameSettings.VirtualResolution

IGameSettings.Defaults

System.ComponentModel.INotifyPropertyChanged.PropertyChanged

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

public interface IRuntimeSettings : IGameSettings, INotifyPropertyChanged

Properties

PreserveAspectRatio

If the game is configured to preserve the aspect ratio, then in case the window is resized and the aspect ratio is changed, the screen will be letterboxed or pillarboxed so the aspect ratio for the actual content will remain the same

Declaration

bool PreserveAspectRatio { get; set; }

Property Value

Type	Description
System.Boolean

Title

Gets the title (the name of the game): would appear on the game window's title bar.

Declaration

string Title { get; set; }

Property Value

Type	Description
System.String	The title.

Vsync

Gets the vsync mode (synchronization of the frame update rate with screen refresh rate to prevent tearing). To read about how this works: https://hardforum.com/threads/how-vsync-works-and-why-people-loathe-it.928593/

Declaration

VsyncMode Vsync { get; set; }

Property Value

Type	Description
VsyncMode	The vsync.

WindowBorder

Gets the style of the window's border.

Declaration

WindowBorder WindowBorder { get; set; }

Property Value

Type	Description
WindowBorder	The window border.

WindowSize

Gets the size of the window (the size of the actual window on screen).

Declaration

Size WindowSize { get; set; }

Property Value

Type	Description
Size	The size of the window.

WindowState

Gets the state of the window (minimized/maximized/etc).

Declaration

WindowState WindowState { get; set; }

Property Value

Type	Description
WindowState	The state of the window.

Methods

LoadFrom(IGameSettings)

Loads settings from the specified object.

Declaration

void LoadFrom(IGameSettings settings)

Parameters

Type	Name	Description
IGameSettings	settings	Settings.