BitOffString (String function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{Template:String:BitOffString subtitle}} | {{Template:String:BitOffString subtitle}} | ||
<var>BitOffString</var> turns off a set of bits in one string as indicated by another. | <var>BitOffString</var> turns off a set of bits in one string as indicated by another. | ||
| Line 7: | Line 6: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <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 nowrap>%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> | <tr><th>string</th> | ||
<td>The string to turn off bits in.</td></tr> | <td>The string to turn off bits in.</td></tr> | ||
| Line 24: | Line 23: | ||
==See also== | ==See also== | ||
<table> | |||
<tr> | |||
<td> | |||
<ul> | <ul> | ||
<li><var>[[BitAndString (String function)|BitAndString]]</var> | <li><var>[[BitAndString (String function)|BitAndString]]</var> | ||
| Line 30: | Line 32: | ||
<li><var>[[BitXorString (String function)|BitXorString]]</var> | <li><var>[[BitXorString (String function)|BitXorString]]</var> | ||
</ul> | </ul> | ||
</td> | |||
<td> | |||
<ul> | |||
<li><var>[[BitClearString, BitFlipString, and BitSetString (String functions)|BitClearString, BitFlipString, and BitSetString]]</var> | |||
<li><var>[[BitValueString (String function)|BitValueString]]</var> | |||
<li><var>[[BitCountString (String function)|BitCountString]]</var> | |||
</ul> | |||
</td> | |||
[[Category:Bit manipulation methods]] | |||
{{Template:String:BitOffString footer}} | {{Template:String:BitOffString footer}} | ||
Latest revision as of 20:18, 3 September 2015
Clear bits in one string from another (String class)
[Introduced in Sirius Mods 7.9]
BitOffString turns off a set of bits in one string as indicated by another.
Syntax
%result = string:BitOffString( offBits, [Pad= c])
Syntax terms
| %result | A string to receive the result of turning off the bits in offBits for string. |
|---|---|
| string | The string to turn off bits in. |
| offBits | The bits to turn off. |
| Pad | A single character that indicates the character with which the shorter of the two input strings is to be extended. As many copies of c 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 Pad is '00':x. |
Usage notes
- Using a null string for offBits is an easy way of turning off a specific set of bits for each byte in a string (the Pad value).
- BitOffString is most useful for working with binary data, for example binary data being sent or received with Janus Sockets.