Test/Library/PackageCache/com.unity.inputsystem@2436e68c60c4/Documentation~/TableOfContents.md

• Introduction
  • Install the Input System package
  • Concepts
  • Workflows
    • Using the Actions Workflow
    • Using the PlayerInput Workflow
    • Using the Direct Workflow
  • Video resources
  • Quick start guide
• Setting up input
  • Actions
  • Input action assets
    • About action assets
    • About project-wide actions
    • Create and assign a default project-wide actions asset
    • Create an empty action asset
    • Assign an existing action asset as project-wide
    • Default actions
    • Generate C# API from actions
  • Create action maps
  • Create, edit and delete actions
  • Configure actions
    • Action and control types
      • About action and control types
      • Configure action type
      • Action types reference
      • Configure control type
    • Bindings
      • Introduction to bindings
      • Binding types
      • Composite bindings
      • Add, duplicate or delete a binding
      • Select a control for binding
      • Edit composite bindings
      • Group bindings to control schemes
      • Binding resolution
      • Restrict binding to a specific device
      • Binding conflicts
      • Initial state checks
    • Controls
      • Introduction to controls
      • Control hierarchies
      • Control types reference
      • Control usages
      • Control paths
      • Control state
      • Record control state history
      • Control actuation
      • Noisy controls
      • Synthetic controls
      • Optimizing controls
    • Controls schemes
    • Interactions
      • Introduction to interactions
      • Apply interactions to bindings
      • Apply Interactions to actions
      • Predefined interactions
        • Default Interactions
        • Built-in Interactions
      • Write custom interactions
    • Processors
      • Introduction to processors
      • Built-in processors
      • Write custom processors
      • Add processors to bindings and actions
      • Add processors to controls
  • Input Actions Editor references
    • Input Actions Editor window reference
    • Action Properties panel reference
    • Binding Properties panel reference
    • Control Schemes and Devices menu reference
  • Configure input from code
    • Declare stand alone actions
    • Configure input from JSON
    • Create actions in code
    • Configure bindings from code
• Responding to input
  • About responding to input
  • Enabling actions
  • Polling actions
  • Set callbacks on actions
  • Read devices directly
  • Scripting with actions API overview
  • The Player Input component
    • About the Player Input Component
    • Get started with the Player Input component
    • Select a notification behavior
      • Configure Unity Events
    • Device Assignments
    • Debug Player Input Component
    • Use PlayerInput Component with UI
    • Local multiplayer scenarios
      • Set up PlayerInput Component for local multiplayer
  • The Player Input Manager Component
    • Get started with the Player Input Manager component
    • Configure the Player Input Manager
    • Set up split-screen local multiplayer
• User rebinding at runtime
  • Look up bindings
  • Display bindings
  • Rebind an action at runtime
  • Save and load rebinds
  • Restore original bindings
• Input settings
  • Create a settings asset
  • Update Mode
  • Background behavior
  • Compensate orientation
  • Default value properties
  • Supported devices
  • Platform-specific settings
• Devices
  • Types of input devices
  • Pointer devices
    • Pointer devices introduction
    • Touch devices
      • Touch devices introduction
      • Touch polling
      • Simulate touches
      • Bind touch input to an action
    • Mouse devices
      • Mouse devices introduction
      • Query and control mouse devices in code
    • Pen devices
      • Pen devices introduction
      • Query pen devices in code
  • Keyboards
    • Keyboard devices introduction
    • Query keyboard devices in code
    • Read text input
  • Joystick support
  • Gamepads
    • Gamepads introduction
    • PlayStation gamepads
    • Switch gamepads
    • Xbox gamepads
    • Query and control gamepads in code
    • Gamepad polling
    • Gamepad haptics
  • Sensors
    • Introduction to sensors
    • Query sensors in code
    • Supported sensors reference
  • Tracked Input Devices
  • Human Interface Device specification
    • Human Interface Device specification introduction
    • Create a custom device layout
    • Use an existing input device to create a layout
    • Use a custom class to create a layout
  • Supported devices reference
  • Devices (scripting)
    • Device descriptions
    • Device capabilities
    • Device matching
    • Device lifecycle
      • Create a device
      • Remove a device
      • Reset a device
      • Sync a device
      • Enable and disable devices
      • Device background and focus changes
      • Devices and domain reloads
    • Native devices
    • Device IDs
    • Device usages
    • Device commands
      • Send a command to a device
      • Add a custom device command
    • Device states
      • Monitor device state changes
      • Synthesize a device state change
    • Working with devices
      • Monitor devices
      • Manually add and remove devices
  • Custom devices
    • Input events
      • Types of events
      • Listen to events
      • Read state events
      • Create events
      • Record events
      • Event processing
      • Event merging
    • Create a custom device
      • Step 1 The state struct
      • Step 2 The Device class
      • Step 3 The Update method
      • Step 4 Device registration and creation
      • Step 5 current and all (optional)
      • Step 6 Device Commands (Optional)
• Input for user interfaces
  • Supported UI systems
    • Understand UI system compatibility
    • Using UI Input Module for UI support
      • Introduction to the UI Input Module
      • Supported input types in the UI Input Module
        • Pointer input UI support
        • Navigation input UI support
        • Tracked input UI support
      • Access the UI Input Module
      • UI Input Module component reference
    • Use IMGUI alongside the Input System package
  • Configure UI Input Actions
  • Default UI Action Map reference
  • Handling input target ambiguity
  • Use a Virtual Mouse for UI cursor control
    • Introduction to Virtual Mouse for UI cursor control
    • Configure a Virtual Mouse
    • Virtual Mouse component reference
  • Multiplayer UI input
    • Introduction to multiplayer UI input
    • Configure multiplayer UI input
  • Create on-screen controls
    • Introduction to on-screen controls
    • Create an on-screen button control
    • Create an on-screen stick control
    • Create a custom on-screen control
• Timing and latency
  • Input events queue
  • Select an input processing mode
  • Optimize for dynamic update
  • Optimize for fixed update
  • Avoid missed or duplicate events
  • Mixed timing scenarios
• Editor features
  • Read input in Editor Windows
  • Use mobile device input in the Editor (Unity Remote)
  • See and record input event flow
• Debugging
  • The input debugger window
  • Debug a device
  • Debug an action
  • Debug users and PlayerInput
  • Debug layouts
  • Trace actions
  • Visualizers
    • Visualise input controls
    • Visualise actions
  • Device Simulation
• Testing
  • Set up test assemblies
  • Set up test fixtures
  • Write tests
• Layouts
  • About layouts
  • Layout formats
    • Add a layout from C#
    • Add a layout from JSON
    • Add a layout using Layout Builder
  • Layout inheritance
  • Control items
  • Override layout definitions
  • Precompiled layouts
    • Create a precompiled layout
• User management
  • About user management
  • Create a user paired with an input device
  • Handle loss of a device
• Migrate from the old input system
  • Enable the correct input system
  • Corresponding old and new APIs
• How do I...?
• Architecture
• Contribute to the Input System source code
• Known limitations