Math.round

From Multi Theft Auto: Wiki

This function is a full featured round function for Lua's math-library. Bear in mind that both the floor and the ceil method may not work properly clientside when you pass something greater than 0 as second argument. This is because of some weird clientside number bug. It's fixed for the round method.

Syntax

int/float math.round( float number, [ int decimals = 0, string method = "round" ] )

Required Arguments

• number: The number to round.

Optional Arguments

NOTE: When using optional arguments, you must supply all arguments before the one you wish to use. For more information on optional arguments, see Optional Arguments.

• decimals: The number of decimals to keep.
• method: The round method that should be used. Valid values are "round" (which is default), "floor" and "ceil".

Returns

Returns the rounded number.

Code

function math.round(number, decimals, method)
    decimals = decimals or 0
    local factor = 10 ^ decimals
    if (method == "ceil" or method == "floor") then return math[method](number * factor) / factor
    else return tonumber(("%."..decimals.."f"):format(number)) end
end

Example

addCommandHandler("pos", function ()
    local x, y, z = getElementPosition(getPedOccupiedVehicle(source) or source)
    outputChatBox("Your current position: ["..math.round(x, 3).."|"..math.round(y, 3).."|"..math.round(z, 3).."]", source)
end, false, false)

Author: NeonBlack

See Also

• callClientFunction » This function allows you to call any clientside function from the server's side.

• callServerFunction » This function allows you to call any server-side function from the client's side.

• Check » This function checks if it's arguments are of the right types and calls the error-function if one isn't.

• doForAllElements » This function can be used to execute a specified function for all elements of a specified type.

• iterElements » Returns an iterator for your for loops saving time typing ipairs( getElementsByType( type ) ), instead you type: iterElements( type ).

• findRotation » Takes two points and returns the direction from point A to point B.

• FormatDate » Formats a date on the basis of a format string and returns it.

• getAge » This function calculates the age of a birthday.

• getPointFromDistanceRotation » Finds a point based on a starting point, direction and distance.

• getTimestamp » With this function you can get the UNIX timestamp.

• IfElse » Returns one of two values based on a boolean expression.

• isLeapYear » Checks if the given year is a leap year.

• math.round » Rounds a number whereas the number of decimals to keep and the method may be set.

• setTableProtected » Protects a table and makes it read-only.

• setVehicleGravityPoint » This clientside function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.

• string.explode » This function splits a string at a given separator pattern and returns a table with the pieces.

• table.copy » This function copies a whole table and all the tables in that table.

• table.map » This function goes through a table and replaces every field with the return of the passed function, where the field's value is passed as first argument and optionally more arguments.

• table.size » Finds the absolute size of a table.

• var_dump »This function outputs information about one or more variables using outputConsole().

• RGBToHex » This function returns a string representing the color in hexadecimal.

• getAlivePlayersInTeam » This function returns a table of the alive players in a team.

• getResourceSettings » This function returns a table of the resource settings.

• onVehicleWeaponFire » This code implements an event that is triggered when a player in a vehicle fires a vehicles weapon.

• toHex » This function converts a decimal number to a hexadecimal number, as a fix to be used clientside.

• getElementSpeed » This function allows you to get element speed in kph or mph units.

• setElementSpeed » This function allows you to set moving element speed in kph or mph units.

• centerWindow » This function center the window in any resolution.

• coroutine.resume » Fix for hidden coroutine error messages

• getPlayerFromNamePart » This function allows you to get player From his Name part.