openclonk/docs/sdk/script/fn/CreateConstruction.xml

<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<!DOCTYPE funcs SYSTEM "../../../clonk.dtd">
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
  <func>
    <title>CreateConstruction</title>
    <category>Objekte</category><subcat>Erzeugung</subcat>
    <version>4.6.5.0 CP</version>
    <syntax>
      <rtype>object</rtype>
      <params>
        <param><type>id</type><name>object_id</name><desc>Typ des zu erstellenden Objekts</desc></param>
        <param><type>int</type><name>xoffset</name><desc>X-Koordinate</desc></param>
        <param><type>int</type><name>yoffset</name><desc>Y-Koordinate</desc></param>
        <param><type>int</type><name>owner</name><desc>Besitzer des zu erstellenden Objekts (Index eines Spielers oder <funclink>NO_OWNER</funclink> f<>r keinen Besitzer)</desc></param>
        <param><type>int</type><name>completion</name><desc>Gibt die Fertigstellung des Objekts in Prozent an (muss mindestens 1 sein)</desc></param>
        <param><type>bool</type><name>adjust_terrain</name><desc>Bestimmt, ob die Landschaft an die Baustelle angepasst werden soll (inkl. Fundament).</desc></param>
        <param><type>bool</type><name>check_site</name><desc><EFBFBD>berpr<EFBFBD>ft die Baustelle vorher auf ihre Eignung</desc></param>
      </params>
    </syntax>
    <desc>Sollte statt <funclink>CreateObject</funclink> benutzt werden, wenn ein Geb<65>ude oder eine Baustelle erzeugt werden soll. Bei lokalen Aufrufen dieser Funktion wird die angegebene Position zu Offset-Koordinaten zum aufrufenden Objekt.
Wenn check_site 1 ist, wird die Baustelle vorher auf ihre Eignung <20>berpr<70>ft. Ist die Position ungeeignet (z.B. durch unebenen Untergrund oder andere Geb<65>ude), wird beim aufrufenden Objekt eine entsprechende Meldung ausgegeben und die Funktion gibt 0 zur<75>ck.</desc>
    <examples>
      <example>
        <code>CreateConstruction( HUT2, 150,100,  0,100,1 );</code>
        <text>Erschafft eine fertige Holzh<7A>tte bei den Koordinaten 150/100 f<>r Spieler 1 und passt die Landschaft an das Geb<65>ude an.</text>
      </example>
      <example>
        <code>CreateConstruction( HUT3, 200,100, <funclink>NO_OWNER</funclink>, 30,1 );</code>
        <text>Errichtet eine zu 30% fertiggestellte Holzh<7A>tte bei den Koordinaten 200/100 ohne Besitzer wobei hier die Landschaft ebenfalls angepasst wird.</text>
      </example>
    </examples>
    <related>
      <funclink>CreateObject</funclink>
      <funclink>CreateContents</funclink>
      <funclink>RemoveObject</funclink>
    </related>
  </func>
  <author>springer</author><date>April 2002</date>
</funcs>