Class: UI::KeyBinding

Inherits:

KeyShortcut

• Object
• LiteRGSS::Disposable
• LiteRGSS::Drawable
• LiteRGSS::Sprite
• LiteRGSS::ShaderedSprite
• Sprite
• KeyShortcut
• UI::KeyBinding

Defined in:

docs/4_Systems_000_General_4_UI_Generics.rb

Overview

Class that allow to show a binding of a specific key

Constant Summary

Constants inherited from KeyShortcut

UI::KeyShortcut::KeyIndex, UI::KeyShortcut::NUMPAD_KEY_INDEX

Instance Attribute Summary

• #index ⇒ Integer readonly

  The index of the key in the Keys array.

• #key ⇒ Symbol readonly

  The key the button describe.

Attributes inherited from LiteRGSS::ShaderedSprite

#blendmode, #shader

Attributes inherited from LiteRGSS::Sprite

#__index__, #angle, #bitmap, #height, #mirror, #opacity, #ox, #oy, #src_rect, #viewport, #visible, #width, #x, #y, #z, #zoom, #zoom_x, #zoom_y

Instance Method Summary

• #find_key(key)

  Find the key rect in the Sprite according to the input key requested.

• #initialize(viewport, key, index) ⇒ KeyBinding constructor

  Create a new KeyBinding sprite.

• #update

  Update the key.

Methods inherited from KeyShortcut

#show_key

Methods inherited from Sprite

#load, #mouse_in?, #set_origin_div, #set_rect, #set_rect_div, #set_z, #simple_mouse_in?, #translate_mouse_coords

Methods inherited from LiteRGSS::Sprite

new, #set_origin, #set_position

Methods inherited from LiteRGSS::Disposable

#dispose, #disposed?

Constructor Details

#initialize(viewport, key, index) ⇒ KeyBinding

Create a new KeyBinding sprite

Parameters:

• viewport (Viewport)
• key (Symbol) —

  Input.trigger? argument

• index (Integer) —

  Index of the key in the Keys constant

# File 'docs/4_Systems_000_General_4_UI_Generics.rb', line 812

def initialize(viewport, key, index)
end

Instance Attribute Details

#index ⇒ Integer (readonly)

Returns the index of the key in the Keys array.

Returns:

• (Integer) —

  the index of the key in the Keys array

# File 'docs/4_Systems_000_General_4_UI_Generics.rb', line 807

def index
  @index
end

#key ⇒ Symbol (readonly)

Returns the key the button describe.

Returns:

• (Symbol) —

  the key the button describe

# File 'docs/4_Systems_000_General_4_UI_Generics.rb', line 805

def key
  @key
end

Instance Method Details

#find_key(key)

Find the key rect in the Sprite according to the input key requested

Parameters:

• key (Symbol) —

  the Virtual Input Key.

# File 'docs/4_Systems_000_General_4_UI_Generics.rb', line 816

def find_key(key)
end

#update

Update the key

# File 'docs/4_Systems_000_General_4_UI_Generics.rb', line 819

def update
end