Module: AMS::Keyboard

Defined in:
Documentation/ams/keyboard.rb

Overview

Note:

All methods below were made compatible with Mac OS X since 3.4.0 unless otherwise stated.

This namespace contains keyboard key state retrieval functions.

Since:

  • 2.0.0

Class Method Summary collapse

Class Method Details

.control_down?Boolean Also known as: ctrl_down?

Determine whether CTRL key is down.

Returns:

  • (Boolean)

Since:

  • 2.0.0

.control_up?Boolean Also known as: ctrl_up?

Determine whether CTRL key is up.

Returns:

  • (Boolean)

Since:

  • 2.0.0

.get_key_code(vk_name) ⇒ Fixnum?

Get virtual key code associated with the virtual key name.

Parameters:

  • vk_name (String, Symbol)

    Virtual key name.

Returns:

  • (Fixnum, nil)

    Virtual key constant code if successful.

See Also:

Since:

  • 3.0.0

.get_key_name(vk_code) ⇒ String?

Get virtual key name associated with the virtual key code.

Parameters:

  • vk_code (Fixnum)

    Virtual key code.

Returns:

  • (String, nil)

    Virtual key name or nil if vk_code is invalid.

See Also:

Since:

  • 3.5.0

.get_key_state(vk) ⇒ Fixnum Also known as: key

Get virtual key state.

Parameters:

  • vk (String, Symbol, Fixnum)

    Virtual key name or key code.

Returns:

  • (Fixnum)

    1 if down or 0 if up.

See Also:

Since:

  • 2.0.0

.get_keyboard_stateArray<Fixnum>

Note:

Windows only!

Get an array of all virtual key states.

Returns:

  • (Array<Fixnum>)

    An array of 256 values of 1 (down) or 0 (up).

See Also:

Since:

  • 2.0.0

.gey_virtual_key_codesHash<String, Fixnum>

Get general virtual key names and their associated key codes.

Returns:

  • (Hash<String, Fixnum>)

Since:

  • 3.0.0

.gey_virtual_key_codes2Hash<String, Fixnum>

Get extended virtual key names and their associated key codes.

Returns:

  • (Hash<String, Fixnum>)

Since:

  • 3.0.0

.gey_virtual_key_namesHash<Fixnum, String>

Get virtual key codes and their associated key names.

Returns:

  • (Hash<Fixnum, String>)

Since:

  • 3.0.0

.key_down?(vk) ⇒ Boolean

Determine whether virtual key is down.

Parameters:

  • vk (String, Symbol, Fixnum)

    Virtual key name or key code.

Returns:

  • (Boolean)

See Also:

Since:

  • 2.0.0

.key_toggled?(vk) ⇒ Boolean

Note:

Windows only!

Determine whether virtual key is toggled.

Parameters:

  • vk (String, Symbol, Fixnum)

    Virtual key name or key code.

Returns:

  • (Boolean)

See Also:

Since:

  • 2.0.0

.key_up?(vk) ⇒ Boolean

Determine whether virtual key is up.

Parameters:

  • vk (String, Symbol, Fixnum)

    Virtual key name or key code.

Returns:

  • (Boolean)

See Also:

Since:

  • 2.0.0

.keys_down?(*vks) ⇒ Boolean

Determine whether an array of virtual keys are down.

Parameters:

  • vks (Array<String, Symbol, Fixnum>)

    Virtual key names or key codes.

Returns:

  • (Boolean)

See Also:

Since:

  • 2.0.0

.keys_up?(*vks) ⇒ Boolean

Determine whether an array of virtual keys are up.

Parameters:

  • vks (Array<String, Symbol, Fixnum>)

    Virtual key names or key codes.

Returns:

  • (Boolean)

See Also:

Since:

  • 2.0.0

.lbutton_down?Boolean

Note:

Windows only!

Determine whether left mouse button is down.

Returns:

  • (Boolean)

Since:

  • 2.0.0

.lbutton_up?Boolean

Note:

Windows only!

Determine whether left mouse button is up.

Returns:

  • (Boolean)

Since:

  • 2.0.0

.lcontrol_down?Boolean Also known as: lctrl_down?

Determine whether left CTRL key is down.

Returns:

  • (Boolean)

Since:

  • 2.0.0

.lcontrol_up?Boolean Also known as: lctrl_up?

Determine whether left CTRL key is up.

Returns:

  • (Boolean)

Since:

  • 2.0.0

Determine whether left ALT key is down.

Returns:

  • (Boolean)

Since:

  • 2.0.0

Determine whether left ALT key is up.

Returns:

  • (Boolean)

Since:

  • 2.0.0

.lshift_down?Boolean

Determine whether left SHIFT key is down.

Returns:

  • (Boolean)

Since:

  • 2.0.0

.lshift_up?Boolean

Determine whether left SHIFT key is up.

Returns:

  • (Boolean)

Since:

  • 2.0.0

.mbutton_down?Boolean

Note:

Windows only!

Determine whether middle mouse button is down.

Returns:

  • (Boolean)

Since:

  • 2.0.0

.mbutton_up?Boolean

Note:

Windows only!

Determine whether middle mouse button is up.

Returns:

  • (Boolean)

Since:

  • 2.0.0

Determine whether ALT key is down.

Returns:

  • (Boolean)

Since:

  • 2.0.0

Determine whether ALT key is up.

Returns:

  • (Boolean)

Since:

  • 2.0.0

.rbutton_down?Boolean

Note:

Windows only!

Determine whether right mouse button is down.

Returns:

  • (Boolean)

Since:

  • 2.0.0

.rbutton_up?Boolean

Note:

Windows only!

Determine whether right mouse button is up.

Returns:

  • (Boolean)

Since:

  • 2.0.0

.rcontrol_down?Boolean Also known as: rctrl_down?

Determine whether right CTRL key is down.

Returns:

  • (Boolean)

Since:

  • 2.0.0

.rcontrol_up?Boolean Also known as: rctrl_up?

Determine whether right CTRL key is up.

Returns:

  • (Boolean)

Since:

  • 2.0.0

.rmenu_down?Boolean Also known as: ralt_down?

Determine whether right ALT key is down.

Returns:

  • (Boolean)

Since:

  • 2.0.0

.rmenu_up?Boolean Also known as: ralt_up?

Determine whether right ALT key is up.

Returns:

  • (Boolean)

Since:

  • 2.0.0

.rshift_down?Boolean

Determine whether right SHIFT key is down.

Returns:

  • (Boolean)

Since:

  • 2.0.0

.rshift_up?Boolean

Determine whether right SHIFT key is up.

Returns:

  • (Boolean)

Since:

  • 2.0.0

.shift_down?Boolean

Determine whether SHIFT key is down.

Returns:

  • (Boolean)

Since:

  • 2.0.0

.shift_up?Boolean

Determine whether SHIFT key is up.

Returns:

  • (Boolean)

Since:

  • 2.0.0

.xbutton1_down?Boolean

Note:

Windows only!

Determine whether X1 mouse button is down.

Returns:

  • (Boolean)

Since:

  • 2.0.0

.xbutton1_up?Boolean

Note:

Windows only!

Determine whether X1 mouse button is up.

Returns:

  • (Boolean)

Since:

  • 2.0.0

.xbutton2_down?Boolean

Note:

Windows only!

Determine whether X2 mouse button is down.

Returns:

  • (Boolean)

Since:

  • 2.0.0

.xbutton2_up?Boolean

Note:

Windows only!

Determine whether X2 mouse button is up.

Returns:

  • (Boolean)

Since:

  • 2.0.0