File: GetChar.xml

package info (click to toggle)
openclonk 8.1-4
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 169,520 kB
  • sloc: cpp: 180,479; ansic: 108,988; xml: 31,371; python: 1,223; php: 767; makefile: 145; sh: 101; javascript: 34
file content (42 lines) | stat: -rw-r--r-- 1,611 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!DOCTYPE funcs
  SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
  <func>
    <title>GetChar</title>
    <category>Script</category>
    <subcat>Strings</subcat>
    <version>5.1 OC</version>
    <syntax>
      <rtype>int</rtype>
      <params>
        <param>
          <type>string</type>
          <name>text</name>
          <desc>String of which to get a character.</desc>
        </param>
        <param>
          <type>int</type>
          <name>index</name>
          <desc>Position of the character. The first character is at position 0. If the specified position is outside the string, <code>nil</code> is returned.</desc>
        </param>
      </params>
    </syntax>
    <desc>Determines the ASCII character code of a character in a string.</desc>
    <remark><code><funclink>Format</funclink>("%c")</code> can be used to convert the character to a string.</remark>
    <examples>
      <example>
        <code>var c = GetChar(<funclink>GetPlayerName</funclink>(0), 0);
<funclink>if</funclink> (<funclink>Inside</funclink>(c, 97, 122)) c-=32;
<funclink>if</funclink> (<funclink>Inside</funclink>(c, 65, 90)) <funclink>Log</funclink>(&quot;Your name begins with the %dth letter of the alphabet.&quot;, c-64)</code>
        <text>Gets the first character of the name of the first player.</text>
      </example>
    </examples>
    <related>
      <funclink>Format</funclink>
      <funclink>GetLength</funclink>
    </related>
  </func>
  <author>Sven2</author><date>2001-11</date>
</funcs>