Class PlayerInputInstaller<TAction, TContext>

Abstract installer for setting up player input services and related components.

Inheritance

object

PlayerInputInstaller<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.InputGateway.Installation.Installers

Assembly: Serenity.InputGateway.Installation.dll

Syntax

public abstract class PlayerInputInstaller<TAction, TContext> where TAction : IDisposable

Type Parameters

Name	Description
TAction
TContext

Constructors

PlayerInputInstaller()

Declaration

protected PlayerInputInstaller()

Fields

_joinService

Declaration

protected IPlayerInputJoinService _joinService

Field Value

Type	Description
IPlayerInputJoinService	Gets the primary input gate.

_joinServiceFactory

Declaration

protected IPlayerInputJoinServiceFactory _joinServiceFactory

Field Value

Type	Description
IPlayerInputJoinServiceFactory	Gets the player input join service factory.

_playerInputActionBindingFactory

Declaration

protected IPlayerInputActionBindingFactory<TAction, TContext> _playerInputActionBindingFactory

Field Value

Type	Description
IPlayerInputActionBindingFactory<TAction, TContext>	Gets the player input action binding factory.

_playerInputFactory

Declaration

protected IPlayerInputFactory _playerInputFactory

Field Value

Type	Description
IPlayerInputFactory	Gets the player input factory.

_playerInputHandler

Declaration

protected object _playerInputHandler

Field Value

Type	Description
object	Gets the player input handler (e.g., a PlayerInput component in Unity).

_playerInputManagerFactory

Declaration

protected IPlayerInputManagerFactory _playerInputManagerFactory

Field Value

Type	Description
IPlayerInputManagerFactory	Gets the player input manager factory.

_playerInputManagerHandler

Declaration

protected object _playerInputManagerHandler

Field Value

Type	Description
object	Gets the player input manager handler (e.g., a PlayerInputManager component in Unity).

_playerInputServiceSettings

Declaration

protected IPlayerInputServiceSettingsDefinition _playerInputServiceSettings

Field Value

Type	Description
IPlayerInputServiceSettingsDefinition	Gets the player input service settings definition.

_playerInputSlotsFactory

Declaration

protected IPlayerInputSlotsFactory _playerInputSlotsFactory

Field Value

Type	Description
IPlayerInputSlotsFactory	Gets the player input slots factory.

_primaryDeviceSelectorFactory

Declaration

protected IPrimaryDeviceSelectorFactory _primaryDeviceSelectorFactory

Field Value

Type	Description
IPrimaryDeviceSelectorFactory	Gets the player input primary device selector factory.

_primaryInputGateFactory

Declaration

protected IPrimaryInputGateFactory _primaryInputGateFactory

Field Value

Type	Description
IPrimaryInputGateFactory	Gets the primary input gate factory.

_primarySelector

Declaration

protected IPrimaryDeviceSelector _primarySelector

Field Value

Type	Description
IPrimaryDeviceSelector	Gets the player input primary device selector.

_routingSettings

Declaration

protected IPlayerInputRoutingSettings _routingSettings

Field Value

Type	Description
IPlayerInputRoutingSettings	Gets the player input service settings.

_service

Declaration

protected IPlayerInputService _service

Field Value

Type	Description
IPlayerInputService	Gets the player input service.

_serviceFactory

Declaration

protected IPlayerInputServiceFactory _serviceFactory

Field Value

Type	Description
IPlayerInputServiceFactory	Gets the player input service factory.

_slots

Declaration

protected IPlayerInputSlots _slots

Field Value

Type	Description
IPlayerInputSlots	Gets the player input slots.

_uiInputRouterFactory

Declaration

protected IUiInputRouterFactory _uiInputRouterFactory

Field Value

Type	Description
IUiInputRouterFactory	Gets the player input UI input router factory.

_uiRouter

Declaration

protected IUiInputRouter _uiRouter

Field Value

Type	Description
IUiInputRouter	Gets the player input UI input router.

Properties

InputActionBindingFactory

Gets the installed player input action binding factory.

Declaration

public IPlayerInputActionBindingFactory<TAction, TContext> InputActionBindingFactory { get; }

Property Value

Type	Description
IPlayerInputActionBindingFactory<TAction, TContext>	The installed player input action binding factory.

