toFixed: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Created page with "{{Command|= Comments ____________________________________________________________________________________________ | arma3dev |= Game name |1.65|= Game version ______________...")
 
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(97 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3dev |= Game name
|game1= arma3
|version1= 1.66


|1.65|= Game version
|gr1= Math
____________________________________________________________________________________________


| Converts a number into a string, keeping a specified number of decimals. If the desired number of decimals are higher than the actual number, nulls are added to create the desired decimal length. This command is almost identical in behaviour to JavaScript [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toFixed toFixed()]<br><br>
|gr2= Strings
'''NOTE:''' Converted number is never presented in scientific notation unlike with other number to string commands. Also Arma's default string conversion limits numbers to 6 [https://en.wikipedia.org/wiki/Significant_figures significant figures], whereas with this command it is possible to preserve some extra precision. (ToDo: example) |= Description
____________________________________________________________________________________________


| number '''toFixed''' decimals |= Syntax
|descr= Converts a number into a string, keeping the specified number of decimals. If the desired number of decimals is higher than the actual number, nulls are added to create the desired decimal length. This command is almost identical in behaviour to JavaScript {{Link|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toFixed|toFixed()}}<br><br>
The alternative syntax acts as keyword and switches engine's [[Number]] to [[String]] global conversion into desired format, from the moment it is applied until the end of script.
To reset output back to default at any time, use {{hl|toFixed -1}} - see {{Link|#Example 5}}.


|p1= number: [[Number]] - number to convert |= Parameter 1
{{Feature|informative|Converted number is never presented in scientific notation unlike with other number to string commands. Also Arma's default string conversion limits numbers to 6 {{Link|https://en.wikipedia.org/wiki/Significant_figures|significant figures}}, whereas with this command it is possible to preserve some extra precision - see {{Link|#Example 6}}.}}
|p2= decimals: [[Number]] - number of decimals to display (range 0-20)) |= Parameter 2


| [[String]] |= Return value
|s1= number [[toFixed]] decimals
____________________________________________________________________________________________


|x1= <code>123 [[toFixed]] 2; //"123.00"</code>|= Example 1
|p1= number: [[Number]] - number to convert
|x2= <code>2.34 [[toFixed]] 1; //"2.3"
2.35 [[toFixed]] 1; //"2.4"</code>|= Example 2
____________________________________________________________________________________________


| [[toString]], [[toArray]], [[toLower]], [[toUpper]] |= See also
|p2= decimals: [[Number]] - number of decimals to display (range 0-20)


}}
|r1= [[String]]
 
|s2= [[toFixed]] decimals
 
|s2since= arma3 1.72
 
|p21= decimals: [[Number]] - number of decimals to display (range 0-20). -1 to reset to default number of decimals
 
|r2= [[Nothing]]
 
|x1= <sqf>123 toFixed 2; // "123.00"</sqf>
 
|x2= <sqf>
2.34 toFixed 1; // "2.3"
2.35 toFixed 1; // "2.4"
</sqf>
 
|x3= Convert position to string preserving position precision:
<sqf>
fn_posToString =
{
format [
"[%1,%2,%3]",
_this select 0 toFixed 8,
_this select 1 toFixed 8,
_this select 2 toFixed 8
]
};
str getPos player; // "[3231.05,171.802,0.00143862]"
getPos player call fn_posToString; // "[3231.04882813,171.80192566,0.00143862]"
</sqf>
 
|x4= Same as '''Example 3''' only using new alternative syntax:
<sqf>
str getPos player; // "[3231.05,171.802,0.00143862]"
toFixed 8;
str getPos player; // "[3231.04882813,171.80192566,0.00143862]"
</sqf>
 
|x5= <sqf>
systemChat str position player; // [11580.3,11797.7,0.00146675]
call
{
toFixed 6;
systemChat str position player; // [11580.341797,11797.737305,0.001467]
};
systemChat str position player; // [11580.341797,11797.737305,0.001467]
toFixed -1;
systemChat str position player; // [11580.3,11797.7,0.00146675]
</sqf>
Ideal to be used when saving data to a database when more precise positioning is required.


<h3 style="display:none">Notes</h3>
|x6= <sqf>
<dl class="command_description">
str (pi/100000); // "3.14159e-005" - scientific notation
(pi/100000) toFixed 10; // "0.0000314159" - no scientific notation
str pi; // "3.14159" - 6 significant figures (default)
pi toFixed 6; // "3.141593" - forced to 7 significant figures
pi toFixed 7; // "3.1415927" - forced to 8 significant figures
</sqf>


</dl>
|seealso= [[toString]] [[toArray]] [[toLower]] [[toUpper]] [[toLowerANSI]] [[toUpperANSI]]
}}


