Class ExtensionsHost

Inheritance

object

ExtensionsHost

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: SadConsole.Configuration

Assembly: SadConsole.Host.MonoGame.dll

Syntax

public static class ExtensionsHost

Methods

Run(Builder)

Runs the game using the builder configuration.

Declaration

public static void Run(this Builder configBuilder)

Parameters

Type	Name	Description
Builder	configBuilder	The builder object that composes the game startup.

ShowMonoGameFPS(Builder)

Adds a MonoGame game component that renders the frames per-second of the game.

Declaration

public static Builder ShowMonoGameFPS(this Builder configBuilder)

Parameters

Type	Name	Description
Builder	configBuilder	The builder object that composes the game startup.

Returns

Type	Description
Builder	The configuration builder.

SkipMonoGameGameCreation(Builder)

When called, tells the game host not to create the monogame game instance at MonoGameInstance.

Declaration

public static Builder SkipMonoGameGameCreation(this Builder configBuilder)

Parameters

Type	Name	Description
Builder	configBuilder	The builder object that composes the game startup.

Returns

Type	Description
Builder	The configuration object.

UseTitleContainer(Builder)

Tells the game host to use the Microsoft.Xna.Framework.TitleContainer to open streams for reading.

Declaration

public static Builder UseTitleContainer(this Builder configBuilder)

Parameters

Type	Name	Description
Builder	configBuilder	The builder object that composes the game startup.

Returns

Type	Description
Builder	The configuration object.

UseUnlimitedFPS(Builder)

Unlimited FPS when rendering (normally limited to 60fps). Must be set before the game is created.

Declaration

public static Builder UseUnlimitedFPS(this Builder configBuilder)

Parameters

Type	Name	Description
Builder	configBuilder	The builder object that composes the game startup.

Returns

Type	Description
Builder	The configuration builder.

WithMonoGameCtor(Builder, Action<Game>)

The monogameCtorCallback method is called by the MonoGame constructor. Some MonoGame specific settings may only be settable via the constructor.

Declaration

public static Builder WithMonoGameCtor(this Builder configBuilder, Action<Game> monogameCtorCallback)

Parameters

Type	Name	Description
Builder	configBuilder	The builder object that composes the game startup.
Action<Game>	monogameCtorCallback	A method.

Returns

Type	Description
Builder	The configuration object.

WithMonoGameInit(Builder, Action<Game>)

Internal only. Called by the MonoGame game to finish configuring SadConsole.

Declaration

public static Builder WithMonoGameInit(this Builder configBuilder, Action<Game> monogameInitCallback)

Parameters

Type	Name	Description
Builder	configBuilder	The builder object that composes the game startup.
Action<Game>	monogameInitCallback	A method.

Returns

Type	Description
Builder	The configuration object.