API Reference

Class TInputShortcutBinding

Description
Hierarchy
Fields
Methods
Properties

Unit

CastleInputs

Declaration

type TInputShortcutBinding = class(TComponent)

Description

Abstract input binding, like a given key / mouse button / game contoller press. The TInputShortcut can be triggered by one or more of these.

Hierarchy

  • TObject
  • TPersistent
  • TComponent
  • TInputShortcutBinding

Overview

Methods

Public function IsPressed(const Container: TCastleContainer; out HowMuch: Single): Boolean; virtual;
Public function IsEvent(const Event: TInputPressRelease): Boolean; virtual;
Public function ToString: String; override;

Description

Methods

Public function IsPressed(const Container: TCastleContainer; out HowMuch: Single): Boolean; virtual;

Is the input currently pressed. If returns True, HowMuch is set to a value between 0.0 and 1.0 that says "how much" the input is pressed (e.g. with what pressure is the game controller axis pressed). If returns False, HowMuch is always 0.0.

Public function IsEvent(const Event: TInputPressRelease): Boolean; virtual;

Does receiving TCastleUserInterface press with this Event means that this input has been just pressed.

Public function ToString: String; override;

Description of the binding.

Generated by PasDoc 0.16.0-snapshot.

Copyright Michalis Kamburelis and Castle Game Engine Contributors.

This webpage is also open-source and we welcome pull requests to improve it.

We use cookies for analytics. See our privacy policy.