Settings Class
Definition
Section titled “Definition”Various settings for SadConsole.
public static class SettingsInheritance object
Fields
Section titled “Fields”DefaultConsoleUseKeyboard
Section titled “DefaultConsoleUseKeyboard”Gets and sets the default value for UseKeyboard when the console is created.
public static bool DefaultConsoleUseKeyboardDefaultScreenObjectUseKeyboard
Section titled “DefaultScreenObjectUseKeyboard”Gets and sets the default value for UseKeyboard.
public static bool DefaultScreenObjectUseKeyboardDefaultScreenObjectUseMouse
Section titled “DefaultScreenObjectUseMouse”Gets and sets the default value for UseMouse.
public static bool DefaultScreenObjectUseMouseClearColor
Section titled “ClearColor”The color to automatically clear the device with.
public static Color ClearColorResizeMode
Section titled “ResizeMode”The type of resizing options for the window.
public static Settings.WindowResizeOptions ResizeModeAllowWindowResize
Section titled “AllowWindowResize”Allow the user to resize the window. Must be set before the game is created.
public static bool AllowWindowResizeDoDraw
Section titled “DoDraw”When true, indicates that the game loop should call Render(TimeSpan) on each object in Screen.
public static bool DoDrawDoFinalDraw
Section titled “DoFinalDraw”When true, indicates that any game framework should render a composed image, of all consoles, to the screen.
public static bool DoFinalDrawDoUpdate
Section titled “DoUpdate”When true, indicates that the game loop should call Update(TimeSpan) on each object in Screen.
public static bool DoUpdateProperties
Section titled “Properties”WindowMinimumSize
Section titled “WindowMinimumSize”When not set to (0,0) this property specifies the minimum size of the game window in pixels.
public static Point WindowMinimumSize { get; set; }SerializationIsCompressed
Section titled “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.
public static bool SerializationIsCompressed { get; set; }UseDefaultExtendedFont
Section titled “UseDefaultExtendedFont”When set to true, and a font is not specified with the GameHost, the IBM 8x16 extended SadConsole font will be used.
public static bool UseDefaultExtendedFont { get; set; }WindowTitle
Section titled “WindowTitle”The window title to display when the app is windowed.
public static string WindowTitle { get; set; }DebuggerPipeId
Section titled “DebuggerPipeId”The identifier of the named pipe used to communicate with the in game debugger app.
public static string DebuggerPipeId { get; }AutomaticAddColorsToMappings
Section titled “AutomaticAddColorsToMappings”Automatically adds all of the static color declarations of SadRogue.Primitives.Color to ColorMappings.
public static bool AutomaticAddColorsToMappings { get; set; }