IntegerToHex (Float function) - Revision history

JAL: /* Usage notes */

2012-11-02T17:52:41Z

Usage notes

← Older revision		Revision as of 17:52, 2 November 2012
Line 30:		Line 30:
	<li>If the specified size of the returned hex value is insufficient to contain the converted value and any necessary sign bit, the request is cancelled.		<li>If the specified size of the returned hex value is insufficient to contain the converted value and any necessary sign bit, the request is cancelled.

	<li><var>IntegerToHex</var> is available as of <var class="product">~~Sirius Mods\|~~Sirius Mods</var> Version 7.5.		<li><var>IntegerToHex</var> is available as of <var class="product">Sirius Mods</var> Version 7.5.
	</ul>		</ul>

JAL at 17:49, 2 November 2012

2012-11-02T17:49:59Z

← Older revision		Revision as of 17:49, 2 November 2012
Line 1:		Line 1:
	{{Template:Float:IntegerToHex subtitle}}		{{Template:Float:IntegerToHex subtitle}}

	The <var>IntegerToHex</~~var> <~~var>[[Intrinsic classes\|intrinsic]]~~</var>~~ function converts an integer to its hexadecimal string representation. Only integers that convert to four hex bytes or less (so a maximum output string length of eight) are allowed.		The <var>IntegerToHex</var> [[Intrinsic classes\|intrinsic]] function converts an integer to its hexadecimal string representation. Only integers that convert to four hex bytes or less (so a maximum output string length of eight) are allowed.

	==Syntax==		==Syntax==
	{{Template:Float:IntegerToHex syntax}}		{{Template:Float:IntegerToHex syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>A string variable to receive the converted value of the method object: <var class="term">float</var>. </td></tr>		<td>A string variable to receive the converted value of the method object: <var class="term">float</var>. </td></tr>

	<tr><th>float</th>		<tr><th>float</th>
	<td>An integer value. The number must be convertible to a hex string that does not exceed the output size specified by the <var class="term">number</var> value (plus a sign bit, if that is indicated).		<td>An integer value. The number must be convertible to a hex string that does not exceed the output size specified by the <var class="term">number</var> value (plus a sign bit, if that is indicated).
	<p>If <var class="term">number</var> is a negative value, you must specify '<code>Signed=true</code>'. </p></td></tr>		<p>If <var class="term">number</var> is a negative value, you must specify <code>Signed=true</code>. </p></td></tr>

	<tr><th>number</th>		<tr><th>number</th>
	<td>A non-zero numeric value that specifies the number of bytes to be returned in hexadecimal format (two characters for each byte). The value must not be greater than 4.</td></tr>		<td>A non-zero numeric value that specifies the number of bytes to be returned in hexadecimal format (two characters for each byte). The value must not be greater than 4.</td></tr>

	<tr><th><var>Signed</var></th>		<tr><th><var>Signed</var></th>
	<td>This is an optional, [[Notation conventions for methods#Named parameters\|name required]], <var>Boolean</var> value that indicates whether the method object number is to be converted to signed output or not. If <code>Signed=True</code>, the resulting hex string will begin with a sign bit '<code>00</code>' or '<code>FF</code>'), and a two's complement conversion is performed.		<td>This is an optional, [[Notation conventions for methods#Named parameters\|name required]], <var>Boolean</var> value that indicates whether the method object number is to be converted to signed output or not. If <code>Signed=True</code>, the resulting hex string will begin with a sign bit '<code>00</code>' or '<code>FF</code>'), and a two's complement conversion is performed.
	<p><var>Signed</var> defaults to '<var>False</var>', which produces an unsigned conversion.</p></td></tr>		<p>
			<var>Signed</var> defaults to <var>False</var>, which produces an unsigned conversion.</p></td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul><li>If the specified size of the returned hex value is greater than the hex value, the returned value is padded on the left with repetitions of the appropriate sign bit.		<ul>
			<li>If the specified size of the returned hex value is greater than the hex value, the returned value is padded on the left with repetitions of the appropriate sign bit.

	<li>If the specified size of the returned hex value is insufficient to contain the converted value and any necessary sign bit, the request is cancelled.		<li>If the specified size of the returned hex value is insufficient to contain the converted value and any necessary sign bit, the request is cancelled.
	<li><var>IntegerToHex</var> is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.5.</ul>
			<li><var>IntegerToHex</var> is available as of <var class="product">Sirius Mods\|Sirius Mods</var> Version 7.5.
			</ul>

	==Examples==		==Examples==
	<ol><li>The following statement displays '<code>00000000</code>':		<ol>
			<li>The following statement displays <code>00000000</code>:
	<p class="code">[[PrintText statement\|printText]] {0:integerToHex(4)}		<p class="code">[[PrintText statement\|printText]] {0:integerToHex(4)}
	</p>		</p>
	<li>The following statement displays '<code>0000000A</code>':
			<li>The following statement displays <code>0000000A</code>:
	<p class="code">printText {10:integerToHex(4)}		<p class="code">printText {10:integerToHex(4)}
	</p>		</p>
	<li>The following statement displays '<code>FF</code>':
			<li>The following statement displays <code>FF</code>:
	<p class="code">printText {255:integerToHex(1)}		<p class="code">printText {255:integerToHex(1)}
	</p>		</p>
	<li>The following statement displays '<code>FF</code>':
			<li>The following statement displays <code>FF</code>:
	<p class="code">printText {-1:integerToHex(1, signed=true)}		<p class="code">printText {-1:integerToHex(1, signed=true)}
	</p></ol>		</p>
			</ol>

	==See also==		==See also==
	<ul><li>The inverse of the <var>IntegerToHex</var> method is <var>[[HexToInteger (String function)\|HexToInteger]]</var>.</ul>		<ul>
			<li>The inverse of the <var>IntegerToHex</var> method is <var>[[HexToInteger (String function)\|HexToInteger]]</var>.
			</ul>

	{{Template:Float:IntegerToHex footer}}		{{Template:Float:IntegerToHex footer}}

JAL2 at 21:30, 7 August 2012

2012-08-07T21:30:39Z

← Older revision		Revision as of 21:30, 7 August 2012
Line 15:		Line 15:
	<td>A non-zero numeric value that specifies the number of bytes to be returned in hexadecimal format (two characters for each byte). The value must not be greater than 4.</td></tr>		<td>A non-zero numeric value that specifies the number of bytes to be returned in hexadecimal format (two characters for each byte). The value must not be greater than 4.</td></tr>
	<tr><th><var>Signed</var></th>		<tr><th><var>Signed</var></th>
	<td>This is an optional, ~~but <var class="term">nameRequired</var>~~, <var>~~boolean~~</var> value that indicates whether the method object number is to be converted to signed output or not. If <code>Signed=True</code>, the resulting hex string will begin with a sign bit '<code>00</code>' or '<code>FF</code>'), and a two's complement conversion is performed.		<td>This is an optional, [[Notation conventions for methods#Named parameters\|name required]], <var>Boolean</var> value that indicates whether the method object number is to be converted to signed output or not. If <code>Signed=True</code>, the resulting hex string will begin with a sign bit '<code>00</code>' or '<code>FF</code>'), and a two's complement conversion is performed.
	<p><var ~~class="term"~~>Signed</var> defaults to '<~~code~~>False</~~code~~>', which produces an unsigned conversion.</p></td></tr>		<p><var>Signed</var> defaults to '<var>False</var>', which produces an unsigned conversion.</p></td></tr>
	</table>		</table>

JAL2: /* Syntax terms */

2012-04-18T16:28:12Z

Syntax terms

← Older revision		Revision as of 16:28, 18 April 2012
Line 13:		Line 13:
	<p>If <var class="term">number</var> is a negative value, you must specify '<code>Signed=true</code>'. </p></td></tr>		<p>If <var class="term">number</var> is a negative value, you must specify '<code>Signed=true</code>'. </p></td></tr>
	<tr><th>number</th>		<tr><th>number</th>
	<td>A non-zero numeric value that specifies the number of ~~hex~~ bytes to be returned. ~~Its~~ value must be greater than ~~0 and less than 5~~.</td></tr>		<td>A non-zero numeric value that specifies the number of bytes to be returned in hexadecimal format (two characters for each byte). The value must not be greater than 4.</td></tr>
	<tr><th><var>Signed</var></th>		<tr><th><var>Signed</var></th>
	<td>This is an optional, but <var class="term">nameRequired</var>, <var>boolean</var> value that indicates whether the method object number is to be converted to signed output or not. If <code>Signed=True</code>, the resulting hex string will begin with a sign bit '<code>00</code>' or '<code>FF</code>'), and a two's complement conversion is performed.		<td>This is an optional, but <var class="term">nameRequired</var>, <var>boolean</var> value that indicates whether the method object number is to be converted to signed output or not. If <code>Signed=True</code>, the resulting hex string will begin with a sign bit '<code>00</code>' or '<code>FF</code>'), and a two's complement conversion is performed.

JALWiccan: 1 revision

2011-05-04T17:46:35Z

1 revision

← Older revision	Revision as of 17:46, 4 May 2011
(No difference)

JALWiccan: 1 revision

2011-05-04T17:46:32Z

1 revision

← Older revision		Revision as of 17:46, 4 May 2011
Line 22:		Line 22:
	<ul><li>If the specified size of the returned hex value is greater than the hex value, the returned value is padded on the left with repetitions of the appropriate sign bit.		<ul><li>If the specified size of the returned hex value is greater than the hex value, the returned value is padded on the left with repetitions of the appropriate sign bit.
	<li>If the specified size of the returned hex value is insufficient to contain the converted value and any necessary sign bit, the request is cancelled.		<li>If the specified size of the returned hex value is insufficient to contain the converted value and any necessary sign bit, the request is cancelled.
	<li><var>IntegerToHex</var> is available as of <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.5.</ul>		<li><var>IntegerToHex</var> is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.5.</ul>

	==Examples==		==Examples==

JALWiccan: 1 revision

2011-04-13T00:07:03Z

1 revision

← Older revision	Revision as of 00:07, 13 April 2011
(No difference)

Goff: printtext

2011-04-13T00:07:02Z

printtext

← Older revision		Revision as of 00:07, 13 April 2011
Line 14:		Line 14:
	<tr><th>number</th>		<tr><th>number</th>
	<td>A non-zero numeric value that specifies the number of hex bytes to be returned. Its value must be greater than 0 and less than 5.</td></tr>		<td>A non-zero numeric value that specifies the number of hex bytes to be returned. Its value must be greater than 0 and less than 5.</td></tr>
	<tr><th>Signed</th>		<tr><th><var>Signed</var></th>
	<td>This is an optional, but <var class="term">nameRequired</var>, <var>boolean</var> value that indicates whether the method object number is to be converted to signed output or not. If <code>Signed=True</code>, the resulting hex string will begin with a sign bit '<code>00</code>' or '<code>FF</code>'), and a two's complement conversion is performed.		<td>This is an optional, but <var class="term">nameRequired</var>, <var>boolean</var> value that indicates whether the method object number is to be converted to signed output or not. If <code>Signed=True</code>, the resulting hex string will begin with a sign bit '<code>00</code>' or '<code>FF</code>'), and a two's complement conversion is performed.
	<p><var class="term">Signed</var> defaults to '<code>False</code>', which produces an unsigned conversion.</p></td></tr>		<p><var class="term">Signed</var> defaults to '<code>False</code>', which produces an unsigned conversion.</p></td></tr>

Goff: printtext

2011-02-22T11:41:22Z

printtext

← Older revision		Revision as of 11:41, 22 February 2011
Line 26:		Line 26:
	==Examples==		==Examples==
	<ol><li>The following statement displays '<code>00000000</code>':		<ol><li>The following statement displays '<code>00000000</code>':
	<p class="code">printText {0:integerToHex(4)}		<p class="code">[[PrintText statement\|printText]] {0:integerToHex(4)}
	</p>		</p>
	<li>The following statement displays '<code>0000000A</code>':		<li>The following statement displays '<code>0000000A</code>':
Line 39:		Line 39:

	==See also==		==See also==
	<ul><li>The inverse of the <var>IntegerToHex</var> method is <var>[[HexToInteger (String function)\|HexToInteger~~]]</var>.~~		<ul><li>The inverse of the <var>IntegerToHex</var> method is <var>[[HexToInteger (String function)\|HexToInteger]]</var>.</ul>
	~~<li>For details of the <var>printtext</var> statement, please see <var>[[Intrinsic classes#printtext\|printText~~]]</var>.</ul>
	{{Template:Float:IntegerToHex footer}}		{{Template:Float:IntegerToHex footer}}

Goff: match syntax diagram to revised template; fix tags and links

2011-02-04T00:27:48Z

match syntax diagram to revised template; fix tags and links

← Older revision		Revision as of 00:27, 4 February 2011
Line 1:		Line 1:
	{{Template:Float:IntegerToHex subtitle}}		{{Template:Float:IntegerToHex subtitle}}

	~~This~~ [[Intrinsic classes\|intrinsic]] function converts an integer to its hexadecimal string representation.		The <var>IntegerToHex</var> <var>[[Intrinsic classes\|intrinsic]]</var> function converts an integer to its hexadecimal string representation. Only integers that convert to four hex bytes or less (so a maximum output string length of eight) are allowed.
	Only integers that convert to four hex bytes or less
	(so a maximum output string length of eight) are allowed.

	~~The <var>IntegerToHex</var> function is available as of version 7.5 of the <var class=product>Sirius Mods</var>.~~
	==Syntax==		==Syntax==
	{{Template:Float:IntegerToHex syntax}}		{{Template:Float:IntegerToHex syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%~~str~~</th>		<tr><th>%string</th>
	<td>A string variable to receive the converted value of the method object number. </td></tr>		<td>A string variable to receive the converted value of the method object: <var class="term">float</var>. </td></tr>
			<tr><th>float</th>
			<td>An integer value. The number must be convertible to a hex string that does not exceed the output size specified by the <var class="term">number</var> value (plus a sign bit, if that is indicated).
			<p>If <var class="term">number</var> is a negative value, you must specify '<code>Signed=true</code>'. </p></td></tr>
	<tr><th>number</th>		<tr><th>number</th>
	~~<td>An integer value. The number must be convertible to a hex string that does not exceed the output size specified by the ''num'' value (plus a sign bit, if that is indicated).~~		<td>A non-zero numeric value that specifies the number of hex bytes to be returned. Its value must be greater than 0 and less than 5.</td></tr>
	~~<p class="output">If ''number'' is a negative value, you must specify ''''Signed=true''''. </td></tr>~~		<tr><th>Signed</th>
	~~</p>~~		<td>This is an optional, but <var class="term">nameRequired</var>, <var>boolean</var> value that indicates whether the method object number is to be converted to signed output or not. If <code>Signed=True</code>, the resulting hex string will begin with a sign bit '<code>00</code>' or '<code>FF</code>'), and a two's complement conversion is performed.
	~~<tr><th>num</th>~~		<p><var class="term">Signed</var> defaults to '<code>False</code>', which produces an unsigned conversion.</p></td></tr>
	<td>A non-zero numeric value that specifies the number of hex bytes to be returned. Its value must be greater than 0 and less than 5. </td></tr>
	<tr><th>Signed~~=bool~~</th>
	<td>This ~~name-required argument (''''Signed'''')~~ is a boolean value that indicates whether the method object number is to be converted to signed output. If so, the resulting hex string will begin with a sign bit '~~'''~~00~~'''~~' or '~~'''~~FF~~'''~~'), and a two's complement conversion is performed.
	<p class="~~code~~">Signed ~~is an optional argument that~~ defaults to '~~'''~~False~~'''~~', which produces an unsigned conversion.</td></tr>
	</p>
	</table>		</table>

	==Usage notes==		==Usage notes==
	*If the specified size of the returned hex value is greater than the hex value, the returned value is padded on the left with repetitions of the appropriate sign bit.		<ul><li>If the specified size of the returned hex value is greater than the hex value, the returned value is padded on the left with repetitions of the appropriate sign bit.
	*If the specified size of the returned hex value is insufficient to contain the converted value and any necessary sign bit, the request is cancelled.		<li>If the specified size of the returned hex value is insufficient to contain the converted value and any necessary sign bit, the request is cancelled.
	*The inverse of the <var>IntegerToHex</var> ~~method~~ is [[~~HexToInteger (String function)~~\|~~HexToInteger~~]].		<li><var>IntegerToHex</var> is available as of <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.5.</ul>

	==Examples==		==Examples==
	The following statement displays '~~'''~~00000000~~'''~~':		<ol><li>The following statement displays '<code>00000000</code>':
	<p class="code">~~[[Intrinsic classes#printtext\|~~printText]] {0:integerToHex(4)}		<p class="code">printText {0:integerToHex(4)}
	</p>		</p>
	The following statement displays '~~'''~~0000000A~~'''~~':		<li>The following statement displays '<code>0000000A</code>':
	<p class="code">printText {10:integerToHex(4)}		<p class="code">printText {10:integerToHex(4)}
	</p>		</p>
	The following statement displays '~~'''~~FF~~'''~~':		<li>The following statement displays '<code>FF</code>':
	<p class="code">printText {255:integerToHex(1)}		<p class="code">printText {255:integerToHex(1)}
	</p>		</p>
	The following statement displays '~~'''~~FF~~'''~~':		<li>The following statement displays '<code>FF</code>':
	<p class="code">printText {-1:integerToHex(1, signed=true)}		<p class="code">printText {-1:integerToHex(1, signed=true)}
			</p></ol>

	~~</p>~~
	==See also==		==See also==
			<ul><li>The inverse of the <var>IntegerToHex</var> method is <var>[[HexToInteger (String function)\|HexToInteger]]</var>.
			<li>For details of the <var>printtext</var> statement, please see <var>[[Intrinsic classes#printtext\|printText]]</var>.</ul>
	{{Template:Float:IntegerToHex footer}}		{{Template:Float:IntegerToHex footer}}