Class Settings
Various settings for SadConsole.
Inherited Members
Namespace: SadConsole
Assembly: SadConsole.dll
Syntax
public static class Settings
Fields
AllowWindowResize
Allow the user to resize the window. Must be set before the game is created.
Declaration
public static bool AllowWindowResize
Field Value
Type | Description |
---|---|
bool |
ClearColor
The color to automatically clear the device with.
Declaration
public static Color ClearColor
Field Value
Type | Description |
---|---|
Color |
DefaultConsoleUseKeyboard
Gets and sets the default value for UseKeyboard when the console is created.
Declaration
public static bool DefaultConsoleUseKeyboard
Field Value
Type | Description |
---|---|
bool |
DefaultScreenObjectUseKeyboard
Gets and sets the default value for UseKeyboard.
Declaration
public static bool DefaultScreenObjectUseKeyboard
Field Value
Type | Description |
---|---|
bool |
DefaultScreenObjectUseMouse
Gets and sets the default value for UseMouse.
Declaration
public static bool DefaultScreenObjectUseMouse
Field Value
Type | Description |
---|---|
bool |
DoDraw
When true, indicates that the game loop should call Render(TimeSpan) on each object in Screen.
Declaration
public static bool DoDraw
Field Value
Type | Description |
---|---|
bool |
DoFinalDraw
When true, indicates that any game framework should render a composed image, of all consoles, to the screen.
Declaration
public static bool DoFinalDraw
Field Value
Type | Description |
---|---|
bool |
DoUpdate
When true, indicates that the game loop should call Update(TimeSpan) on each object in Screen.
Declaration
public static bool DoUpdate
Field Value
Type | Description |
---|---|
bool |
ResizeMode
The type of resizing options for the window.
Declaration
public static Settings.WindowResizeOptions ResizeMode
Field Value
Type | Description |
---|---|
Settings.WindowResizeOptions |
Properties
AutomaticAddColorsToMappings
Automatically adds all of the static color declarations of Color to ColorMappings.
Declaration
public static bool AutomaticAddColorsToMappings { get; set; }
Property Value
Type | Description |
---|---|
bool |
DebuggerPipeId
The identifier of the named pipe used to communicate with the in game debugger app.
Declaration
public static string DebuggerPipeId { get; }
Property Value
Type | Description |
---|---|
string |
SerializationIsCompressed
When set to true, all loading and saving performed by SadConsole uses GZIP. LoadFont(string) does not use this setting and always runs uncompressed.
Declaration
public static bool SerializationIsCompressed { get; set; }
Property Value
Type | Description |
---|---|
bool |
UseDefaultExtendedFont
When set to true, and a font is not specified with the GameHost, the IBM 8x16 extended SadConsole font will be used.
Declaration
public static bool UseDefaultExtendedFont { get; set; }
Property Value
Type | Description |
---|---|
bool |
WindowMinimumSize
When not set to (0,0) this property specifies the minimum size of the game window in pixels.
Declaration
public static Point WindowMinimumSize { get; set; }
Property Value
Type | Description |
---|---|
Point |
WindowTitle
The window title to display when the app is windowed.
Declaration
public static string WindowTitle { get; set; }
Property Value
Type | Description |
---|---|
string |