Class ConfigSchemeGroup

Defines a control scheme group for the InputRebindManager. Each group corresponds to a column in a typical input configuration screen (e.g., "WASD", "IJKL", "Gamepad").

Inheritance

object

ConfigSchemeGroup

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Scylla.Input

Assembly: ScyllaInput.dll

Syntax

public class ConfigSchemeGroup

Remarks

The GroupName must match the binding group names defined in the Unity Input Action Asset. Bindings whose groups field contains this name will be assigned to this scheme group.

The optional DeviceFilter restricts which device types are accepted during interactive rebinding for bindings in this group (e.g., "<Keyboard>" for keyboard-only, "<Gamepad>" for gamepad-only).

Constructors

ConfigSchemeGroup(string, string)

Initializes a new ConfigSchemeGroup with the specified group name and optional device filter.

Declaration

public ConfigSchemeGroup(string groupName, string deviceFilter = null)

Parameters

Type	Name	Description
string	groupName	The name of the control scheme group. Must match a binding group name in the Input Action Asset (e.g., "WASD", "Gamepad").
string	deviceFilter	Optional Unity Input System device path prefix used to restrict rebinding input to a specific device class (e.g., "<Keyboard>", "<Gamepad>"). Pass null to accept input from any device.

ConfigSchemeGroup(string, string, string)

Initializes a new ConfigSchemeGroup with a column header distinct from the binding group name.

Declaration

public ConfigSchemeGroup(string groupName, string displayName, string deviceFilter)

Parameters

Type	Name	Description
string	groupName	The name of the control scheme group. Must match a binding group name in the Input Action Asset (e.g., "WASD", "Gamepad").
string	displayName	Column header for this group. Falls back to groupName when null or empty.
string	deviceFilter	Optional Unity Input System device path prefix used to restrict rebinding input to a specific device class (e.g., "<Keyboard>", "<Gamepad>"). Pass null to accept input from any device.

Remarks

The two are separate because they answer to different audiences. The group name is whatever the Input Action Asset calls the binding group, which is usually named for the devices it uses. The display name is the column header a player reads, and "Keyboard Input" is a better heading than "Keyboard&Mouse".

Properties

DeviceFilter

Gets the optional device path prefix filter used during interactive rebinding to restrict accepted inputs to a specific device class.

Declaration

public string DeviceFilter { get; }

Property Value

Type	Description
string	A device path prefix (e.g., "<Keyboard>", "<Gamepad>"), or null if no device filter is applied.

DisplayName

Gets the column header for this group. Defaults to GroupName when no separate display name was supplied.

Declaration

public string DisplayName { get; }

Property Value

Type	Description
string

GroupName

Gets the name of the control scheme group. This must match the binding group names defined in the Unity Input Action Asset.

Declaration

public string GroupName { get; }

Property Value

Type	Description
string