Difference between revisions of "Format Decimal"
Jump to navigation
Jump to search
Huney Jewell (talk | contribs) (Added some further explanation) |
m (<lsl> tag to <source>) |
||
(11 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{LSL Header}}__NOTOC__ | {{LSL Header}}__NOTOC__ | ||
<div id="box"> | <div id="box">{{#vardefine:p_number_desc|any valid float, positive or negative | ||
== Function: [[string]] FormatDecimal([[float]] number, [[integer]] precision); == | }}{{#vardefine:p_precision_desc|precision of result. Positive values truncate rounded fraction, negative values truncate rounded '''number''' to integer | ||
}} | |||
== Function: [[string]] FormatDecimal([[float]] {{LSL Param|number}}, [[integer]] {{LSL Param|precision}}); == | |||
<div style="padding: 0.5em;"> | <div style="padding: 0.5em;"> | ||
''Formats a float value to a fixed precision ie. for display purposes'' | ''Formats a float value to a fixed precision ie. for display purposes'' | ||
Returns a [[String|string]] that comprises the '''number''' truncated and rounded to the given '''precision'''. | Returns a [[String|string]] that comprises the '''{{LSL Param|number}}''' truncated and rounded to the given '''{{LSL Param|precision}}'''. | ||
{ | {| | ||
{{LSL DefineRow|[[float]]|number| | {{LSL DefineRow|[[float]]|number|{{#var:p_number_desc}}}} | ||
{{LSL DefineRow|[[integer]]|precision| | {{LSL DefineRow|[[integer]]|precision|{{#var:p_precision_desc}}}} | ||
}} | |} | ||
<br/> | <br/> | ||
{| | {| {{Prettytable}} | ||
|-{{Hl2}} | |-{{Hl2}} | ||
!precision | !{{LSL Param|precision}} | ||
!Value | !Value | ||
|- | |- | ||
|positive | |positive | ||
|Truncates ''number'' rounded to this fraction positions | |Truncates '''{{LSL Param|number}}''' rounded to this fraction positions | ||
|- | |- | ||
|zero | |zero | ||
|Truncates ''number'' rounded to it's integer value | |Truncates '''{{LSL Param|number}}''' rounded to it's integer value | ||
|- | |- | ||
|negative | |negative | ||
|Rounds ''number'' at this pre-decimal position | |Rounds '''{{LSL Param|number}}''' at this pre-decimal position | ||
|} | |} | ||
</div></div> | </div></div> | ||
Line 31: | Line 31: | ||
== Specification == | == Specification == | ||
<div style="padding: 0.5em;"> | <div style="padding: 0.5em;"> | ||
< | <source lang="lsl2"> | ||
string FormatDecimal (float number, integer precision) | string FormatDecimal(float number, integer precision) | ||
{ | { | ||
float roundingValue = llPow(10, -precision)*0.5; | float roundingValue = llPow(10, -precision)*0.5; | ||
Line 49: | Line 49: | ||
return llGetSubString(strNumber, 0, llSubStringIndex(strNumber, ".") + precision); | return llGetSubString(strNumber, 0, llSubStringIndex(strNumber, ".") + precision); | ||
} | } | ||
</ | </source> | ||
< | '''Examples:''' | ||
< | {| border="2" cellspacing="0" cellpadding="3" rules="all" style="margin:1em 1em 1em 0; border:solid 1px #AAAAAA; border-collapse:collapse; background-color:#F9F9F9; font-size:90%; empty-cells:show;" | ||
< | |-{{Hl2}} | ||
< | !{{LSL Param|number}} | ||
!{{LSL Param|precision}} | |||
!Result | |||
!Code | |||
|- | |||
|style="text-align: right;" |123.456 | |||
|style="text-align: center;" |2 | |||
|style="text-align: right;" |123.46 | |||
|<code>FormatDecimal(123.456, 2)</code> | |||
|- | |||
|style="text-align: right;" | -123.456 | |||
|style="text-align: center;" |2 | |||
|style="text-align: right;" | -123.46 | |||
|<code>FormatDecimal(-123.456, 2)</code> | |||
|- | |||
|style="text-align: right;" |123.456 | |||
|style="text-align: center;" |0 | |||
|style="text-align: right;" |123 | |||
|<code>FormatDecimal(123.456, 0)</code> | |||
|- | |||
|style="text-align: right;" |123.456 | |||
|style="text-align: center;" | -2 | |||
|style="text-align: right;" |100 | |||
|<code>FormatDecimal(123.456, -2)</code> | |||
|} | |||
</div></div><div id="box"> | </div></div><div id="box"> | ||
== Caveats == | == Caveats == | ||
<div style="padding: 0.5em;"> | <div style="padding: 0.5em;"> | ||
Line 62: | Line 87: | ||
== Example == | == Example == | ||
<div style="padding: 0.5em;"> | <div style="padding: 0.5em;"> | ||
Trivial example to listen to any chat from the object owner for ''number,precision'' values and respond formatted value. | Trivial example to listen to any chat from the object owner for '''{{LSL Param|number}}, {{LSL Param|precision}}''' values and respond formatted value. | ||
< | <source lang="lsl2"> | ||
// Insert code of FormatDecimal user function here | |||
default | default | ||
Line 98: | Line 107: | ||
} | } | ||
} | } | ||
</ | </source> | ||
</div></div> | </div></div> | ||
{{LSLC|Examples|Format Decimal}} | {{LSLC|Examples|Format Decimal}} |
Latest revision as of 14:00, 24 January 2015
LSL Portal | Functions | Events | Types | Operators | Constants | Flow Control | Script Library | Categorized Library | Tutorials |
Function: string FormatDecimal(float number, integer precision);
Formats a float value to a fixed precision ie. for display purposes
Returns a string that comprises the number truncated and rounded to the given precision.
• float | number | – | any valid float, positive or negative | |
• integer | precision | – | precision of result. Positive values truncate rounded fraction, negative values truncate rounded number to integer |
precision | Value |
---|---|
positive | Truncates number rounded to this fraction positions |
zero | Truncates number rounded to it's integer value |
negative | Rounds number at this pre-decimal position |
Specification
string FormatDecimal(float number, integer precision)
{
float roundingValue = llPow(10, -precision)*0.5;
float rounded;
if (number < 0) rounded = number - roundingValue;
else rounded = number + roundingValue;
if (precision < 1) // Rounding integer value
{
integer intRounding = (integer)llPow(10, -precision);
rounded = (integer)rounded/intRounding*intRounding;
precision = -1; // Don't truncate integer value
}
string strNumber = (string)rounded;
return llGetSubString(strNumber, 0, llSubStringIndex(strNumber, ".") + precision);
}
Examples:
number | precision | Result | Code |
---|---|---|---|
123.456 | 2 | 123.46 | FormatDecimal(123.456, 2)
|
-123.456 | 2 | -123.46 | FormatDecimal(-123.456, 2)
|
123.456 | 0 | 123 | FormatDecimal(123.456, 0)
|
123.456 | -2 | 100 | FormatDecimal(123.456, -2)
|
Caveats
Maximum value is restricted to integer range, that is -2,147,483,648 to +2,147,483,647
Example
Trivial example to listen to any chat from the object owner for number, precision values and respond formatted value.
// Insert code of FormatDecimal user function here
default
{
state_entry()
{
llOwnerSay("Enter: [number,precision]");
llListen(0, "", llGetOwner(), "");
}
listen(integer _chan, string _str, key _id, string _msg)
{
list values=llCSV2List(_msg);
float number = llList2Float(values,0);
integer decimals = llList2Integer(values,1);
llOwnerSay("Number " + (string)number + " is formatted " + FormatDecimal(number, decimals));
}
}