SquareRoot (Float function): Difference between revisions
Jump to navigation
Jump to search
m (match syntax diagram to template; fix tags and links) |
mNo edit summary |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Float:SquareRoot subtitle}} | {{Template:Float:SquareRoot subtitle}} | ||
The <var>SquareRoot</ | The <var>SquareRoot</var> [[Intrinsic classes|intrinsic]] function returns a number that is the [http://en.wikipedia.org/wiki/Square_root square root] of the method object. An attempt to obtain the square root of a negative number results in request cancellation. | ||
==Syntax== | ==Syntax== | ||
{{Template:Float:SquareRoot syntax}} | {{Template:Float:SquareRoot syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%number</th> | <tr><th>%number</th> | ||
<td>A variable to receive the square root of the method object. </td></tr> | <td>A variable to receive the square root of the method object. </td></tr> | ||
<tr><th>float</th> | <tr><th>float</th> | ||
<td>A <var>Float</var> value.</td></tr> | <td>A <var>Float</var> value.</td></tr> | ||
| Line 14: | Line 16: | ||
==Usage notes== | ==Usage notes== | ||
<ul><li><var>SquareRoot</var> is available as of <var class="product"> | <ul> | ||
<li><var>SquareRoot</var> is available as of <var class="product">Sirius Mods</var> Version 7.2. | |||
</ul> | |||
==Examples== | ==Examples== | ||
<ol><li>The following displays the square root of <code>3.14159</code>: | <ol> | ||
<p class="code">printText {3.14159:squareroot} | <li>The following displays the square root of <code>3.14159</code>: | ||
<p class="code">[[PrintText statement|printText]] {3.14159:squareroot} | |||
</p> | </p> | ||
<li>The following displays the square root of the number in <code>%x</code>: | <li>The following displays the square root of the number in <code>%x</code>: | ||
<p class="code">printText {%x:squareroot} | <p class="code">printText {%x:squareroot} | ||
Latest revision as of 18:09, 2 November 2012
Square root of a number (Float class)
The SquareRoot intrinsic function returns a number that is the square root of the method object. An attempt to obtain the square root of a negative number results in request cancellation.
Syntax
%number = float:SquareRoot
Syntax terms
| %number | A variable to receive the square root of the method object. |
|---|---|
| float | A Float value. |
Usage notes
- SquareRoot is available as of Sirius Mods Version 7.2.
Examples
- The following displays the square root of
3.14159:printText {3.14159:squareroot}
- The following displays the square root of the number in
%x:printText {%x:squareroot}