Getting started

This guide will show you how to get started with this library.

Install

Install using the following dotnet command:

dotnet add package Apos.Input

Setup

Import the library with:

using Apos.Input;
using Track = Apos.Input.Track;

In your game’s LoadContent(), pass the game class to InputHelper.Setup():

protected override void LoadContent() {
    InputHelper.Setup(this);
}

In your game’s Update(GameTime gameTime), call the two functions:

protected override void Update(GameTime gametime) {
    //Call UpdateSetup at the start.
    InputHelper.UpdateSetup();

    //...

    //Call UpdateCleanup at the end.
    InputHelper.UpdateCleanup();
}

Input types

This library provides an API over various input types.

Type	Description
ICondition	Base interface for conditions. Provides `Pressed()`, `Held()`, `HeldOnly()`, `Released()`, `Consume()`.
KeyboardCondition	Polls keyboard button presses.
MouseCondition	Polls mouse button clicks.
GamePadCondition	Polls controller button clicks.
AnyCondition	Combines other conditions. This is equivalent to the `or` Boolean operator. Triggers when any condition is triggered.
AllCondition	Combines other conditions. This is equivalent to the `and` Boolean operator. Triggers when all conditions are triggered.
Track.KeyboardCondition	Same as KeyboardCondition, but also tracks the given key preventing it from triggering again on the same frame if it’s already been triggered once.
Track.MouseCondition	Same as MouseCondition, but also tracks the given mouse button preventing it from triggering again on the same frame if it’s already been triggered once.
Track.GamePadCondition	Same as GamePadCondition, but also tracks the given controller button preventing it from triggering again on the same frame if it’s already been triggered once.

Static usage

If you don’t want to instantiate anything, you can use KeyboardCondition, GamePadCondition, and MouseCondition statically.

if (KeyboardCondition.Pressed(Keys.Space) ||
    GamePadCondition.Pressed(GamePadButton.A, 0) ||
    MouseCondition.Pressed(MouseButton.LeftButton)) {

    // Do the jump.

}

Instanced usage

Let’s create a condition for a jump.

Create a keyboard condition:

ICondition jump = new KeyboardCondition(Keys.Space);

Create a gamepad condition for the first gamepad which is at index 0:

ICondition jump = new GamePadCondition(GamePadButton.A, 0);

Create a mouse condition:

ICondition jump = new MouseCondition(MouseButton.LeftButton);

Use AnyCondition to combine the three conditions together:

ICondition jump =
    new AnyCondition(
        new KeyboardCondition(Keys.Space),
        new GamePadCondition(GamePadButton.A, 0),
        new MouseCondition(MouseButton.LeftButton)
    );

To use jump, you can do:

if (jump.Pressed()) {

    // Do the jump.

}

Use AllCondition to require multiple keys at the same time.

ICondition run =
    new AllCondition(
        new KeyboardCondition(Keys.LeftShift),
        new KeyboardCondition(Keys.Right)
    );

if (run.Held()) {

    // Run while the buttons are held.

}

If you also want to walk, you can do:

ICondition walk = new KeyboardCondition(Keys.Right);

if (walk.Held()) {

    // Walk while the right button is held.

}

If you combine both, it gives:

if (run.Held()) {

    // Run while the buttons are held.

}
if (walk.Held()) {

    // Walk while the right button is held.

}

An issue arises where walk will trigger during the run since both need the Right button. To fix that, you can opt into the tracking system for the Right button. The tracking system will make walk never trigger during run.

ICondition run =
    new AllCondition(
        new KeyboardCondition(Keys.LeftShift),
        new Track.KeyboardCondition(Keys.Right)
    );
ICondition walk = new Track.KeyboardCondition(Keys.Right);

Check the Design choices to understand the thinking process behind this library.
Check the API for more info on each condition types.

_{Edit this page on GitHub}