> For the complete documentation index, see [llms.txt](https://docs.sparkframework.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sparkframework.dev/documentation/developer-guide/core-systems/inputs/api.md).

# API

**Assembly:** `Spark.Inputs` **Interface:** `IInputPlugin` **Implementation:** `InputPlugin`

## Interface

```csharp
public interface IInputPlugin
{
    InputEntry GetInputEntry(string id);
    InputEntry[] GetAllInputEntries();
    bool HasInputEntry(string id);
}
```

## Methods

### GetInputEntry

```csharp
InputEntry GetInputEntry(string id)
```

Returns the input entry with the given ID, or `null` if not found.

### GetAllInputEntries

```csharp
InputEntry[] GetAllInputEntries()
```

Returns all input entries in the database.

### HasInputEntry

```csharp
bool HasInputEntry(string id)
```

Returns `true` if an input entry with the given ID exists.

## InputEntry

Extends `SparkDatabaseEntry`. Wraps a Unity Input System action reference.

| Field         | Type                 | Description                         |
| ------------- | -------------------- | ----------------------------------- |
| `inputAction` | InputActionReference | Reference to an Input System action |

**Methods:**

```csharp
InputAction GetInputAction()   // Returns the resolved InputAction
bool IsValid()                 // True if inputAction is assigned and resolves
```

The entry auto-populates its `entryName` and `displayName` from the referenced action's name.

## Initialization

On startup, the Inputs plugin automatically enables all `InputActionAsset` objects referenced by registered `InputEntry` entries. This ensures input actions are active without manual setup.

## Usage

```csharp
var inputPlugin = Spark.GetPlugin<IInputPlugin>();
if (inputPlugin != null)
{
    InputEntry jumpEntry = inputPlugin.GetInputEntry("input_jump");
    if (jumpEntry != null && jumpEntry.IsValid())
    {
        InputAction jumpAction = jumpEntry.GetInputAction();
        jumpAction.performed += ctx => Debug.Log("Jump!");
    }
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.sparkframework.dev/documentation/developer-guide/core-systems/inputs/api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.