Author Topic: "{CMDACTION}" value "Plugin" is undocumented  (Read 2181 times)

Pfeil

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 4782
  • RTFM
"{CMDACTION}" value "Plugin" is undocumented
« on: December 05, 2018, 05:21:53 AM »
The documentation that comes with VoiceAttack v1.7.3 states:
Quote from: VoiceAttackhelp.pdf page 132
{CMDACTION} - The method by which the current command was executed. The possible results are, 'Spoken', 'Keyboard', 'Joystick', 'Mouse', 'Profile', 'External', 'Unrecognized', ‘ProfileUnloadChange’, ‘ProfileUnloadClose’, ‘DictationRecognized’ and 'Other'.

However, if a command is executed using an inline function(and presumably plugins as well, though I didn't test this) the token will return the value "Plugin" instead.


EDIT: Also applies to the documentation with v1.7.3.1

EDIT#2: Also applies to the documentation with v1.7.3.9; The "Plugin" value is also missing from the documentation for the "Command.Action()" inline function method.

EDIT#3: Fixed with v1.7.5.8
« Last Edit: May 09, 2019, 05:49:45 PM by Pfeil »

Gary

  • Administrator
  • Hero Member
  • *****
  • Posts: 2832
Re: "{CMDACTION}" value "Plugin" is undocumented
« Reply #1 on: April 02, 2019, 06:27:25 PM »
Ah!  I see it.  I've updated the documentation.  Thanks for keeping up with this, Pfeil.

Pfeil

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 4782
  • RTFM
Re: "{CMDACTION}" value "Plugin" is undocumented
« Reply #2 on: April 22, 2019, 10:35:48 PM »
The section for "{CMDACTION}" now lists "Plugin" as a possible value, and mentions when it would apply:
Quote from: VoiceAttackHelp.pdf page 135
{CMDACTION} - The method by which the current command was executed. The possible
results are, 'Spoken', 'Keyboard', 'Joystick', 'Mouse', 'Profile', 'External', 'Unrecognized',
‘ProfileUnloadChange’, ‘ProfileUnloadClose’, ‘DictationRecognized’, ‘Plugin’ and 'Other'.
Quote from: VoiceAttackHelp.pdf page 135
A value of,
‘Plugin’ is rendered if the command is executed from a plugin or inline function.

However, the section for the "Action()" method only mentions when it would apply, and does not list it as a possible value:
Quote from: VoiceAttackHelp.pdf page 180
Action() – returns a string to indicate the method by which the current command was
executed. The possible results are, 'Spoken', 'Keyboard', 'Joystick', 'Mouse', 'Profile',
'External', 'Unrecognized', ‘ProfileUnloadChange’, ‘ProfileUnloadClose’,
‘DictationRecognized’ and 'Other'.
Quote from: VoiceAttackHelp.pdf page 180
A value of, ‘Plugin’ is returned if the
command is executed from a plugin or inline function.

Gary

  • Administrator
  • Hero Member
  • *****
  • Posts: 2832
Re: "{CMDACTION}" value "Plugin" is undocumented
« Reply #3 on: April 22, 2019, 10:39:16 PM »
Got it!

Thanks, Pfeil!