WoW:API SetConsoleKey - Revision history

Move page script: Move page script moved page API SetConsoleKey to WoW:API SetConsoleKey without leaving a redirect

2023-08-15T04:47:17Z

Move page script moved page API SetConsoleKey to API SetConsoleKey without leaving a redirect

← Older revision

Revision as of 04:47, 15 August 2023

WoWWiki>Saiket: Cleaned up and added explanation of "-console" startup argument.

2008-05-17T00:03:23Z

Cleaned up and added explanation of "-console" startup argument.

← Older revision		Revision as of 00:03, 17 May 2008
Line 1:		Line 1:
	{{wowapi}}		{{wowapi}} __NOTOC__
	~~{{stub/API}}~~

	~~Calling this function with no parameters appears~~ to ~~unbind~~ the console key ~~(normally~~ the "`" key~~) for the duration of the WoW session~~.		Sets the key used to open the console overlay for the current session. Upon restarting the game, the console key will return to the default "`" (tilde) key.

	~~Calling this function with a parameter indicating the a new keybinding to set the Console Key to will rebind~~ the console ~~keybinding for the duration of the~~ WoW ~~session; however, unlike~~ the ~~analogous argument for [[API SetBinding\|SetBinding()]]~~, ~~it appears~~ that ~~you can ''only'' provide~~ the ~~values of keys that represent standard ASCII characters--no modifiers or other special keys are allowed. For instance, <tt>SetConsoleKey("CTRL-F")</tt> won~~'t ~~work, but <tt>SetConsoleKey("F")</tt> will~~.		''Note that the console is only accessible when WoW is started with the "-console" parameter, and that this function does nothing if the parameter wasn't used.''

	~~However, it should be noted that the console~~ key ~~is a very special keybinding in WoW; whenever the bound key is pressed, ''regardless'' of context or mode, the console window will appear~~ (~~or disappear, if it's already visible). This means that setting the console~~ key to "~~F" will ''prevent you from ever generating the 'F' character again'', even if it's in a chat window or within the console itself.~~		SetConsoleKey("key")
			== Parameters ==
			=== Arguments ===
			:("key")

	~~Using [[API SaveBindings\|SaveBindings()]] does not appear~~ to ~~permanently save this particular~~ binding ~~to disk~~.		:;key : String - The character to bind to opening the console overlay. When set to ''nil'', the console binding gets removed.

	'''NB''' as of [[~~Patch_0.11_~~(~~Release_Notes~~)~~\|Patch 0.11~~]]~~, the console is no more accessible~~.
			== Details ==
			Unlike the analogous [[API SetBinding\|SetBinding()]] function, you can ''only'' provide the values of keys that represent standard ASCII characters--no modifiers are allowed. For instance, <tt>SetConsoleKey("CTRL-F")</tt> won't work, but <tt>SetConsoleKey("F")</tt> will. In addition, non-alphabetic keys that require modifiers to access, such as <tt>"!"</tt> using <Shift+1>, cannot be used.

			It should be noted that the console key is a very special keybinding in WoW; whenever the bound key is pressed, ''regardless'' of context or mode, the console window will appear (or disappear, if it's already visible). This means that setting the console key to <tt>"F"</tt> will ''prevent you from ever generating the <tt>"F"</tt> character again'', even if it's in a chat window or within the console itself.

			Using [[API SaveBindings\|SaveBindings()]] does not permanently save this particular binding to disk.

WoWWiki>Kirkburn at 00:29, 4 December 2007

2007-12-04T00:29:41Z

← Older revision		Revision as of 00:29, 4 December 2007
Line 1:		Line 1:
	{{wowapi}}		{{wowapi}}
	{{stub/~~api~~}}		{{stub/API}}

	Calling this function with no parameters appears to unbind the console key (normally the "`" key) for the duration of the WoW session.		Calling this function with no parameters appears to unbind the console key (normally the "`" key) for the duration of the WoW session.

WoWWiki>Hobinbot: upgraded deprecated template

2007-01-06T17:33:23Z

upgraded deprecated template

← Older revision		Revision as of 17:33, 6 January 2007
Line 1:		Line 1:
			{{wowapi}}
	{{stub/api}}		{{stub/api}}

Line 10:		Line 11:

	'''NB''' as of [[Patch_0.11_(Release_Notes)\|Patch 0.11]], the console is no more accessible.		'''NB''' as of [[Patch_0.11_(Release_Notes)\|Patch 0.11]], the console is no more accessible.
	~~----~~
	~~{{WoW API}}~~

WoWWiki>Hashar at 15:59, 3 October 2006

2006-10-03T15:59:35Z

← Older revision		Revision as of 15:59, 3 October 2006
Line 9:		Line 9:
	Using [[API SaveBindings\|SaveBindings()]] does not appear to permanently save this particular binding to disk.		Using [[API SaveBindings\|SaveBindings()]] does not appear to permanently save this particular binding to disk.

			'''NB''' as of [[Patch_0.11_(Release_Notes)\|Patch 0.11]], the console is no more accessible.
	----		----
	{{WoW API}}		{{WoW API}}

WoWWiki>Mikk at 23:05, 23 May 2006

2006-05-23T23:05:51Z

← Older revision		Revision as of 23:05, 23 May 2006
Line 1:		Line 1:
			{{stub/api}}

	Calling this function with no parameters appears to unbind the console key (normally the "`" key) for the duration of the WoW session.		Calling this function with no parameters appears to unbind the console key (normally the "`" key) for the duration of the WoW session.

Line 6:		Line 8:

	Using [[API SaveBindings\|SaveBindings()]] does not appear to permanently save this particular binding to disk.		Using [[API SaveBindings\|SaveBindings()]] does not appear to permanently save this particular binding to disk.

			----
			{{WoW API}}

WoWWiki>Foopy: Origination

2006-05-19T11:45:39Z

Origination

New page

Calling this function with no parameters appears to unbind the console key (normally the "`" key) for the duration of the WoW session.

Calling this function with a parameter indicating the a new keybinding to set the Console Key to will rebind the console keybinding for the duration of the WoW session; however, unlike the analogous argument for [[API SetBinding|SetBinding()]], it appears that you can ''only'' provide the values of keys that represent standard ASCII characters--no modifiers or other special keys are allowed. For instance, <tt>SetConsoleKey("CTRL-F")</tt> won't work, but <tt>SetConsoleKey("F")</tt> will.

However, it should be noted that the console key is a very special keybinding in WoW; whenever the bound key is pressed, ''regardless'' of context or mode, the console window will appear (or disappear, if it's already visible). This means that setting the console key to "F" will ''prevent you from ever generating the 'F' character again'', even if it's in a chat window or within the console itself.

Using [[API SaveBindings|SaveBindings()]] does not appear to permanently save this particular binding to disk.