Class InputIconSet.IconMapping

Associates a Unity Input System binding path with an icon sprite and a human-readable display string for use in button-prompt UI.

Inheritance

object

InputIconSet.IconMapping

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

[Serializable]
public class InputIconSet.IconMapping

Fields

BindingPath

The Unity Input System binding path that this entry maps, for example "<Gamepad>/buttonSouth" or "<Keyboard>/space". The path is compared case-insensitively after whitespace trimming, so minor formatting differences do not prevent a match.

Declaration

[Tooltip("The Unity Input System binding path (e.g., '<Gamepad>/buttonSouth')")]
public string BindingPath

Field Value

Type	Description
string

DisplayText

The concise label shown next to or in place of the icon, for example "A", "X", or "Space". When this is empty or null, InputHintsManager falls back to the Unity Input System's own binding display string.

Declaration

[Tooltip("Human-readable display text (e.g., 'A', 'X', 'Space')")]
public string DisplayText

Field Value

Type	Description
string

Icon

The sprite displayed in the UI for this binding. May be null if only a text label is needed without a graphical icon.

Declaration

[Tooltip("The icon sprite to display for this binding")]
public Sprite Icon

Field Value

Type	Description
Sprite