isNumber: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Added version.)
No edit summary
Line 1: Line 1:
{{stub}}
{{MacroFunction
{{MacroFunction
|name=isNumber
|name=isNumber
|trusted=false
|version=1.3b48
|version=1.3b48
|description=
|description=
Returns 1 if the parameter is a number, or 0 if it is not.
Test if the string parameter is a number. Returns 1 if the passed in string is a number, or 0 if it is not.  Will accept integer or floating point values with or without a leading sign character. Strings containing numbers in scientific notation ({{code|1e3}}) or not in Base-10 will return false.


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: num = isNumber(val)]
[h: num = isNumber(string)]
</source>
</syntaxhighlight >
'''Parameters'''
{{param|string|A string to test.}}
 
|example=
Test if the input is a valid number
<syntaxhighlight lang="mtmacro" line>
[h: status = input("mod|0|Attack Modifier")]
[h: abort(status)]
[r, if(isNumber(mod) == 1), code: {
  [h: atkMod = number(mod)]
  Attack Mod is: [r: atkMod]
};{
  <b>Invalid input for attack modifier: [r: mod]</b>
}]
 
</syntaxhighlight>
 
}}
}}
[[Category:Mathematical Function]]
[[Category:Mathematical Function]]

Revision as of 16:05, 20 November 2021

isNumber() Function

Introduced in version 1.3b48
Test if the string parameter is a number. Returns 1 if the passed in string is a number, or 0 if it is not. Will accept integer or floating point values with or without a leading sign character. Strings containing numbers in scientific notation (1e3) or not in Base-10 will return false.

Usage

[h: num = isNumber(string)]

Parameters

  • string - A string to test.

Example

Test if the input is a valid number
[h: status = input("mod|0|Attack Modifier")]
[h: abort(status)]
[r, if(isNumber(mod) == 1), code: {
  [h: atkMod = number(mod)]
  Attack Mod is: [r: atkMod]
};{
  <b>Invalid input for attack modifier: [r: mod]</b>
}]