MapKey command: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Created page with "__TOC__ {| |width="50%"| '''Action:''' |width="50%"| <span class="f_Para">Lets you assign a keyboard shortcut without having...")
 
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 2: Line 2:


{|
{|
|width="50%"| '''Action:'''
|width="125px"| '''Action:'''
|width="50%"|
|width="775px"|
<span class="f_Para">Lets you [[reconfiguring_gui_buttons.html#use_mapbutton|assign a keyboard shortcut]] without having to edit a mapping file (</span><span class="f_Monospace">ui.xml</span><span class="f_Para"> or </span><span class="f_Monospace">uimore.xml</span><span class="f_Para">) and to restart the Client. </span>
<span class="f_Para">Lets you [[Reconfiguring GUI buttons and hot keys#Using a Client command|assign a keyboard shortcut]] without having to edit a mapping file (</span><span class="term">ui.xml</span><span class="f_Para"> or </span><span class="term">uimore.xml</span><span class="f_Para">) and to restart the Client. </span>


'''Syntax:'''
'''Syntax:'''
Line 10: Line 10:
<p class="syntax">mapKey [modifier-]key command </p>
<p class="syntax">mapKey [modifier-]key command </p>


<span class="f_Para">Where (case not important): </span>
Where (case not important):  


<span class="f_ListBul1" style="font-family: Arial,'Lucida Sans Unicode','Lucida Grande','Lucida Sans';display:inline-block;width:30px;margin-left:-30px">•</span><span class="f_EmphItal">modifier</span><span class="f_ListBul1"> is one of:  </span>
*''modifier'' is one of:  
 
**''alt'' maps the ALT-key version of a key combination (command runs when you hold down the Alt key and press the specified ''key'')
<span class="f_ListBul2" style="font-family: Arial,'Lucida Sans Unicode','Lucida Grande','Lucida Sans';display:inline-block;width:25px;margin-left:-25px">▪</span><span class="f_Monospace">alt</span><span class="f_ListBul2"> </span>
**''cntrl'',''control'', ''cntl'', ''ctl'', or ''ctrl'' maps the control key version of a key combination
 
<span class="f_ListContinue2">Maps the ALT-key version of a key combination (command runs when you hold down the Alt key and press the specified </span><span class="f_EmphItal">key</span><span class="f_ListContinue2">) </span>
 
<span class="f_ListBul2" style="font-family: Arial,'Lucida Sans Unicode','Lucida Grande','Lucida Sans';display:inline-block;width:25px;margin-left:-25px">▪</span><span class="f_Monospace">cntrl</span><span class="f_ListBul2">, </span><span class="f_Monospace">control</span><span class="f_ListBul2">, </span><span class="f_Monospace">cntl</span><span class="f_ListBul2">, </span><span class="f_Monospace">ctl</span><span class="f_ListBul2">, or </span><span class="f_Monospace">ctrl</span><span class="f_ListBul2"> </span>
 
<span class="f_ListContinue2">Maps the control key version of a key combination </span>


''modifier'' is optional, and its default is no modifier.  
''modifier'' is optional, and its default is no modifier.  


*''key'' is a keyboard key: a single letter or digit, or one of F2 through F12 (the function keys)  
*''key'' is a keyboard key: a single letter or digit, or one of F2 through F12 (the function keys)  
*''command'' is a [[Client command|Client command]]  
*''command'' is a [[Client Command Reference|Client command]]  


<span class="f_Para">Examples:  </span>
<span class="f_Para">Examples:  </span>
<p class="syntax"><span class="f_CodeExample">mapKey f2 Step </span><br />
<p class="syntax"><span class="f_CodeExample">mapKey f2 Step </span>
<span class="f_CodeExample">mapKey ALT-f2 stepover  </span><br />
<span class="f_CodeExample">mapKey ALT-f2 stepover  </span>
<span class="f_CodeExample">mapkey Ctl-f2 stepout  </span><br />
<span class="f_CodeExample">mapkey Ctl-f2 stepout  </span>
<span class="f_CodeExample">mapKey ALT-2 run </span>
<span class="f_CodeExample">mapKey ALT-2 run </span>
</p>
</p>

Latest revision as of 23:01, 3 February 2023

Action:

Lets you assign a keyboard shortcut without having to edit a mapping file (ui.xml or uimore.xml) and to restart the Client.

Syntax:

mapKey [modifier-]key command 

Where (case not important):

  • modifier is one of:  
    • alt maps the ALT-key version of a key combination (command runs when you hold down the Alt key and press the specified key)
    • cntrl,control, cntl, ctl, or ctrl maps the control key version of a key combination

modifier is optional, and its default is no modifier.

  • key is a keyboard key: a single letter or digit, or one of F2 through F12 (the function keys)
  • command is a Client command

Examples:  

mapKey f2 Step  mapKey ALT-f2 stepover   mapkey Ctl-f2 stepout   mapKey ALT-2 run 

After you execute the command, the new mapping is reflected immediately in the keyboard. The new mapping does not appear in the mapping file, and it does not remain if the Client is restarted.

The command to remove a keyboard shortcut mapping is clearKey. The command to map a Client button is mapButton.

Client menu: --
Introduced: Build 57
Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=MapKey_command&oldid=119524"