Unit CastleInputs

Description

Key and mouse shortcuts (TInputShortcut) and global management of them.

See https://castle-engine.io/manual_key_mouse.php for overview.

TInputShortcut instance represents a key/mouse shortcut. Instances of this class are spread throughout the engine. We have two different ways of using TInputShortcut instance:

You create new inputs by simply constructing new TInputShortcut instances. Make sure you add all global inputs before calling Config.Load, as some functionality assumes that all shortcuts are already added at the time Config.Load is called. The engine units themselves never call Config.Load, it is left to the final application.

Uses

Overview

Classes, Interfaces, Objects and Records

Name Description
Class TInputShortcut A keyboard and/or mouse shortcut for activating some action.
Class TInputShortcutList Group of TInputShortcut, to easily manage (search, load, save...) the inputs.

Functions and Procedures

function InputsAll: TInputShortcutList;
function InputsGroup(const Group: TInputGroupNotLocal): TInputShortcutList;

Types

TInputGroup = (...);
TInputGroupNotLocal = igBasic..High(TInputGroup);

Description

Functions and Procedures

function InputsAll: TInputShortcutList;

List of all global inputs. All TInputShortcut instances with group other than igLocal will be automatically added here.

function InputsGroup(const Group: TInputGroupNotLocal): TInputShortcutList;
 

Types

TInputGroup = (...);

Type of input, for TInputShortcut.Group.

Values
  • igLocal
  • igBasic
  • igItems
  • igOther
TInputGroupNotLocal = igBasic..High(TInputGroup);
 

Generated by PasDoc 0.16.0.