Class UnityPlayerInputRoutingSettings

Unity ScriptableObject implementation for player input routing configuration settings.
Defines comprehensive input routing behavior including device handling, UI interaction modes, session management, and policy enforcement.
Serves as the central configuration point for the Unity Player Input system routing architecture.

Inheritance

object

UnityPlayerInputRoutingSettings

Implements

IPlayerInputRoutingSettings

IFoundationSettings

Namespace: Serenity.InputGateway.Infrastructure.Settings

Assembly: Serenity.UnityPlayerInput.Infrastructure.dll

Syntax

public class UnityPlayerInputRoutingSettings : ScriptableObject, IPlayerInputRoutingSettings, IFoundationSettings

Constructors

UnityPlayerInputRoutingSettings()

Declaration

public UnityPlayerInputRoutingSettings()

Fields

Guid

Declaration

public string Guid

Field Value

Type	Description
string	Global unique identifier for this settings instance.

Id

Declaration

public string Id

Field Value

Type	Description
string	Unique identifier for this settings instance.

deviceFilter

Declaration

public UnityPlayerInputDeviceFilterSettings deviceFilter

Field Value

Type	Description
UnityPlayerInputDeviceFilterSettings	Gets or sets the device filtering settings. Defines rules for which input devices are accepted or rejected by the system based on layout, capabilities, and other criteria.

gameSessionMode

Declaration

public GameSessionMode gameSessionMode

Field Value

Type	Description
GameSessionMode	Gets or sets the current game session mode. Defines whether the game operates in single-player or multiplayer mode, affecting input routing policies.

joinGate

Declaration

public UnityPlayerInputJoinGateSettings joinGate

Field Value

Type	Description
UnityPlayerInputJoinGateSettings	Gets or sets the join gate settings. Defines custom rules and restrictions for player joining behavior including capacity limits and device usage constraints.

localJoin

Declaration

public PlayerInputJoinBehavior localJoin

Field Value

Type	Description
PlayerInputJoinBehavior	Gets or sets the local player join behavior. Controls when and how additional local players can join the game session.

menuMode

Declaration

public PlayerInputUiInteractionMode menuMode

Field Value

Type	Description
PlayerInputUiInteractionMode	Gets or sets the UI interaction mode for menu navigation. Determines how players can interact with menu interfaces in single or multiplayer contexts.

splitKeyboardAndMouse

Declaration

public bool splitKeyboardAndMouse

Field Value

Type	Description
bool	Gets or sets whether keyboard and mouse should be treated as separate input devices. When true, keyboard and mouse are handled independently for multiplayer scenarios. When false, keyboard and mouse are combined into a single composite input device.

Properties

Filter

Declaration

public IPlayerInputDeviceFilterSettings Filter { get; }

Property Value

Type	Description
IPlayerInputDeviceFilterSettings	Gets the device filtering settings as a domain interface. Provides access to device filtering rules through the abstracted interface.

GameSessionMode

Declaration

public GameSessionMode GameSessionMode { get; }

Property Value

Type	Description
GameSessionMode	Gets the current game session mode. Returns whether the game is configured for single-player or multiplayer operation.

Gate

Declaration

public IPlayerInputJoinGateSettings Gate { get; }

Property Value

Type	Description
IPlayerInputJoinGateSettings	Gets the join gate settings as a domain interface. Provides access to player joining rules through the abstracted interface.

LocalJoin

Declaration

public PlayerInputJoinBehavior LocalJoin { get; }

Property Value

Type	Description
PlayerInputJoinBehavior	Gets the local player join behavior. Returns the configured behavior for when and how additional local players can join.

MenuMode

Declaration

public PlayerInputUiInteractionMode MenuMode { get; }

Property Value

Type	Description
PlayerInputUiInteractionMode	Gets the UI interaction mode for menu navigation. Returns the configured interaction mode that determines how players can interact with menus.

SplitKeyboardAndMouse

Declaration

public bool SplitKeyboardAndMouse { get; }

Property Value

Type	Description
bool	Gets whether keyboard and mouse should be treated as separate input devices. Returns the configured split behavior for keyboard/mouse device handling.

Implements

IPlayerInputRoutingSettings

IFoundationSettings