Extensions Class
Definition
Section titled “Definition”Extensions to the Builder type.
public static class ExtensionsInheritance object
Methods
Section titled “Methods”OnStart(Builder, EventHandler<GameHost>)
Section titled “OnStart(Builder, EventHandler<GameHost>)”Sets an event handler for the Started event.
public static Builder OnStart(this Builder configBuilder, EventHandler<GameHost> instance_Started)Parameters
Section titled “Parameters”configBuilder Builder
The builder object that composes the game startup.
instance_Started EventHandler<GameHost>
The event handler
Returns
Section titled “Returns”Builder
The configuration builder.
OnEnd(Builder, EventHandler<GameHost>)
Section titled “OnEnd(Builder, EventHandler<GameHost>)”Sets an event handler for the Ending event.
public static Builder OnEnd(this Builder configBuilder, EventHandler<GameHost> instance_Ending)Parameters
Section titled “Parameters”configBuilder Builder
The builder object that composes the game startup.
instance_Ending EventHandler<GameHost>
The event handler
Returns
Section titled “Returns”Builder
The configuration builder.
AddFrameUpdateEvent(Builder, EventHandler<GameHost>)
Section titled “AddFrameUpdateEvent(Builder, EventHandler<GameHost>)”Sets an event handler for the FrameUpdate event.
public static Builder AddFrameUpdateEvent(this Builder configBuilder, EventHandler<GameHost> instance_FrameUpdate)Parameters
Section titled “Parameters”configBuilder Builder
The builder object that composes the game startup.
instance_FrameUpdate EventHandler<GameHost>
The event handler
Returns
Section titled “Returns”Builder
The configuration builder.
AddFrameRenderEvent(Builder, EventHandler<GameHost>)
Section titled “AddFrameRenderEvent(Builder, EventHandler<GameHost>)”Sets an event handler for the FrameRender event.
public static Builder AddFrameRenderEvent(this Builder configBuilder, EventHandler<GameHost> instance_FrameRender)Parameters
Section titled “Parameters”configBuilder Builder
The builder object that composes the game startup.
instance_FrameRender EventHandler<GameHost>
The event handler
Returns
Section titled “Returns”Builder
The configuration builder.
ConfigureWindow(Builder, Action<ConfigureWindowConfig, BuilderBase, GameHost>)
Section titled “ConfigureWindow(Builder, Action<ConfigureWindowConfig, BuilderBase, GameHost>)”Configures the game window.
public static Builder ConfigureWindow(this Builder configBuilder, Action<ConfigureWindowConfig, BuilderBase, GameHost> loader)Parameters
Section titled “Parameters”configBuilder Builder
The builder object that composes the game startup.
loader Action<ConfigureWindowConfig, BuilderBase, GameHost>
The method to invoke when this is run.
Returns
Section titled “Returns”Builder
The configuration builder.
SetScreenSize(Builder, int, int)
Section titled “SetScreenSize(Builder, int, int)”Sets the initial screen size of the window, in cells.
[Obsolete("Use SetWindowSizeInCells instead.")]public static Builder SetScreenSize(this Builder configBuilder, int width, int height)Parameters
Section titled “Parameters”configBuilder Builder
The builder object that composes the game startup.
width int
The cell count along the x-axis.
height int
The cell count along the y-axis.
Returns
Section titled “Returns”Builder
The configuration builder.
SetWindowSizeInCells(Builder, int, int, bool)
Section titled “SetWindowSizeInCells(Builder, int, int, bool)”Sets the desired resolution of the SadConsole window in cells using the default font.
public static Builder SetWindowSizeInCells(this Builder configBuilder, int width, int height, bool zoom = false)Parameters
Section titled “Parameters”configBuilder Builder
The builder object that composes the game startup.
width int
How wide the window is in font cells.
height int
How tall the window is in font cells.
zoom bool
When true, creates a larger window to automatically zoom the contents.
Returns
Section titled “Returns”Remarks
Section titled “Remarks”The width and height values are used to generate the game window based on how large the font is. For example, if the font is 10x8, and you request window size of 20x20, a window is created with a width of 10 * 20 and a height of 8 * 20 in pixels, which is 200x160. When zoom is set to true, the window will try to get as big as possible while keeping the SadConsole output crisp.
SetWindowSizeInPixels(Builder, int, int)
Section titled “SetWindowSizeInPixels(Builder, int, int)”Sets the desired resolution of the SadConsole window in pixels. The output surface and initial cell counts are calculated based on the current font, and set to a value that allows the most cells to appear on screen.
public static Builder SetWindowSizeInPixels(this Builder configBuilder, int width, int height)Parameters
Section titled “Parameters”configBuilder Builder
The builder object that composes the game startup.
width int
The width of the window.
height int
The height of the window.
Returns
Section titled “Returns”UseDefaultConsole(Builder)
Section titled “UseDefaultConsole(Builder)”Sets the StartingConsole and Screen properties to new console when the game starts.
public static Builder UseDefaultConsole(this Builder configBuilder)Parameters
Section titled “Parameters”configBuilder Builder
The builder object that composes the game startup.
Returns
Section titled “Returns”Builder
The configuration builder.
ConfigureFonts(Builder, Action<FontConfig, GameHost>)
Section titled “ConfigureFonts(Builder, Action<FontConfig, GameHost>)”Configures which default font to use during game startup, as well as which other fonts to load for the game.
public static Builder ConfigureFonts(this Builder configBuilder, Action<FontConfig, GameHost> fontLoader)Parameters
Section titled “Parameters”configBuilder Builder
The builder object that composes the game startup.
fontLoader Action<FontConfig, GameHost>
A method that provides access to the FontConfig object that loads fonts.
Returns
Section titled “Returns”Builder
The configuration builder.
ConfigureFonts(Builder, string, string[]?)
Section titled “ConfigureFonts(Builder, string, string[]?)”Configures SadConsole to use the specified font file as the default font.
public static Builder ConfigureFonts(this Builder configBuilder, string customDefaultFont, string[]? extraFonts = null)Parameters
Section titled “Parameters”configBuilder Builder
The builder object that composes the game startup.
customDefaultFont string
Creates the font config for SadConsole using this font file as the default.
extraFonts string[]
Extra fonts to load into SadConsole.
Returns
Section titled “Returns”Builder
The configuration builder.
ConfigureFonts(Builder, bool)
Section titled “ConfigureFonts(Builder, bool)”Configures SadConsole to use the built in default fonts.
public static Builder ConfigureFonts(this Builder configBuilder, bool useExtendedDefault = false)Parameters
Section titled “Parameters”configBuilder Builder
The builder object that composes the game startup.
useExtendedDefault bool
When true, SadConsole sets the default font to EmbeddedFontExtended; otherwise EmbeddedFont is used.
Returns
Section titled “Returns”Builder
The configuration builder.
FixOldFontName(Builder)
Section titled “FixOldFontName(Builder)”Adds the embedded fonts to the font dictionary with the old incorrect name.
public static Builder FixOldFontName(this Builder configBuilder)Parameters
Section titled “Parameters”configBuilder Builder
The builder object that composes the game startup.
Returns
Section titled “Returns”Builder
The configuration builder.
SetDefaultFontSize(Builder, Sizes)
Section titled “SetDefaultFontSize(Builder, Sizes)”Sets the default font size for the game. The default is One.
public static Builder SetDefaultFontSize(this Builder configBuilder, IFont.Sizes size)Parameters
Section titled “Parameters”configBuilder Builder
The builder object that composes the game startup.
size IFont.Sizes
The size of the default font.
Returns
Section titled “Returns”Builder
The configuration builder.
SetSplashScreen<TSplashScreen>(Builder)
Section titled “SetSplashScreen<TSplashScreen>(Builder)”Sets the startup splash screen to the specified object.
public static Builder SetSplashScreen<TSplashScreen>(this Builder configBuilder) where TSplashScreen : IScreenSurface, new()Parameters
Section titled “Parameters”configBuilder Builder
The builder object that composes the game startup.
Returns
Section titled “Returns”Builder
The configuration builder.
SetSplashScreen(Builder, Func<GameHost, ScreenSurface[]>)
Section titled “SetSplashScreen(Builder, Func<GameHost, ScreenSurface[]>)”Sets the startup splash screens to the array returned by the creator delegate.
public static Builder SetSplashScreen(this Builder configBuilder, Func<GameHost, ScreenSurface[]> creator)Parameters
Section titled “Parameters”configBuilder Builder
The builder object that composes the game startup.
creator Func<GameHost, ScreenSurface[]>
A delegate that returns an array of surface objects.
Returns
Section titled “Returns”Builder
The configuration builder.
SetStartingScreen<TRootObject>(Builder)
Section titled “SetStartingScreen<TRootObject>(Builder)”Sets the Screen property to the specified type.
public static Builder SetStartingScreen<TRootObject>(this Builder configBuilder) where TRootObject : IScreenObject, new()Parameters
Section titled “Parameters”configBuilder Builder
The builder object that composes the game startup.
Returns
Section titled “Returns”Builder
The configuration builder.
SetStartingScreen(Builder, Func<GameHost, IScreenObject>)
Section titled “SetStartingScreen(Builder, Func<GameHost, IScreenObject>)”Sets the Screen property to the return value of the creator parameter.
public static Builder SetStartingScreen(this Builder configBuilder, Func<GameHost, IScreenObject> creator)Parameters
Section titled “Parameters”configBuilder Builder
The builder object that composes the game startup.
creator Func<GameHost, IScreenObject>
A method that returns an object as the starting screen.
Returns
Section titled “Returns”Builder
The configuration builder.
IsStartingScreenFocused(Builder, bool)
Section titled “IsStartingScreenFocused(Builder, bool)”Either focuses or unfocuses the starting screen.
public static Builder IsStartingScreenFocused(this Builder configBuilder, bool value)Parameters
Section titled “Parameters”configBuilder Builder
The builder object that composes the game startup.
value bool
Indicates whether or not Screen is focused.
Returns
Section titled “Returns”Builder
The configuration builder.