New (CharacterToUnicodeMap constructor): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 6: | Line 6: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%outCharacterToUnicodeMap</th><td> | <tr><th>%outCharacterToUnicodeMap</th><td>A <var>CharacterToUnicodeMap</var> object.</td></tr> | ||
<tr><th nowrap="true"><var> | <tr><th nowrap="true"><var>%(CharacterToUnicodeMap)</var></th> | ||
<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. See [[#Usage notes|"Usage notes"]], below, for more information about invoking a <var>Constructor</var>.</td></tr> | <td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. See [[#Usage notes|"Usage notes"]], below, for more information about invoking a <var>CharacterToUnicodeMap</var> <var>Constructor</var>.</td></tr> | ||
<tr><th><var>In</var></th> | <tr><th><var>In</var></th> | ||
<td>string</td></tr> | <td>An optional, [[Notation conventions for methods#Named parameters|name required]], <var>String</var> that specifies the single-byte character code points to be mapped to their <var>Unicode</var translation characters in the <var>Out</var> argument. | ||
No character duplications are allowed in the In string, which may not be more than 256 characters.</td></tr> | |||
<tr><th><var>Out</var></th> | <tr><th><var>Out</var></th> | ||
<td>Unicode</td></tr> | <td>An optional, name required, <var>Unicode</var> string, each of whose characters is mapped to the character in the <var>In</var> string that occupies the same relative position in the string. | ||
The <var>Out</var> string may not be longer than the <var>In</var>; it may be shorter, however, as long as a <var>Pad</var> character is specified. <var>Out</var> may not contain more than 256 characters.</td></tr> | |||
<tr><th><var>Pad</var></th> | <tr><th><var>Pad</var></th> | ||
<td>Unicode</td></tr> | <td>An optional, name required, <var>Unicode</var> string argument that specifies the character(s) used to pad the <var>Out</var> string on the right if it is shorter than <var>In</var>. | ||
</td></tr> | |||
</table> | </table> | ||
| Line 27: | Line 30: | ||
</ul> | </ul> | ||
==See also== | ==See also== | ||
{{Template:CharacterToUnicodeMap:New footer}} | {{Template:CharacterToUnicodeMap:New footer}} | ||
Revision as of 22:44, 29 November 2011
Create CharacterToUnicodeMap object (CharacterToUnicodeMap class)
[Introduced in Sirius Mods 8.0]
This page is under construction.
Syntax
%characterToUnicodeMap = [%(CharacterToUnicodeMap):]New[( [In= string], - [Out= unicode], [Pad= unicode])]
Syntax terms
| %outCharacterToUnicodeMap | A CharacterToUnicodeMap object. |
|---|---|
| %(CharacterToUnicodeMap) | The optional class name in parentheses denotes a Constructor. See "Usage notes", below, for more information about invoking a CharacterToUnicodeMap Constructor. |
| In | An optional, name required, String that specifies the single-byte character code points to be mapped to their Unicode</var translation characters in the Out argument. No character duplications are allowed in the In string, which may not be more than 256 characters. |
| Out | An optional, name required, Unicode string, each of whose characters is mapped to the character in the In string that occupies the same relative position in the string. The Out string may not be longer than the In; it may be shorter, however, as long as a Pad character is specified. Out may not contain more than 256 characters. |
| Pad | An optional, name required, Unicode string argument that specifies the character(s) used to pad the Out string on the right if it is shorter than In. |
Usage notes
- As described in "Using New or other Constructors", New can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is Null:
%charToUniMap = new %charToUniMap = %(CharacterToUnicodeMap):new %charToUniMap = %charToUniMap:new