WoW:USERAPI round: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Wow, the old one was overly complicated.)
mNo edit summary
Line 13: Line 13:


== Example ==
== Example ==
  local number = round(math.pi, 2)
  local number = round(math.pi, 3)
  print(number) -- prints 3.14
  print(number) -- prints 3.142


==Code==
==Code==
<!-- No, no sanity checks are needed. That's the programmers responsibility. -->
<!-- No, no sanity checks are needed. That's the programmers responsibility. -->
<pre>function round(number, decimals)
<pre>function round(number, decimals)
return number - (number % (0.1 ^ decimals))
    return (("%%.%df"):format(decimals)):format(number)
end</pre>
end</pre>
== See Also ==
* [[truncate]]
__NOTOC__
__NOTOC__

Revision as of 08:59, 18 January 2010

This page documents a <i>user-defined function</i> that you can copy and paste into your addon. Replace PREFIX with your addon or lib prefix to avoid conflicts between different versions of these functions.

User defined functions


Round a number off to n places.

number = round(number, decimals)

Function Parameters

Arguments

number
Number. The number to round.
decimals
Number. Round to this many places.

Returns

number
Number. The rounded number.

Example

local number = round(math.pi, 3)
print(number) -- prints 3.142

Code

function round(number, decimals)
    return (("%%.%df"):format(decimals)):format(number)
end

See Also