<h3 style="display:none">Bottom Section</h3>
{{Note
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
|user= R3vo
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
|timestamp= 20160902215600
|text= <sqf>
parseNumber (3.56346 toFixed 4); // 0.0026 ms (10000 cycles)
[3.5634,4] call BIS_fnc_cutDecimals; // 0.0111 ms (10000 cycles)
</sqf>
}}

Latest revision as of 19:43, 3 September 2024

Arma 3 logo black.png1.66
Hover & click on the images for description

Description

Description:
Converts a number into a string, keeping the specified number of decimals. If the desired number of decimals is higher than the actual number, nulls are added to create the desired decimal length. This command is almost identical in behaviour to JavaScript toFixed()

The alternative syntax acts as keyword and switches engine's Number to String global conversion into desired format, from the moment it is applied until the end of script. To reset output back to default at any time, use toFixed -1 - see Example 5.
ⓘ
Converted number is never presented in scientific notation unlike with other number to string commands. Also Arma's default string conversion limits numbers to 6 significant figures, whereas with this command it is possible to preserve some extra precision - see Example 6.
Groups:
MathStrings

Syntax

Syntax:
number toFixed decimals
Parameters:
number: Number - number to convert
decimals: Number - number of decimals to display (range 0-20)
Return Value:
String

Alternative Syntax

Syntax:
toFixed decimals
Parameters:
decimals: Number - number of decimals to display (range 0-20). -1 to reset to default number of decimals
Return Value:
Nothing

Examples

Example 1:
123 toFixed 2; // "123.00"
Example 2:
2.34 toFixed 1; // "2.3" 2.35 toFixed 1; // "2.4"
Example 3:
Convert position to string preserving position precision:
fn_posToString = { format [ "[%1,%2,%3]", _this select 0 toFixed 8, _this select 1 toFixed 8, _this select 2 toFixed 8 ] }; str getPos player; // "[3231.05,171.802,0.00143862]" getPos player call fn_posToString; // "[3231.04882813,171.80192566,0.00143862]"
Example 4:
Same as Example 3 only using new alternative syntax:
str getPos player; // "[3231.05,171.802,0.00143862]" toFixed 8; str getPos player; // "[3231.04882813,171.80192566,0.00143862]"
Example 5:
systemChat str position player; // [11580.3,11797.7,0.00146675] call { toFixed 6; systemChat str position player; // [11580.341797,11797.737305,0.001467] }; systemChat str position player; // [11580.341797,11797.737305,0.001467] toFixed -1; systemChat str position player; // [11580.3,11797.7,0.00146675]
Ideal to be used when saving data to a database when more precise positioning is required.
Example 6:
str (pi/100000); // "3.14159e-005" - scientific notation (pi/100000) toFixed 10; // "0.0000314159" - no scientific notation str pi; // "3.14159" - 6 significant figures (default) pi toFixed 6; // "3.141593" - forced to 7 significant figures pi toFixed 7; // "3.1415927" - forced to 8 significant figures

Additional Information

See also:
toString toArray toLower toUpper toLowerANSI toUpperANSI

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
R3vo - c
Posted on Sep 02, 2016 - 21:56 (UTC)
parseNumber (3.56346 toFixed 4); // 0.0026 ms (10000 cycles) [3.5634,4] call BIS_fnc_cutDecimals; // 0.0111 ms (10000 cycles)
Retrieved from "https://community.bistudio.com/wiki?title=toFixed&oldid=369349"