Class MenuInstallerInstallInput<TAction, TContext>

Input data transfer object for installing a Menu.

Inheritance

object

MenuInstallerInstallInput<TAction, TContext>

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Serenity.Menu.Installation.DTO

Assembly: Serenity.Menu.Installation.dll

Syntax

public class MenuInstallerInstallInput<TAction, TContext> where TAction : IDisposable

Type Parameters

Name	Description
TAction
TContext

Remarks

This DTO encapsulates all necessary dependencies and configurations required for the installation of a Menu.

Constructors

MenuInstallerInstallInput(string, string, object, string, IViewBrowserService, IPlayerInputService, IPlayerInputActionBindingFactory<TAction, TContext>, IFoundationViewElementFactory, IUiThemeDefinition, ILogService)

Initializes a new instance of the MenuInstallerInstallInput<TAction, TContext> class.

Declaration

public MenuInstallerInstallInput(string id, string controllerId, object canvas, string audioPlayerId, IViewBrowserService viewBrowserService, IPlayerInputService playerInputService, IPlayerInputActionBindingFactory<TAction, TContext> playerInputActionBindingFactory, IFoundationViewElementFactory foundationViewElementFactory, IUiThemeDefinition theme, ILogService logService)

Parameters

Type	Name	Description
string	id
string	controllerId
object	canvas	The canvas object where the menu will be rendered.
string	audioPlayerId	The identifier for the audio player associated with the menu.
IViewBrowserService	viewBrowserService	The service responsible for managing view navigation and rendering.
IPlayerInputService	playerInputService	The service responsible for handling player input.
IPlayerInputActionBindingFactory<TAction, TContext>	playerInputActionBindingFactory	The factory for creating player input action bindings.
IFoundationViewElementFactory	foundationViewElementFactory	The factory for creating foundation view elements.
IUiThemeDefinition	theme	The UI theme definition to be applied to the menu.
ILogService	logService	The logging service for recording installation events and errors.

Exceptions

Type	Condition
ArgumentNullException	Thrown when a required parameter is null.

Fields

AudioPlayerId

Declaration

public string AudioPlayerId

Field Value

Type	Description
string	The identifier for the audio player associated with the menu.

Canvas

Declaration

public object Canvas

Field Value

Type	Description
object	The canvas object where the menu will be rendered.

ControllerId

Declaration

public string ControllerId

Field Value

Type	Description
string	The identifier for the menu controller.

FoundationViewElementFactory

Declaration

public IFoundationViewElementFactory FoundationViewElementFactory

Field Value

Type	Description
IFoundationViewElementFactory	The factory for creating foundation view elements.

Id

Declaration

public string Id

Field Value

Type	Description
string	The identifier for the menu service

Remarks

This ID is used to uniquely identify the menu service within the application.

LogService

Declaration

public ILogService LogService

Field Value

Type	Description
ILogService	The logging service for recording installation events and errors.

PauseMenuId

Declaration

public string PauseMenuId

Field Value

Type	Description
string	The id of the pause menu, supplied by the composition root from the GameMode settings. Used only for lifecycle validation: a menu used as the pause menu must not be lazy at runtime, so if it is configured LazyOnFirstOpen the installer warns and forces PreloadOnStartup. Optional (may be null).

PlayerInputActionBindingFactory

Declaration

public IPlayerInputActionBindingFactory<TAction, TContext> PlayerInputActionBindingFactory

Field Value

Type	Description
IPlayerInputActionBindingFactory<TAction, TContext>	The factory for creating player input action bindings.

PlayerInputService

Declaration

public IPlayerInputService PlayerInputService

Field Value

Type	Description
IPlayerInputService	The service responsible for handling player input.

Theme

Declaration

public IUiThemeDefinition Theme

Field Value

Type	Description
IUiThemeDefinition	The UI theme definition to be applied to the menu.

ViewBrowserService

Declaration

public IViewBrowserService ViewBrowserService

Field Value

Type	Description
IViewBrowserService	The service responsible for managing view navigation and rendering.

See Also

IViewBrowserService

IPlayerInputService

IPlayerInputActionBindingFactory<TAction, TContext>

IFoundationViewElementFactory

IUiThemeDefinition

ILogService