mod: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "‎" to "")
 
(83 intermediate revisions by 15 users not shown)
Line 1: Line 1:
back to [[Scripting_Reference#M|COMREF]]
{{RV|type=command


<h2 style="color:#000066">''aa '''mod '''''b''</h2>
|game1= ofp
|version1= 1.00


|game2= ofpe
|version2= 1.00


'''Operand types:'''
|game3= arma1
|version3= 1.00


'''a:''' [[Number]]
|game4= arma2
|version4= 1.00


'''b:''' [[Number]]
|game5= arma2oa
|version5= 1.50


'''Type of returned value:'''
|game6= tkoh
|version6= 1.00


[[Number]]
|game7= arma3
|version7= 0.50


'''Description:'''
|gr1= Math


'''Remainder''' of a divided by b.
|descr= Remainder of a divided by b.


'''Note:''' Remainer is calculated in real domain.
|alias= [[a % b]]


|s1= a [[mod]] b


'''Example:'''
|p1= a: [[Number]]


_rem = 3 '''mod''' 2 ...... Result is 1
|p2= b: [[Number]]


|r1= [[Number]]


'''Comments'''
|x1= <sqf>_remaining = 5 mod 2; // returns 1, as 5 divided by 2 is 2 &times; 2 + 1</sqf>


You can use '''mod''' to round a decimal number down to the nearest whole number.
|seealso= [[Math Commands]] [[Operators]] [[a % b]]
}}


For example:
{{Note
 
|user= Hoz
If you wanted to use the command random to generate a whole number between 0 and 6, you could put this in a script:-
|timestamp= 20060416013400
 
|text= <nowiki/>
_rand = [[random]] 6
* Remainder is calculated in real domain.
 
* mod is identical to [[a % b]]
_num = _rand - (_rand '''mod''' 1)
You can use mod to round a decimal number down to the nearest whole number. For example: If you wanted to use the command random to generate a whole number between 0 and 5, you could put this in a script:  
<sqf>
_rand = random 6;
_num = _rand - (_rand mod 1);
</sqf>
In A1, the new commands [[round]], [[floor]] or [[ceil]] would be the easier way to round.
}}

Latest revision as of 12:54, 26 April 2023

Hover & click on the images for description

Description

Description:
Remainder of a divided by b.
Alias:
a % b
Groups:
Math

Syntax

Syntax:
a mod b
Parameters:
a: Number
b: Number
Return Value:
Number

Examples

Example 1:
_remaining = 5 mod 2; // returns 1, as 5 divided by 2 is 2 × 2 + 1

Additional Information

See also:
Math Commands Operators a % b

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
Hoz - c
Posted on Apr 16, 2006 - 01:34 (UTC)
  • Remainder is calculated in real domain.
  • mod is identical to a % b
You can use mod to round a decimal number down to the nearest whole number. For example: If you wanted to use the command random to generate a whole number between 0 and 5, you could put this in a script:
_rand = random 6; _num = _rand - (_rand mod 1);
In A1, the new commands round, floor or ceil would be the easier way to round.