OnHotKey

From Wiki
Jump to: navigation, search

Synopsis

onHotKey {key-specifier} {[alt] | [ctrl] | [shift]}

Description

The onHotKey command performs the following line of code (brackets do NOT work) when a certain key is pressed. The key-specifier can either be A-Z, 0-9, F1-F12 and ESC, BACK, TAB, ENTER, PAUSE, CAPSLOCK, SPACE, PGDN, PGUP, END, HOME, LEFT, RIGHT, UP, DOWN, PRNSCR, INSERT, DELETE, NUMLOCK or SCROLLLOCK.


Note: The code is only executed when the parser passes it, if you want a key-press to perform a certain action you have to make a loop. See the example.
Note: This function is NOT client or focus specific. Be careful what you type when running a script with onhotkey, chatting on one client, or in a different application may cause your character to do things in game you do not intend.

Example

set #lpc 1000
repeat
  onhotkey a
    gosub hotkey a
  onhotkey b
    gosub hotkey b
  onhotkey c
    gosub hotkey c
  onhotkey d
    gosub hotkey d
  onhotkey e
    gosub hotkey e
  sleep 1
until #false

sub hotkey
{
  event sysmessage %1
  Loop:
  sleep 1
  onhotkey %1
    goto Loop
  return
}

Example

set #lpc 1000
desactive:
  onhotkey t alt
    goto active
  onhotkey y alt
    halt
goto desactive

active:
    onhotkey r alt
      goto desactive
    goto active

See Also

Client

  • Client commands are used to send information to the Ultima Online client in order to perform an action or effect some change.
chooseSkill Reads the current skill value/lock status for a specific skill
click Clicks at a specific position in the UO client
cmpPix Compares a current pixel to a previously saved pixel
contPos Moves the active topmost gump to a new position
deleteJournal Forgets the contents of the journal buffer
findItem Finds items, monsters, players, NPCs based on object ID or object type
getShopInfo Retrieves information from the client about the currently shown top entry on a shopping gump
getUOTitle Gets the text on the title bar of the client
hideItem Removes an items graphic from the client
ignoreItem Removes items from the list searched by findItem
key Sends a key-stroke to the client
move Moves the character to a specified location
msg Sends a string to the client as keystrokes
nextCPos Denotes where the next opened container/gump will open
onHotKey Performs a line of code if a specific key is pressed
savePix Saves the color of a pixel in a specified location
setShopItem Sets the number of items to purchase given by ID
setUOTitle Sets the text on the title bar of the client
scanJournal Scans the users journal and stores the string for examination
sleep Waits a specified amount of time
target Waits for a target cursor to appear
terminate Terminates the current client
uoXL Start/manage clients
wait Waits a specified amount of time