JoinService

Gets the player input join service.

Declaration

public IPlayerInputJoinService JoinService { get; }

Property Value

Type	Description
IPlayerInputJoinService	The player input join service.

JoinServiceFactory

Gets the player input join service factory.

Declaration

public IPlayerInputJoinServiceFactory JoinServiceFactory { get; }

Property Value

Type	Description
IPlayerInputJoinServiceFactory	The player input join service factory.

PlayerInputActionBindingFactory

Gets the player input action binding factory.

Declaration

public IPlayerInputActionBindingFactory<TAction, TContext> PlayerInputActionBindingFactory { get; }

Property Value

Type	Description
IPlayerInputActionBindingFactory<TAction, TContext>	The player input action binding factory.

PlayerInputFactory

Gets the player input factory.

Declaration

public IPlayerInputFactory PlayerInputFactory { get; }

Property Value

Type	Description
IPlayerInputFactory	The player input factory.

PlayerInputHandler

Gets the player input handler (e.g., a PlayerInput component in Unity).

Declaration

public object PlayerInputHandler { get; }

Property Value

Type	Description
object	The player input handler.

PlayerInputManagerFactory

Gets the player input manager factory.

Declaration

public IPlayerInputManagerFactory PlayerInputManagerFactory { get; }

Property Value

Type	Description
IPlayerInputManagerFactory	The player input manager factory.

PlayerInputManagerHandler

Gets the player input manager handler (e.g., a PlayerInputManager component in Unity).

Declaration

public object PlayerInputManagerHandler { get; }

Property Value

Type	Description
object	The player input manager handler.

PlayerInputServiceSettings

Gets the player input service settings definition.

Declaration

public IPlayerInputServiceSettingsDefinition PlayerInputServiceSettings { get; }

Property Value

Type	Description
IPlayerInputServiceSettingsDefinition	The player input service settings definition.

PlayerInputSlotsFactory

Gets the player input slots factory.

Declaration

public IPlayerInputSlotsFactory PlayerInputSlotsFactory { get; }

Property Value

Type	Description
IPlayerInputSlotsFactory	The player input slots factory.

PrimaryDeviceSelectorFactory

Gets the player input primary device selector factory.

Declaration

public IPrimaryDeviceSelectorFactory PrimaryDeviceSelectorFactory { get; }

Property Value

Type	Description
IPrimaryDeviceSelectorFactory	The player input primary device selector factory.

PrimaryInputGateFactory

Gets the primary input gate factory.

Declaration

public IPrimaryInputGateFactory PrimaryInputGateFactory { get; }

Property Value

Type	Description
IPrimaryInputGateFactory	The primary input gate factory.

PrimarySelector

Gets the player input primary device selector.

Declaration

public IPrimaryDeviceSelector PrimarySelector { get; }

Property Value

Type	Description
IPrimaryDeviceSelector	The player input primary device selector.

RoutingSettings

Gets the player input routing settings.

Declaration

public IPlayerInputRoutingSettings RoutingSettings { get; }

Property Value

Type	Description
IPlayerInputRoutingSettings	The player input routing settings.

Service

Gets the player input service.

Declaration

public IPlayerInputService Service { get; }

Property Value

Type	Description
IPlayerInputService	The player input service.

ServiceFactory

Gets the player input service factory.

Declaration

public IPlayerInputServiceFactory ServiceFactory { get; }

Property Value

Type	Description
IPlayerInputServiceFactory	The player input service factory.

Slots

Gets the player input slots.

Declaration

public IPlayerInputSlots Slots { get; }

Property Value

Type	Description
IPlayerInputSlots	The player input slots.

UiInputRouterFactory

Gets the player input UI input router factory.

Declaration

public IUiInputRouterFactory UiInputRouterFactory { get; }

Property Value

Type	Description
IUiInputRouterFactory	The player input UI input router factory.

UiRouter

Gets the player input UI input router.

Declaration

public IUiInputRouter UiRouter { get; }

Property Value

Type	Description
IUiInputRouter	The player input UI input router.

Methods

GetService()

Gets the installed player input service.

Declaration

public IPlayerInputService GetService()

Returns

Type	Description
IPlayerInputService	The installed player input service.

