LocalPlayerInput

namespace Griff.Runtime;

public sealed class LocalPlayerInput : IInput

One player’s share of this machine’s controls (see LocalPlayers): the keys of their side of the keyboard (or all of it, with the mouse), and their own controller. The actions are the game’s, read on those keys and that controller only: on the left keys Punch is F and Kick G, on the right K and L, and the rest are the action’s own keys on that side of the keyboard.

Properties

Actions

public IReadOnlyCollection<string> Actions { get; }

AnyPressed

public InputBinding? AnyPressed { get; }

Cursor

public MouseCursor Cursor { get; set; }

Horizontal

public float Horizontal { get; }

IsGamepadConnected

public bool IsGamepadConnected { get; }

IsMouseInView

public bool IsMouseInView { get; }

IsMouseLocked

public bool IsMouseLocked { get; }

Keys

public KeySet Keys { get; }

Which keys it has.

LeftKeys

public static IReadOnlyDictionary<string, Key[]> LeftKeys { get; }

The keys the actions have on the left side of the keyboard, where they aren’t simply their own keys on that side: WASD moves, F and G are the first buttons (Punch and Kick, Fire and Attack).

LeftStick

public Vector2 LeftStick { get; }

LeftTrigger

public float LeftTrigger { get; }

MouseDelta

public Vector2 MouseDelta { get; }

MouseOnScreen

public Vector2? MouseOnScreen { get; }

MouseWorld

public Vector2 MouseWorld { get; }

Move

public Vector2 Move { get; }

Pad

public int Pad { get; }

The platform’s number of its controller, or -1 for none.

RightKeys

public static IReadOnlyDictionary<string, Key[]> RightKeys { get; }

The keys the actions have on the right side of the keyboard: the arrows move, K and L (or the number pad’s 1 and 2) are the first buttons.

RightStick

public Vector2 RightStick { get; }

RightTrigger

public float RightTrigger { get; }

Scroll

public float Scroll { get; }

TypedText

public string TypedText { get; }

UsingGamepad

public bool UsingGamepad { get; }

Vertical

public float Vertical { get; }

WantsMouseLock

public bool WantsMouseLock { get; set; }

Methods

AimFrom

public Vector2 AimFrom(Vector2 origin)

AimFrom

public Vector2 AimFrom(Vector3 origin)

Bind

public void Bind(string action, params InputBinding[] bindings)

BindingsOf

public IReadOnlyList<InputBinding> BindingsOf(string action)

The keys and buttons that are action for this player: their side’s keys, and the controller’s buttons.

IsDown

public bool IsDown(string action)

IsDown

public bool IsDown(Key key)

IsDown

public bool IsDown(MouseButton button)

IsDown

public bool IsDown(GamepadButton button)

KeysOf

public IReadOnlyList<Key> KeysOf(string action, KeySet side)

The keys action has on side of the keyboard (all of them for All).

OnLeft

public static bool OnLeft(Key key)

True if key is on the left side of the keyboard (as the left keys’ player has it).

Rebind

public void Rebind(string action, params InputBinding[] bindings)

ResetBindings

public void ResetBindings(string? action = null)

Rumble

public void Rumble(float strength = 0.5f, float seconds = 0.2f)

TypeInto

public string TypeInto(string text, int maxLength = 2147483647)

WasPressed

public bool WasPressed(string action)

WasPressed

public bool WasPressed(Key key)

WasPressed

public bool WasPressed(MouseButton button)

WasPressed

public bool WasPressed(GamepadButton button)

WasPressed

public bool WasPressed(string action, float buffer)

WasReleased

public bool WasReleased(string action)

WasReleased

public bool WasReleased(Key key)

WasReleased

public bool WasReleased(MouseButton button)

WasReleased

public bool WasReleased(GamepadButton button)