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 InputBindingNode

    A single binding inside an action map, viewed through the underlying InputJSONNode.

    Inheritance
    object
    InputBindingNode
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Scylla.Input
    Assembly: ScyllaInput.dll
    Syntax
    public sealed class InputBindingNode
    Remarks

    The wrapper reads and writes the backing node rather than holding a copy, so members nobody models are carried along untouched and a binding that is never edited is re-emitted exactly as it was parsed.

    Bindings live on the map, not on the action, and reference their owning action by Action name rather than by GUID. Renaming an action therefore means rewriting every binding that names it.

    Constructors

    InputBindingNode(InputJSONNode)

    Wraps an existing binding node.

    Declaration
    public InputBindingNode(InputJSONNode node)
    Parameters
    Type Name Description
    InputJSONNode node

    The backing node.

    Exceptions
    Type Condition
    ArgumentNullException

    Thrown when the node is null.

    Properties

    Action

    Gets or sets the owning action name.

    Declaration
    public string Action { get; set; }
    Property Value
    Type Description
    string

    Groups

    Gets or sets the semicolon-separated binding group list.

    Declaration
    public string Groups { get; set; }
    Property Value
    Type Description
    string

    ID

    Gets or sets the stable GUID.

    Declaration
    public string ID { get; set; }
    Property Value
    Type Description
    string

    Interactions

    Gets or sets the semicolon-separated interaction list.

    Declaration
    public string Interactions { get; set; }
    Property Value
    Type Description
    string

    IsComposite

    Gets or sets whether this binding is a composite head.

    Declaration
    public bool IsComposite { get; set; }
    Property Value
    Type Description
    bool

    IsPartOfComposite

    Gets or sets whether this binding is a part of the preceding composite head.

    Declaration
    public bool IsPartOfComposite { get; set; }
    Property Value
    Type Description
    bool

    Name

    Gets or sets the binding name. Composite parts use this for the part name.

    Declaration
    public string Name { get; set; }
    Property Value
    Type Description
    string

    Node

    Gets the backing node, for access to members this wrapper does not model.

    Declaration
    public InputJSONNode Node { get; }
    Property Value
    Type Description
    InputJSONNode

    Path

    Gets or sets the control path, or the composite type name for a composite head.

    Declaration
    public string Path { get; set; }
    Property Value
    Type Description
    string

    Processors

    Gets or sets the semicolon-separated processor list.

    Declaration
    public string Processors { get; set; }
    Property Value
    Type Description
    string

    Methods

    Create(string, string, string, string)

    Builds a new binding node with every member present, in the order Unity emits them.

    Declaration
    public static InputBindingNode Create(string name, string id, string path, string action)
    Parameters
    Type Name Description
    string name

    Binding or composite part name.

    string id

    Stable GUID.

    string path

    Control path or composite type name.

    string action

    Owning action name.

    Returns
    Type Description
    InputBindingNode

    The wrapper around the new node.

    In this article
    Back to top Scylla Framework - Input Module API Documentation