WoW:USERAPI round: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (bolded title of article)
m (Move page script moved page USERAPI round to USERAPI round without leaving a redirect)
 
(4 intermediate revisions by 3 users not shown)
Line 3: Line 3:


'''Round''' a number off to n places.
'''Round''' a number off to n places.
  number = round(input, n)
  number = round(number, decimals)


== Function Parameters ==
== Function Parameters ==
=== Arguments ===
=== Arguments ===
;input : Number. The number to round
;number: Number. The number to round.
;n : Number. Round to this many places. If nil, round to 0 places.
;decimals : Number. Round to this many places.
=== Returns ===
=== Returns ===
; number : Number. The rounded number.
;number : Number. The rounded number.


== 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==
<pre>function round(input, places)
<!-- No, no sanity checks are needed. That's the programmers responsibility. -->
     if not places then
<pre>function round(number, decimals)
        places = 0
     return (("%%.%df"):format(decimals)):format(number)
    end
    if type(input) == "number" and type(places) == "number" then
        local pow = 1
        for i = 1, ceil(places) do
            pow = pow * 10
        end
        return floor(input * pow + 0.5) / pow
    end
end</pre>
end</pre>
== See Also ==
* [[truncate]]
__NOTOC__
__NOTOC__

Latest revision as of 04:49, 15 August 2023

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[edit]

Arguments[edit]

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

Returns[edit]

number
Number. The rounded number.

Example[edit]

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

Code[edit]

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

See Also[edit]


Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:USERAPI_round&oldid=20769"