Install(PlayerInputInstallerInstallInput)

Installs the player input system.

Declaration

public abstract void Install(PlayerInputInstallerInstallInput input)

Parameters

Type	Name	Description
PlayerInputInstallerInstallInput	input	The input DTO containing necessary dependencies.

InstallJoinServiceFactory()

Installs the join service factory.

Declaration

protected abstract IPlayerInputJoinServiceFactory InstallJoinServiceFactory()

Returns

Type	Description
IPlayerInputJoinServiceFactory	The join service factory.

InstallPlayerInputActionBindingFactory()

Installs the player input action binding factory.

Declaration

protected abstract IPlayerInputActionBindingFactory<TAction, TContext> InstallPlayerInputActionBindingFactory()

Returns

Type	Description
IPlayerInputActionBindingFactory<TAction, TContext>	The player input action binding factory.

InstallPlayerInputFactory(object)

Installs the player input factory.

Declaration

protected abstract IPlayerInputFactory InstallPlayerInputFactory(object inputActionAsset)

Parameters

Type	Name	Description
object	inputActionAsset	The input action asset (e.g., InputActionAsset in Unity).

Returns

Type	Description
IPlayerInputFactory	The player input factory.

InstallPlayerInputManagerFactory()

Installs the player input manager factory.

Declaration

protected abstract IPlayerInputManagerFactory InstallPlayerInputManagerFactory()

Returns

Type	Description
IPlayerInputManagerFactory	The player input manager factory.

InstallPlayerInputSlotsFactory()

Installs the player input slots factory.

Declaration

protected abstract IPlayerInputSlotsFactory InstallPlayerInputSlotsFactory()

Returns

Type	Description
IPlayerInputSlotsFactory	The player input slots factory.

InstallPrimaryDeviceSelectorFactory()

Installs the primary device selector factory.

Declaration

protected abstract IPrimaryDeviceSelectorFactory InstallPrimaryDeviceSelectorFactory()

Returns

Type	Description
IPrimaryDeviceSelectorFactory	The primary device selector factory.

InstallPrimaryInputGateFactory()

Installs the primary input gate factory.

Declaration

protected abstract IPrimaryInputGateFactory InstallPrimaryInputGateFactory()

Returns

Type	Description
IPrimaryInputGateFactory	The primary input gate factory.

InstallService(object, IPlayerInputServiceSettingsDefinition, TaskBuildContext, IUiInputRouter, IPlayerInputSlots, IUiInputRouter, IPrimaryDeviceSelector, IPrimaryInputGate, IPlayerInputJoinService)

Installs the player input service.

Declaration

protected abstract IPlayerInputService InstallService(object playerInput, IPlayerInputServiceSettingsDefinition settings, TaskBuildContext context, IUiInputRouter uiInputRouter, IPlayerInputSlots slots, IUiInputRouter inputRouter, IPrimaryDeviceSelector primaryDeviceSelector, IPrimaryInputGate primaryInputGate, IPlayerInputJoinService joinService)

Parameters

Type	Name	Description
object	playerInput	The player input handle (e.g., a PlayerInput component in Unity).
IPlayerInputServiceSettingsDefinition	settings	The settings for the player input service.
TaskBuildContext	context	The task build context for creating tasks.
IUiInputRouter	uiInputRouter	The UI input router to handle UI input routing.
IPlayerInputSlots	slots	The player input slots to manage.
IUiInputRouter	inputRouter	The input router to handle input routing.
IPrimaryDeviceSelector	primaryDeviceSelector	The primary device selector to handle primary device selection.
IPrimaryInputGate	primaryInputGate	The primary input gate to handle primary input gating.
IPlayerInputJoinService	joinService	The player input join service to handle player joining.

Returns

Type	Description
IPlayerInputService	The installed player input service.

InstallServiceFactory()

Installs the player input service factory.

Declaration

protected abstract IPlayerInputServiceFactory InstallServiceFactory()

Returns

Type	Description
IPlayerInputServiceFactory	The player input service factory.

InstallUiInputRouterFactory()

Installs the UI input router factory.

Declaration

protected abstract IUiInputRouterFactory InstallUiInputRouterFactory()

Returns

Type	Description
IUiInputRouterFactory	The UI input router factory.