m204wiki - User contributions [en]

Unspace (String function)

2012-06-10T22:21:25Z

John: /* Syntax terms */

{{Template:String:Unspace subtitle}}
The <var>Unspace</var> [[Intrinsic classes|intrinsic]] function removes the whitespace characters from the method object string and it returns the resulting string. Options are available to:<ul><li>
Define which character or characters are to be interpreted as whitespace<li>Remove leading whitespace, trailing whitespace, both or neither;<li>Collapse to a single whitespace character any sequences of non-leading, non-trailing whitespace</ul>

==Syntax==
{{Template:String:Unspace syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%outString</th>
<td>A variable to receive the string result of the <var>Unspace</var> method.</td></tr>
<tr><th>string</th>
<td>The input method object string</td></tr>
<tr><th><var>Spaces</var></th>
<td><var class="term">Spaces</var> is an optional, [[Methods#Named parameters|name required]], parameter, which is a string that specifies the set of characters considered to be whitespace. The default set is the blank space (<code>' '</code>) character. If you specify multiple <var class="term">Spaces</var> characters:<ul><li>There is no separator character.<li>The first character of the string is the replacement space character: a single one of these is substituted for each sequence (which may be one) of non-leading, non-trailing Spaces characters in the method object string.</ul></td></tr>
<tr><th><var>Leading</var></th>
<td><var class="term">Leading</var> is an optional, but <var class="term">Name-Required</var>, parameter, which is a <var>[[Enumerations#Using_Boolean_enumerations|"Boolean Enumeration"]]</var> value that specifies whether to strip all leading whitespace characters. The default is <code>True</code>, strip leading whitespace.</td></tr>
<tr><th><var>Trailing</var></th>
<td><var class="term">Trailing</var> is an optional, but <var class="term">Name-Required</var>, parameter, which is a <var>[[Enumerations#Using_Boolean_enumerations|"Boolean Enumeration"]]</var> value that specifies whether to strip all trailing whitespace characters. The default is <code>True</code>, strip trailing whitespace.</td></tr>
<tr><th><var>Compress</var></th>
<td><var class="term">Compress</var> is an optional, but <var class="term">Name-Required</var>, parameter, which is a <var>[[Enumerations#Using_Boolean_enumerations|"Boolean Enumeration"]]</var> value that specifies whether to collapse sequences of spaces to single spaces. The default is <code>True</code>, collapse such sequences.</td></tr>
</table>

==Usage notes==
<ul><li>Duplicate Spaces characters are tolerated and do not affect the result.
<li>Prior to <var class="product">Sirius Mods</var> Version 7.8, <var>Unspace</var> compressed a string consisting entirely of whitespace characters to a single whitespace character. As of Version 7.8 (and also in Version 7.7 maintenance), <var>Unspace</var> converts a string of whitespace characters to a null string. The Version 7.8 result of
<p class="code">printText {~} = X{' ':unspace}X</p>
is:
<p class="output">' ':unspace = XX
</p>
<li><var>Unspace</var> is available as of <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.3.</ul>

==Examples==
<ol><li>The following are example <var>Unspace</var> statements:
<p class="code">%ls is longstring
%ls = ' so me chars '

[[PrintText statement|printText]] {~} = {%ls:unspace()}
printText {~} = {%ls:unspace(Spaces='X ')}
printText {~} = {%ls:unspace(leading=false)}
printText {~} = {%ls:unspace(trailing=false)}
printText {~} = {%ls:unspace(compress=false)}
</p>
The results are respectively:
<p class="code">%ls:unspace() = so me chars
%ls:unspace(Spaces='X ') = soXmeXchars
%ls:unspace(leading=false) = so me chars
%ls:unspace(trailing=false) = so me chars
%ls:unspace(compress=false) = so me chars
</p></ol>

==See also==
{{Template:String:Unspace footer}}

Unspace (String function)

2012-01-08T23:15:16Z

John: /* Syntax terms */

{{Template:String:Unspace subtitle}}
The <var>Unspace</var> [[Intrinsic classes|intrinsic]] function removes the whitespace characters from the method object string and it returns the resulting string. Options are available to:<ul><li>
Define which character or characters are to be interpreted as whitespace<li>Remove leading whitespace, trailing whitespace, both or neither;<li>Collapse to a single whitespace character any sequences of non-leading, non-trailing whitespace</ul>

==Syntax==
{{Template:String:Unspace syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%outString</th>
<td>A variable to receive the string result of the <var>Unspace</var> method.</td></tr>
<tr><th>string</th>
<td>The input method object string</td></tr>
<tr><th><var>Spaces</var></th>
<td><var class="term">Spaces</var> is an optional, but [[Methods#Named parameters|name required]], parameter, which is a string that specifies the set of characters considered to be whitespace. The default set is the blank space (<code>' '</code>) character. If you specify multiple <var class="term">Spaces</var> characters:<ul><li>There is no separator character.<li>The first character of the string is the replacement space character: a single one of these is substituted for each sequence (which may be one) of non-leading, non-trailing Spaces characters in the method object string.</ul></td></tr>
<tr><th><var>Leading</var></th>
<td><var class="term">Leading</var> is an optional, but <var class="term">Name-Required</var>, parameter, which is a <var>[[Enumerations#Using_Boolean_enumerations|"Boolean Enumeration"]]</var> value that specifies whether to strip all leading whitespace characters. The default is <code>True</code>, strip leading whitespace.</td></tr>
<tr><th><var>Trailing</var></th>
<td><var class="term">Trailing</var> is an optional, but <var class="term">Name-Required</var>, parameter, which is a <var>[[Enumerations#Using_Boolean_enumerations|"Boolean Enumeration"]]</var> value that specifies whether to strip all trailing whitespace characters. The default is <code>True</code>, strip trailing whitespace.</td></tr>
<tr><th><var>Compress</var></th>
<td><var class="term">Compress</var> is an optional, but <var class="term">Name-Required</var>, parameter, which is a <var>[[Enumerations#Using_Boolean_enumerations|"Boolean Enumeration"]]</var> value that specifies whether to collapse sequences of spaces to single spaces. The default is <code>True</code>, collapse such sequences.</td></tr>
</table>

==Usage notes==
<ul><li>Duplicate Spaces characters are tolerated and do not affect the result.
<li>Prior to <var class="product">Sirius Mods</var> Version 7.8, <var>Unspace</var> compressed a string consisting entirely of whitespace characters to a single whitespace character. As of Version 7.8 (and also in Version 7.7 maintenance), <var>Unspace</var> converts a string of whitespace characters to a null string. The Version 7.8 result of
<p class="code">printText {~} = X{' ':unspace}X</p>
is:
<p class="output">' ':unspace = XX
</p>
<li><var>Unspace</var> is available as of <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.3.</ul>

==Examples==
<ol><li>The following are example <var>Unspace</var> statements:
<p class="code">%ls is longstring
%ls = ' so me chars '

[[PrintText statement|printText]] {~} = {%ls:unspace()}
printText {~} = {%ls:unspace(Spaces='X ')}
printText {~} = {%ls:unspace(leading=false)}
printText {~} = {%ls:unspace(trailing=false)}
printText {~} = {%ls:unspace(compress=false)}
</p>
The results are respectively:
<p class="code">%ls:unspace() = so me chars
%ls:unspace(Spaces='X ') = soXmeXchars
%ls:unspace(leading=false) = so me chars
%ls:unspace(trailing=false) = so me chars
%ls:unspace(compress=false) = so me chars
</p></ol>

==See also==
{{Template:String:Unspace footer}}

ToRadians (Float function)

2011-05-04T17:46:32Z

John: Created page with "{{Template:Float:ToRadians subtitle}} The <var>ToRadians</var> <var>intrinsic</var> function converts a number represented in degrees to radians. ==Syntax..."

{{Template:Float:ToRadians subtitle}}

The <var>ToRadians</var> <var>[[Intrinsic classes|intrinsic]]</var> function converts a number represented in degrees to radians.

==Syntax==
{{Template:Float:ToRadians syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%number</th>
<td>A variable to receive the converted radians value. </td></tr>
<tr><th>float</th>
<td>A <var>Float</var> degrees value.</td></tr>
</table>

==Usage notes==
<ul><li><var>ToRadians</var> is available as of <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.8.</ul>

==Examples==
<ol><li>The following displays <code>6.28318530717959</code>:
<p class="code">[[PrintText statement|printText]] {360:toRadians}
</p>
</ol>

==See also==
{{Template:Float:ToRadians footer}}

ToDegrees (Float function)

2011-05-04T17:46:32Z

John: Created page with "{{Template:Float:ToDegrees subtitle}} The <var>ToDegrees</var> <var>intrinsic</var> function converts a number represented in radians to degrees. ==Syntax..."

{{Template:Float:ToDegrees subtitle}}

The <var>ToDegrees</var> <var>[[Intrinsic classes|intrinsic]]</var> function converts a number represented in radians to degrees.

==Syntax==
{{Template:Float:ToDegrees syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%number</th>
<td>A variable to receive the converted degrees value. </td></tr>
<tr><th>float</th>
<td>A <var>Float</var> radians value.</td></tr>
</table>

==Usage notes==
<ul><li><var>ToDegrees</var> is available as of <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.8.</ul>

==Examples==
<ol><li>The following displays <code>180</code>:
<p class="code">[[PrintText statement|printText]] {$pi:toDegrees}
</p>
</ol>

==See also==
{{Template:Float:ToDegrees footer}}

StringTokenizer (String function)

2011-04-13T00:21:16Z

John:

{{Template:String:StringTokenizer subtitle}}

This method returns a new instance of a <var>StringTokenizer</var> object using the method string as the tokenizer string.
It has three optional arguments that let you specify the delimiter characters
that determine the tokens in the string that is being tokenized.
==Syntax==
{{Template:String:StringTokenizer syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%stringTokenizer</th>
<td>A <var>StringTokenizer</var> object expression to contain the new object instance. </td></tr>

<tr><th>string</th>
<td>The string to be tokenized.</td></tr>

<tr><th><var>TokenChars</var></th>
<td>This name required string argument <var>TokenChars</var> is a set of single-character token-delimiters (delimiters that are also tokens) that may be separated by whitespace characters.
<var>TokenChars</var> is an optional argument that defaults to a null string. </td></tr>
<tr><th><var>Spaces</var></th>
<td>This name required string argument <var>Spaces</var> is a set of "whitespace" characters, that is, characters that separate tokens. Each of these characters is a "non-token delimiter," a delimiter that is not itself a token.

<var>Spaces</var> is an optional argument that defaults to a blank character. </td></tr>
<tr><th><var>Quotes</var></th>
<td>This name required string argument <var>Quotes</var> is a set of quotation characters. The text between each disjoint pair of identical quotation characters (a "quoted region") is treated as a single token, and any delimiter characters (Quote, Space, or TokenChar) within a quoted region are treated as non-delimiters.

<var>Quotes</var> is an optional argument that defaults to a null string.</td></tr>

</table>

==Usage notes==
<ul>
<li>A character may belong to at most one of the Spaces,
Quotes, or TokenChars sets of characters.
<li>If you are specifying Spaces, Quotes, or TokenChars,
each character in the string is a quotation
character &mdash; that is, you may not separate characters &mdash; and no character
may repeat (except for apostrophe, which may be doubled).
<li>A quoted region is not affected by the [[TokensToLower (StringTokenizer property)|TokensToLower]]
and [[TokensToUpper (StringTokenizer property)|TokensToUpper]] properties.
</ul>
==Examples==

<p class="code">begin
%tok is object stringtokenizer

%tok = 'foo bar':stringTokenizer

printText {~} is '{%tok:string}'

repeat while not %tok:atEnd
printText {~} is '{%tok:nextToken}'
end repeat
end
</p>

The result is:
<p class="output">%tok:string is 'foo bar'
%tok:nextToken is 'foo'
%tok:nextToken is 'bar'

</p>
==See also==
[[New_(StringTokenizer_constructor)]]
{{Template:String:StringTokenizer footer}}

BitOffString (String function)

2011-04-13T00:21:16Z

John: Created page with "{{Template:String:BitOffString subtitle}} <var>BitOffString</var> turns off a set of bits in one string as indicated by another. ==Syntax== {{Template:String:BitOffString synt..."

{{Template:String:BitOffString subtitle}}

<var>BitOffString</var> turns off a set of bits in one string as indicated by another.

==Syntax==
{{Template:String:BitOffString syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th><td>A string to receive the result of turning off the bits in <var class="term">offBits</var> for <var class="term">string</var>.</td></tr>
<tr><th>string</th>
<td>The string to turn off bits in.</td></tr>
<tr><th>offBits</th>
<td>The bits to turn off.</td></tr>
<tr><th><var>Pad</var></th>
<td>A single character that indicates the character with which the shorter of the two input strings is to be extended. As many copies of <var class="term">pad</var> are used as is required to make the shorter string as long as the longer. If both strings are of equal length, no padding is required. The default value of <var class="term">pad</var> is <code>'00':x</code>.</td></tr>
</table>

==Usage notes==
<ul>
<li>Using a null <var class="term">string</var> for <var class="term">offBits</var> is an easy way of turning off a specific set of bits for each byte in a string (the <var class="term">pad</var> value).
<li><var>BitOffString</var> is most useful for working with binary data, for example binary data being sent or received with <var class="product">[[Janus Sockets]]</var>.
<li><var>BitOffString</var> was introduced in <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> version 7.9.
</ul>

==See also==
{{Template:String:BitOffString footer}}

BitOnString (String function)

2011-04-13T00:21:16Z

John:

{{Template:String:BitOnString subtitle}}

<var>BitOnString</var> sets bits in one string as indicated by another.

==Syntax==
{{Template:String:BitOnString syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th><td>A string to receive the result of setting the bits in <var class="term">onBits</var> for <var class="term">string</var>.</td></tr>
<tr><th>string</th>
<td>The string to set bits in.</td></tr>
<tr><th>onBits</th>
<td>The bits to set.</td></tr>
<tr><th><var>Pad</var></th>
<td>A single character that indicates the character with which the shorter of the two input strings is to be extended. As many copies of <var class="term">pad</var> are used as is required to make the shorter string as long as the longer. If both strings are of equal length, no padding is required. The default value of <var class="term">pad</var> is <code>'00':x</code>.</td></tr>
</table>

==Usage notes==
<ul>
<li>Using a null <var class="term">string</var> for <var class="term">onBits</var> is an easy way of turning on a specific set of bits for each byte in a string (the <var class="term">pad</var> value).
<li><var>BitOnString</var> is most useful for working with binary data, for example binary data being sent or received with <var class="product">[[Janus Sockets]]</var>.
<li><var>BitOnString</var> was introduced in <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> version 7.9.
</ul>

==See also==
{{Template:String:BitOnString footer}}

BitXorString (String function)

2011-04-13T00:21:16Z

John: Created page with "{{Template:String:BitXorString subtitle}} <var>BitXorString</var> does a logical XOR of the bits in two strings. ==Syntax== {{Template:String:BitXorString syntax}} ===Syntax t..."

{{Template:String:BitXorString subtitle}}

<var>BitXorString</var> does a logical XOR of the bits in two strings.

==Syntax==
{{Template:String:BitXorString syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th><td>A string to receive the result of XORing together the bits in <var class="term">string</var> and <var class="term">xorBits</var>.</td></tr>
<tr><th>string</th>
<td>One of the strings to be XORed.</td></tr>
<tr><th>xorBits</th>
<td>The other string to be XORed.</td></tr>
<tr><th><var>Pad</var></th>
<td>A single character that indicates the character with which the shorter of the two input strings is to be extended. As many copies of <var class="term">pad</var> are used as is required to make the shorter string as long as the longer. If both strings are of equal length, no padding is required. The default value of <var class="term">pad</var> is <code>'00':x</code>.</td></tr>
</table>

==Usage notes==
<ul>
<li>Using a null <var class="term">string</var> or <var class="term">xorBits</var> is an easy way of XORing each byte in a string with a specific byte value (the <var class="term">pad</var> value).
<li><var>BitXorString</var> is most useful for working with binary data, for example binary data being sent or received with <var class="product">[[Janus Sockets]]</var>.
<li><var>BitXorString</var> was introduced in <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> version 7.9.
</ul>

==See also==
{{Template:String:BitXorString footer}}

BitOnString and BitOrString (String functions)

2011-04-13T00:21:16Z

John:

{{Template:String:BitOrString subtitle}}

<var>BitOrString</var> does a logical OR of the bits in two strings.

==Syntax==
{{Template:String:BitOrString syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th><td>A string to receive the result of ORing together the bits in <var class="term">string</var> and <var class="term">orBits</var>.</td></tr>
<tr><th>string</th>
<td>One of the strings to be ORed.</td></tr>
<tr><th>orBits</th>
<td>The other string to be ORed.</td></tr>
<tr><th><var>Pad</var></th>
<td>A single character that indicates the character with which the shorter of the two input strings is to be extended. As many copies of <var class="term">pad</var> are used as is required to make the shorter string as long as the longer. If both strings are of equal length, no padding is required. The default value of <var class="term">pad</var> is <code>'00':x</code>.</td></tr>
</table>

==Usage notes==
<ul>
<li>Using a null <var class="term">string</var> for <var class="term">orBits</var> is an easy way of ORing each byte in a string with a specific byte value (the <var class="term">pad</var> value).
<li><var>BitOrString</var> is most useful for working with binary data, for example binary data being sent or received with <var class="product">[[Janus Sockets]]</var>.
<li><var>BitOrString</var> was introduced in <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> version 7.9.
</ul>
==Examples==
<ol><li>The following example converts lower case alphabetic characters to upper case (because EBCDIC A-Z are equal to a-z plus X'40'):
<p class="pre">%upper = %lower:bitOrString('', pad='40':x)
</p>
In, the above code, if <code>%lower</code> were <code>'foobar'</code>, <code>%upper</code> would be set to <code class="output">'FOOBAR'</code>.
</ol>

==See also==
{{Template:String:BitOrString footer}}

BitShiftLeftInteger (Float function)

2011-03-30T12:24:22Z

John: Created page with "{{Template:Float:BitShiftLeftInteger subtitle}} The <var>BitShiftLeftInteger</var> intrinsic function performs a left shift on the bits of an integer. ==S..."

{{Template:Float:BitShiftLeftInteger subtitle}}

The <var>BitShiftLeftInteger</var> [[Intrinsic classes|intrinsic]] function performs a left shift on the bits of an integer.

==Syntax==
{{Template:Float:BitShiftLeftInteger syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th><td>A variable to receive the result of shifting the bits of <var class="term">float</var>.</td></tr>
<tr><th>float</th><td>The float to be shifted.</td></tr>

<tr><th>shift</th><td>The shift length.</td></tr>

</table>

==Usage notes==
<ul><li>The <var>BitShiftLeftInteger</var> function is available as of <var class="product">[[Sirius Mods]]</var> Version 7.9</ul>

==Examples==
<ol><li>The following statement sets %y to 4 times %x:
<p class="code">%y = %x:bitShiftLeftInteger(2)
</p></ol>
==See also==
{{Template:Float:BitShiftLeftInteger footer}}

BitShiftRightInteger (Float function)

2011-03-30T11:59:20Z

John: Created page with "{{Template:Float:BitShiftRightInteger subtitle}} The <var>BitShiftRightInteger</var> intrinsic function performs a logical right shift on the bits of an in..."

{{Template:Float:BitShiftRightInteger subtitle}}

The <var>BitShiftRightInteger</var> [[Intrinsic classes|intrinsic]] function performs a logical right shift on the bits of an integer.

==Syntax==
{{Template:Float:BitShiftRightInteger syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th><td>A variable to receive the result of shifting the bits of <var class="term">float</var>.</td></tr>
<tr><th>float</th><td>The float to be shifted.</td></tr>

<tr><th>shift</th><td>The shift length.</td></tr>

</table>

==Usage notes==
<ul><li>The <var>BitShiftRightInteger</var> function is available as of <var class="product">[[Sirius Mods]]</var> Version 7.9</ul>

==Examples==

==See also==
{{Template:Float:BitShiftRightInteger footer}}

BitXorInteger (Float function)

2011-03-30T11:35:30Z

John: Created page with "{{Template:Float:BitXorInteger subtitle}} The <var>BitXorInteger</var> intrinsic function performs a logical XOR on the bits of two integers. ==Syntax== {..."

{{Template:Float:BitXorInteger subtitle}}

The <var>BitXorInteger</var> [[Intrinsic classes|intrinsic]] function performs a logical XOR on the bits of two integers.

==Syntax==
{{Template:Float:BitXorInteger syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th><td>A variable to receive the result of XORing together the bits of <var class="term">float</var> and <var class="term">xorBits</var>.</td></tr>
<tr><th>float</th><td>One of the floats to be XORed.</td></tr>

<tr><th>xorBits</th><td>The other float to be XORed.</td></tr>

</table>

==Usage notes==
<ul><li>The <var>BitXorInteger</var> function is available as of <var class="product">[[Sirius Mods]]</var> Version 7.9</ul>

==Examples==

==See also==
{{Template:Float:BitXorInteger footer}}

BitOnInteger and BitOrInteger (Float functions)

2011-03-30T11:32:29Z

John: Created page with "{{Template:Float:BitOrInteger subtitle}} The <var>BitOrInteger</var> intrinsic function performs a logical OR on the bits of two integers. ==Syntax== {{Te..."

{{Template:Float:BitOrInteger subtitle}}

The <var>BitOrInteger</var> [[Intrinsic classes|intrinsic]] function performs a logical OR on the bits of two integers.

==Syntax==
{{Template:Float:BitOrInteger syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th><td>A variable to receive the result of ORing together the bits of <var class="term">float</var> and <var class="term">orBits</var>.</td></tr>
<tr><th>float</th><td>One of the floats to be ORed.</td></tr>

<tr><th>orBits</th><td>The other float to be ORed.</td></tr>

</table>

==Usage notes==
<ul><li>The <var>BitOrInteger</var> function is available as of <var class="product">[[Sirius Mods]]</var> Version 7.9</ul>

==Examples==

==See also==
{{Template:Float:BitOrInteger footer}}

BitOnInteger (Float function)

2011-03-30T10:40:03Z

John: /* Syntax terms */

{{Template:Float:BitOnInteger subtitle}}

The <var>BitOnInteger</var> [[Intrinsic classes|intrinsic]] function turns on a set of bits in an integer as indicated by another.

==Syntax==
{{Template:Float:BitOnInteger syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th><td>A variable to receive the result of turning on the bits of <var class="term">onBits</var> in <var class="term">float</var>.</td></tr>
<tr><th>float</th><td>The float to turn on bits in.</td></tr>

<tr><th>onBits</th><td>The bits to turn on.</td></tr>

</table>

==Usage notes==
<ul><li>The <var>BitOnInteger</var> function is available as of <var class="product">[[Sirius Mods]]</var> Version 7.9</ul>

==Examples==

<ol><li>The following statement rounds an integer up to the nearest odd integer:
<p class="code">%y = %x:bitOnInteger(1)
</p></ol>

==See also==
{{Template:Float:BitOnInteger footer}}

BitOnInteger (Float function)

2011-03-30T10:39:38Z

John: Created page with "{{Template:Float:BitOnInteger subtitle}} The <var>BitOnInteger</var> intrinsic function turns on a set of bits in an integer as indicated by another. ==Sy..."

{{Template:Float:BitOnInteger subtitle}}

The <var>BitOnInteger</var> [[Intrinsic classes|intrinsic]] function turns on a set of bits in an integer as indicated by another.

==Syntax==
{{Template:Float:BitOnInteger syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th><td>A variable to receive the result of turning on the bits of <var class="term">onBits</var> in <var class="term">float</var>.</td></tr>
<tr><th>float</th><td>The float to turn on bits in.</td></tr>

<tr><th>offBits</th><td>The bits to turn on.</td></tr>

</table>

==Usage notes==
<ul><li>The <var>BitOnInteger</var> function is available as of <var class="product">[[Sirius Mods]]</var> Version 7.9</ul>

==Examples==

<ol><li>The following statement rounds an integer up to the nearest odd integer:
<p class="code">%y = %x:bitOnInteger(1)
</p></ol>

==See also==
{{Template:Float:BitOnInteger footer}}

BitOffInteger (Float function)

2011-03-30T10:35:09Z

John: Created page with "{{Template:Float:BitOffInteger subtitle}} The <var>BitOffInteger</var> intrinsic function turns off a set of bits in an integer as indicated by another. =..."

{{Template:Float:BitOffInteger subtitle}}

The <var>BitOffInteger</var> [[Intrinsic classes|intrinsic]] function turns off a set of bits in an integer as indicated by another.

==Syntax==
{{Template:Float:BitOffInteger syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th><td>A variable to receive the result of turning off the bits of <var class="term">offBits</var> in <var class="term">float</var>.</td></tr>
<tr><th>float</th><td>The float to turn off bits in.</td></tr>

<tr><th>offBits</th><td>The bits to turn off.</td></tr>

</table>

==Usage notes==
<ul><li>The <var>BitOffInteger</var> function is available as of <var class="product">[[Sirius Mods]]</var> Version 7.9</ul>

==Examples==

==See also==
{{Template:Float:BitOffInteger footer}}

BitAndInteger (Float function)

2011-03-30T10:28:59Z

John: Created page with "{{Template:Float:BitAndInteger subtitle}} The <var>BitAndInteger</var> intrinsic function performs a logical AND on the bits of two integers. ==Syntax== {..."

{{Template:Float:BitAndInteger subtitle}}

The <var>BitAndInteger</var> [[Intrinsic classes|intrinsic]] function performs a logical AND on the bits of two integers.

==Syntax==
{{Template:Float:BitAndInteger syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th><td>A variable to receive the result of ANDing together the bits of <var class="term">float</var> and <var class="term">andBits</var>.</td></tr>
<tr><th>float</th><td>One of the floats to be ANDed.</td></tr>

<tr><th>andBits</th><td>The other float to be ANDed.</td></tr>

</table>

==Usage notes==
<ul><li>The <var>BitAndInteger</var> function is available as of <var class="product">[[Sirius Mods]]</var> Version 7.9</ul>

==Examples==
<ol><li>The following statement checks whether the least significant bit of an integer is set. It sets %y to 1 if %x is odd and 0 if %x is even:
<p class="code">%y = %x:bitAndInteger(1)
</p></ol>

==See also==
{{Template:Float:BitAndInteger footer}}

DaysToString (Float function)

2011-03-29T22:40:12Z

John: /* See also */

{{Template:Float:DaysToString subtitle}}

The <var>DaysToString</var> [[Intrinsic classes|intrinsic]] function operates on a <var>Float</var> value representing days since 1900 and returns a formatted string representing that date/time.

==Syntax==
{{Template:Float:DaysToString syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%string</th><td>A variable to receive the formatted [[Datetime_string_formats|date/time string]] result of the <var>DaysToString</var> method.</td></tr>
<tr><th>float</th><td>A <var>Float</var> value representing days since 1900.</td></tr>
<tr><th>format</th><td>A valid [[Datetime_string_formats|date/time string format]].</td></tr>
</table>

==Usage notes==
<ul><li>The <var>DaysToString</var> function is available as of <var class="product">[[Sirius Mods]]</var> Version 7.8</ul>

==Examples==

==See also==

[[MillisecondsToString_(Float_function)]]

[[SecondsToString_(Float_function)]]

{{Template:Float:DaysToString footer}}

DaysToString (Float function)

2011-03-29T22:40:02Z

John: /* See also */

SecondsToString (Float function)

2011-03-29T22:39:42Z

John: /* See also */

{{Template:Float:SecondsToString subtitle}}

The <var>SecondsToString</var> [[Intrinsic classes|intrinsic]] function operates on a <var>Float</var> value representing seconds since 1900 and returns a formatted string representing that date/time.

==Syntax==
{{Template:Float:SecondsToString syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%string</th><td>A variable to receive the formatted [[Datetime_string_formats|date/time string]] result of the <var>SecondsToString</var> method.</td></tr>
<tr><th>float</th><td>A <var>Float</var> value representing seconds since 1900.</td></tr>
<tr><th>format</th><td>A valid [[Datetime_string_formats|date/time string format]].</td></tr>
</table>

==Usage notes==
<ul><li>The <var>SecondsToString</var> function is available as of <var class="product">[[Sirius Mods]]</var> Version 7.8</ul>

==Examples==

==See also==
[[MillisecondsToString_(Float_function)]]

[[DaysToString_(Float_function)]]

{{Template:Float:SecondsToString footer}}

SecondsToString (Float function)

2011-03-29T22:39:33Z

John: /* See also */

MillisecondsToString (Float function)

2011-03-29T22:39:11Z

John: /* See also */

{{Template:Float:MillisecondsToString subtitle}}

The <var>MillisecondsToString</var> [[Intrinsic classes|intrinsic]] function operates on a <var>Float</var> value representing milliseconds since 1900 and returns a formatted string representing that date/time.

==Syntax==
{{Template:Float:MillisecondsToString syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%string</th><td>A variable to receive the formatted [[Datetime_string_formats|date/time string]] result of the <var>MillisecondsToString</var> method.</td></tr>
<tr><th>float</th><td>A <var>Float</var> value representing milliseconds since 1900.</td></tr>
<tr><th>format</th><td>A valid [[Datetime_string_formats|date/time string format]].</td></tr>
</table>

==Usage notes==
<ul><li>The <var>MillisecondsToString</var> function is available as of <var class="product">[[Sirius Mods]]</var> Version 7.8</ul>

==Examples==

==See also==
[[SecondsToString_(Float_function)]]

[[DaysToString_(Float_function)]]

{{Template:Float:MillisecondsToString footer}}

MillisecondsToString (Float function)

2011-03-29T22:39:00Z

John: /* See also */

MillisecondsToString (Float function)

2011-03-29T22:38:47Z

John: Created page with "{{Template:Float:MillisecondsToString subtitle}} The <var>MillisecondsToString</var> intrinsic function operates on a <var>Float</var> value representing m..."

{{Template:Float:MillisecondsToString subtitle}}

The <var>MillisecondsToString</var> [[Intrinsic classes|intrinsic]] function operates on a <var>Float</var> value representing milliseconds since 1900 and returns a formatted string representing that date/time.

==Syntax==
{{Template:Float:MillisecondsToString syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%string</th><td>A variable to receive the formatted [[Datetime_string_formats|date/time string]] result of the <var>MillisecondsToString</var> method.</td></tr>
<tr><th>float</th><td>A <var>Float</var> value representing milliseconds since 1900.</td></tr>
<tr><th>format</th><td>A valid [[Datetime_string_formats|date/time string format]].</td></tr>
</table>

==Usage notes==
<ul><li>The <var>MillisecondsToString</var> function is available as of <var class="product">[[Sirius Mods]]</var> Version 7.8</ul>

==Examples==

==See also==
[[SecondsToString_(Float_function)]]
[[DaysToString_(Float_function)]]
{{Template:Float:MillisecondsToString footer}}

SecondsToString (Float function)

2011-03-29T22:37:01Z

John:

DaysToString (Float function)

2011-03-29T22:36:25Z

John:

SecondsToString (Float function)

2011-03-29T22:36:07Z

John:

{{Template:Float:SecondsToString subtitle}}

The <var>SecondsToString</var> [[Intrinsic classes|intrinsic]] function operates on a <var>Float</var> value representing seconds since 1900 and returns a formatted string representing that date/time.

==Syntax==
{{Template:Float:SecondsToString syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%string</th><td>A variable to receive the formatted [[Datetime_string_formats|date/time string]] result of the <var>SecondsToString</var> method.</td></tr>
<tr><th>float</th><td>A <var>Float</var> value representing seconds since 1900.</td></tr>
<tr><th>format</th><td>A valid [[Datetime_string_formats|date/time string]].</td></tr>
</table>

==Usage notes==
<ul><li>The <var>SecondsToString</var> function is available as of <var class="product">[[Sirius Mods]]</var> Version 7.8</ul>

==Examples==

==See also==
{{Template:Float:SecondsToString footer}}

SecondsToString (Float function)

2011-03-29T22:35:26Z

John: Created page with "{{Template:Float:SecondsToString subtitle}} The <var>SecondsToString</var> intrinsic function operates on a <var>Float</var> value representing seconds sin..."

{{Template:Float:SecondsToString subtitle}}

The <var>SecondsToString</var> [[Intrinsic classes|intrinsic]] function operates on a <var>Float</var> value representing seconds since 1900 and returns a formatted string representing that date/time.

==Syntax==
{{Template:Float:SecondsToString syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%string</th><td>A variable to receive the formatted [[Datetime_string_formats|date/time string]] result of the <var>SecondsToString</var> method.</td></tr>
<tr><th>float</th><td>A <var>Float</var> value representing seconds since 1900.</td></tr>
<tr><th>format</th><td>A valid date/time string format</td></tr>
</table>

==Usage notes==
<ul><li>The <var>SecondsToString</var> function is available as of <var class="product">[[Sirius Mods]]</var> Version 7.8</ul>

==Examples==

==See also==
{{Template:Float:SecondsToString footer}}

DaysToString (Float function)

2011-03-29T22:33:25Z

John:

{{Template:Float:DaysToString subtitle}}

The <var>DaysToString</var> [[Intrinsic classes|intrinsic]] function operates on a <var>Float</var> value representing days since 1900 and returns a formatted string representing that date/time.

==Syntax==
{{Template:Float:DaysToString syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%string</th><td>A variable to receive the formatted [[Datetime_string_formats|date/time string]] result of the <var>DaysToString</var> method.</td></tr>
<tr><th>float</th><td>A <var>Float</var> value representing days since 1900.</td></tr>
<tr><th>format</th><td>A valid date/time string format</td></tr>
</table>

==Usage notes==
<ul><li>The <var>DaysToString</var> function is available as of <var class="product">[[Sirius Mods]]</var> Version 7.8</ul>

==Examples==

==See also==
{{Template:Float:DaysToString footer}}

DaysToString (Float function)

2011-03-29T22:32:57Z

John: Created page with "{{Template:Float:DaysToString subtitle}} The <var>DaysToString</var> intrinsic function operates on a <var>Float</var> value representing days since 1900 a..."

{{Template:Float:DaysToString subtitle}}

The <var>DaysToString</var> [[Intrinsic classes|intrinsic]] function operates on a <var>Float</var> value representing days since 1900 and returns a formatted string representing that date/time.

==Syntax==
{{Template:Float:DaysToString syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%string</th><td>A variable to receive the formatted [[Datetime_string_formats|date/time string]] result of the <var>DaysToString</var> method.</td></tr>
<tr><th>float</th><td>A <var>Float</var> value representing days since 1900.</td></tr>
<tr><th>format</th><td>A valid date/time string format</td></tr>
</table>

==Usage notes==
<ul><li>The <var>Absolute</var> function is available as of <var class="product">[[Sirius Mods]]</var> Version 7.8</ul>

==Examples==

==See also==
{{Template:Float:DaysToString footer}}

ToRadians (Float function)

2011-03-29T20:21:26Z

John: Created page with "{{Template:Float:ToRadians subtitle}} The <var>ToRadians</var> <var>intrinsic</var> function converts a number represented in degrees to radians. ==Syntax..."

{{Template:Float:ToRadians subtitle}}

The <var>ToRadians</var> <var>[[Intrinsic classes|intrinsic]]</var> function converts a number represented in degrees to radians.

==Syntax==
{{Template:Float:ToRadians syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%number</th>
<td>A variable to receive the converted radians value. </td></tr>
<tr><th>float</th>
<td>A <var>Float</var> degrees value.</td></tr>
</table>

==Usage notes==
<ul><li><var>ToRadians</var> is available as of <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> Version 7.8.</ul>

==Examples==
<ol><li>The following displays <code>6.28318530717959</code>:
<p class="code">[[PrintText statement|printText]] {360:toRadians}
</p>
</ol>

==See also==
{{Template:Float:ToRadians footer}}

ToDegrees (Float function)

2011-03-29T20:16:01Z

John: Created page with "{{Template:Float:ToDegrees subtitle}} The <var>ToDegrees</var> <var>intrinsic</var> function converts a number represented in radians to degrees. ==Syntax..."

{{Template:Float:ToDegrees subtitle}}

The <var>ToDegrees</var> <var>[[Intrinsic classes|intrinsic]]</var> function converts a number represented in radians to degrees.

==Syntax==
{{Template:Float:ToDegrees syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%number</th>
<td>A variable to receive the converted degrees value. </td></tr>
<tr><th>float</th>
<td>A <var>Float</var> radians value.</td></tr>
</table>

==Usage notes==
<ul><li><var>ToDegrees</var> is available as of <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> Version 7.8.</ul>

==Examples==
<ol><li>The following displays <code>180</code>:
<p class="code">[[PrintText statement|printText]] {$pi:toDegrees}
</p>
</ol>

==See also==
{{Template:Float:ToDegrees footer}}

StringToSeconds (String function)

2011-03-29T20:00:30Z

John: Created page with "{{Template:String:StringToSeconds subtitle}} <var>StringToSeconds</var> is an <var>intrinsic</var> function to convert a [[Datetime_string_formats|date/tim..."

{{Template:String:StringToSeconds subtitle}}

<var>StringToSeconds</var> is an <var>[[Intrinsic classes|intrinsic]]</var> function to convert a [[Datetime_string_formats|date/time string]] to seconds since 1900.

==Syntax==
{{Template:String:StringToSeconds syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%seconds</th>
<td>The float variable to receive the computed time since 1900.</td></tr>
<tr><th>string</th>
<td>The input date/time string.</td></tr>
<tr><th>format</th>
<td>The format of the date/time string.</td></tr>
<tr><th>centspan</th>
<td>See [[CENTSPAN_parameter]].</td/tr>
</table>

==Usage notes==

==Examples==

==See also==
[[StringToMilliseconds_(String_function)]]

[[StringToDays_(String_function)]]

{{Template:String:StringToSeconds footer}}

StringToDays (String function)

2011-03-29T19:59:20Z

John: Created page with "{{Template:String:StringToDays subtitle}} <var>StringToDays</var> is an <var>intrinsic</var> function to convert a [[Datetime_string_formats|date/time stri..."

{{Template:String:StringToDays subtitle}}

<var>StringToDays</var> is an <var>[[Intrinsic classes|intrinsic]]</var> function to convert a [[Datetime_string_formats|date/time string]] to days since 1900.

==Syntax==
{{Template:String:StringToDays syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%days</th>
<td>The float variable to receive the computed time since 1900.</td></tr>
<tr><th>string</th>
<td>The input date/time string.</td></tr>
<tr><th>format</th>
<td>The format of the date/time string.</td></tr>
<tr><th>centspan</th>
<td>See [[CENTSPAN_parameter]].</td/tr>
</table>

==Usage notes==

==Examples==

==See also==
[[StringToMilliseconds_(String_function)]]

[[StringToSeconds_(String_function)]]

{{Template:String:StringToDays footer}}

StringToMilliseconds (String function)

2011-03-29T15:23:24Z

John: Created page with "{{Template:String:StringToMilliseconds subtitle}} <var>StringToMilliseconds</var> is an <var>intrinsic</var> function to convert a [[Datetime_string_format..."

{{Template:String:StringToMilliseconds subtitle}}

<var>StringToMilliseconds</var> is an <var>[[Intrinsic classes|intrinsic]]</var> function to convert a [[Datetime_string_formats|date/time string]] to milliseconds since 1900.

==Syntax==
{{Template:String:StringToMilliseconds syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%milliseconds</th>
<td>The float variable to receive the computed time since 1900.</td></tr>
<tr><th>string</th>
<td>The input date/time string.</td></tr>
<tr><th>format</th>
<td>The format of the date/time string.</td></tr>
<tr><th>centspan</th>
<td>See [[CENTSPAN_parameter]].</td/tr>
</table>

==Usage notes==

==Examples==

==See also==
[[StringToSeconds_(String_function)]]

[[StringToDays_(String_function)]]

{{Template:String:StringToMilliseconds footer}}

StringTokenizer (String function)

2011-03-29T14:13:39Z

John:

{{Template:String:StringTokenizer subtitle}}

This method returns a new instance of a <var>StringTokenizer</var> object using the method string as the tokenizer string.
It has three optional arguments that let you specify the delimiter characters
that determine the tokens in the string that is being tokenized.
==Syntax==
{{Template:String:StringTokenizer syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%stringTokenizer</th>
<td>A <var>StringTokenizer</var> object expression to contain the new object instance. </td></tr>

<tr><th>string</th>
<td>The string to be tokenized.</td></tr>

<tr><th>TokenChars</th>
<td>This name required string argument <var>TokenChars</var> is a set of single-character token-delimiters (delimiters that are also tokens) that may be separated by whitespace characters.
<var>TokenChars</var> is an optional argument that defaults to a null string. </td></tr>
<tr><th>Spaces</th>
<td>This name required string argument <var>Spaces</var> is a set of "whitespace" characters, that is, characters that separate tokens. Each of these characters is a "non-token delimiter," a delimiter that is not itself a token.

<var>Spaces</var> is an optional argument that defaults to a blank character. </td></tr>
<tr><th>Quotes</th>
<td>This name required string argument <var>Quotes</var> is a set of quotation characters. The text between each disjoint pair of identical quotation characters (a "quoted region") is treated as a single token, and any delimiter characters (Quote, Space, or TokenChar) within a quoted region are treated as non-delimiters.

<var>Quotes</var> is an optional argument that defaults to a null string.</td></tr>

</table>

==Usage notes==
<ul>
<li>A character may belong to at most one of the Spaces,
Quotes, or TokenChars sets of characters.
<li>If you are specifying Spaces, Quotes, or TokenChars,
each character in the string is a quotation
character — that is, you may not separate characters — and no character
may repeat (except for apostrophe, which may be doubled).
<li>A quoted region is not affected by the [[TokensToLower (StringTokenizer property)|TokensToLower]]
and [[TokensToUpper (StringTokenizer property)|TokensToUpper]] properties.
</ul>
==Examples==

<p class="code">begin
%tok is object stringtokenizer

%tok = 'foo bar':stringTokenizer

printText {~} is '{%tok:string}'

repeat while not %tok:atEnd
printText {~} is '{%tok:nextToken}'
end repeat
end
</p>

The result is:
<p class="output">%tok:string is 'foo bar'
%tok:nextToken is 'foo'
%tok:nextToken is 'bar'

</p>
==See also==
[[New_(StringTokenizer_constructor)]]
{{Template:String:StringTokenizer footer}}

StringTokenizer (String function)

2011-03-29T14:07:16Z

John: Created page with "{{Template:String:StringTokenizer subtitle}} This method returns a new instance of a <var>StringTokenizer</var> object using the method string as the tokenizer string. It has th..."

{{Template:String:StringTokenizer subtitle}}

This method returns a new instance of a <var>StringTokenizer</var> object using the method string as the tokenizer string.
It has three optional arguments that let you specify the delimiter characters
that determine the tokens in the string that is being tokenized.
==Syntax==
{{Template:String:StringTokenizer syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%stringTokenizer</th>
<td>A <var>StringTokenizer</var> object expression to contain the new object instance. </td></tr>

<tr><th>string</th>
<td>The string to be tokenized.</td></tr>

<tr><th>TokenChars</th>
<td>This name required string argument <var>TokenChars</var> is a set of single-character token-delimiters (delimiters that are also tokens) that may be separated by whitespace characters.
<var>TokenChars</var> is an optional argument that defaults to a null string. </td></tr>
<tr><th>Spaces</th>
<td>This name required string argument <var>Spaces</var> is a set of "whitespace" characters, that is, characters that separate tokens. Each of these characters is a "non-token delimiter," a delimiter that is not itself a token.

<var>Spaces</var> is an optional argument that defaults to a blank character. </td></tr>
<tr><th>Quotes</th>
<td>This name required string argument <var>Quotes</var> is a set of quotation characters. The text between each disjoint pair of identical quotation characters (a "quoted region") is treated as a single token, and any delimiter characters (Quote, Space, or TokenChar) within a quoted region are treated as non-delimiters.

<var>Quotes</var> is an optional argument that defaults to a null string.</td></tr>

</table>

==Usage notes==
<ul>
<li>A character may belong to at most one of the Spaces,
Quotes, or TokenChars sets of characters.
<li>If you are specifying Spaces, Quotes, or TokenChars,
each character in the string is a quotation
character — that is, you may not separate characters — and no character
may repeat (except for apostrophe, which may be doubled).
<li>A quoted region is not affected by the [[TokensToLower (StringTokenizer property)|TokensToLower]]
and [[TokensToUpper (StringTokenizer property)|TokensToUpper]] properties.
</ul>
==Examples==

<p class="code">begin
%tok is object stringtokenizer

%tok = 'foo bar':stringTokenizer

printText {~} is '{%tok:string}'

repeat while not %tok:atEnd
printText {~} is '{%tok:nextToken}'
end repeat
end
</p>

The result is:
<p class="output">%tok:string is 'foo bar'
%tok:nextToken is 'foo'
%tok:nextToken is 'bar'

</p>
==See also==
{{Template:String:StringTokenizer footer}}

BitOffString (String function)

2011-03-29T03:35:58Z

{{Template:String:BitOffString subtitle}}

<var>BitOffString</var> turns off a set of bits in one string as indicated by another.

==Syntax==
{{Template:String:BitOffString syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th><td>A string to receive the result of turning off the bits in <var class="term">offBits</var> for <var class="term">string</var>.</td></tr>
<tr><th>string</th>
<td>The string to turn off bits in.</td></tr>
<tr><th>offBits</th>
<td>The bits to turn off.</td></tr>
<tr><th>Pad</th>
<td>A single character that indicates the character with which the shorter of the two input strings is to be extended. As many copies of <var class="term">pad</var> are used as is required to make the shorter string as long as the longer. If both strings are of equal length, no padding is required. The default value of <var class="term">pad</var> is <code>'00':x</code>.</td></tr>
</table>

==Usage notes==
<ul>
<li>Using a null <var class="term">string</var> for <var class="term">offBits</var> is an easy way of turning off a specific set of bits for each byte in a string (the <var class="term">pad</var> value).
<li><var>BitOffString</var> is most useful for working with binary data, for example binary data being sent or received with <var class="product">[[Janus Sockets]]</var>.
<li><var>BitOffString</var> was introduced in <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> version 7.9.
</ul>

==See also==
{{Template:String:BitOffString footer}}

BitOnString and BitOrString (String functions)

2011-03-29T03:32:49Z

John:

{{Template:String:BitOrString subtitle}}

<var>BitOrString</var> does a logical OR of the bits in two strings.

==Syntax==
{{Template:String:BitOrString syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th><td>A string to receive the result of ORing together the bits in <var class="term">string</var> and <var class="term">orBits</var>.</td></tr>
<tr><th>string</th>
<td>One of the strings to be ORed.</td></tr>
<tr><th>orBits</th>
<td>The other string to be ORed.</td></tr>
<tr><th>Pad</th>
<td>A single character that indicates the character with which the shorter of the two input strings is to be extended. As many copies of <var class="term">pad</var> are used as is required to make the shorter string as long as the longer. If both strings are of equal length, no padding is required. The default value of <var class="term">pad</var> is <code>'00':x</code>.</td></tr>
</table>

==Usage notes==
<ul>
<li>Using a null <var class="term">string</var> for <var class="term">orBits</var> is an easy way of ORing each byte in a string with a specific byte value (the <var class="term">pad</var> value).
<li><var>BitOrString</var> is most useful for working with binary data, for example binary data being sent or received with <var class="product">[[Janus Sockets]]</var>.
<li><var>BitOrString</var> was introduced in <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> version 7.9.
</ul>
==Examples==
<ol><li>The following example converts lower case alphabetic characters to upper case (because EBCDIC A-Z are equal to a-z plus X'40'):
<p class="pre">%upper = %lower:bitOrString('', pad='40':x)
</p>
In, the above code, if <code>%lower</code> were <code>'foobar'</code>, <code>%upper</code> would be set to <code class="output">'FOOBAR'</code>.
</ol>

==See also==
{{Template:String:BitOrString footer}}

BitOnString (String function)

2011-03-29T03:32:40Z

John:

{{Template:String:BitOnString subtitle}}

<var>BitOnString</var> sets bits in one string as indicated by another.

==Syntax==
{{Template:String:BitOnString syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th><td>A string to receive the result of setting the bits in <var class="term">onBits</var> for <var class="term">string</var>.</td></tr>
<tr><th>string</th>
<td>The string to set bits in.</td></tr>
<tr><th>onBits</th>
<td>The bits to set.</td></tr>
<tr><th>Pad</th>
<td>A single character that indicates the character with which the shorter of the two input strings is to be extended. As many copies of <var class="term">pad</var> are used as is required to make the shorter string as long as the longer. If both strings are of equal length, no padding is required. The default value of <var class="term">pad</var> is <code>'00':x</code>.</td></tr>
</table>

==Usage notes==
<ul>
<li>Using a null <var class="term">string</var> for <var class="term">onBits</var> is an easy way of turning on a specific set of bits for each byte in a string (the <var class="term">pad</var> value).
<li><var>BitOnString</var> is most useful for working with binary data, for example binary data being sent or received with <var class="product">[[Janus Sockets]]</var>.
<li><var>BitOnString</var> was introduced in <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> version 7.9.
</ul>

==See also==
{{Template:String:BitOnString footer}}

BitAndString (String function)

2011-03-29T03:32:19Z

John:

{{Template:String:BitAndString subtitle}}

<var>BitAndString</var> does a logical AND of the bits in two strings.

==Syntax==
{{Template:String:BitAndString syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th><td>A string to receive the result of ANDing together the bits in <var class="term">string</var> and <var class="term">andBits</var>.</td></tr>
<tr><th>string</th>
<td>One of the strings to be ANDed.</td></tr>
<tr><th>andBits</th>
<td>The other string to be ANDed.</td></tr>
<tr><th>Pad</th>
<td>A single character that indicates the character with which the shorter of the two input strings is to be extended. As many copies of <var class="term">pad</var> are used as is required to make the shorter string as long as the longer. If both strings are of equal length, no padding is required. The default value of <var class="term">pad</var> is <code>'00':x</code>.</td></tr>
</table>

==Usage notes==
<ul>
<li>Using a null <var class="term">string</var> for <var class="term">andBits</var> is an easy way of ANDing each byte in a string with a specific byte value (the <var class="term">pad</var> value).
<li><var>BitAndString</var> is most useful for working with binary data, for example binary data being sent or received with <var class="product">[[Janus Sockets]]</var>.
<li><var>BitAndString</var> was introduced in <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> version 7.9.
</ul>

==Examples==
<ol><li>The following example turns off the low order bit of a numeric value's string representation, rounding every digit down to an even number (because EBCDIC binary digits map 0-9 to hex values X'F0'-X'F9'):
<p class="pre">%evenDigits = %digits:bitAndString('', pad='FE':x)
</p>
In, the above code, if <code>%digits</code> were <code>'31415926'</code>, <code>%evenDigits</code> would be set to <code class="output">'20404826'</code>.

<li>The following example:
<p class="pre">[[PrintText statement|printText]] {~='Red':bitAndString('Green', pad='FF':x)}
</p>
outputs
<p class="output">'Red':bitAndString('Green', pad='FF':x)=Aaden
</p>
To see why this is correct run the following:
<p class="pre">printText {~='Red':stringToHex}
printText {~='Green':stringToHex}
printText {~='Red':bitAndString('Green', pad='FF':x):stringToHex}
</p>
which outputs
<p class="output">'Red':stringToHex=D98584
'Green':stringToHex=C799858595
'Red':bitAndString('Green', pad='FF':x):stringToHex=C181848595
</p></ol>

==See also==
{{Template:String:BitAndString footer}}

BitOnString (String function)

2011-03-29T03:31:38Z

John:

{{Template:String:BitOnString subtitle}}

<var>BitOnString</var> sets bits in one string as indicated by another.

==Syntax==
{{Template:String:BitOnString syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th><td>A string to receive the result of setting the bits in <var class="term">onBits</var> for <var class="term">string</var>.</td></tr>
<tr><th>string</th>
<td>The string to set bits in.</td></tr>
<tr><th>onBits</th>
<td>The bits to set.</td></tr>
<tr><th>Pad</th>
<td>A single character that indicates the character with which the shorter of the two input strings is to be extended. As many copies of <var class="term">pad</var> are used as is required to make the shorter string as long as the longer. If both strings are of equal length, no padding is required. The default value of <var class="term">pad</var> is <code>'00':x</code>.</td></tr>
</table>

==Usage notes==
<ul>
<li>Using a null <var class="term">string</var> or <var class="term">onBits</var> is an easy way of turning on a specific set of bits for each byte in a string (the <var class="term">pad</var> value).
<li><var>BitOnString</var> is most useful for working with binary data, for example binary data being sent or received with <var class="product">[[Janus Sockets]]</var>.
<li><var>BitOnString</var> was introduced in <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> version 7.9.
</ul>

==See also==
{{Template:String:BitOnString footer}}

BitOnString (String function)

2011-03-29T03:30:54Z

John: Created page with "{{Template:String:BitOnString subtitle}} <var>BitOnString</var> sets bits in one string as indicated by another. ==Syntax== {{Template:String:BitOnString syntax}} ===Syntax te..."

{{Template:String:BitOnString subtitle}}

<var>BitOnString</var> sets bits in one string as indicated by another.

==Syntax==
{{Template:String:BitOnString syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th><td>A string to receive the result of setting the bits in <var class="term">onBits</var> for <var class="term">string</var>.</td></tr>
<tr><th>string</th>
<td>The string to set bits in.</td></tr>
<tr><th>onBits</th>
<td>The bits to set.</td></tr>
<tr><th>Pad</th>
<td>A single character that indicates the character with which the shorter of the two input strings is to be extended. As many copies of <var class="term">pad</var> are used as is required to make the shorter string as long as the longer. If both strings are of equal length, no padding is required. The default value of <var class="term">pad</var> is <code>'00':x</code>.</td></tr>
</table>

==Usage notes==
<ul>
<li>Using a null <var class="term">string</var> or <var class="term">orBits</var> is an easy way of turning on a specific set of bits for each byte in a string (the <var class="term">pad</var> value).
<li><var>BitOnString</var> is most useful for working with binary data, for example binary data being sent or received with <var class="product">[[Janus Sockets]]</var>.
<li><var>BitOnString</var> was introduced in <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> version 7.9.
</ul>

==See also==
{{Template:String:BitOnString footer}}

BitXorString (String function)

2011-03-28T21:39:45Z

{{Template:String:BitXorString subtitle}}

<var>BitXorString</var> does a logical XOR of the bits in two strings.

==Syntax==
{{Template:String:BitXorString syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th><td>A string to receive the result of XORing together the bits in <var class="term">string</var> and <var class="term">xorBits</var>.</td></tr>
<tr><th>string</th>
<td>One of the strings to be XORed.</td></tr>
<tr><th>xorBits</th>
<td>The other string to be XORed.</td></tr>
<tr><th>Pad</th>
<td>A single character that indicates the character with which the shorter of the two input strings is to be extended. As many copies of <var class="term">pad</var> are used as is required to make the shorter string as long as the longer. If both strings are of equal length, no padding is required. The default value of <var class="term">pad</var> is <code>'00':x</code>.</td></tr>
</table>

==Usage notes==
<ul>
<li>Using a null <var class="term">string</var> or <var class="term">xorBits</var> is an easy way of XORing each byte in a string with a specific byte value (the <var class="term">pad</var> value).
<li><var>BitXorString</var> is most useful for working with binary data, for example binary data being sent or received with <var class="product">[[Janus Sockets]]</var>.
<li><var>BitXorString</var> was introduced in <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> version 7.9.
</ul>

==See also==
{{Template:String:BitXorString footer}}

BitOnString and BitOrString (String functions)

2011-03-28T21:12:08Z

John: Created page with "{{Template:String:BitOrString subtitle}} <var>BitOrString</var> does a logical OR of the bits in two strings. ==Syntax== {{Template:String:BitOrString syntax}} ===Syntax terms..."

{{Template:String:BitOrString subtitle}}

<var>BitOrString</var> does a logical OR of the bits in two strings.

==Syntax==
{{Template:String:BitOrString syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th><td>A string to receive the result of ORing together the bits in <var class="term">string</var> and <var class="term">orBits</var>.</td></tr>
<tr><th>string</th>
<td>One of the strings to be ORed.</td></tr>
<tr><th>orBits</th>
<td>The other string to be ORed.</td></tr>
<tr><th>Pad</th>
<td>A single character that indicates the character with which the shorter of the two input strings is to be extended. As many copies of <var class="term">pad</var> are used as is required to make the shorter string as long as the longer. If both strings are of equal length, no padding is required. The default value of <var class="term">pad</var> is <code>'00':x</code>.</td></tr>
</table>

==Usage notes==
<ul>
<li>Using a null <var class="term">string</var> or <var class="term">orBits</var> is an easy way of ORing each byte in a string with a specific byte value (the <var class="term">pad</var> value).
<li><var>BitOrString</var> is most useful for working with binary data, for example binary data being sent or received with <var class="product">[[Janus Sockets]]</var>.
<li><var>BitOrString</var> was introduced in <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> version 7.9.
</ul>
==Examples==
<ol><li>The following example converts lower case alphabetic characters to upper case (because EBCDIC A-Z are equal to a-z plus X'40'):
<p class="pre">%upper = %lower:bitOrString('', pad='40':x)
</p>
In, the above code, if <code>%lower</code> were <code>'foobar'</code>, <code>%upper</code> would be set to <code class="output">'FOOBAR'</code>.
</ol>

==See also==
{{Template:String:BitOrString footer}}

MediaWiki:Googlesearchheader

2011-03-27T16:38:06Z

John: Created page with "== Google Search =="

== Google Search ==

Pop (Arraylist function)

2011-01-19T23:27:39Z

John:

{{Template:Arraylist:Pop subtitle}}
[[Category:Arraylist methods|Pop function]]

<p>
Pop is a member of the [[Arraylist class]].
</p>

This callable function returns the current contents of the last item
in the method object Arraylist; then it removes that item.

Pop is available in ''Sirius Mods'' version 7.0 and later.
==Syntax==
{{Template:Arraylist:Pop syntax}}
===Syntax terms===
<dl>
<dt><i>%item</i>
<dd>A variable of the same
type as specified on the ''%arrayl'' declaration
to contain the contents of the last ''%arrayl'' item.
<dt><i>%arrayl</i>
<dd>An Arraylist object.

</dl>
==Usage notes==
<ul>
<li>The Pop method for object %arrayl is equivalent to
specifying <tt>%arrayl:[[Item (Arraylist property)|Item]](%arrayl:Count)</tt>
followed by <tt>%arrayl:[[RemoveItem (Arraylist function)|RemoveItem]](%arrayl:Count)</tt>.
<li>[[LastItem (Arraylist property)|LastItem]]
returns the last item of an Arraylist without removing it.
[[Dequeue (Arraylist function)|Dequeue]]
returns the first item of an Arraylist, then removes it.
<li>The [[Push (Arraylist function)|Push]] function, a synonym for Add,
appends an item to an Arraylist.
</ul>

Dequeue (Arraylist function)

2011-01-19T23:27:39Z

John:

{{Template:Arraylist:Dequeue subtitle}}
[[Category:Arraylist methods|Dequeue function]]

<p>
Dequeue is a member of the [[Arraylist class]].
</p>

This callable function returns the current contents of the first item
in the method object Arraylist; then it removes that item.

Dequeue is available in ''Sirius Mods'' version 7.0 and later.
==Syntax==
{{Template:Arraylist:Dequeue syntax}}
===Syntax terms===
<dl>
<dt><i>%item</i>
<dd>A variable of the same
type as specified on the ''%arrayl'' declaration
to contain the contents of the first ''%arrayl'' item.
<dt><i>%arrayl</i>
<dd>An Arraylist object.

</dl>
==Usage notes==
<ul>
<li>The Dequeue method for object %arrayl is equivalent to
specifying <tt>%arrayl:[[Item (Arraylist property)|Item]](1)</tt>
followed by <tt>%arrayl:[[RemoveItem (Arraylist function)|RemoveItem]](1)</tt>.
<li>The [[FirstItem (Arraylist property)|FirstItem]] property
returns the first item of an Arraylist without removing it.
The [[Pop (Arraylist function)|Pop]] function
returns the last item of an Arraylist, then removes it.
</ul>

Pop (Stringlist function)

2011-01-04T22:04:24Z

John:

{{Template:Stringlist:Pop subtitle}}

This callable method returns the current contents of the last item in the method object Stringlist, then it removes that last item. Pop is available in ''[[Sirius Mods]]'' version 7.0 and later.

Pop is a member of the [[Stringlist class]].

==Syntax==
{{Template:Stringlist:Pop syntax}}
===Syntax terms===
<dl>
<dt>%string
<dd>This longstring is to contain the contents of the last item in '''%sl'''.
<dt>%sl
<dd>A Stringlist object.
</dl>

==Usage notes==
<ul>
<li>All errors in Pop result in request cancellation.
<li>The [[LastItem (Stringlist function)]] returns the last item of a Stringlist without removing it. The [[Push (Stringlist function)]], a synonym for the [[Add (Stringlist function)]], appends a string to a Stringlist.
</ul>

[[Category:Stringlist methods|Pop function]]

Dequeue (Stringlist function)

2011-01-04T22:03:59Z

John:

{{Template:Stringlist:Dequeue subtitle}}

This callable method returns the current contents of the first item in the method object Stringlist, then it removes that first item. Dequeue is available in ''[[Sirius Mods]]'' version 7.0 and later.

Dequeue is a member of the [[Stringlist class]].

==Syntax==
{{Template:Stringlist:Dequeue syntax}}
===Syntax terms===
<dl>
<dt>%string
<dd>This longstring is to contain the contents of the first item in '''%sl'''.
<dt>%sl
<dd>A Stringlist object.
</dl>

==Usage notes==
<ul>
<li>All errors in Dequeue result in request cancellation.
<li>The [[FirstItem (Stringlist function)]] returns the first item of a Stringlist without removing it. The [[Pop (Stringlist function)]] returns the last item of a Stringlist, then removes it.
</ul>

[[Category:Stringlist methods|Dequeue function]]