# Input Action

{% hint style="success" %}

#### Like what your seeing?

Support us as a [GitHub Sponsor](https://kb.heathen.group/old-kb/where-to-buy/become-a-sponsor) and get instant access to all our assets, exclusive tools and assets, escalated support and issue tracking and our gratitude.\
\
These articles are made possible by our [GitHub Sponsors](https://kb.heathen.group/old-kb/where-to-buy/become-a-sponsor) ... become a sponsor today!
{% endhint %}

## Introduction

```csharp
public class InputAction : GameEvent<InputActionData>
```

Represents a Steam Input Action such as defined in your games IGA file.

These must be created as part of your [Steam Settings](https://kb.heathen.group/old-kb/old-toolkit-for-steamworks/unity/objects/classes/steam-settings) object .

## Fields and Attributes

<table><thead><tr><th width="181.56643368118847">Type</th><th width="173.82668241105068">Name</th><th width="375.82373346952215">Comment</th></tr></thead><tbody><tr><td>InputActionType</td><td>type</td><td>The type of action (Analog or Digital)</td></tr><tr><td>string</td><td>actionName</td><td>The name of the action as it appears in the IGA file</td></tr><tr><td>InputAnalogActionHandle_t</td><td>AnalogHandle</td><td>The native Steam API handle if this is a analog handle and has been resolved.</td></tr><tr><td>InputDigitalActionHandle_t</td><td>DigitalHandle</td><td>The native Steam API handle if this is a digital handle and has been resolved.</td></tr></tbody></table>

## Methods

### Get Data

```csharp
public InputActionData this[InputHandle_t controller];
```

This returns the current cashed state for this action and for this controller, this does not update the state with the latest data from Steam it simply returns the last updated state. Typically you would have a behaviour poll all relivent actions at the start of an update and let various behaviours simply read the last known state for the actions they are interested in.

#### Example:

```csharp
public class PlayerController : MonoBehaviour
{
    Steamworks.InputHandle_t controller;
    public InputAction someAction;
    
    // ...
    
    private void Start()
    {
        controller = HeathenEngineering.SteamworksIntegration.API.Input.Client.ConnectedControllers[0];
    }
    
    //...
    
    private void Update()
    {
        SteamSettings.Client.UpdateAllActions(controller);
        
        var actionData = someAction[controller];
        if(actionData.active)
            Debug.Log("Engaged: " + actionData.state);
    }
}
```

Once you have a script updating the status of your actions other behaviours can simply read that most recent state;

```csharp
public class SomeOtherBehaviour : MonoBehaviour
{
    Steamworks.InputHandle_t controller;
    public InputAction otherAction;
    
    // ...
    
    private void Start()
    {
        controller = HeathenEngineering.SteamworksIntegration.API.Input.Client.ConnectedControllers[0];
    }
    
    // ...
    
    private void Update()
    {
        var actionData = otherAction[controller];
        if(actionData.active)
            Debug.Log("Engaged: " + actionData.state);
    }
}
```

### Update Status

```csharp
public void UpdateStatus(InputHandle_t controller);
```

Call this to update the state of the action for the indicated controller.

#### Example:

```csharp
var controller = Input.Client.ConnectedControllers[0];
// ...
testAction.UpdateStatus(controller);
```

You can optionally call this for all actions at once via the Steam Settings object

```csharp
var controller = Input.Client.ConnectedControllers[0];
// ...
SteamSettings.Client.UpdateAllActions(controller);
```

### Get Input Glyphs

```csharp
public Texture2D[] GetInputGlyphs(InputHandle_t controller, InputActionSet set);
```

```csharp
public Texture2D[] GetInputGlyphs(InputHandle_t controller, InputActionSetLayer set);
```

```csharp
public Texture2D[] GetInputGlyphs(InputHandle_t controller, InputactionSetHandle_t set);
```

This returns the set of textures related to the action for the given controller and action set. For example if this action exists on the indicated set and is mapped to the B button and Right Trigger then the B button texture and RT texture will be returned.&#x20;

The images for these can be configured in your app.

#### Examples:

```csharp
var images = action.GetInputGlyphs(controller, actionSet);
// ...
rawImage.Texture = images[0];
```

### Get Input Names

```csharp
public string[] GetInputNames(InputHandle_t controller, InputActionSet set);
```

```csharp
public string[] GetInputNames(InputHandle_t controller, InputActionSetLayer set);
```

```csharp
public string[] GetInputNames(InputHandle_t controller, InputactionSetHandle_t set);
```

This returns the set of names related to the action for the given controller and action set. For example if this action exists on the indicated set and is mapped to B and Right Trigger then the string "B Button" and "Right Trigger" will be returned.

#### Examples:

```csharp
var names = action.GetInputNames(controller, actionSet);
// ...
label.Text = names[0];
```

## How To

### Create

Input Actions are created as part of your [Steam Settings](https://kb.heathen.group/old-kb/old-toolkit-for-steamworks/unity/objects/classes/steam-settings) object

![](https://4053370152-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MZWu8yFOWhCYCMkJFmR%2Fuploads%2FO8HbbBkNOqDYKB2X0Sz4%2Fimage.png?alt=media\&token=9b5e4da1-6a70-427d-b992-6438fc4245e5)

### Set Analog or Digital

Click the AI or DI buttton to change the type

AI represents "Analog Input"

DI represents "Digital Input"

![](https://4053370152-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MZWu8yFOWhCYCMkJFmR%2Fuploads%2FPKN7Hw4jyaAZzjkieQQX%2Fimage.png?alt=media\&token=f8ccf72d-10bd-4b44-82a3-d1304d113121)