Scylla Framework
  • API Reference
Search Results for

    Show / Hide Table of Contents
    • Scylla.Input
      • AutoResolveChange
      • AutoResolveResult
      • BindingConflict
      • BindingStorageSettings
      • BindingStorageType
      • BridgeSettings
      • BufferedInput
      • ConfigActionEntry
      • ConfigActionGroup
      • ConfigBindingEntry
      • ConfigConflict
      • ConfigGroupExclusion
      • ConfigLayout
      • ConfigLayout.Builder
      • ConfigLayoutColumnDefinition
      • ConfigLayoutConflictScope
      • ConfigLayoutDefinition
      • ConfigLayoutExclusionDefinition
      • ConfigLayoutGroupDefinition
      • ConfigLayoutGroupMode
      • ConfigLayoutMemberReference
      • ConfigLayoutValidationMessage
      • ConfigLayoutValidationSeverity
      • ConfigSchemeGroup
      • ContextConflictScope
      • ContextValidationMessage
      • ContextValidationSeverity
      • ControlScheme
      • ControlSchemeChangedEvent
      • ControlSchemeManager
      • ControlSchemeType
      • GamepadButton
      • GamepadType
      • IBindingStorage
      • IControlSchemeManager
      • IInputActionManager
      • IInputBindingManager
      • IInputBridgeManager
      • IInputBufferManager
      • IInputConflictScope
      • IInputContextManager
      • IInputControlAliasResolver
      • IInputHintsManager
      • IInputListener
      • IInputRebindabilityProvider
      • IScyllaInputBridge
      • IdentityControlAliasResolver
      • InputActionCanceledEvent
      • InputActionManager
      • InputActionMapNode
      • InputActionMetadata
      • InputActionNode
      • InputActionPerformedEvent
      • InputActionStartedEvent
      • InputActionsDocument
      • InputActionsDocumentIO
      • InputActionsJSONKeys
      • InputAnnotation
      • InputAssetInfo
      • InputBindingGroups
      • InputBindingManager
      • InputBindingMetadata
      • InputBindingNode
      • InputBindingsLoadedEvent
      • InputBindingsSavedEvent
      • InputBridgeManager
      • InputBridgeQueryMode
      • InputBufferConsumedEvent
      • InputBufferManager
      • InputBufferedEvent
      • InputCodegenSettings
      • InputCompositeUtil
      • InputConflictEngine
      • InputConflictPair
      • InputConflictPolicy
      • InputConflictReason
      • InputConflictRecord
      • InputConflictRecordBuilder
      • InputConflictResolution
      • InputConflictSet
      • InputContext
      • InputContextChangedEvent
      • InputContextDefinition
      • InputContextExclusivity
      • InputContextManager
      • InputContextPoppedEvent
      • InputContextPushedEvent
      • InputControlAliasEntry
      • InputControlAliasResolver
      • InputControlAliasScope
      • InputControlPathUtil
      • InputControlSchemeNode
      • InputDeviceChangedEvent
      • InputDeviceConnectedEvent
      • InputDeviceDisconnectedEvent
      • InputDeviceType
      • InputDeviceUtil
      • InputDisabledEvent
      • InputEnabledEvent
      • InputEventType
      • InputHint
      • InputHintChangedEvent
      • InputHintsManager
      • InputIconSet
      • InputIconSet.IconMapping
      • InputIconSetChangedEvent
      • InputInteractionKind
      • InputInteractionResolver
      • InputInteractionSignature
      • InputJSONMember
      • InputJSONNode
      • InputJSONNodeReader
      • InputJSONNodeType
      • InputJSONNodeWriter
      • InputLoggingSettings
      • InputMapMetadata
      • InputMetadataRebindabilityProvider
      • InputMetadataReconciler
      • InputMetadataRecordKind
      • InputModifierMetadataUtil
      • InputOrphanRecord
      • InputRebindCancelledEvent
      • InputRebindCompletedEvent
      • InputRebindManager
      • InputRebindOperation
      • InputRebindStartedEvent
      • InputRebindUtils
      • InputRebindability
      • InputReconcileAction
      • InputReconcileOptions
      • InputReconcileReport
      • InputReconcileReport.Entry
      • InputSchemeDeviceNode
      • InputSchemeMetadata
      • JSONFileBindingStorage
      • ManagedRebindCancelledEvent
      • ManagedRebindCompletedEvent
      • ManagedRebindDataRefreshedEvent
      • ManagedRebindStartedEvent
      • PlayerPrefsBindingStorage
      • RebindMode
      • RebindSettings
      • ScyllaInput
      • ScyllaInput.Meta
      • ScyllaInputAction
      • ScyllaInputActionMap
      • ScyllaInputActionsMetadata
      • ScyllaInputActionsMetadataMigrator
      • ScyllaInputBinding
      • ScyllaInputConfiguration
      • ScyllaInputContextConfiguration
      • ScyllaKey
      • ScyllaKeyConverter
      • ScyllaModifier
      • UnityInputSystemBridge
    • Scylla.Input.Editor
      • DeviceStatusWidget
      • IconMappingDrawer
      • InputIconSetEditor
      • ScyllaInputActionsMetadataEditor
      • ScyllaInputConfigurationEditor
      • ScyllaInputContextConfigurationEditor
      • ScyllaInputDependencyProvider
      • ScyllaInputEditor
      • ScyllaInputGameProfile
      • ScyllaInputGameProfiles
      • ScyllaInputMenuItems
      • ScyllaInputWizard

    Class ConfigActionEntry

    Represents one action entry in the InputRebindManager data model, containing the action's metadata and one ConfigBindingEntry per configured scheme group.

    Inheritance
    object
    ConfigActionEntry
    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 ConfigActionEntry
    Remarks

    For actions with directional composites (e.g., 2DVector), a separate ConfigActionEntry is created for each composite part (Up, Down, Left, Right), with the DisplayName reflecting the part (e.g., "Move Up").

    For modifier composites (e.g., ButtonWithOneModifier), the entry represents the entire composite and the binding display text combines modifier and button (e.g., "Shift + A").

    Properties

    ActionID

    Gets the Unity Input System action name.

    Declaration
    public string ActionID { get; }
    Property Value
    Type Description
    string

    Bindings

    Gets the list of binding entries, one per configured ConfigSchemeGroup, in the same order as the scheme groups passed to Initialize(ConfigLayout).

    Declaration
    public IReadOnlyList<ConfigBindingEntry> Bindings { get; }
    Property Value
    Type Description
    IReadOnlyList<ConfigBindingEntry>

    CompositePartName

    Gets the composite part name for directional composite entries (e.g., "up", "down", "left", "right"), or null for non-composite entries.

    Declaration
    public string CompositePartName { get; }
    Property Value
    Type Description
    string

    DisplayName

    Gets the human-readable display name for this entry. For directional composite parts, this includes the part name (e.g., "Move Up").

    Declaration
    public string DisplayName { get; }
    Property Value
    Type Description
    string

    GroupID

    Gets the ID of the ConfigActionGroup this entry belongs to.

    Declaration
    public string GroupID { get; }
    Property Value
    Type Description
    string
    Remarks

    Group membership, not map membership, is what scopes conflict detection. Two rows in the same group always conflict when they share a control; two rows in different groups conflict unless those groups were declared mutually exclusive.

    Actions that matched no declared group land in UNGROUPED_ID, which shares no exclusive set.

    IsDirectionalComposite

    Gets a value indicating whether this entry represents a part of a directional composite (e.g., 2DVector Up/Down/Left/Right).

    Declaration
    public bool IsDirectionalComposite { get; }
    Property Value
    Type Description
    bool

    IsModifierComposite

    Gets a value indicating whether this action uses modifier composites (e.g., ButtonWithOneModifier, ButtonWithTwoModifiers).

    Declaration
    public bool IsModifierComposite { get; }
    Property Value
    Type Description
    bool

    MapID

    Gets the name of the parent action map containing this action.

    Declaration
    public string MapID { get; }
    Property Value
    Type Description
    string

    ModifierDepth

    Gets the modifier depth of the action, used for modifier disambiguation. Actions with different modifier depths sharing the same trigger key do not conflict.

    Declaration
    public int ModifierDepth { get; }
    Property Value
    Type Description
    int

    PrimaryBindingIndex

    Gets the flat Unity binding index for this entry. For simple actions this is the primary binding index. For composite parts this is the first matching binding index. Returns -1 if no binding exists.

    Declaration
    public int PrimaryBindingIndex { get; }
    Property Value
    Type Description
    int
    In this article
    Back to top Scylla Framework - Input Module API Documentation