BitOnString (String function)
Set bits in one string from another (String class) [introduced in Sirius Mods 7.9]
BitOnString sets bits in one string as indicated by another.
Syntax
%result = string:BitOnString( onBits, [Pad= c])
Syntax terms
%result | A string to receive the result of setting the bits in onBits for string. |
---|---|
string | The string to set bits in. |
onBits | The bits to set. |
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 c is '00':x . |
Usage notes
- Using a null string for onBits is an easy way of turning on a specific set of bits for each byte in a string (the pad value).
- BitOnString is most useful for working with binary data, for example binary data being sent or received with Janus Sockets.