Interface IInput

The entry point for getting input from the user (keyboard/mouse/touch).

Inherited Members

IInputEvents.MouseDown

IInputEvents.MouseUp

IInputEvents.MouseMove

IInputEvents.KeyDown

IInputEvents.KeyUp

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

public interface IInput : IInputEvents

Properties

IsTouchDrag

Is the user currently touching and dragging (for touch screens)?

Declaration

bool IsTouchDrag { get; }

Property Value

Type	Description
System.Boolean	true if is touch drag; otherwise, false.

LeftMouseButtonDown

Is the left mouse button currently pressed down?

Declaration

bool LeftMouseButtonDown { get; }

Property Value

Type	Description
System.Boolean	true if left mouse button down; otherwise, false.

MousePosition

Gets the mouse position in the room's co-ordinates (based on the game's virtual resolution), after adjusting for the viewport.

Declaration

MousePosition MousePosition { get; }

Property Value

Type	Description
MousePosition	The mouse position.

RightMouseButtonDown

Is the right mouse button currently pressed down?

Declaration

bool RightMouseButtonDown { get; }

Property Value

Type	Description
System.Boolean	true if right mouse button down; otherwise, false.

Methods

IsKeyDown(Key)

Is the specified key on the keyboard currently pressed down?

Declaration

bool IsKeyDown(Key key)

Parameters

Type	Name	Description
Key	key	Key.

Returns

Type	Description
System.Boolean	true, if key down was ised, false otherwise.