Author Topic: "Not Set" capitalization inconsistencies  (Read 2046 times)

Pfeil

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 4782
  • RTFM
"Not Set" capitalization inconsistencies
« on: April 08, 2020, 07:45:15 PM »
Both the documentation in VoiceAttackHelp.pdf, and the actual values in VoiceAttack, are inconsistent when it comes to the capitalization of "Not Set":

The documentation uses a combination of "NOT SET", E.G.
Quote from: VoiceAttackHelp.pdf v1.8.5+ page 80, "Small Integer (Condition) Value Comparison"
Note: If a variable that is being compared is NOT SET, the comparison will always result as false.
(also note the lack of quotes wrapping "NOT SET" in the above example)
"Not Set", E.G.
Quote from: VoiceAttackHelp.pdf v1.8.5+ page 66, "'Set a Small Integer (Condition) Value'"
If you try to set your
small integer variable to a value outside of this range, your small integer variable’s
value will be set to, ‘Not Set’.
and "Not set", which only occurs in one instance:
Quote from: VoiceAttackHelp.pdf v1.8.5+ page 153, "{TXTCONCAT:variableName1 / value:variableName2 / value}"
If variable 1 or variable 2 are “Not set”, the result will be, “Not set”.

I had started listing every individual instance of each variation, but that turned out to be too visually cluttered to be all that useful, and I trust your PDF viewer/editor has a case-sensitive search feature as well.


The GUI refers to "Not Set" on the configuration dialog for the "Begin a Conditional (If Statement) Block" action and its variations (E.G. the "Loop Start" action), as well as the variable setting actions (E.G. the "Set a Small Integer Value" action).


These tokens return "Not set":
Code: [Select]
'{TIME:dateVariableName}' = 'Not set'
'{time:dateVariableName}' = 'Not set'
'{TIMEHOUR:dateVariableName}' = 'Not set'
'{TIMEHOUR24:dateVariableName}' = 'Not set'
'{TIMEMINUTE:dateVariableName}' = 'Not set'
'{TIMESECOND:dateVariableName}' = 'Not set'
'{TIMEMILLISECOND:dateVariableName}' = 'Not set'
'{TIMEAMPM:dateVariableName}' = 'Not set'
'{TIMESTAMP:dateVariableName}' = 'Not set'
'{DATE:dateVariableName}' = 'Not set'
'{DATEYEAR:dateVariableName}' = 'Not set'
'{DATEDAY:dateVariableName}' = 'Not set'
'{DATEMONTH:dateVariableName}' = 'Not set'
'{DATEMONTHNUMERIC:dateVariableName}' = 'Not set'
'{DATEDAYOFWEEK:dateVariableName}' = 'Not set'
'{DATETICKS:dateVariableName}' = 'Not set'
'{DATETIMEFORMAT:dateVariableName:textFormatVariable}' = 'Not set'
'{SMALL:variableName }' = 'Not set'
'{SMALLFORMAT:variableName }' = 'Not set'
'{INT:variableName}' = 'Not set'
'{INTFORMAT:variableName}' = 'Not set'
'{DEC:variableName}' = 'Not set'
'{DECINV:variableName}' = 'Not set'
'{BOOL:variableName}' = 'Not set'
'{TXT:variableName}' = 'Not set'
'{TXTLEN:variableName / value}' = 'Not set'
'{TXTUPPER:variableName / value}' = 'Not set'
'{TXTLOWER:variableName / value}' = 'Not set'
'{TXTTRIM:variableName / value}' = 'Not set'
'{TXTREPLACEVAR:variableSource / value:variableFrom / value:variableTo / value}' = 'Not set'
'{TXTREGEXREPLACE:variableSource / value:variableFrom / value:variableTo }' = 'Not set'
'{TXTCONCAT:variableName1 / value:variableName2 / value}' = 'Not set'
'{STATE_AUDIOPOS: variableName / value }' = 'Not set'
'{STATE_AUDIOCOUNT: variableName / value }' = 'Not set'
'{STATE_APPVOL: variableName / value}' = 'Not set'
'{STATE_APPMUTE: variableName / value}' = 'Not set'

These return "Not Set":
Code: [Select]
'{CMDSEGMENT:0}' = 'Not Set'
'{TXTSUBSTR:textVariableOf / text value : intVariableBegin / int value : intVariableLength / int value}' = 'Not Set'

These return "" (blank), despite similar tokens like "{TXTUPPER:}" returning "Not set":
Code: [Select]
'{TXTURL:variableName}' = ''
'{TXTNUM:variableName / value}' = ''
'{TXTALPHA:variableName / value}' = ''
'{TXTWORDTONUM:variableName / value :"cero,uno,dos,tres,quatro,cinco,seis,siete,ocho,nueve"}' = ''
'{TXTTITLE:variableName / value}' = ''

These return "" (blank), despite the documentation for both stating "Returns “0” if there are none."
Code: [Select]
'{PROCESSCOUNT:textVariable}' = ''
'{WINDOWCOUNT:textVariable}' = ''


While VoiceAttack is mostly case-insensitive, I feel it would be the least confusing to have a consistent capitalization for all uses, so new users don't have to worry about the significance of the variations.



As an aside, these sections seem redundant, and possibly confusing:
Quote from: VoiceAttackHelp.pdf v1.8.5+ page 149, "{SMALL:variableName }"
Note that with this token, everything to the left of the colon is case-sensitive. Everything to the right is not ({SMALL:mY sMaLL InT} would work the same way
;))
Quote from: VoiceAttackHelp.pdf v1.8.5+ page 150, "{INT:variableName}"
Note that with this token, everything to the left of the colon is case-sensitive. Everything to the right is not ({INT:mY InT} would work the same way ;))
Quote from: VoiceAttackHelp.pdf v1.8.5+ page 150, "{DEC:variableName}"
Note that with this token, everything to the left of the colon is case-sensitive. Everything to the right is not ({DEC:mY DeCImal} would work the same way ;))
as far as I am aware, almost all tokens are case sensitive (I.E. all uppercase, with the singular exception of "{time}"), pre-colon.


EDIT: All changes made with v1.8.5.7
« Last Edit: May 06, 2020, 11:21:23 PM by Pfeil »

Gary

  • Administrator
  • Hero Member
  • *****
  • Posts: 2832
Re: "Not Set" capitalization inconsistencies
« Reply #1 on: May 04, 2020, 08:39:00 PM »
I think I got most of this wrangled up (took a while lol).  Watch out for some design changes in the next beta regarding this.

I'm not sure what you're saying in the last part (we can talk about that on Discord). 


Fantastic work, Pfeil!

Pfeil

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 4782
  • RTFM
Re: "Not Set" capitalization inconsistencies
« Reply #2 on: May 05, 2020, 09:19:03 PM »
Most instances have been changed with v1.8.5.6, with these exceptions:

51 instances of "Not Set" remain in the documentation.

The "{TXTURL:}" token now returns "Not+set".

"{TXTNUM:}" still returns "" (blank).

Gary

  • Administrator
  • Hero Member
  • *****
  • Posts: 2832
Re: "Not Set" capitalization inconsistencies
« Reply #3 on: May 06, 2020, 07:39:47 PM »
Round 2 looks complete ;)