Class engine.generator.interface.PlayerHotkeys

Handles player hotkey interface This provides methods to bind and manage hotkeys as well as using them
This interface is designed to work with the engine.HotkeysDisplay class to display current hotkeys to the player

Methods

engine.generator.interface.PlayerHotkeys:activateHotkey (id)

Uses an hotkeyed talent This requires the ActorTalents interface to use talents and a method player:playerUseItem(o, item, inven) to use inventory objects

engine.generator.interface.PlayerHotkeys:hotkeyTalent (tid)

Activates a hotkey with a type "talent"

engine.generator.interface.PlayerHotkeys:hotkeyInventory (name)

Activates a hotkey with a type "inventory"

engine.generator.interface.PlayerHotkeys:isHotkeyBound (kind, id)

Check if something is bound, and return the spot if it is

engine.generator.interface.PlayerHotkeys:prevHotkeyPage ()

Switch to previous hotkey page

engine.generator.interface.PlayerHotkeys:nextHotkeyPage ()

Switch to next hotkey page

engine.generator.interface.PlayerHotkeys:setHotkeyPage (v)

Switch to hotkey page



Methods

engine.generator.interface.PlayerHotkeys:activateHotkey (id)
Uses an hotkeyed talent This requires the ActorTalents interface to use talents and a method player:playerUseItem(o, item, inven) to use inventory objects

Parameters:

  • id
engine.generator.interface.PlayerHotkeys:hotkeyTalent (tid)
Activates a hotkey with a type "talent"

Parameters:

  • tid
engine.generator.interface.PlayerHotkeys:hotkeyInventory (name)
Activates a hotkey with a type "inventory"

Parameters:

  • name
engine.generator.interface.PlayerHotkeys:isHotkeyBound (kind, id)
Check if something is bound, and return the spot if it is

Parameters:

  • kind
  • id
engine.generator.interface.PlayerHotkeys:prevHotkeyPage ()
Switch to previous hotkey page
engine.generator.interface.PlayerHotkeys:nextHotkeyPage ()
Switch to next hotkey page
engine.generator.interface.PlayerHotkeys:setHotkeyPage (v)
Switch to hotkey page

Parameters:

  • v
generated by LDoc 1.4.3