marko10_000
/
openclonk
forked from Mirrors/openclonk
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Removed default-this object parameter from a lot of functions

stable-5.2
Nicolas Hake 2009-08-12 22:44:09 +02:00
parent 0deb014cf0
commit 276a5abfed
172 changed files with 2231 additions and 2755 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CMakeLists.txt
View File

@ -377,7 +377,7 @@ set(OC_CLONK_SOURCES
src/zlib/zutil.h
)
mark_as_advanced(OC_CLONK_SOURCES)
mark_as_advanced(OC_SYSTEM_SORUCES)
mark_as_advanced(OC_SYSTEM_SOURCES)
if(WIN32)
list(APPEND OC_CLONK_SOURCES

7
docs/sdk/script/fn/ActIdle.xml
View File

@ -8,14 +8,11 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>bool</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Zu überprüfendes Objekt</desc><optional /></param>
</params>
</syntax>
<desc>Prüft, ob das Objekt eine Aktivität ausführt. Bei lokalem Aufruf kann pObj == 0 sein.</desc>
<desc>Prüft, ob das aufrufende Objekt eine Aktivität ausführt.</desc>
<examples>
<example>
<code><funclink>if</funclink>(ActIdle(i = <funclink>FindObject</funclink>(HUT1)) <funclink>Explode</funclink>(15, i);</code>
<code><funclink>if</funclink>((i = <funclink>FindObject</funclink>(HUT1))->ActIdle()) i-><funclink>Explode</funclink>(15);</code>
<text>Lässt die Bambushütte explodieren, wenn die Tür geschlossen ist</text>
</example>
</examples>

11
docs/sdk/script/fn/AddCommand.xml
View File

@ -10,11 +10,6 @@
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>object</type>
<name>pObj</name>
<desc>Objekt, dem das Kommando gegeben wird.</desc>
</param>
<param>
<type>string</type>
<name>szCommand</name>
@ -84,7 +79,7 @@
</params>
</syntax>
<desc>Fügt ein Kommado in die Kommandoliste eines Objekts hinzu (an den Anfang, siehe auch <funclink>AppendCommand</funclink>). D.h. es wird ein Kommando hinzugefügt, welches das Objekt vor anderen vorher gegebenen Kommandos auszuführen hat (war vorher kein Kommando gesetzt, so entspricht AddCommand <funclink>SetCommand</funclink>) <br />
<desc>Fügt ein Kommado in die Kommandoliste des aufrufenden Objekts hinzu (an den Anfang, siehe auch <funclink>AppendCommand</funclink>). D.h. es wird ein Kommando hinzugefügt, welches das Objekt vor anderen vorher gegebenen Kommandos auszuführen hat (war vorher kein Kommando gesetzt, so entspricht AddCommand <funclink>SetCommand</funclink>) <br />
Für Kommando-Beschreibungen siehe <funclink>SetCommand</funclink>
</desc>
<remark>
@ -95,8 +90,8 @@
<code>Timer:
var obj = <funclink>FindObject</funclink>(0, -20, -40, 40, 40, <funclink>OCF_CrewMember</funclink>();
if(obj)
if(<funclink>GetComDir</funclink>(obj) == <funclink>COMD_Right</funclink>())
<funclink>AddCommand</funclink>(obj, "Jump");
if(obj-><funclink>GetComDir</funclink>() == <funclink>COMD_Right</funclink>())
obj-><funclink>AddCommand</funclink>("Jump");
return();</code>
<text>
Dieser Timer-Script bewirkt (aus einem Objekt aufgerufen, welches auf dem Boden liegt), dass jeder Clonk, der über das Objekt von links nach rechts hinübergeht, springt. Dazu wird erst ein Clonk (bzw. CrewMember) über dem Objekt gesucht. Wurde ein solcher gefunden, und läuft er im Moment nach rechts (ComDir), so wird dem Clonk das Kommando "Jump" hinzugefügt.

13
docs/sdk/script/fn/AddMenuItem.xml
View File

@ -12,7 +12,6 @@
<param><type>string</type><name>szCaption</name><desc>Text des neuen Menüeintrags</desc></param>
<param><type>string</type><name>szCommand</name><desc>Kommando, das bei Auswahl des Menüeintrags ausgeführt werden soll. Kann entweder ein Funktionsname oder ein Statement sein. Wenn ein Funktionsname angegeben wird, dann wird die Funktion in dem Objekt aufgerufen, welches bei <funclink>CreateMenu</funclink> als pCommandObject übergeben wurde.</desc></param>
<param><type>id</type><name>idItem</name><desc>Die ID wird als Bild für den Menüeintrag verwendet. Der Name der Definition kann mit %s in szCaption verwendet werden. Außerdem wird die ID als erster Parameter an den Aufruf von szCommand übergeben, sofern dieser nur ein Funktionsname ist.</desc></param>
<param><type>object</type><name>pMenuObject</name><desc>Objekt, dessen Menü der Eintrag hinzugefügt werden soll. Kann bei lokalen Aufrufen 0 sein.</desc></param>
<param><type>int</type><name>iCount</name><desc>Gewünschte Zahl, die neben dem Menüeintrag angezeigt werden soll (ähnlich der Mengenanzeige im Aktivieren-Menü)</desc></param>
<param><type>int</type><name>iParameter</name><desc>Wird als 2. Parameter an die in szCommand angegebene Funktion übergeben (siehe Anmerkung)</desc></param>
<param><type>string</type><name>szInfoCaption</name><desc>Beschreibungstext des neuen Menüeintrags</desc></param>
@ -58,7 +57,7 @@ func SayHello()
func DoMagic()
{
Sound("Magic*");
ObjectCall(CreateObject(MLGT,0,0),"Activate",this());
CreateObject(MLGT,0,0)->~Activate(this);
}
func CreateItem(id item)
@ -68,16 +67,6 @@ func CreateItem(id item)
}</code>
<text>Menü für einen Spezialclonk.</text>
</example>
<example>
<code>func Activate(object clonk)
{
// Menü im Clonk mit lokalen Kommandos erzeugen
CreateMenu(GetID(), clonk, this());
// Menüeinträge erzeugen
AddMenuItem(Format("%s Schrumpfen", GetName(clonk)), Format("DoCon(-10,Object(%d))", ObjectNumber(%d)), 0, this(), 0, 0, "Eine Art Jungbrunnen.", 4, clonk);
}</code>
<text>Menü für ein Schrumpfobjekt.</text>
</example>
</examples>
<related>
<funclink>CreateMenu</funclink>

5
docs/sdk/script/fn/AddVertex.xml
View File

@ -11,14 +11,13 @@
<params>
<param><type>int</type><name>iX</name><desc>X-Koordinate, von der Objektmitte aus gesehen.</desc></param>
<param><type>int</type><name>iY</name><desc>Y-Koordinate, von der Objektmitte aus gesehen.</desc></param>
<param><type>object</type><name>pObj</name><desc>Objekt, dem der Vertex hinzugefügt werden soll.</desc></param>
</params>
</syntax>
<desc>Fügt dem Objekt pObj einen neuen Vertex hinzu.</desc>
<desc>Fügt dem aufrufenden Objekt einen neuen Vertex hinzu.</desc>
<remark>Achtung: Bei jeder Vertexaktualisierung (also beispielsweise dann, wenn sich Fertigstellungswert oder Rotation eines Objekts ändern) werden alle Vertices wieder auf die Definitionswerte zurückgesetzt.</remark>
<examples>
<example>
<code>AddVertex(50,0, <funclink>GetHiRank</funclink>(0));</code>
<code><funclink>GetHiRank</funclink>(0)->AddVertex(50,0);</code>
<text>Lässt den Captain des ersten Spielers im Boden festhängen.</text>
</example>
</examples>

11
docs/sdk/script/fn/AppendCommand.xml
View File

@ -10,11 +10,6 @@
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>object</type>
<name>pObj</name>
<desc>Objekt, dem das Kommando gegeben wird.</desc>
</param>
<param>
<type>string</type>
<name>szCommand</name>
@ -71,15 +66,15 @@
</params>
</syntax>
<desc>Fügt ein Kommando der Kommandoliste eines Objekts am Ende hinzu. Das Objekt wird also das zuerst gegebene Kommando ausführen und sich danach automatisch dem mit AppendCommand hinzugefügten widmen.<br />
<desc>Fügt ein Kommando der Kommandoliste des aufrufenden Objekts am Ende hinzu. Das Objekt wird also das zuerst gegebene Kommando ausführen und sich danach automatisch dem mit AppendCommand hinzugefügten widmen.<br />
Für Kommando-Beschreibungen siehe <funclink>SetCommand</funclink><br/>
Bemerkung: Mit AppendCommand hinzugefügte Befehle werden nicht an gesteuerte Fahrzeuge weitergeleitet (siehe VehicleControl)</desc>
<examples>
<example>
<code>var base = <funclink>FindBase</funclink>();
<funclink>SetCommand</funclink>(<funclink>this</funclink>(), "MoveTo", base);
AppendCommand(<funclink>this</funclink>(), "Throw", 0, <funclink>GetX</funclink>(base), <funclink>GetY</funclink>(base));</code>
<funclink>SetCommand</funclink>("MoveTo", base);
AppendCommand("Throw", nil, base-><funclink>GetX</funclink>(), base-><funclink>GetY</funclink>());</code>
<text>
Gibt dem Clonk den Befehl, zuerst zu der ersten (gefundenen) Basis zu laufen, und dann das erste Objekt, das er trägt, auf diese zu werfen.<br />
</text>

2
docs/sdk/script/fn/BlastObjects.xml
View File

@ -13,7 +13,7 @@
<param><type>int</type><name>iY</name><desc>Y-Koordinate</desc></param>
<param><type>int</type><name>iLevel</name><desc>Stärke</desc></param>
<param><type>object</type><name>pContainer</name><desc>Objekt, in dem die zu sprengenden Objekte enthalten sind.</desc></param>
<param><type>int</type><name>iCausedBy</name><desc>Spielernummer des Spielers, der der Verursacher des Schaden ist, plus eins.</desc></param>
<param><type>int</type><name>iCausedBy</name><desc>Spielernummer des Spielers, der der Verursacher des Schaden ist.</desc></param>
</params>
</syntax>
<desc>Fügt allen Objekten an angegebener Position Explosionsschaden zu. iX und iY sind immer globale Koordinaten. Wenn ein pContainer angegeben ist, wird der Schaden nur den Objekten zugefügt, die in pContainer enthalten sind. Explosionsschaden kann zur Entzündung führen oder auch Lebewesen wegschleudern. Bei lokalen Aufrufen gilt der Schaden als vom Controller des aufrufenden Objekts verursacht.</desc>

3
docs/sdk/script/fn/ChangeDef.xml
View File

@ -10,7 +10,6 @@
<rtype>bool</rtype>
<params>
<param><type>id</type><name>idNewDef</name><desc>ID der neuen Definition für das Objekt</desc></param>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen Typ geändert wird. 0 bei lokalem Aufruf.</desc></param>
</params>
</syntax>
<desc>Weist einem Objekt eine neue Definition zu.</desc>
@ -24,7 +23,7 @@
eine gleichnamige in der Zieldefinition existiert).</remark>
<examples>
<example>
<code>ChangeDef(MONS, <funclink>GetCursor</funclink>(0));</code>
<code><funclink>GetCursor</funclink>(0)->ChangeDef(MONS);</code>
<text>Verwandelt den ausgewählten Clonk des ersten Spielers in ein Monster.</text>
</example>
</examples>

4
docs/sdk/script/fn/CheckEnergyNeedChain.xml
View File

@ -9,11 +9,9 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>bool</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, von dem aus gesucht werden soll. 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Überprüft, ob ein an das angegebene Objekt angeschlossener Verbraucher Energie benötigt. Dabei werden auch indirekt (also über mehrere Leitungen über einen weiteren Verbraucher) angeschlossene Verbraucher überprüft.</desc>
<desc>Überprüft, ob ein an das aufrufende Objekt angeschlossener Verbraucher Energie benötigt. Dabei werden auch indirekt (also über mehrere Leitungen über einen weiteren Verbraucher) angeschlossene Verbraucher überprüft.</desc>
<remark>Es wird nur in die Richtung geprüft, in der auch Energie durch Energieleitungen fließen kann. Also vom Versorger zum Verbraucher.</remark>
<examples>
<example>

11
docs/sdk/script/fn/ClearMenuItems.xml
View File

@ -8,22 +8,19 @@
<version>4.9.1.0 GWE</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pMenuObject</name><desc>Objekt, aus dessen Menü alle Einträge geleert werden sollen. 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Entfernt alle Einträge aus einem Menü.</desc>
<examples>
<example>
<code>var pClonk=<funclink>GetCursor</funclink>();
<funclink>CreateMenu</funclink>(CLNK, pClonk, pClonk, 0, "", 0, 2);
<funclink>AddMenuItem</funclink>("", "", TIM1, pClonk,0,0,"Alter Text");
pClonk-><funclink>CreateMenu</funclink>(CLNK, pClonk, nil, "", 0, 2);
pClonk-><funclink>AddMenuItem</funclink>("", "", TIM1, nil,nil,"Alter Text");
[...]
ClearMenuItems(pClonk);
<funclink>AddMenuItem</funclink>(0, "", TIM1, pClonk,0,0,"Neuer Text");</code>
pClonk->ClearMenuItems();
pClonk-><funclink>AddMenuItem</funclink>(nil, "", TIM1, nil,0,0,"Neuer Text");</code>
<text>Öffnet zunächst ein Textfenster mit dem Inhalt "Alter Text" für den ausgewählten Clonk des ersten Spielers, und ändert die Beschriftung dann später auf "Neuer Text".</text>
</example>
</examples>

7
docs/sdk/script/fn/CloseMenu.xml
View File

@ -8,14 +8,11 @@
<version>4.9.1.0 GWE</version>
<syntax>
<rtype>bool</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen Menü geschlossen wird. 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Schließt das Menü eines Objekts.</desc>
<desc>Schließt das Menü des aufrufenden Objekts.</desc>
<examples>
<example>
<code>CloseMenu(<funclink>Contained</funclink>());</code>
<code><funclink>Contained</funclink>()->CloseMenu();</code>
<text>Schließt das Menü des eigenen Behälters.</text>
</example>
</examples>

3
docs/sdk/script/fn/ComponentAll.xml
View File

@ -9,11 +9,10 @@
<syntax>
<rtype>bool</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Das Objekt, dessen Components geprüft werden sollen.</desc></param>
<param><type>id</type><name>idComponents</name><desc>ID der erwarteten Components.</desc></param>
</params>
</syntax>
<desc>Prüft, ob ein Objekt nur aus einem Objekttyp besteht.</desc>
<desc>Prüft, ob das aufrufende Objekt nur aus Objekten vom Typ id besteht.</desc>
<related>
<funclink>GetComponent</funclink>
</related>

7
docs/sdk/script/fn/ComposeContents.xml
View File

@ -10,14 +10,13 @@
<rtype>object</rtype>
<params>
<param><type>id</type><name>id</name><desc>Typ des zu erstellenden Objekts</desc></param>
<param><type>object</type><name>pObj</name><desc>Objekt, welches die benötigten Komponenten enthält</desc></param>
</params>
</syntax>
<desc>Erzeugt ein Objekt vom Typ id als Inhalt von pObj. Das Objekt wird aus seinen Komponenten zusammen gesetzt, die in pObj enthalten sein müssen. Andernfalls wird eine Meldung ausgegeben, welche Objekte noch benötigt werden. Auch ComposeContents produziert den Engine Objekt-Call BuildNeedsMaterial, durch den die Meldung über noch benötigtes Material ausgewertet und abgefangen werden kann.</desc>
<desc>Erzeugt ein Objekt vom Typ id als Inhalt des aufrufenden Objekts. Das Objekt wird aus seinen Komponenten zusammen gesetzt, die im aufrufenden Objekt enthalten sein müssen. Andernfalls wird eine Meldung ausgegeben, welche Objekte noch benötigt werden. Auch ComposeContents produziert den Engine Objekt-Call BuildNeedsMaterial, durch den die Meldung über noch benötigtes Material ausgewertet und abgefangen werden kann.</desc>
<examples>
<example>
<code>ComposeContents( STMG, <funclink>FindObject</funclink>(HUT1) );</code>
<text>Setzt in der nächstgelegenen Hütte eine Dampfmaschine zusammen, wenn die Materialien dazu vorhanden sind.</text>
<code><funclink>FindObject</funclink>(HUT1)->ComposeContents(STMG);</code>
<text>Setzt in einer Hütte eine Dampfmaschine zusammen, wenn die Materialien dazu vorhanden sind.</text>
</example>
</examples>
</func>

5
docs/sdk/script/fn/Contained.xml
View File

@ -8,11 +8,8 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>object</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, für welches die Überprüfung durchgeführt werden soll; Null für lokale Aufrufe</desc></param>
</params>
</syntax>
<desc>Liefert das Objekt, in dem sich pObj befindet. Rückgabewert Null, wenn pObj sich im Freien befindet.</desc>
<desc>Liefert das Objekt, in dem sich das aufrufende Objekt befindet, oder nil, wenn es in keinem anderen Objekt enthalten ist.</desc>
<related>
<funclink>Contents</funclink>
</related>

3
docs/sdk/script/fn/Contents.xml
View File

@ -10,10 +10,9 @@
<rtype>object</rtype>
<params>
<param><type>int</type><name>iIndex</name><desc>Index des Objekts in pObj, Zählung beginnt mit 0</desc></param>
<param><type>object</type><name>pObj</name><desc>Objekt, in welchem gesucht werden soll; null für lokale Aufrufe</desc></param>
</params>
</syntax>
<desc>Liefert das indizierte Objekt, das in pObj enthalten ist.</desc>
<desc>Liefert das indizierte Objekt, das im aufrufenden Objekt enthalten ist.</desc>
<related>
<funclink>Contained</funclink>
<funclink>FindContents</funclink>

3
docs/sdk/script/fn/ContentsCount.xml
View File

@ -10,10 +10,9 @@
<rtype>int</rtype>
<params>
<param><type>id</type><name>id</name><desc>Objekttyp, der gezählt wird</desc></param>
<param><type>object</type><name>pObj</name><desc>Objekt, in dessen Inhalt gezählt werden soll</desc></param>
</params>
</syntax>
<desc>Liefert die Anzahl der Objekte vom Typ id, die in pObj enthalten sind.</desc>
<desc>Liefert die Anzahl der Objekte vom Typ id, die im aufrufenden Objekt enthalten sind.</desc>
<related>
<funclink>FindContents</funclink>
<funclink>ObjectCount</funclink>

7
docs/sdk/script/fn/CreateContents.xml
View File

@ -10,14 +10,13 @@
<rtype>object</rtype>
<params>
<param><type>id</type><name>id</name><desc>Typ des zu erstellenden Objekts</desc></param>
<param><type>object</type><name>pObj</name><desc>Hierin wird das Objekt erstellt</desc></param>
<param><type>int</type><name>iCount</name><desc>Anzahl zu erstellender Objekte. Ab 4.9.6.0 CR</desc></param>
<param><type>int</type><name>iCount</name><desc>Anzahl zu erstellender Objekte. Wenn nicht angegeben, wird 1 angenommen.</desc></param>
</params>
</syntax>
<desc>Erzeugt ein Objekt vom Typ id als Inhalt von pObj.</desc>
<desc>Erzeugt ein Objekt vom Typ id als Inhalt des aufrufenden Objekts.</desc>
<examples>
<example>
<code>CreateContents(ROCK,<funclink>GetHiRank</funclink>(0));</code>
<code><funclink>GetHiRank</funclink>(0)->CreateContents(ROCK);</code>
<text>Der höchstrangige Clonk des Spielers erhält einen Stein.</text>
</example>
</examples>

5
docs/sdk/script/fn/CreateMenu.xml
View File

@ -7,10 +7,9 @@
<category>Objekte</category><subcat>Menü</subcat>
<version>4.6.5.0 CP</version><extversion>4.9.6.0 CR</extversion>
<syntax>
<rtype>int</rtype>
<rtype>bool</rtype>
<params>
<param><type>id</type><name>idSymbol</name><desc>Objektdefinition, deren Bild als Symbol verwendet wird</desc></param>
<param><type>object</type><name>pMenuObject</name><desc>Objekt, in welchem das Menü geöffnet wird; kann bei lokalen Aufrufen Null sein</desc></param>
<param><type>object</type><name>pCommandObject</name><desc>Erhält das Menükommando (siehe <funclink>AddMenuItem</funclink>); kann bei lokalen Aufrufen Null sein</desc></param>
<param><type>int</type><name>iExtra</name><desc>Zusätzliche Information im Menü über das jeweils markierte Objekt. Die angegebenen C4MN_*-Konstanten sind seit 4.9.5.0 CE ebenfalls definiert und sollten statt der numerischen Werte verwendet werden:
<table>
@ -37,7 +36,7 @@
<param><type>id</type><name>idMenuID</name><desc>Wenn angegeben, wird diese ID als Menü-ID gesetzt. Die aktuelle Menü-ID wird zum Beispiel von <funclink>GetMenu</funclink> zurückgegeben.</desc><optional /></param>
</params>
</syntax>
<desc>Erzeugt ein benutzerdefiniertes Menü in pMenuObject. Menüeinträge müssen mit <funclink>AddMenuItem</funclink> hinzugefügt werden.</desc>
<desc>Erzeugt ein benutzerdefiniertes Menü im aufrufenden Objekt. Menüeinträge müssen mit <funclink>AddMenuItem</funclink> hinzugefügt werden.</desc>
<examples>
<example>
<text>siehe <funclink>AddMenuItem</funclink></text>

2
docs/sdk/script/fn/DeathAnnounce.xml
View File

@ -7,7 +7,7 @@
<category>Objekte</category><subcat>Lebewesen</subcat>
<version>4.6.5.0 CP</version>
<syntax>
<rtype>bool</rtype>
<rtype>void</rtype>
</syntax>
<desc>Gibt eine Botschaft a la "[name] ist von uns gegangen" über dem aufrufenden Objekt aus.</desc>
<related>

2
docs/sdk/script/fn/DigFree.xml
View File

@ -7,7 +7,7 @@
<category>Landschaft</category>
<version>4.6.5.0 CP</version>
<syntax>
<rtype>int</rtype>
<rtype>void</rtype>
<params>
<param><type>int</type><name>iX</name><desc>X-Koordinate</desc></param>
<param><type>int</type><name>iY</name><desc>Y-Koordinate</desc></param>

2
docs/sdk/script/fn/DigFreeRect.xml
View File

@ -7,7 +7,7 @@
<category>Landschaft</category>
<version>4.6.5.0 CP</version>
<syntax>
<rtype>int</rtype>
<rtype>void</rtype>
<params>
<param><type>int</type><name>iX</name><desc>X-Koordinate</desc></param>
<param><type>int</type><name>iY</name><desc>Y-Koordinate</desc></param>

9
docs/sdk/script/fn/DoCon.xml
View File

@ -7,26 +7,25 @@
<category>Objekte</category><subcat>Status</subcat>
<version>4.6.5.0 CP</version>
<syntax>
<rtype>bool</rtype>
<rtype>void</rtype>
<params>
<param><type>int</type><name>iChange</name><desc>Veränderung der Fertigstellung in Prozentpunkten; positiv oder negativ.</desc></param>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen Fertigstellung geändert werden soll. 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>
Verändert die Fertigstellung eines Objekts. Die meisten Lebewesen und Bäume können dadurch vergrößert oder verkleinert werden. Gebäude können zu Baustellen zurückgesetzt und Baustellen vorwärts oder rückwärts gebaut werden.<br />
Verändert die Fertigstellung des aufrufenden Objekts. Die meisten Lebewesen und Bäume können dadurch vergrößert oder verkleinert werden. Gebäude können zu Baustellen zurückgesetzt und Baustellen vorwärts oder rückwärts gebaut werden.<br />
Sinkt die Fertigstellung eines Objekts auf oder unter 0, wird dieses gelöscht.
</desc>
<examples>
<example>
<code>var obj;
<funclink>while</funclink> (obj=<funclink>FindObject</funclink>(0,0,0,0,0,<funclink>OCF_Construct</funclink>(),0,0,<funclink>NoContainer</funclink>(),obj)) DoCon(100,obj);</code>
<funclink>while</funclink> (obj=<funclink>FindObject</funclink>(0,0,0,0,0,<funclink>OCF_Construct</funclink>(),0,0,<funclink>NoContainer</funclink>(),obj)) obj->DoCon(100);</code>
<text>Baut alle Baustellen fertig.</text>
</example>
<example>
<code>DoCon(-50, <funclink>GetCursor</funclink>(plr));</code>
<code><funclink>GetCursor</funclink>(plr)->DoCon(-50);</code>
<text>Raubt dem angewähltem Mannschaftsmitglied von Spieler plr die Hälfte seiner normalen Größe. Wenn es vorher ausgewachsen war, hat es danach halbe normale Größe, wenn es halbe normale Größe hatte ist es danach weg.</text>
</example>

11
docs/sdk/script/fn/DoCrewExp.xml
View File

@ -8,18 +8,17 @@
<subcat>Mannschaft</subcat>
<version>4.9.1.0 GWE</version>
<syntax>
<rtype>bool</rtype>
<rtype>void</rtype>
<params>
<param><type>int</type><name>iChange</name><desc>Veränderung des Erfahrungswertes</desc></param>
<param><type>object</type><name>pObj</name><desc>Crewobjekt, dem Erfahrung gegeben werden soll</desc></param>
</params>
</syntax>
<desc>Gibt einem Clonk Erfahrungspunkte.</desc>
<desc>Gibt dem aufrufenden Clonk Erfahrungspunkte.</desc>
<remark>Der Clonk muss eine Infosektion haben, das heißt er muss ein CrewMember sein und einem Spieler gehören.</remark>
<examples>
<example>
<code>DoCrewExp(100, <funclink>GetCursor</funclink>());
<funclink>Sound</funclink>("Applause", 1); <funclink>GameOver</funclink>();</code>
<code><funclink>GetCursor</funclink>()->DoCrewExp(100);
<funclink>Sound</funclink>("Applause", true); <funclink>GameOver</funclink>();</code>
<text>Gibt dem ausgewählten Clonk des ersten Spielers 100 Punkte Erfahrung, spielt einen Applaus ab und beendet die Runde.</text>
</example>
</examples>
@ -28,4 +27,4 @@
</related>
</func>
<author>Sven2</author><date>April 2002</date>
</funcs>
</funcs>

9
docs/sdk/script/fn/DoDamage.xml
View File

@ -7,16 +7,17 @@
<category>Objekte</category><subcat>Status</subcat>
<version>4.6.5.0 CP</version>
<syntax>
<rtype>bool</rtype>
<rtype>void</rtype>
<params>
<param><type>int</type><name>iChange</name><desc>Veränderung des Schadenswertes; positiv oder negativ</desc></param>
<param><type>object</type><name>pTarget</name><desc>Objekt, das beschädigt wird. 0 bei lokalem Aufruf.</desc><optional /></param>
<param><type>int</type><name>iDmgType</name><desc>Schadensursache, die an Fx*Damage-Callbacks von Effekten übergeben wird (siehe <emlink href="script/Effects.html">Effekte-Dokumentation</emlink>). Standard ist FX_Call_DmgScript.</desc><optional /></param>
<param><type>int</type><name>iCausedBy</name><desc>Spielernummer des Spielers, der den Schaden verursacht hat.</desc><optional /></param>
</params>
</syntax>
<desc>Verändert den Schadenswert eines Objekts. Bei iChange ungleich Null wird im Zielobjekt außerdem die Funktion Damage aufgerufen. Bei lokalem Aufruf gilt der Besitzer des aufrufenden Objekts als Verursacher des Schadens.</desc>
<desc>Verändert den Schadenswert des aufrufenden Objekts. Bei iChange ungleich Null wird im Zielobjekt außerdem die Funktion Damage aufgerufen.</desc>
<examples>
<example>
<code>DoDamage(500, <funclink>FindObject</funclink>(TREE));</code>
<code><funclink>FindObject</funclink>(TREE)->DoDamage(500);</code>
<text>Fällt einen Baum, wenn er noch nicht gefällt ist.</text>
</example>
</examples>

11
docs/sdk/script/fn/DoEnergy.xml
View File

@ -7,19 +7,18 @@
<category>Objekte</category><subcat>Status</subcat>
<version>4.6.5.0 CP<extversion>4.9.6.0 CR</extversion></version>
<syntax>
<rtype>bool</rtype>
<rtype>void</rtype>
<params>
<param><type>int</type><name>iChange</name><desc>Veränderung des Energiewertes; positiv oder negativ in Prozent zum Maximalwert. 100% entsprechen hierbei dem maximalen Physical-Wert von 100000.</desc></param>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen Energiewert verändert wird. 0 bei lokalem Aufruf.</desc><optional /></param>
<param><type>bool</type><name>fExakt</name><desc>Wenn WAHR, wird iChange auf den exakten Energiewert angewendet (0 bis Wert von Physical "Energy").</desc><optional /></param>
<param><type>int</type><name>iEngType</name><desc>Schadensursache, die an Fx*Damage-Callbacks von Effekten übergeben wird (siehe <emlink href="script/Effects.html">Effekte-Dokumentation</emlink>). Standard ist FX_Call_EngScript.</desc><optional /></param>
<param><type>int</type><name>iCausedBy</name><desc>Spielernummer des Spielers, der den Schaden verursacht hat, plus eins.</desc><optional /></param>
<param><type>int</type><name>iCausedBy</name><desc>Spielernummer des Spielers, der den Schaden verursacht hat.</desc><optional /></param>
</params>
</syntax>
<desc>Verändert die Energie eines Objekts. Die Energie entspricht bei Gebäuden der elektrischen Energie, und bei Lebewesen der Lebensenergie.</desc>
<desc>Verändert die Energie des aufrufenden Objekts. Die Energie entspricht bei Gebäuden der elektrischen Energie, und bei Lebewesen der Lebensenergie.</desc>
<examples>
<example>
<code>DoEnergy(<funclink>GetPhysical</funclink>("Energy", 0, <funclink>GetCursor</funclink>(0))*50/100000, <funclink>GetCursor</funclink>(0));</code>
<code><funclink>GetCursor</funclink>(0)->DoEnergy(<funclink>GetCursor</funclink>(0)-><funclink>GetPhysical</funclink>("Energy")*50/100000);</code>
<text>Gibt den ausgewählten Clonk des ersten Spielers 50% mehr Energie.</text>
</example>
</examples>
@ -30,4 +29,4 @@
</func>
<author>Sven2</author><date>November 2001</date>
<author>Clonkonaut</author><date>April 2008</date>
</funcs>
</funcs>

7
docs/sdk/script/fn/DoMagicEnergy.xml
View File

@ -10,14 +10,13 @@
<rtype>bool</rtype>
<params>
<param><type>int</type><name>iChange</name><desc>Veränderung des Magiewertes; positiv oder negativ</desc></param>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen Magiewert verändert wird. 0 bei lokalem Aufruf.</desc><optional /></param>
<param><type>bool</type><name>fAllowPartial</name><desc>Wenn wahr, überträgt der Befehl auch teilweise Zauberenergie bis auf 0 oder das Maximum. Der Befehl schlägt nur fehl, wenn die Zauberenergie gar nicht verändert wurde. Ab CR.</desc><optional /></param>
</params>
</syntax>
<desc>Verändert den Magiewert eines Objekts. Jedoch wird die gewünschte Veränderung vorgabemäßig nur als ganze ausgeführt und daher auch nur, wenn dadurch nicht die Ober- bzw. Untergrenze (physische Fähigkeit des Clonks bzw. 0) überschritten wird. Wenn die Veränderung iChange nicht als ganze ausgeführt werden kann, gibt die Funktion FALSE zurück. Hierdurch kann mit einem einzelnen Funktionsaufruf gleichzeitig überprüft werden, ob eine Transaktion überhaupt möglich ist.</desc>
<desc>Verändert den Magiewert des aufrufenden Objekts. Jedoch wird die gewünschte Veränderung vorgabemäßig nur als ganze ausgeführt und daher auch nur, wenn dadurch nicht die Ober- bzw. Untergrenze (physische Fähigkeit des Clonks bzw. 0) überschritten wird. Wenn die Veränderung iChange nicht als ganze ausgeführt werden kann, gibt die Funktion FALSE zurück. Hierdurch kann mit einem einzelnen Funktionsaufruf gleichzeitig überprüft werden, ob eine Transaktion überhaupt möglich ist.</desc>
<examples>
<example>
<code><funclink>if</funclink> (DoMagicEnergy(-10)) <funclink>ObjectCall</funclink>(<funclink>CreateObject</funclink>(MLGT,0,0,<funclink>GetOwner</funclink>()), "Activate", <funclink>this</funclink>());</code>
<code><funclink>if</funclink> (DoMagicEnergy(-10)) <funclink>CreateObject</funclink>(MLGT)->Activate(<funclink>this</funclink>);</code>
<text>Zaubert einen Blitzzauber, wenn die nötige magische Aufladung dafür vorhanden ist.</text>
</example>
</examples>
@ -26,4 +25,4 @@
</related>
</func>
<author>Sven2</author><date>November 2001</date>
</funcs>
</funcs>

5
docs/sdk/script/fn/EnergyCheck.xml
View File

@ -10,10 +10,9 @@
<rtype>bool</rtype>
<params>
<param><type>int</type><name>iEnergy</name><desc>Abgefragter Energiewert</desc></param>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen Energiezustand abgefragt wird. 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Gibt zurück, ob der Energiewert eines Objekts größer oder gleich iEnergy ist. Wenn die Spielregel "Energiebedarf" nicht aktiviert ist, gibt diese Funktion immer TRUE zurück. Außerdem werden Leitungen dazu motiviert, Energie hierhin zu transferieren.</desc>
<desc>Gibt zurück, ob der Energiewert des aufrufenden Objekts größer oder gleich iEnergy ist. Wenn die Spielregel "Energiebedarf" nicht aktiviert ist, gibt diese Funktion immer TRUE zurück. Außerdem werden Leitungen dazu motiviert, Energie hierhin zu transferieren.</desc>
<examples>
<example>
<code><funclink>if</funclink>(EnergyCheck(10000)) { <funclink>DoEnergy</funclink>(-10000); <funclink>SetAction</funclink>("Working"); }</code>
@ -27,4 +26,4 @@
</related>
</func>
<author>Sven2</author><date>November 2001</date>
</funcs>
</funcs>

7
docs/sdk/script/fn/Enter.xml
View File

@ -10,13 +10,12 @@
<rtype>bool</rtype>
<params>
<param><type>object</type><name>pTarget</name><desc>Objekt, in das hineinversetzt wird</desc></param>
<param><type>object</type><name>pObj</name><desc>Objekt, das in pTarget hineinversetzt wird. 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Versetzt ein Objekt in ein anderes hinein. Bei diesem Vorgang wird weder RejectCollect, noch Collection oder ActivateEntrance im Zielobjekt aufgerufen. Dafür aber RejectEntrance und Entrance im Objekt, das hineinversetzt werden soll.</desc>
<desc>Versetzt das aufrufende Objekt in ein anderes hinein. Bei diesem Vorgang wird weder RejectCollect, noch Collection oder ActivateEntrance im Zielobjekt aufgerufen. Dafür aber RejectEntrance und Entrance im Objekt, das hineinversetzt werden soll.</desc>
<examples>
<example>
<code>Enter(<funclink>FindObject</funclink>(HUT1), <funclink>GetCursor</funclink>(0));</code>
<code><funclink>GetCursor</funclink>(0)->Enter(<funclink>FindObject</funclink>(HUT1));</code>
<text>Der ausgewählte Clonk des ersten Spielers wird in die erstbeste Hütte versetzt.</text>
</example>
</examples>
@ -26,4 +25,4 @@
</related>
</func>
<author>Sven2</author><date>November 2001</date>
</funcs>
</funcs>

11
docs/sdk/script/fn/Exit.xml
View File

@ -9,19 +9,18 @@
<syntax>
<rtype>bool</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Nach draußen zu bewegendes Objekt. 0 bei lokalem Aufruf.</desc><optional /></param>
<param><type>int</type><name>iX</name><desc>X-Austrittsposition. Offset zum aufrufenden Objekt bei lokalem Aufruf.</desc><optional /></param>
<param><type>int</type><name>iY</name><desc>Y-Austrittsposition. Offset zum aufrufenden Objekt bei lokalem Aufruf.</desc><optional /></param>
<param><type>int</type><name>iX</name><desc>Offset der X-Austrittsposition.</desc><optional /></param>
<param><type>int</type><name>iY</name><desc>Offset der Y-Austrittsposition.</desc><optional /></param>
<param><type>int</type><name>iR</name><desc>Rotation des Austrittsobjekts in Grad.</desc><optional /></param>
<param><type>int</type><name>iXDir</name><desc>X-Geschwindigkeit des Austrittsobjekts. Es gilt der übergebene Wert ohne Genauigkeitsteilung (Precision 1).</desc><optional /></param>
<param><type>int</type><name>iYDir</name><desc>Y-Geschwindigkeit des Austrittsobjekts. Es gilt der übergebene Wert ohne Genauigkeitsteilung (Precision 1).</desc><optional /></param>
<param><type>int</type><name>iRDir</name><desc>Rotationsgeschwindigkeit des Austrittsobjekts.</desc><optional /></param>
</params>
</syntax>
<desc>Versetzt ein Objekt aus seinem Behälter heraus, und setzt optional seine Geschwindigkeit.</desc>
<desc>Versetzt das aufrufende Objekt aus seinem Behälter heraus, und setzt optional seine Geschwindigkeit.</desc>
<examples>
<example>
<code>Exit(<funclink>Contents</funclink>(), 0,-20, <funclink>Random</funclink>(360), 0,-15, <funclink>Random</funclink>(11)-5);</code>
<code><funclink>Contents</funclink>()->Exit(0,-20, <funclink>Random</funclink>(360), 0,-15, <funclink>Random</funclink>(11)-5);</code>
<text>Bewegt das erste Inhaltsobjekt oberhalb aus dem aufrufenden Objekt heraus, dreht es zufällig und schleudert es nach oben.</text>
</example>
</examples>
@ -31,4 +30,4 @@
</func>
<author>Sven2</author><date>November 2001</date>
<author>matthes</author><date>October 2004</date>
</funcs>
</funcs>

7
docs/sdk/script/fn/Explode.xml
View File

@ -7,10 +7,9 @@
<category>Objekte</category><subcat>Existenz</subcat>
<version>4.6.5.0 CP<extversion>4.9.6.0 CR</extversion></version>
<syntax>
<rtype>bool</rtype>
<rtype>void</rtype>
<params>
<param><type>int</type><name>iLevel</name><desc>Explosionsstärke. Die Explosionsstärke bestimmt das Ausmaß des Explosionsschadens sowie die akustische Gestaltung. Bis Stärke 29 einschließlich wird Blast1 abgespielt, von Stärke 30 bis stärke 39 einschließlich Blast2, und bei Werten darüber Blast3.</desc></param>
<param><type>object</type><name>pObj</name><desc>Objekt, das explodiert. 0 bei lokalem Aufruf.</desc><optional /></param>
<param><type>id</type><name>idEffect</name><desc>Wenn angegeben, wird ein Objekt dieser Art und keine Partikel erzeugt. Es wird angenommen, dass das neu erstellte Objekt den Explosionseffekt übernimmt. Ab 4.9.6.0 CR</desc><optional /></param>
<param><type>string</type><name>szParticle</name><desc>Name eines Partikels, der statt der normalen Explosionspartikel erzeugt wird.</desc><optional /></param>
</params>
@ -19,7 +18,7 @@
<remark>Siehe Hinweis zu <funclink>RemoveObject</funclink>.</remark>
<examples>
<example>
<code>Explode(25, <funclink>GetHiRank</funclink>(0));</code>
<code><funclink>GetHiRank</funclink>(0)->Explode(25);</code>
<text>Der höchstrangige Clonk des ersten Spielers explodiert.</text>
</example>
</examples>
@ -30,4 +29,4 @@
</func>
<author>Sven2</author><date>November 2001</date>
<author>Clonkonaut</author><date>April 2008</date>
</funcs>
</funcs>

5
docs/sdk/script/fn/Extinguish.xml
View File

@ -8,14 +8,11 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>bool</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen Feuer gelöscht werden soll. 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Löscht das Feuer eines brennenden Objekts.</desc>
<examples>
<example>
<code>Extinguish(<funclink>FindObject</funclink>(0, 0,0,0,0, <funclink>OCF_OnFire</funclink>()));</code>
<code><funclink>FindObject</funclink>(0, 0,0,0,0, <funclink>OCF_OnFire</funclink>())->Extinguish();</code>
<text>Löscht irgendein brennendes Objekt.</text>
</example>
</examples>

1
docs/sdk/script/fn/FightWith.xml
View File

@ -10,7 +10,6 @@
<rtype>bool</rtype>
<params>
<param><type>object</type><name>pTarget</name><desc>Objekt, das bekämpft werden soll.</desc></param>
<param><type>object</type><name>pFighter</name><desc>Objekt, das kämpfen soll. 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Beginnt einen Zweikampf. Mit diesem Befehl können auch Clonks nicht verfeindeter Spieler einen Kampf beginnen. Beide Teilnehmer müssen <funclink>OCF_FightReady</funclink> sein.</desc>

5
docs/sdk/script/fn/FindContents.xml
View File

@ -10,7 +10,6 @@
<rtype>object</rtype>
<params>
<param><type>id</type><name>idType</name><desc>Objekttyp, von dem das Inhaltsobjekt sein soll</desc></param>
<param><type>object</type><name>pObj</name><desc>Durchsuchter Behälter. 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Liefert das erste in einem Behälter enthaltene Objekt vom Typ idType.</desc>
@ -18,7 +17,7 @@
<example>
<code>var hut;
<funclink>if</funclink> (hut=<funclink>FindObject</funclink>(HUT2)) <funclink>Exit</funclink>(FindContents(CLNK, hut), <funclink>GetX</funclink>(hut), <funclink>GetY</funclink>(hut));</code>
<funclink>if</funclink> (hut=<funclink>FindObject</funclink>(HUT2)) hut->FindContents(CLNK)-><funclink>Exit</funclink>(hut-><funclink>GetX</funclink>(), hut-><funclink>GetY</funclink>());</code>
<text>Befördert einen Clonk aus einer Hütte heraus.</text>
</example>
</examples>
@ -29,4 +28,4 @@
</related>
</func>
<author>Sven2</author><date>November 2001</date>
</funcs>
</funcs>

1
docs/sdk/script/fn/FindOtherContents.xml
View File

@ -10,7 +10,6 @@
<rtype>object</rtype>
<params>
<param><type>id</type><name>idType</name><desc>ID des zu ignorierenden Objekttyps</desc></param>
<param><type>object</type><name>pObj</name><desc>Behälter, der durchsucht wird. 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Liefert das erste Inhaltsobjekt eines Behälters, das nicht vom angegebenen Typ ist.</desc>

9
docs/sdk/script/fn/FinishCommand.xml
View File

@ -10,11 +10,6 @@
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>object</type>
<name>pObj</name>
<desc>Objekt, dessen Kommando beendet wird.</desc>
</param>
<param>
<type>bool</type>
<name>fSuccess</name>
@ -40,8 +35,8 @@
if (!(pTree = FindWorkTree(clonk)))
// Kein geeigneter Baum (fertig)
{
<funclink>Message</funclink>("$TxtNomoresuitabletrees$",this());
FinishCommand(clonk, 0, 1);
<funclink>Message</funclink>("$TxtNomoresuitabletrees$",this);
clonk->FinishCommand(false, 1);
return(0);
}
[...]

9
docs/sdk/script/fn/Fling.xml
View File

@ -7,17 +7,16 @@
<category>Objekte</category><subcat>Bewegung</subcat>
<version>4.6.5.0 CP</version>
<syntax>
<rtype>bool</rtype>
<rtype>void</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, das weggeschleudert wird. Muss angegeben werden.</desc></param>
<param><type>int</type><name>iXDir</name><desc>X-Schleudergeschwindigkeit</desc></param>
<param><type>int</type><name>iYDir</name><desc>Y-Schleudergeschwindigkeit</desc></param>
</params>
</syntax>
<desc>Verschleudert pObj in die angegebene Richtung. Diese Funktion ist für Lebewesen konzipiert, da sie die entsprechenden Aktivitäten setzt.</desc>
<desc>Verschleudert das aufrufende Objekt in die angegebene Richtung. Diese Funktion ist für Lebewesen konzipiert, da sie die entsprechenden Aktivitäten setzt.</desc>
<examples>
<example>
<code>Fling(<funclink>GetCursor</funclink>(0), 10, -15);</code>
<code><funclink>GetCursor</funclink>(0)->Fling(10, -15);</code>
<text>Verschleudert den ausgewählten Clonk nach oben rechts.</text>
</example>
</examples>
@ -28,4 +27,4 @@
</related>
</func>
<author>Sven2</author><date>November 2001</date>
</funcs>
</funcs>

2
docs/sdk/script/fn/FreeRect.xml
View File

@ -7,7 +7,7 @@
<category>Landschaft</category>
<version>4.6.5.0 CP<extversion>4.9.5.0 CE</extversion></version>
<syntax>
<rtype>bool</rtype>
<rtype>void</rtype>
<params>
<param><type>int</type><name>iX</name><desc>Linke Kante des Rechtecks</desc></param>
<param><type>int</type><name>iY</name><desc>Obere Kante des Rechtecks</desc></param>

9
docs/sdk/script/fn/GetActTime.xml
View File

@ -8,11 +8,8 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, Null bei lokalem Aufruf.</desc></param>
</params>
</syntax>
<desc>Liefert den Zeitraum in Frames, die das angegebene Objekt bereits die aktuelle Aktivität ausgeführt hat.</desc>
<desc>Liefert den Zeitraum in Frames, die das aufrufende Objekt bereits die aktuelle Aktivität ausgeführt hat.</desc>
<examples>
<example>
<code>private func Burning()
@ -27,9 +24,9 @@
var pOre;
<funclink>if</funclink> (!(pOre = <funclink>FindContents</funclink>(ORE1))) <funclink>return</funclink>(1);
// Erz verbrauchen
<funclink>RemoveObject</funclink>(pOre);
pOre-><funclink>RemoveObject</funclink>();
// Metall auswerfen
<funclink>Exit</funclink>(<funclink>CreateContents</funclink>(METL), -27, +13, 0, -1);
<funclink>CreateContents</funclink>(METL)-><funclink>Exit</funclink>(-27, +13, 0, -1);
// Sound
<funclink>Sound</funclink>("Pshshsh");
}

5
docs/sdk/script/fn/GetAction.xml
View File

@ -8,14 +8,11 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>string</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Abzufragendes Objekt. 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Liefert den Namen der momentanen Aktivität eines Objekts zurück, "Idle", wenn das Objekt keine Aktivität ausführt.</desc>
<examples>
<example>
<code><funclink>if</funclink>(GetAction(<funclink>FindObject</funclink>(Find_ID(CLNK))) <emlink href="script/operatoren.html">eq</emlink> "Swim") <funclink>Message</funclink>("Toll, irgendein Clonk schwimmt");</code>
<code><funclink>if</funclink>(<funclink>FindObject</funclink>(Find_ID(CLNK))->GetAction() == "Swim") <funclink>Message</funclink>("Toll, irgendein Clonk schwimmt");</code>
</example>
</examples>
<related>

7
docs/sdk/script/fn/GetActionTarget.xml
View File

@ -10,13 +10,12 @@
<rtype>object</rtype>
<params>
<param><type>int</type><name>iTargetIndex</name><desc>0 für pTarget oder 1 für pTarget2</desc></param>
<param><type>object</type><name>pObj</name><desc>Objekt, 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Liefert die aktuellen Aktivitätszielobjekte eines Objekts.</desc>
<desc>Liefert die aktuellen Aktivitätszielobjekte des aufrufenden Objekts.</desc>
<examples>
<example>
<code><funclink>ObjectCall</funclink>( GetActionTarget( ), "ChopDown");</code>
<code>GetActionTarget()->~ChopDown();</code>
<text>Im StartCall der Fällen-Aktivität eines Clonks ausgeführt, fällt es die meisten Bäume sofort.</text>
</example>
</examples>
@ -30,4 +29,4 @@
</related>
</func>
<author>Günther</author><date>April 2002</date>
</funcs>
</funcs>

7
docs/sdk/script/fn/GetAlive.xml
View File

@ -8,14 +8,11 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>bool</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen Zustand geprüft werden soll.</desc><optional /></param>
</params>
</syntax>
<desc>Gibt zurück, ob das Objekt noch am Leben ist.</desc>
<desc>Gibt zurück, ob das aufrufende Objekt noch am Leben ist.</desc>
<examples>
<example>
<code><funclink>if</funclink>(!GetAlive(<funclink>FindObject</funclink>(MCLK))) <funclink>EliminatePlayer</funclink>(0);</code>
<code><funclink>if</funclink>(!<funclink>FindObject</funclink>(<funclink>Find_ID</funclink>(MCLK))->GetAlive()) <funclink>EliminatePlayer</funclink>(0);</code>
<text>Eliminiert den ersten Spieler, wenn der erste Zauberclonk getötet wurde. Achtung: In einem echten Skript würde zuvor die Existenz des ersten Spielers geprüft.</text>
</example>
</examples>

5
docs/sdk/script/fn/GetBase.xml
View File

@ -8,11 +8,8 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Zu prüfende Heimatbasis. Null bei lokalem Aufruf.</desc></param>
</params>
</syntax>
<desc>Liefert die Nummer des Spielers, dessen Heimatbasis pObj ist. Rückgabewert -1 wenn pObj keine Heimatbasis ist.</desc>
<desc>Liefert die Nummer des Spielers, dessen Heimatbasis das aufrufende Objekt ist. Rückgabewert <funclink>NO_OWNER</funclink> wenn es keine Heimatbasis ist.</desc>
<related>
<funclink>FindBase</funclink>
</related>

5
docs/sdk/script/fn/GetBreath.xml
View File

@ -8,11 +8,8 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Das Objekt, dessen Atemwert gesucht wird.</desc></param>
</params>
</syntax>
<desc>Liefert den aktuellen Atemwert eines Objekts in Prozent. 100% stellen hierbei den maximalen Physical-Wert von 100000 dar. Siehe auch DefCore.txt Sektion [Physical]. pObj Null bei lokalem Aufruf.</desc>
<desc>Liefert den aktuellen Atemwert des aufrufenden Objekts in Prozent. 100% stellen hierbei den maximalen Physical-Wert von 100000 dar. Siehe auch DefCore.txt Sektion [Physical].</desc>
<related>
<funclink>GetPhysical</funclink>
</related>

8
docs/sdk/script/fn/GetCategory.xml
View File

@ -8,15 +8,11 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen Kategorie abgefragt wird. 0 bei lokalem Aufruf.</desc><optional /></param>
<param><type>id</type><name>idDef</name><desc>Wenn angegeben, wird die Kategorie dieser Definition zurückgegeben.</desc><optional /></param>
</params>
</syntax>
<desc>Fragt die Objektkategorie eines Objekts ab. Die Objektkategorie wird normalerweise über die <emlink href="definition/defcore.html">DefCore</emlink> gesetzt, und danach höchstens in seltenen Fällen mit <funclink>SetCategory</funclink> geändert. Sie bestimmt das allgemeine Verhalten eines Objekts und dessen Platzierung. Eine mit GetCategory abgefragt Kategorie kann mit dem &amp;-Operator gegen eine C4D_-Konstante geprüft werden.</desc>
<desc>Fragt die Objektkategorie des aufrufenden Objekts oder der aufrufenden Definition ab. Die Objektkategorie wird normalerweise über die <emlink href="definition/defcore.html">DefCore</emlink> gesetzt, und danach höchstens in seltenen Fällen mit <funclink>SetCategory</funclink> geändert. Sie bestimmt das allgemeine Verhalten eines Objekts und dessen Platzierung. Eine mit GetCategory abgefragt Kategorie kann mit dem &amp;-Operator gegen eine C4D_-Konstante geprüft werden.</desc>
<examples>
<example>
<code><funclink>if</funclink> (GetCategory(obj) &amp; <funclink>C4D_Structure</funclink>()) <funclink>Incinerate</funclink>(obj);</code>
<code><funclink>if</funclink> (obj->GetCategory() &amp; <funclink>C4D_Structure</funclink>()) <funclink>Incinerate</funclink>(obj);</code>
<text>Zündet obj an, wenn es ein Gebäude ist.</text>
</example>
</examples>

11
docs/sdk/script/fn/GetClrModulation.xml
View File

@ -9,19 +9,18 @@
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen Färbung abgefragt werden soll. 0 bei lokalen Aufruf.</desc></param>
<param><type>int</type><name>iOverlayID</name><desc>Wenn angegeben, wird stattdessen die Farbmodulation dieses Grafikoverlays abgefragt. Das Overlay muss vorher mit <funclink>SetGraphics</funclink> erstellt worden sein. Ab CR.</desc><optional /></param>
</params>
</syntax>
<desc>Fragt die Farbmodulation eines Objekts ab. Diese ist ein Farbwert, der multiplikativ (oder auch additiv, bei entsprechend aktiviertem BlitMode in der DefCore) aufgerechnet wird. Für weitere Hinweise siehe auch <funclink>SetClrModulation</funclink>().</desc>
<desc>Fragt die Farbmodulation des aufrufenden Objekts ab. Diese ist ein Farbwert, der multiplikativ (oder auch additiv, bei entsprechend aktiviertem BlitMode in der DefCore) aufgerechnet wird. Für weitere Hinweise siehe auch <funclink>SetClrModulation</funclink>().</desc>
<remark>Ist der Rückgabewert dieser Funktion 0, so wurde keine Farbmodulation durchgeführt (analog zu <funclink>RGBa</funclink>(255,255,255,0)).</remark>
<examples>
<example>
<code>global func SetObjAlpha(var byAlpha, pObj)
<code>global func SetObjAlpha(byAlpha, pObj)
{
var dwClrMod=GetClrModulation(pObj);
var dwClrMod=pObj->GetClrModulation();
<funclink>if</funclink> (!dwClrMod) dwClrMod = byAlpha&lt;&lt;24; else dwClrMod = dwClrMod &amp; 16777215 | byAlpha&lt;&lt;24;
<funclink>return</funclink>(<funclink>SetClrModulation</funclink>(dwClrMod, pObj));
<funclink>return</funclink>(pObj-><funclink>SetClrModulation</funclink>(dwClrMod));
}</code>
<text>Globale Funktion: Setzt nur den Alphawert der Farbmodulation eines Objekts.</text>
</example>
@ -31,7 +30,7 @@
<funclink>RGBa</funclink>
<funclink>SetGamma</funclink>
<funclink>SetClrModulation</funclink>
<funclink>GetColorDw</funclink>
<funclink>GetColor</funclink>
</related>
</func>
<author>Sven2</author><date>Fabruar 2004</date>

13
docs/sdk/script/fn/GetColor.xml
View File

@ -8,23 +8,20 @@
<version>4.9.1.0 GWE</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Abgefragtes Objekt. 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Fragt den indizierten Farbwert eines Objekts ab, nach dem die ColorByOwner-Flächern eingefärbt sind. Dieser konnte beispielsweise durch <funclink>SetOwner</funclink> oder <funclink>SetColor</funclink> gesetzt worden sein.</desc>
<remark>Die Funktion ist nur noch für das 8 Bit-Grafiksystem relevant. Normalerweise sollte der Farbwert eines Objekts mit <funclink>GetColorDw</funclink> abgefragt werden.</remark>
<desc>Fragt den RGB-Farbwert der Färbung der ColorByOwner-Flächen des aufrufenden Objekts ab. Diese werden beispielsweise durch <funclink>SetOwner</funclink> oder <funclink>SetColor</funclink> gesetzt.</desc>
<examples>
<example>
<code><funclink>SetColor</funclink>((GetColor()+1)%12);</code>
<code>caller-><funclink>SetColor</funclink>(GetColor());</code>
<text>Färbt das aufrufende Objekt auf die nächste Spielerfarbe um.</text>
<text>Färbt caller so ein wie das aktuelle Objekt.</text>
</example>
</examples>
<related>
<funclink>GetColorDw</funclink>
<funclink>GetPlrColor</funclink>
<funclink>SetColor</funclink>
<funclink>GetClrModulation</funclink>
</related>
</func>
<author>Sven2</author><date>Mai 2002</date>

32
docs/sdk/script/fn/GetColorDw.xml
View File

@ -1,32 +0,0 @@
<?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>GetColorDw</title>
<category>Objekte</category><subcat>Darstellung</subcat>
<version>4.9.1.0 GWE</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Abgefragtes Objekt. 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Fragt den RGB-Farbwert der Färbung der ColorByOwner-Flächen eines Objekts ab. Diese werden beispielsweise durch <funclink>SetOwner</funclink>, <funclink>SetColor</funclink> oder <funclink>SetColorDw</funclink> gesetzt.</desc>
<examples>
<example>
<code><funclink>SetColorDw</funclink>(GetColorDw(), caller);</code>
<text>Färbt caller so ein wie das aktuelle Objekt.</text>
</example>
</examples>
<related>
<funclink>GetPlrColorDw</funclink>
<funclink>GetColor</funclink>
<funclink>SetColorDw</funclink>
<funclink>GetClrModulation</funclink>
</related>
</func>
<author>Sven2</author><date>Mai 2002</date>
</funcs>

5
docs/sdk/script/fn/GetComDir.xml
View File

@ -8,11 +8,8 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt dessen ComDir abgefragt werden soll. 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Liefert die aktuelle Befehlsrichtung eines Objekts. Diese gibt die momentane, beabsichtigte Bewegungsrichtung an. Die Auswirkung dieser Richtung hängt von der <emlink href="definition/procedures.html">Prozedur</emlink> der aktuellen <emlink href="definition/actmap.html">Aktivität</emlink> ab.</desc>
<desc>Liefert die aktuelle Befehlsrichtung des aufrufenden Objekts. Diese gibt die momentane, beabsichtigte Bewegungsrichtung an. Die Auswirkung dieser Richtung hängt von der <emlink href="definition/procedures.html">Prozedur</emlink> der aktuellen <emlink href="definition/actmap.html">Aktivität</emlink> ab.</desc>
<related>
<emlink href="definition/procedures.html">Prozedur</emlink>
<funclink>SetComDir</funclink>

10
docs/sdk/script/fn/GetCommand.xml
View File

@ -13,12 +13,6 @@
<syntax>
<rtype>any</rtype>
<params>
<param>
<type>object</type>
<name>pObj</name>
<optional />
<desc>Objekt, von dem ein Kommando abgefragt wird.</desc>
</param>
<param>
<type>int</type>
<name>iElement</name>
@ -34,13 +28,13 @@
</params>
</syntax>
<desc>Gibt Informationen über ein Kommando eines Objekts zurück. Führt das Objekt momentan keine Aktion aus, so wird (bei jedem Wert von iElement) 0 zurückgegeben.</desc>
<desc>Gibt Informationen über ein Kommando des aufrufenden Objekts zurück. Führt das Objekt momentan keine Aktion aus, so wird (bei jedem Wert von iElement) 0 zurückgegeben.</desc>
<examples>
<example>
<code>func Timer()
{
if(GetCommand() eq "Enter" &amp;&amp; GetCommand(0, 1) == <funclink>FindBase</funclink>(<funclink>GetOwner</funclink>()))
if(GetCommand() == "Enter" &amp;&amp; GetCommand(1) == <funclink>FindBase</funclink>(<funclink>GetOwner</funclink>()))
<funclink>Enter</funclink>(<funclink>FindBase</funclink>(<funclink>GetOwner</funclink>()));
}</code>
<text>

7
docs/sdk/script/fn/GetCon.xml
View File

@ -8,14 +8,11 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt dessen Fertigstellung abgefragt werden soll.</desc><optional /></param>
</params>
</syntax>
<desc>Liefert die Fertigstellung eines Objekts in Prozent. Bei Baustellen ist dies die Fertigstellung, während es bei Tieren und Pflanzen die Größe angibt (Siehe StretchGrowth/OverSize in der <emlink href="definition/defcore.html">DefCore</emlink>)</desc>
<desc>Liefert die Fertigstellung des aufrufenden Objekts in Prozent. Bei Baustellen ist dies die Fertigstellung, während es bei Tieren und Pflanzen die Größe angibt (Siehe StretchGrowth/OverSize in der <emlink href="definition/defcore.html">DefCore</emlink>)</desc>
<examples>
<example>
<code><funclink>if</funclink> (GetCon(<funclink>GetCursor</funclink>()) > 50) <funclink>DoCon</funclink>(-10, <funclink>GetCursor</funclink>());</code>
<code><funclink>if</funclink> (<funclink>GetCursor</funclink>()->GetCon() > 50) <funclink>GetCursor</funclink>()-><funclink>DoCon</funclink>(-10);</code>
<text>Schrumpft den ausgewählten Clonk des ersten Spielers um 10% seiner Normalgröße, wenn er nicht schon auf halbe Größe geschrumpft ist.</text>
</example>
</examples>

7
docs/sdk/script/fn/GetContact.xml
View File

@ -9,18 +9,17 @@
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObject</name><desc>Objekt, dessen Kontaktstatus ermittelt werden soll. 0 bei lokalem Aufruf.</desc><optional /></param>
<param><type>int</type><name>iVertex</name><desc>Index des abzufragenden Vertex. -1 prüft alle Vertices, und gibt das Ergebnis als eine mit binärem Oder kombinierte Bitmaske zurück.</desc></param>
<param><type>int</type><name>dwCNAT</name><desc>Bitmaske von CNAT-Werten, die angeben, welche Richtungen geprüft werden sollen. Bei 0 werden alle Richtungen geprüft.</desc><optional /></param>
</params>
</syntax>
<desc>Ermittelt, in welche Richtungen einzelne oder alle Vertices eines Objekts feste Landschaft berühren. Die Richtungen werden als Bitmaske von <emlink href="definition/cnat.html">CNAT-Werten</emlink> übergeben bzw. von der Funktion zurückgegeben.</desc>
<desc>Ermittelt, in welche Richtungen einzelne oder alle Vertices des aufrufenden Objekts feste Landschaft berühren. Die Richtungen werden als Bitmaske von <emlink href="definition/cnat.html">CNAT-Werten</emlink> übergeben bzw. von der Funktion zurückgegeben.</desc>
<examples>
<example>
<code>protected func Activate(object pCaller)
{
[Hopp!]
if (GetContact(pCaller, -1) &amp; CNAT_Bottom) <funclink>return</funclink>(pCaller-><funclink>Jump</funclink>());
if (pCaller->GetContact(-1) &amp; CNAT_Bottom) <funclink>return</funclink>(pCaller-><funclink>Jump</funclink>());
<funclink>return</funclink>(false);
}</code>
<text>Script für eine Hüpfpille: Wenn man sie mit Doppelgraben aktiviert, hüpft der Clonk, falls er auf dem Boden steht.</text>
@ -34,4 +33,4 @@
</related>
</func>
<author>Sven2</author><date>Januar 2005</date>
</funcs>
</funcs>

7
docs/sdk/script/fn/GetController.xml
View File

@ -9,11 +9,8 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen kontrollierender Spieler abgegfragt werden soll. 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Fragt ab, welcher Spieler ein Objekt zur Zeit kontrolliert bzw. zuletzt kontrolliert hat. Bei Mannschaftsmitgliedern ist dies normalerweise immer der Besitzer; bei Fahrzeugen der Controller des Clonks, der es zuletzt bedient (angefasst und geschoben/gezogen) hat. Objekte, die von Lebewesen aufgenommen werden, nehmen automatisch den Controller ihres Containers an. Beim Besitzerwechsel (siehe <funclink>SetOwner</funclink>())wird automatisch auch der Controller auf den neuen Besitzer geändert.</desc>
<desc>Fragt ab, welcher Spieler das aufrufende Objekt zur Zeit kontrolliert bzw. zuletzt kontrolliert hat. Bei Mannschaftsmitgliedern ist dies normalerweise immer der Besitzer; bei Fahrzeugen der Controller des Clonks, der es zuletzt bedient (angefasst und geschoben/gezogen) hat. Objekte, die von Lebewesen aufgenommen werden, nehmen automatisch den Controller ihres Containers an. Beim Besitzerwechsel (siehe <funclink>SetOwner</funclink>())wird automatisch auch der Controller auf den neuen Besitzer geändert.</desc>
<remark>Der Controller wird durch eine temporäre Kontrolle durch beispielsweise <funclink>SetCursor</funclink> nicht verändert.</remark>
<examples>
<example>
@ -28,4 +25,4 @@
</related>
</func>
<author>Sven2</author><date>Mai 2002</date>
</funcs>
</funcs>

7
docs/sdk/script/fn/GetCrewEnabled.xml
View File

@ -9,14 +9,11 @@
<version>4.9.1.0 GWE</version>
<syntax>
<rtype>bool</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen Status abgefragt werden soll. 0 bei lokalem Aufruf.</desc></param>
</params>
</syntax>
<desc>Fragt ab, ob ein Mannschaftsmitglied gegenwärtig angewählt werden kann.</desc>
<examples>
<example>
<code><funclink>if</funclink> (!GetCrewEnabled(<funclink>GetHiRank</funclink>())) <funclink>SetCrewEnabled</funclink>(1, <funclink>GetCursor</funclink>());</code>
<code><funclink>if</funclink> (!<funclink>GetHiRank</funclink>()->GetCrewEnabled()) <funclink>GetHiRank</funclink>()-><funclink>SetCrewEnabled</funclink>(true);</code>
<text>Aktiviert den höchstrangigen Clonk des ersten Spielers, falls er noch nicht aktiviert ist.</text>
</example>
</examples>
@ -27,4 +24,4 @@
</related>
</func>
<author>Sven2</author><date>April 2002</date>
</funcs>
</funcs>

5
docs/sdk/script/fn/GetDamage.xml
View File

@ -9,11 +9,8 @@
<version>4.9.1.0 GWE</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen Schadenswert abgefragt werden soll. 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Fragt den Schadenswert eines Objekts ab.</desc>
<desc>Fragt den Schadenswert des aufrufenden Objekts ab.</desc>
<examples>
<example>
<code><funclink>if</funclink>(GetDamage() > 100) <funclink>Split2Components</funclink>();</code>

9
docs/sdk/script/fn/GetDefBottom.xml
View File

@ -8,14 +8,11 @@
<version>4.9.1.0 GWE<extversion>4.9.1.0 GWE</extversion></version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen Unterkante ermittelt werden soll. 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Fragt die Unterkante eines Objekts ab. Diese entspricht Y-Position + DefCore-OffsetY + DefCore-Height. Eine eventuelle Drehung wird hier nicht mit eingerechnet.</desc>
<desc>Fragt die Unterkante des aufrufenden Objekts ab. Diese entspricht Y-Position + DefCore-OffsetY + DefCore-Height. Eine eventuelle Drehung wird hier nicht mit eingerechnet.</desc>
<examples>
<example>
<code><funclink>Exit</funclink>(<funclink>Contents</funclink>(), 0, GetDefBottom()-<funclink>GetY</funclink>());</code>
<code><funclink>Contents</funclink>()-><funclink>Exit</funclink>(0, GetDefBottom()-<funclink>GetY</funclink>());</code>
<text>Befördert das erste Inhaltsobjekt aus dem ausrufenden Objekt heraus an seine mittlere Unterkante.</text>
</example>
</examples>
@ -24,4 +21,4 @@
</related>
</func>
<author>Sven2</author><date>April 2002</date>
</funcs>
</funcs>

12
docs/sdk/script/fn/GetDefCoreVal.xml
View File

@ -20,12 +20,6 @@
<desc>Sektion des abzufragenden Eintrags. Wird 0 übergeben, werden alle Sektionen nach einem Eintrag mit dem entspr. Namen durchsucht.</desc>
<optional/>
</param>
<param>
<type>id</type>
<name>idDef</name>
<desc>Objektdefinition, von der der Eintrag abgefragt werden soll. Bei Übergabe von 0 wird die Definition des aufrufenden Objekts angenommen.</desc>
<optional/>
</param>
<param>
<type>int</type>
<name>iEntryNr</name>
@ -35,7 +29,7 @@
</params>
</syntax>
<desc>Gibt einen Eigenschaftswert einer Objektdefinition nach seinem Namen in der <emlink href="definition/defcore.html">DefCore.txt</emlink>
<desc>Gibt einen Eigenschaftswert der aufrufenden Objektdefinition nach seinem Namen in der <emlink href="definition/defcore.html">DefCore.txt</emlink>
zurück.</desc>
<remark>Ist der abzufragende Eintrag eine ID-Liste (z.B. "Components" in der DefCore.txt), so wird bei
@ -43,8 +37,8 @@
<examples>
<example>
<code>var wdt = GetDefCoreVal("Width", "DefCore", GetID());</code>
<text>Ermittelt die Breite des Objekts. Die beiden letzten Parameter könnten in diesem Fall weggelassen werden.</text>
<code>var wdt = GetID()->GetDefCoreVal("Width", "DefCore");</code>
<text>Ermittelt die Breite des Objekts.</text>
</example>
<example>
<code><funclink>Log</funclink>(" Eine Werkstatt benötigt folgendes Material:");

6
docs/sdk/script/fn/GetDesc.xml
View File

@ -9,15 +9,11 @@
<version>4.6.5.0 CP<extversion>4.9.1.0 GWE</extversion></version>
<syntax>
<rtype>string</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen Beschreibung gesucht wird. 0 bei lokalem Aufruf.</desc><optional/></param>
<param><type>id</type><name>idDef</name><desc>Falls angegeben, wird stattdessen die Beschreibung dieser Definition zurückgegeben.</desc><optional/></param>
</params>
</syntax>
<desc>Gibt die Beschreibung eines Objekts oder einer Objektdefinition zurück. Die Beschreibung wird in Objektdefinitionen in der Desc**.txt angegeben.</desc>
<examples>
<example>
<code><funclink>Message</funclink>("%s|&lt;c ff0000&gt;%s&lt;/c&gt;", 0, <funclink>GetName</funclink>(<funclink>GetCursor</funclink>()), GetDesc(<funclink>GetCursor</funclink>()));</code>
<code><funclink>Message</funclink>("%s|&lt;c ff0000&gt;%s&lt;/c&gt;", nil, <funclink>GetCursor</funclink>()-><funclink>GetName</funclink>(), <funclink>GetCursor</funclink>()->GetDesc());</code>
<text>Gibt eine Meldung auf dem Bildschirm aus, die den Namen des gerade ausgewählten Clonks des ersten Spielers, sowie den Beschreibungstext seines Clonktyps enthält.</text>
</example>
</examples>

11
docs/sdk/script/fn/GetDir.xml
View File

@ -8,11 +8,8 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen Richtung abgefragt wird. 0 bei lokalem Aufruf.</desc></param>
</params>
</syntax>
<desc>Liefert die aktuelle Richtung eines Objekts als DIR_x()-Wert.</desc>
<desc>Liefert die aktuelle Richtung des aufrufenden Objekts als DIR_x-Wert.</desc>
<examples>
<example>
<code>/* Wird bei Doppelklick auf Graben aufgerufen */
@ -27,12 +24,12 @@ protected func Activate()
// Rotation des Pfeiles
var irot = -90 + 180 * <funclink>GetDir</funclink>();
// Pfeil schleudern
<funclink>Exit</funclink>(pArrow, iexitX, 0, irot, ispeedX, 0);
<funclink>return</funclink>(1);
pArrow-><funclink>Exit</funclink>(iexitX, 0, irot, ispeedX, 0);
<funclink>return</funclink> 1;
}
</code>
<text>Clonk der einen Bogen verschluckt hat.</text>
<text>Hinweis: <funclink>DIR_Left</funclink>() = 0 / <funclink>DIR_Right</funclink>() = 1</text>
<text>Hinweis: <funclink>DIR_Left</funclink> = 0 / <funclink>DIR_Right</funclink> = 1</text>
</example>
</examples>
<related>

5
docs/sdk/script/fn/GetEnergy.xml
View File

@ -8,11 +8,8 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Das Objekt, dessen Energiewert gesucht wird. 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Liefert den aktuellen Energiewert eines Objekts in Prozent. 100% stellen hierbei den maximalen Physical-Wert von 100000 dar. Siehe auch DefCore.txt Sektion [Physical]. pObj Null bei lokalem Aufruf.</desc>
<desc>Liefert den aktuellen Energiewert des aufrufenden Objekts in Prozent. 100% stellen hierbei den maximalen Physical-Wert von 100000 dar. Siehe auch DefCore.txt Sektion [Physical].</desc>
<remark>"Energy" ist bei Lebewesen deren Lebensenergie und bei Gebäuden die im Objekt vorhandene elektrische Energie.</remark>
<related>
<funclink>GetPhysical</funclink>

7
docs/sdk/script/fn/GetEntrance.xml
View File

@ -8,11 +8,8 @@
<version>4.9.1.0 GWE</version>
<syntax>
<rtype>bool</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen Entrance-Wert abgefragt wird. 0 bei lokalem Aufruf.</desc></param>
</params>
</syntax>
<desc>Liefert den aktuellen Eintrittsstatus eines Objekts. TRUE bei erlaubtem Eintritt, FALSE bei verbotenem Eintritt.</desc>
<desc>Liefert den aktuellen Eintrittsstatus des aufrufenden Objekts. TRUE bei erlaubtem Eintritt, FALSE bei verbotenem Eintritt.</desc>
<examples>
<example>
<code>/* Wird bei klick auf Spezial aufgerufen */
@ -21,7 +18,7 @@ protected func ControlSpecial()
// ist man irgendwo drinnen?
if(<funclink>Contained</funclink>())
// Tür zu?
if(!GetEntrance(<funclink>Contained</funclink>()))
if(!<funclink>Contained</funclink>()->GetEntrance())
// Selbstmord begehen!
<funclink>Kill</funclink>();
<funclink>return</funclink>(1);

7
docs/sdk/script/fn/GetID.xml
View File

@ -8,14 +8,11 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>id</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Das Objekt, dessen ID gesucht wird.</desc></param>
</params>
</syntax>
<desc>Gibt die ID eines Objekts zurück.</desc>
<desc>Gibt die ID des aufrufenden Objekts zurück.</desc>
<examples>
<example>
<code><funclink>CreateObject</funclink>(GetID(<funclink>this</funclink>()))</code>
<code><funclink>CreateObject</funclink>(GetID())</code>
<text>Erstellt ein Duplikat des aufrufenden Objekts.</text>
</example>
</examples>

5
docs/sdk/script/fn/GetKiller.xml
View File

@ -8,11 +8,8 @@
<version>4.9.6.0 CR</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Abzufragendes Objekt. 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Liefert den Spieler, der zuletzt Energieabzug an einem Objekt verursacht hat.</desc>
<desc>Liefert den Spieler, der zuletzt Energieabzug am aufrufenden Objekt verursacht hat.</desc>
<remark>Aufgrund der Komplexität der Spielwelt von Clonk ist es nicht immer möglich, den tatsächlichen Schadensverursacher in Kettenreaktionen korrekt ausfindig zu machen.
Zur Schadensverfolgung speichert jedes Objekt einen steuernden Spieler, der die Spielernummer des Spielers angibt, der ein Objekt zuletzt kontrolliert bzw. geworfen, geschoben, abgeschossen, etc. hat (für Details siehe <funclink>GetController</funclink>). Dieses Feld wird benutzt, um den Schaden erzeugenden Spieler zu ermitteln:<br />
<ul><li>Bei Objekttreffern der steuernde Spieler des geworfenen Objektes. Dieser wird für Gegenstände automatisch beim Einsammeln gesetzt.</li>

5
docs/sdk/script/fn/GetMagicEnergy.xml
View File

@ -8,11 +8,8 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Das Objekt, dessen Zauberenergiewert gesucht wird.</desc></param>
</params>
</syntax>
<desc>Liefert den aktuellen Zauberenergiewert eines Objekts. pObj Null bei lokalem Aufruf.</desc>
<desc>Liefert den aktuellen Zauberenergiewert des aufrufenden Objekts.</desc>
<related>
<funclink>GetPhysical</funclink>
</related>

6
docs/sdk/script/fn/GetMass.xml
View File

@ -8,12 +8,8 @@
<version>4.6.5.0 CP<extversion>4.9.1.0 GWE</extversion></version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Gewogenes Objekt. 0 bei lokalem Aufruf oder angegebenem idDef.</desc><optional /></param>
<param><type>id</type><name>idDef</name><desc>Objektdefinition, von der das Standardgewicht ermittelt werden soll. 0 bei angegebenem pObj</desc><optional /></param>
</params>
</syntax>
<desc>Liefert die Masse eines Objekts inklusive aller Inhaltsobjekte. Bei angegebenem idDef wird pObj ignoriert und stattdessen die Standardmasse der Objektdefinition zurückgegeben. Sind idDef und pObj 0, gilt das aufrufende Objekt als pObj.</desc>
<desc>Liefert die Masse des aufrufenden Objekts (inklusive aller Inhaltsobjekte) oder der aufrufenden Definition.</desc>
<examples>
<example>
<code>/* Wird bei klick auf Spezial aufgerufen */

9
docs/sdk/script/fn/GetMenu.xml
View File

@ -7,13 +7,10 @@
<category>Objekte</category><subcat>Menü</subcat>
<version>4.9.1.0 GWE</version>
<syntax>
<rtype>id</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Menüobjekt</desc></param>
</params>
<rtype>id?</rtype>
</syntax>
<desc>Liefert die ID des Menüs, falls das Objekt ein Menü geöffnet hat. Normalerweise ist das die ID des Menüsymbols (idSymbol), wenn nicht bei <funclink>CreateMenu</funclink> explizit eine andere Menü-ID als idMenuID angegeben wurde. 0 bei keinem Menü oder bei keinem Symbol.</desc>
<remark>Ein Rückgabewert von -1 bedeutet, dass kein gültiges Symbol ermittelt werden konnte. Dies kann z.B. dann auftreten, wenn bei einem globalen Aufruf kein Objektzeiger an die Funktion übergeben wurde. Engineinterne Menüs (Kaufen, Verkaufen, etc.) geben keine gültigen IDs zurück.</remark>
<desc>Liefert die ID des Menüs, falls das Objekt ein Menü geöffnet hat. Normalerweise ist das die ID des Menüsymbols (idSymbol), wenn nicht bei <funclink>CreateMenu</funclink> explizit eine andere Menü-ID als idMenuID angegeben wurde. NONE bei keinem Symbol.</desc>
<remark>Ein Rückgabewert von nil bedeutet, dass kein gültiges Symbol ermittelt werden konnte. Dies kann z.B. dann auftreten, wenn kein Menü geöffnet ist. Engineinterne Menüs (Kaufen, Verkaufen, etc.) geben keine gültigen IDs zurück.</remark>
<examples>
<example>
<code>/* Wird bei klick auf Spezial aufgerufen */

11
docs/sdk/script/fn/GetMenuSelection.xml
View File

@ -7,15 +7,12 @@
<category>Objekte</category><subcat>Menü</subcat>
<version>4.9.1.0 GWE</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen Menü abgefragt wird. 0 bei lokalem Aufruf.</desc></param>
</params>
<rtype>int?</rtype>
</syntax>
<desc>Ermittelt den gerade ausgewählten Menüeintrag des geöffneten Menüs eines Objekts.</desc>
<desc>Ermittelt den gerade ausgewählten Menüeintrag des geöffneten Menüs des aufrufenden Objekts, oder nil, wenn kein Menü geöffnet ist.</desc>
<examples>
<example>
<code><funclink>Log</funclink>("Aktuelle Auswahl: Punkt %d...", GetMenuSelection(<funclink>GetCursor</funclink>(0));</code>
<code><funclink>Log</funclink>("Aktuelle Auswahl: Punkt %d...", <funclink>GetCursor</funclink>(0)->GetMenuSelection();</code>
<text>Gibt ins Log aus, welchen Menüpunkt der Spieler gerade gewählt hat.</text>
</example>
</examples>
@ -24,4 +21,4 @@
</related>
</func>
<author>Sven2</author><date>November 2001</date>
</funcs>
</funcs>

4
docs/sdk/script/fn/GetName.xml
View File

@ -8,10 +8,6 @@
<version>4.6.5.0 CP<extversion>4.9.1.0 GWE</extversion></version>
<syntax>
<rtype>string</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Das Objekt, dessen Name gesucht wird. 0 bei lokalem Aufruf.</desc><optional/></param>
<param><type>id</type><name>idDef</name><desc>Falls angegeben, wird stattdessen der Name dieser Definition zurückgegeben.</desc><optional/></param>
</params>
</syntax>
<desc>Gibt den Namen eines Objekts oder einer Objektdefinition zurück. Hat das Objekt keinen eigenen Namen, wird der Name der Definition zurückgegeben.</desc>
</func>

9
docs/sdk/script/fn/GetOCF.xml
View File

@ -8,20 +8,17 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen OCF abgefragt wird. 0 bei lokalem Aufruf.</desc></param>
</params>
</syntax>
<desc>Liefert das Object-Character-Flag eines Objekts. Dieser Wert beschreibt den aktuellen Zustand des Objekts. Der Rückgabewert ist eine Bitmaske und kann mit BitAnd() mit einem OCF_x()-Wert verglichen werden.</desc>
<desc>Liefert das Object-Character-Flag des aufrufenden Objekts. Dieser Wert beschreibt den aktuellen Zustand des Objekts. Der Rückgabewert ist eine Bitmaske und kann mit &amp; mit einem OCF_x-Wert verglichen werden.</desc>
<examples>
<example>
<code>/* Wird bei Schäden aufgerufen */
protected func Damage()
{
// Brennt?
if(GetOCF() &amp; <funclink>OCF_OnFire</funclink>())
if(GetOCF() &amp; <funclink>OCF_OnFire</funclink>)
// Freuen
<funclink>Message</funclink>("Juhu! Ich brenne!", <funclink>this</funclink>());
<funclink>Message</funclink>("Juhu! Ich brenne!", <funclink>this</funclink>);
<funclink>return</funclink>(1);
}
</code>

3
docs/sdk/script/fn/GetObjectBlitMode.xml
View File

@ -9,11 +9,10 @@
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen Zeichenstil abgefragt werden soll. 0 bei lokalem Aufruf.</desc><optional /></param>
<param><type>int</type><name>iOverlayID</name><desc>Wenn angegeben, wird stattdessen der Blitmodus dieses Grafikoverlays abgefragt. Das Overlay muss vorher mit <funclink>SetGraphics</funclink> erstellt worden sein. Ab CR.</desc><optional /></param>
</params>
</syntax>
<desc>Liefert den aktuellen Zeichenmodus eines Objekts.</desc>
<desc>Liefert den aktuellen Zeichenmodus des aufrufenden Objekts.</desc>
<remark>Für eine Übersicht über die Zeichenmodi, siehe <funclink>SetObjectBlitMode</funclink>().</remark>
<remark>Für ein Beispiel siehe <funclink>SetObjectBlitMode</funclink>().</remark>
<related>

10
docs/sdk/script/fn/GetObjectInfoCoreVal.xml
View File

@ -20,12 +20,6 @@
<desc>Sektion des abzufragenden Eintrags. Wird 0 übergeben, werden alle Sektionen nach einem Eintrag mit dem entspr. Namen durchsucht.</desc>
<optional/>
</param>
<param>
<type>object</type>
<name>pObj</name>
<desc>Objekt, von dem der Eintrag abgefragt werden soll. Null bei lokalen Aufrufen.</desc>
<optional/>
</param>
<param>
<type>int</type>
<name>iEntryNr</name>
@ -43,11 +37,11 @@
<examples>
<example>
<code>var exp = GetObjCoreExperience(obj);</code>
<code>var exp = obj->GetObjCoreExperience();</code>
<text>Ermittelt die Erfahrung eines Objekts (Objekt muss Crewmember sein!). GetObjCoreExperience
ist dabei eine globale Funktion aus GetXVal.c (siehe Anmerkung).<br/>
Obiger Code entspricht:</text>
<code>var exp = GetObjectInfoCoreVal("Experience", "ObjectInfo", obj);</code>
<code>var exp = obj->GetObjectInfoCoreVal("Experience", "ObjectInfo");</code>
</example>
</examples>

8
docs/sdk/script/fn/GetObjectVal.xml
View File

@ -20,12 +20,6 @@
<desc>Sektion des abzufragenden Eintrags. Wird 0 übergeben, werden alle Sektionen nach einem Eintrag mit dem entspr. Namen durchsucht.</desc>
<optional/>
</param>
<param>
<type>object</type>
<name>pObj</name>
<desc>Objekt, von dem der Eintrag abgefragt werden soll. Null bei lokalen Aufrufen.</desc>
<optional/>
</param>
<param>
<type>int</type>
<name>iEntryNr</name>
@ -35,7 +29,7 @@
</params>
</syntax>
<desc>Gibt einen Eigenschaftswert eines Objekts nach seinem Namen in der Objects.txt zurück.</desc>
<desc>Gibt einen Eigenschaftswert des aufrufenden Objekts nach seinem Namen in der Objects.txt zurück.</desc>
<remark>Die meisten Möglichkeiten für Werte von strEntry sind bereits in System.c4g/GetXVal.c vordefiniert</remark>

7
docs/sdk/script/fn/GetOwner.xml
View File

@ -8,11 +8,8 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, von dem der Besitzer ermittelt wird. 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Ermittelt den Besitzer eines Objekts.</desc>
<desc>Ermittelt den Besitzer des aufrufenden Objekts.</desc>
<examples>
<example>
<code><funclink>Message</funclink>("Ich gehöre %s!", <funclink>this</funclink>(), <funclink>GetPlayerName</funclink>(GetOwner()))</code>
@ -24,4 +21,4 @@
</related>
</func>
<author>Sven2</author><date>November 2001</date>
</funcs>
</funcs>

5
docs/sdk/script/fn/GetPhase.xml
View File

@ -8,11 +8,8 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt dessen Aktivitätsphase zurückgegeben werden soll. Null bei lokalem Aufruf.</desc></param>
</params>
</syntax>
<desc>Liefert die Aktivitätsphase von *pObj. *pObj ist Null bei lokalem Aufruf.</desc>
<desc>Liefert die Aktivitätsphase des aufrufenden Objekts.</desc>
<related>
<funclink>GetAction</funclink>
<funclink>GetActTime</funclink>

15
docs/sdk/script/fn/GetPhysical.xml
View File

@ -10,22 +10,25 @@
<rtype>int</rtype>
<params>
<param><type>string</type><name>szPhysical</name><desc>Name der abzufragenden physischen Eigenschaft.</desc></param>
<param><type>int</type><name>iMode</name><desc>iMode 0 liefert die gerade aktuellen Eigenschaften (permanent oder temporär) und kann auch bei Objekten ohne Objektinfo (z.B. Fahrzeugen oder Gebäuden) angewendet werden. iMode 1 liefert die permanenten Eigenschaften aus der Objektinfo. iMode 2 liefert die temporären Eigenschaften, allerdings nur wenn sich die Eigenschaften auch gerade im temporären Modus befinden.</desc></param>
<param><type>object</type><name>pObj</name><desc>Das Objekt, dessen Physical festgestellt wird. Null bei lokalen Aufrufen.</desc></param>
<param><type>id</type><name>idDef</name><desc>Wenn angegeben, wird stattdessen der Definitionswert der angegebenen Definition aus der DefCore.txt, Sektion [Physical] zurückgegeben.</desc></param>
<param><type>int</type><name>iMode</name><desc>Änderungsmodus (symbolische Konstanten ab CR):<br />
<table><rowh><col>Konstante</col><col>Wert</col><col>Bedeutung</col></rowh>
<row><col>PHYS_Current</col><col>0</col><col>Im Objektkontext: Die Eigenschaften werden im gerade aktiven Modus (temporär oder permanent) des Objektes abgefragt. Dieser Modus funktioniert als einziger auch bei Objekten ohne Objektinfo. Im Definitionskontext: Die Standardwerte der Definition werden abgefragt.</col></row>
<row><col>PHYS_Permanent</col><col>1</col><col>Die permanenten Eigenschaften aus der Spielerdatei werden abgefragt. Dies ist nur bei Spielercrew-Mitgliedern möglich.</col></row>
<row><col>PHYS_Temporary</col><col>2</col><col>Die temporären Eigenschaften werden abgefragt, wenn sie existieren.</col></row>
</param>
</params>
</syntax>
<desc>Liefert die physischen Eigenschaften eines Objekts.</desc>
<desc>Liefert die physischen Eigenschaften des Objekts oder der Definition im Aufrufkontext.</desc>
<examples>
<example>
<code><funclink>if</funclink> (GetPhysical("Magic", 0, <funclink>GetCursor</funclink>())) <funclink>Message</funclink>("Ich kann zaubern!", <funclink>GetCursor</funclink>());</code>
<code><funclink>if</funclink> (<funclink>GetCursor</funclink>()->GetPhysical("Magic")) <funclink>GetCursor</funclink>()-><funclink>Message</funclink>("Ich kann zaubern!");</code>
<text>Der ausgewählte Clonk des ersten Spielers freut sich, wenn er gerade Zauberenergie aufnehmen kann.</text>
</example>
</examples>
<related>
<funclink>SetPhysical</funclink>
<funclink>TrainPhysical</funclink>
<funclink>ResetPhysical</funclink>
<funclink>ResetPhysical</funclink>
</related>
</func>
<author>jwk</author><date>Juni 2002</date>

8
docs/sdk/script/fn/GetPlrColorDw.xml → docs/sdk/script/fn/GetPlrColor.xml
View File

@ -3,7 +3,7 @@
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<title>GetPlrColorDw</title>
<title>GetPlrColor</title>
<category>Spieler</category>
<version>4.9.5.0 CE</version>
<syntax>
@ -16,14 +16,14 @@
<examples>
<example>
<code><funclink>Message</funclink>("&lt;c %x&gt;%s&lt;/c&gt; hat %d Punkte.", 0, GetPlrColorDw(0), <funclink>GetPlayerName</funclink>(0), <funclink>GetScore</funclink>(0));</code>
<code><funclink>Message</funclink>("&lt;c %x&gt;%s&lt;/c&gt; hat %d Punkte.", 0, GetPlrColor(0), <funclink>GetPlayerName</funclink>(0), <funclink>GetScore</funclink>(0));</code>
<text>Gibt Statusinformationen über den ersten Spieler aus, wobei dessen Spielername in seiner Spielerfarbe gefärbt wird.</text>
</example>
</examples>
<related>
<funclink>GetColorDw</funclink>
<funclink>SetColorDw</funclink>
<funclink>GetColor</funclink>
<funclink>SetColor</funclink>
</related>
</func>
<author>Sven2</author><date>Oktober 2003</date>

11
docs/sdk/script/fn/GetPortrait.xml
View File

@ -9,22 +9,21 @@
<syntax>
<rtype>any</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, über dessen Portrait Informationen abgefragt werden sollen. 0 bei lokalem Aufruf.</desc><optional /></param>
<param><type>bool</type><name>fGetID</name><desc>Wenn TRUE gibt die Funktion die ID der Definition zurück, aus der das Portrait stammt. Andernfalls wird der Name des Portraits zurückgegeben.</desc><optional /></param>
<param><type>bool</type><name>fGetPermanent</name><desc>Wenn TRUE gibt die Funktion die Portraitwerte des permanenten Portraits zurück, sonst die des momentan verwendeten.</desc><optional /></param>
</params>
</syntax>
<desc>Fragt Name oder ID des Portraits eines Crew-Mitglieds ab.</desc>
<desc>Fragt Name oder ID des Portraits des aufrufenden Crew-Mitglieds ab.</desc>
<remark>Hat das Crew-Mitglied ein individuelles Portrait, so gibt die Funktion "custom" bzw. die ID NONE zurück. Siehe dazu auch die Tabelle und die Beschreibung des fCopyGfx-Parameters von <funclink>SetPortrait</funclink></remark>
<examples>
<example>
<code>if(!WildcardMatch(<funclink>GetPortrait</funclink>(0, 0, 1), "?") )
<funclink>SetPortrait</funclink>("random", 0, <funclink>GetPortrait</funclink>(0, 1, 1), 1);
<code>if(!WildcardMatch(<funclink>GetPortrait</funclink>(0, 1), "?") )
<funclink>SetPortrait</funclink>("random", <funclink>GetPortrait</funclink>(1, 1), 1);
</code>
<text>Weißt dem aufrufenden Clonk ein zufälliges Portrait zu, wenn der Name des momentanen Portraits nicht aus nur einem Zeichen besteht (zum Beispiel wenn die Portraits mit "1", "2", "3" etc. durchnummeriert sind), sondern länger ist (beispielsweise "Armored1" oder "Armored2").</text>
<text>Weist dem aufrufenden Clonk ein zufälliges Portrait zu, wenn der Name des momentanen Portraits nicht aus nur einem Zeichen besteht (zum Beispiel wenn die Portraits mit "1", "2", "3" etc. durchnummeriert sind), sondern länger ist (beispielsweise "Armored1" oder "Armored2").</text>
</example>
<example>
<code><funclink>SetPortrait</funclink>(<funclink>GetPortrait</funclink>(0, 0, 1), 0, <funclink>GetPortrait</funclink>(0, 1, 1) );
<code><funclink>SetPortrait</funclink>(<funclink>GetPortrait</funclink>(0, 1), <funclink>GetPortrait</funclink>(1, 1) );
</code>
<text>Stellt das Standardportrait eines Clonkes wieder her, falls es zwischenzeitlich durch andere SetPortrait-Aufrufe geändert wurde.</text>
</example>

5
docs/sdk/script/fn/GetProcedure.xml
View File

@ -8,11 +8,8 @@
<version>4.9.1.0 GWE</version>
<syntax>
<rtype>string</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Abzufragendes Objekt. 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Gibt die Prozedur der gegenwärtigen Aktivität eines Objekts zurück (z.B. FLOAT, ATTACH, etc.). Bei einer NONE-Prozedur oder keiner Aktivität wird 0 zurückgegeben.</desc>
<desc>Gibt die Prozedur der gegenwärtigen Aktivität des aufrufenden Objekts zurück (z.B. FLOAT, ATTACH, etc.). Bei einer NONE-Prozedur oder keiner Aktivität wird nil zurückgegeben.</desc>
<related>
<funclink>GetAction</funclink>
</related>

5
docs/sdk/script/fn/GetR.xml
View File

@ -8,11 +8,8 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt dessen Rotation zurück gegeben werden soll. Null bei lokalem Aufruf.</desc></param>
</params>
</syntax>
<desc>Liefert die Rotation in Grad von *pObj. Der Rückgabewert liegt zwischen -180° und 180°. 0° ist der Normalzustand.</desc>
<desc>Liefert die Rotation des aufrufenden Objekts in Grad. Der Rückgabewert liegt zwischen -180° und 180°. 0° ist der Normalzustand.</desc>
<related>
<funclink>GetRDir</funclink>
<funclink>SetR</funclink>

3
docs/sdk/script/fn/GetRDir.xml
View File

@ -9,11 +9,10 @@
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt dessen Rotations-Geschwindigkeit zurück gegeben werden soll. Null bei lokalem Aufruf.</desc></param>
<param><type>int</type><name>iPrecision</name><desc>Genauigkeit. Keine Angabe oder Null entspricht 10.</desc><optional/></param>
</params>
</syntax>
<desc>Liefert die Rotations-Geschwindigkeit von pObj.</desc>
<desc>Liefert die Rotations-Geschwindigkeit des aufrufenden Objekts.</desc>
<related>
<funclink>SetRDir</funclink>
<funclink>GetR</funclink>

5
docs/sdk/script/fn/GetRank.xml
View File

@ -8,11 +8,8 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt dessen Rang zurück gegeben werden soll. Null bei lokalem Aufruf.</desc></param>
</params>
</syntax>
<desc>Liefert die Rang-Nummer von pObj. 0 ist ein unbeförderter Clonk. *pObj ist Null bei lokalem Aufruf.</desc>
<desc>Liefert die Rang-Nummer des aufrufenden Objekts. 0 ist ein unbeförderter Clonk.</desc>
<related>
<funclink>GetHiRank</funclink>
</related>

1
docs/sdk/script/fn/GetUnusedOverlayID.xml
View File

@ -10,7 +10,6 @@
<rtype>int</rtype>
<params>
<param><type>int</type><name>iBaseIndex</name><desc>ID des Overlays hinter dem die Suche beginnen soll.</desc></param>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen Overlays durchsucht werden sollen. Kann bei lokalen Aufrufen 0 sein.</desc></param>
</params>
</syntax>
<desc>Gibt eine ungenutzte Overlay-ID zurück. Es wird der erste freie Overlay nach iBaseIndex zurückgegeben.</desc>

6
docs/sdk/script/fn/GetValue.xml
View File

@ -9,19 +9,17 @@
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, von dem der aktuelle Wert abgefragt werden soll. 0 bei lokalem Aufruf oder angegebenem idDef.</desc><optional /></param>
<param><type>id</type><name>idDef</name><desc>Wenn angegeben: Definition, von der der Standardwert abgefragt werden soll. Ansonsten wird pObj ausgewertet.</desc><optional /></param>
<param><type>object</type><name>pBase</name><desc>Basis, in der gekauft wird. Falls pObj einen CalcValue-Aufruf zur Verfügung stellt, wird dieser Parameter an den Aufruf weitergegeben.</desc><optional /></param>
<param><type>int</type><name>iForPlayer</name><desc>Spieler, für den der Wert gilt. Falls pObj einen CalcValue-Aufruf zur Verfügung stellt, wird auch dieser Parameter an den Aufruf weitergegeben.</desc><optional /></param>
</params>
</syntax>
<desc>Gibt einen Objekt- oder Definitionswert zurück. Bei angegebenem idDef wird der Definitionswert zurückgegeben, ansonsten der Objektwert von pObj oder dem aufrufenden Objekt bei pObj=0.<br />Ein Objektwert berechnet sich folgendermaßen: Bei angegebenem pObj wird zunächst geprüft, ob eine CalcValue-Funktion im Script des Objekttyps von pObj vorhanden ist, und gegebenenfalls ausgewertet. Ansonsten wird der Definitionswert (siehe nächster Absatz) verwendet. Unabhängig davon wird der Wert des Objekts immer der Fertigstellung (GetCon()/100) multipliziert. Tote Lebewesen (GetCategory()&amp;OCF_Living() &amp;&amp; !GetAlive()) haben immer den Wert 0.<br />Der Definitionswert wird folgendermaßen ermittelt: Ist eine CalcDefValue-Funktion im Script vorhanden, wird diese ausgewertet. Ansonsten wird eine Wertüberladung aus der Scenario.txt verwendet. Ist diese ebenfalls nicht vorhanden, wird der in der DefCore angegebene Wert benutzt.<br /></desc>
<desc>Gibt einen Objekt- oder Definitionswert zurück.<br />Ein Objektwert berechnet sich folgendermaßen: Zunächst geprüft, ob eine CalcValue-Funktion im Script des Objekttyps vorhanden ist, und gegebenenfalls ausgewertet. Ansonsten wird der Definitionswert (siehe nächster Absatz) verwendet. Unabhängig davon wird der Wert des Objekts immer mit der Fertigstellung (<funclink>GetCon</funclink>()/100) multipliziert. Tote Lebewesen (<funclink>GetCategory</funclink>()&amp;<funclink>OCF_Living</funclink> &amp;&amp; !<funclink>GetAlive</funclink>()) haben immer den Wert 0.<br />Der Definitionswert wird folgendermaßen ermittelt: Ist eine CalcDefValue-Funktion im Script vorhanden, wird diese ausgewertet. Ansonsten wird eine Wertüberladung aus der Scenario.txt verwendet. Ist diese ebenfalls nicht vorhanden, wird der in der DefCore angegebene Wert benutzt.<br /></desc>
<remark>Die beiden Parameter pBase und iForPlayer sind für szenarienspezifische Handelsmodelle gedacht, und werden nur in CalcValue/CalcDefValue-Aufrufen verwendet.</remark>
<examples>
<example>
<code>var iValue=GetValue();
<funclink>while</funclink> (iValue-->0) <funclink>CreateContents</funclink>(ROCK);
<funclink>RemoveObject</funclink>(0, 1);</code>
<funclink>RemoveObject</funclink>(true);</code>
<text>Objektscript: Das Objekt erzeugt so viele Steine, wie es wert ist, und vernichtet sich dann selber (wobei es die Steine auswirft).</text>
</example>
</examples>

43
docs/sdk/script/fn/GetVertex.xml
View File

@ -2,24 +2,31 @@
<!DOCTYPE funcs SYSTEM "../../../clonk.dtd">
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<title>GetVertex</title>
<category>Objekte</category><subcat>Vertices</subcat>
<version>4.6.5.0 CP</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>int</type><name>iIndex</name><desc>Index des Vertex.</desc></param>
<param><type>bool</type><name>fY</name><desc>Bei fY 0 wird die X-Koordinate, bei fY 1 die Y-Koordinate zurückgegeben.</desc></param>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen Vertices ausgelesen werden. 0 bei lokalem Aufruf.</desc><optional/></param>
</params>
</syntax>
<desc>Liefert eine Koordinate des indizierten Vertex (siehe <emlink href="definition/defcore.html">DefCore.txt</emlink>) eines Objekts. Koordinaten in Relation zur Objektmitte.</desc>
<related>
<func>
<title>GetVertex</title>
<category>Objekte</category><subcat>Vertices</subcat>
<version>4.6.5.0 CP</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>int</type><name>iIndex</name><desc>Index des Vertex.</desc></param>
<param><type>int</type><name>data</name><desc>
<table><rowh><col>Wert</col><col>Bedeutung</col></rowh>
<row><col>VTX_X</col><col>X-Koordinate des Vertex.</col></row>
<row><col>VTX_Y</col><col>Y-Koordinate des Vertex.</col></row>
<row><col>VTX_CNAT</col><col><emlink href="definition/cnat.html">CNAT-Wert</emlink> des Vertex.</col></row>
<row><col>VTX_Friction</col><col>Reibung des Vertex.</col></row>
</table></desc>
</param>
</params>
</syntax>
<desc>Liefert eine Koordinate des indizierten Vertex (siehe <emlink href="definition/defcore.html">DefCore.txt</emlink>) des aufrufenden Objekts. Koordinaten in Relation zur Objektmitte.</desc>
<related>
<funclink>SetVertex</funclink>
<funclink>GetVertexNum</funclink>
</related>
</func>
<author>jwk</author><date>August 2002</date>
<funclink>GetVertexNum</funclink>
</related>
</func>
<author>jwk</author><date>August 2002</date>
<author>isilkor</author><date>2009-08-12</date>
</funcs>

5
docs/sdk/script/fn/GetVertexNum.xml
View File

@ -8,11 +8,8 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen Vertices ausgelesen werden. 0 bei lokalem Aufruf.</desc><optional/></param>
</params>
</syntax>
<desc>Liefert die Anzahl der Vertices eines Objekts.</desc>
<desc>Liefert die Anzahl der Vertices des aufrufenden Objekts.</desc>
<related>
<funclink>GetVertex</funclink>
</related>

5
docs/sdk/script/fn/GetX.xml
View File

@ -8,11 +8,8 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt dessen X-Wert zurück gegeben werden soll. Null bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Liefert die X-Position von *pObj.</desc>
<desc>Liefert die X-Position des aufrufenden Objekts.</desc>
<related>
<funclink>GetXDir</funclink>
<funclink>GetYDir</funclink>

3
docs/sdk/script/fn/GetXDir.xml
View File

@ -9,11 +9,10 @@
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt dessen Geschwindigkeit zurück gegeben werden soll. Null bei lokalem Aufruf.</desc></param>
<param><type>int</type><name>iPrecision</name><desc>Genauigkeit mit der die Geschwindigkeit zurückgegeben werden soll (Standardwert: 10)</desc></param>
</params>
</syntax>
<desc>Liefert die Geschwindigkeit in X-Richtung von pObj.</desc>
<desc>Liefert die Geschwindigkeit in X-Richtung des aufrufenden Objekts.</desc>
<remark>Es wird immer die wahre Geschwindigkeit (in Pixeln pro Frame) mal iPrecision zurückgegeben. Wird iPrecision also nicht angegeben, wird immer das zehnfache der "wahren" Geschwindigkeit zurückgegeben!</remark>
<related>
<funclink>GetYDir</funclink>

5
docs/sdk/script/fn/GetY.xml
View File

@ -8,11 +8,8 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt dessen Y-Wert zurück gegeben werden soll. Null bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Liefert die Y-Position von *pObj.</desc>
<desc>Liefert die Y-Position des aufrufenden Objekts.</desc>
<related>
<funclink>GetXDir</funclink>
<funclink>GetYDir</funclink>

3
docs/sdk/script/fn/GetYDir.xml
View File

@ -9,11 +9,10 @@
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt dessen Geschwindigkeit zurück gegeben werden soll. Null bei lokalem Aufruf.</desc></param>
<param><type>int</type><name>iPrecision</name><desc>Genauigkeit mit der die Geschwindigkeit zurückgegeben werden soll (Standardwert: 10)</desc></param>
</params>
</syntax>
<desc>Liefert die Geschwindigkeit in Y-Richtung von pObj.</desc>
<desc>Liefert die Geschwindigkeit in Y-Richtung des aufrufenden Objekts.</desc>
<remark>Es wird immer die wahre Geschwindigkeit (in Pixeln pro Frame) mal iPrecision zurückgegeben. Wird iPrecision also nicht angegeben, wird immer das zehnfache der "wahren" Geschwindigkeit zurückgegeben!</remark>
<related>
<funclink>GetXDir</funclink>

11
docs/sdk/script/fn/GrabObjectInfo.xml
View File

@ -15,22 +15,17 @@
<name>pFrom</name>
<desc>Objekt (Clonk), von dem die Infosektion genommen werden soll.</desc>
</param>
<param>
<type>object</type><optional />
<name>pTo</name>
<desc>Objekt (Clonk), das die Infosektion übernehmen soll. 0 bei lokalem Aufruf.</desc>
</param>
</params>
</syntax>
<desc>Überträgt die Infosektion von einem anderen Objekt zu pFrom bzw. dem aufrufenden Objekt. Die Infosektion enthält Namen, Rang, permantente Physicals, usw. Mit diesem Befehl lassen sich beispielsweise Wiederbelebungen realisieren, indem einfach beim Tod eines Clonks ein neuer erstellt und die Infosektion übertragen wird.</desc>
<remark>Der Befehl impliziert ein <funclink>MakeCrewMember</funclink> zum bestizenden Spieler. Der Clonk sollte also nicht schon vor dem Aufruf mit MakeCrewMember zur Spielercrew hinzugefügt werden, weil dadurch jeweils ein neuer Clonk aus der Crew eingestellt und sofort wieder entlassen würde.</remark>
<desc>Überträgt die Infosektion von einem anderen Objekt zu dem aufrufenden Objekt. Die Infosektion enthält Namen, Rang, permantente Physicals, usw. Mit diesem Befehl lassen sich beispielsweise Wiederbelebungen realisieren, indem einfach beim Tod eines Clonks ein neuer erstellt und die Infosektion übertragen wird.</desc>
<remark>Der Befehl impliziert ein <funclink>MakeCrewMember</funclink> zum besitzenden Spieler. Der Clonk sollte also nicht schon vor dem Aufruf mit MakeCrewMember zur Spielercrew hinzugefügt werden, weil dadurch jeweils ein neuer Clonk aus der Crew eingestellt und sofort wieder entlassen würde.</remark>
<examples>
<example>
<code>protected Death:
var newclnk = <funclink>CreateObject</funclink>(<funclink>GetID</funclink>(), <funclink>Random</funclink>(<funclink>LandscapeWidth</funclink>())-<funclink>GetX</funclink>(), <funclink>Random</funclink>(<funclink>LandscapeHeight</funclink>())-<funclink>GetY</funclink>(), <funclink>GetOwner</funclink>());
GrabObjectInfo(<funclink>this</funclink>(), newclnk);
newclnk->GrabObjectInfo(<funclink>this</funclink>());
<funclink>return</funclink>(1);</code>
<text>Dieser Teil eines Objektscripts sorgt dafür, dass ein Clonk bei seinem Tod irgendwo in der Landschaft neu erstellt wird, und unter demselben Namen und mit denselben Physicals weiterspielen kann.</text>
</example>

9
docs/sdk/script/fn/InLiquid.xml
View File

@ -8,15 +8,8 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>object</type>
<name>pObj</name>
<desc>Zielobjekt. 0 bei lokalem Aufruf.</desc>
</param>
</params>
</syntax>
<desc>Gibt TRUE zurück, wenn sich das Objekt in einer Flüssigkeit befindet.</desc>
<desc>Gibt TRUE zurück, wenn sich das aufrufende Objekt in einer Flüssigkeit befindet.</desc>
<related>
<funclink>OCF_InLiquid</funclink>
<funclink>GBackLiquid</funclink>

9
docs/sdk/script/fn/Incinerate.xml
View File

@ -8,15 +8,8 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>object</type>
<name>pObj</name>
<desc>Objekt, welches entzündet werden soll.</desc>
</param>
</params>
</syntax>
<desc>Zündet das übergebene Objekt an. In dem jeweiligen Objekt wird ggf. Incineration() aufgerufen</desc>
<desc>Zündet das aufrufende Objekt an. In dem jeweiligen Objekt wird ggf. Incineration() aufgerufen</desc>
<related>
<funclink>OnFire</funclink>
<funclink>OCF_OnFire</funclink>

7
docs/sdk/script/fn/Jump.xml
View File

@ -9,13 +9,6 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>object</type>
<name>pObj</name>
<desc>Objekt, das springen soll.</desc>
</param>
</params>
</syntax>
<desc>Veranlasst das Objekt dazu, zu springen. Dabei gelten sämtliche Beschränkungen, die auch bei Ansteuerung über die Tastatur gelten:
Das Objekt kann nur springen, wenn es gerade steht (seine Action die Procedure "WALK" hat).<br />

32
docs/sdk/script/fn/Kill.xml
View File

@ -1,6 +1,32 @@
<?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>Kill</title> <category>Objekte</category><subcat>Lebewesen</subcat> <version>4.9.1.0 GWE<extversion>4.9.5.0 CE</extversion></version> <syntax> <rtype>bool</rtype> <params> <param><type>object</type><name>pObj</name><desc>Objekt, das getötet wird. 0 bei lokalem Aufruf.</desc><optional /></param>
<param><type>bool</type><name>fForced</name><desc>Wenn gesetzt, wird das Objekt auch dann getötet, wenn ein Effekt das zu unterbrechen versucht. Ab CE.</desc><optional /></param> </params> </syntax> <desc>Tötet ein Objekt. Nur Lebewesen.</desc> <examples> <example> <code>Kill(<funclink>FindObject</funclink>(0, 0,0,0,0, <funclink>OCF_Alive</funclink>()));</code> <text>Tötet ein Lebewesen.</text> </example> </examples> <related> <funclink>Punch</funclink> <funclink>RemoveObject</funclink> </related> </func> <author>Sven2</author><date>November 2001, März 2004</date></funcs>
<funcs>
<func>
<title>Kill</title>
<category>Objekte</category>
<subcat>Lebewesen</subcat>
<version>4.9.1.0 GWE<extversion>4.9.5.0 CE</extversion></version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>bool</type><name>fForced</name>
<desc>Wenn gesetzt, wird das Objekt auch dann getötet, wenn ein Effekt das zu unterbrechen versucht. Ab CE.</desc><optional />
</param>
</params>
</syntax>
<desc>Tötet das aufrufende Objekt. Nur Lebewesen.</desc>
<examples>
<example>
<code><funclink>FindObject</funclink>(0, 0,0,0,0, <funclink>OCF_Alive</funclink>())->Kill();</code>
<text>Tötet ein Lebewesen.</text>
</example>
</examples>
<related>
<funclink>Punch</funclink>
<funclink>RemoveObject</funclink>
</related>
</func>
<author>Sven2</author><date>November 2001, März 2004</date>
</funcs>

7
docs/sdk/script/fn/LocalN.xml
View File

@ -10,15 +10,14 @@
<rtype>&amp;</rtype>
<params>
<param><type>string</type><name>szName</name><desc>Name der Variablen, zu der eine Referenz zurückgegeben werden soll</desc></param>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen Variable abgefragt werden soll. 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Gibt eine Referenz auf eine Objektlokale Variable zurück. Diese Referenz kann zum Lesen und Schreiben benutzt werden.</desc>
<examples>
<example>
<code><emlink href="script/NamedVar.html">var</emlink> obj;
if (obj <emlink href="script/operatoren.html">=</emlink> LocalN ("basement", <funclink>FindObject</funclink> (WTWR))) <funclink>Explode</funclink> (20, obj);</code>
<text>Lässt ein Fundament eines Zauberturms explodieren. Funktioniert nur bei einem Zauberturm, alle anderen Objekte benutzen <funclink>Local</funclink> (9) zum Speichern des Fundamentobjektes.</text>
if (obj <emlink href="script/operatoren.html">=</emlink> <funclink>FindObject</funclink>(WTWR)->LocalN("basement")) obj-><funclink>Explode</funclink>(20);</code>
<text>Lässt ein Fundament eines Zauberturms explodieren.</text>
</example>
<example>
<code>func <emlink href="definition/script.html#ObjektCallsderEngine">Initialize</emlink> () {
@ -26,7 +25,7 @@ if (obj <emlink href="script/operatoren.html">=</emlink> LocalN ("basement", <fu
}
//Mit Timer=1 in der <emlink href="definition/defcore.html">DefCore.txt</emlink> jeden Frame aufgerufen
func TimerCall () {
<funclink>SetPosition</funclink> (<funclink>GetX</funclink> (), <funclink>GetY</funclink> (), LocalN("Baum"));
LocalN("Baum")-><funclink>SetPosition</funclink> (<funclink>GetX</funclink> (), <funclink>GetY</funclink> (), );
}
</code>
<text>Das Objekt trägt einen Baum mit sich herum.</text>

11
docs/sdk/script/fn/MakeCrewMember.xml
View File

@ -10,11 +10,6 @@
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>object</type>
<name>pObj</name>
<desc>Objekt (Clonk), das der Crew hinzugefügt werden soll</desc>
</param>
<param>
<type>int</type>
<name>iPlayer</name>
@ -23,13 +18,13 @@
</params>
</syntax>
<desc>Fügt ein Objekt (z.B. einen Clonk) der Crew eines Spielers hinzu. Das Objekt muss die CrewMember-Eigenschaft in der DefCore gesetzt haben.<br/>
Gibt 1 zurück, wenn das Objekt erfolgreich der Crew hinzugefügt wurde.</desc>
<desc>Fügt das aufrufende Objekt (z.B. einen Clonk) der Crew eines Spielers hinzu. Das Objekt muss die CrewMember-Eigenschaft in der DefCore gesetzt haben.<br/>
Gibt true zurück, wenn das Objekt erfolgreich der Crew hinzugefügt wurde.</desc>
<examples>
<example>
<code>var nclnk = <funclink>CreateObject</funclink>(CLNK, 0, 0, <funclink>GetOwner</funclink>());
MakeCrewMember(nclnk, <funclink>GetOwner</funclink>());
nclnk->MakeCrewMember(<funclink>GetOwner</funclink>());
</code>
<text>Dieser kurze Objektscript erstellt einen neuen Clonk und fügt ihn der Crew seines Besitzers hinzu.</text>
</example>

9
docs/sdk/script/fn/ObjectNumber.xml
View File

@ -8,19 +8,16 @@
<version>4.9.1.0 GWE</version>
<syntax>
<rtype>int</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objektpointer, von dem die Nummer abgefragt wird.</desc></param>
</params>
</syntax>
<desc>Bestimmt die Nummer eines Objekts. Diese Nummer ist eindeutig und kann mittels der Funktion <funclink>Object</funclink> in einen Objektpointer zurückverwandelt werden.</desc>
<desc>Bestimmt die Nummer des aufrufenden Objekts. Diese Nummer ist eindeutig und kann mittels der Funktion <funclink>Object</funclink> in einen Objektpointer zurückverwandelt werden.</desc>
<examples>
<example>
<code>func Activate(pCaller)
{
<funclink>CreateMenu</funclink>(<funclink>GetID</funclink>(), pCaller, pCaller, 0, "Kein geeignetes Objekte in Reichweite!");
pCaller-><funclink>CreateMenu</funclink>(<funclink>GetID</funclink>(), pCaller, 0, "Kein geeignetes Objekt in Reichweite!");
var obj;
<funclink>while</funclink>(obj = <funclink>FindObject</funclink>(0, -50, -50, 100, 100, <funclink>OCF_Chop</funclink>(), 0, 0, <funclink>NoContainer</funclink>(), obj))
<funclink>AddMenuItem</funclink>("%s fällen", <funclink>Format</funclink>("SetCommand(this(), \"Chop\", Object(%d))", ObjectNumber(obj)), <funclink>GetID</funclink>(obj), pCaller);
pCaller-><funclink>AddMenuItem</funclink>("%s fällen", <funclink>Format</funclink>("SetCommand(this(), \"Chop\", Object(%d))", obj->ObjectNumber()), obj-><funclink>GetID</funclink>());
}</code>
<text>Wird die Funktion aufgerufen, so wird im aufrufenden Objekt (pCaller) ein Menu erzeugt, das alle fällbaren (<funclink>OCF_Chop</funclink>()) Objekte in einem bestimmten Bereich um das Objekt enthält.
Das Auswählen eines der Menüeinträge bewirkt dann, dass über <funclink>SetCommand</funclink> das Kommando "Chop" gesetzt wird. Da dabei der Objektpointer des Objekts zwischengespeichert werden muss,

5
docs/sdk/script/fn/OnFire.xml
View File

@ -8,11 +8,8 @@
<version>4.6.5.0 CP</version>
<syntax>
<rtype>bool</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Zu prüfendes Objekt.</desc></param>
</params>
</syntax>
<desc>Gibt zurück, ob ein Objekt brennt.</desc>
<desc>Gibt zurück, ob das aufrufende Objekt brennt.</desc>
<related>
<funclink>OCF_OnFire</funclink>
<funclink>Incinerate</funclink>

9
docs/sdk/script/fn/RemoveObject.xml
View File

@ -7,20 +7,19 @@
<category>Objekte</category><subcat>Existenz</subcat>
<version>4.6.5.0 CP<extversion>4.9.1.0 GWE</extversion></version>
<syntax>
<rtype>bool</rtype>
<rtype>void</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, das entfernt werden soll. 0 bei lokalem Aufruf.</desc><optional /></param>
<param><type>bool</type><name>fEjectContents</name><desc>Wenn wahr, wird der Inhalt des Objekts vor der Vernichtung ausgeleert. Ansonsten wird er mit vernichtet.</desc><optional /></param>
</params>
</syntax>
<desc>Entfernt ein Objekt.</desc>
<desc>Entfernt das aufrufende Objekt.</desc>
<remark>
Beim Löschen eines Objekts werden viele interne Zeiger gelöscht, und das Objekt selber wird ungültig. Darum sollte der Zeiger auf dieses Objekt (z.B. innerhalb von threadlokalen Variablen) anschließend nicht mehr benutzt werden. Wenn sich ein Objekt selber entfernt, sollte die Funktion sofort mit return() beendet werden.<br />
Wenn sich das Objekt zu diesem Zeitpunkt in einer Crew befindet, wird das assoziierte Infoobjekt in der Crew nicht als getötet markiert. Das heißt, ein darauffolgender <funclink>MakeCrewMember</funclink>()-Aufruf kann wieder in demselben Mannschaftsmitglied resultieren. Um dies zu verhindern, sollte das Objekt zuvor mit <funclink>Kill</funclink>() getötet werden.
</remark>
<examples>
<example>
<code>public func Activate(pClonk) { return(RemoveObject(pClonk)); }</code>
<code>public func Activate(pClonk) { pClonk->RemoveObject(); }</code>
<text>Wenn ein Clonk dieses Objekt aktiviert, wird er entfernt.</text>
</example>
</examples>
@ -31,4 +30,4 @@
</related>
</func>
<author>Sven2</author><date>August 2002</date>
</funcs>
</funcs>

3
docs/sdk/script/fn/RemoveVertex.xml
View File

@ -10,10 +10,9 @@
<rtype>int</rtype>
<params>
<param><type>int</type><name>iX</name><desc>Index des Vertex, das entfernt werden soll.</desc></param>
<param><type>object</type><name>pObj</name><desc>Objekt, von dem ein Vertex entfernt werden soll. 0 bei lokalem Aufruf.</desc><optional /></param>
</params>
</syntax>
<desc>Entfernt einen Vertex von einem Objekt.</desc>
<desc>Entfernt einen Vertex vom aufrufenden Objekt.</desc>
<remark>Achtung: Bei jeder Vertexaktualisierung (also beispielsweise dann, wenn sich Fertigstellungswert oder Rotation eines Objekts ändern) werden alle Vertices wieder auf die Definitionswerte zurückgesetzt.</remark>
<examples>
<example>

1
docs/sdk/script/fn/ResetPhysical.xml
View File

@ -9,7 +9,6 @@
<syntax>
<rtype>bool</rtype>
<params>
<param><type>object</type><name>pObj</name><desc>Objekt, dessen Physicals zurückgesetzt werden sollen. Bei lokalem Aufruf 0.</desc><optional/></param>
<param><type>string</type><name>sPhys</name><desc>Sollte, wenn angegeben, der Name einer Physical sein, die zuvor mit <funclink>SetPhysical</funclink> im Modus PHYS_StackTemporary gesetzt wurde. Es wird dann diese Physical auf den alten Wert, den sie vor dem temporären Setzen hatte, zurückgesetzt und die temporäre Änderung vom Stapel entfernt. Ist der Stapel leer - das heißt, wenn für alle <funclink>SetPhysical</funclink>-Aufrufe mit PHYS_StackTemporary-Parameter entsprechende ResetPhysical-Aufrufe mit sPhys-Parameter getätigt wurden, werden die temporären Physicals wieder gelöscht. Ist der Parameter 0 oder nicht angegeben, werden die temporären Physicals immer zurückgesetzt und alle temporären Zwischenwerte vom Stapel gelöscht. Für ein Beispiel zu diesem Parameter siehe <funclink>SetPhysical</funclink>.</desc><optional/></param>
</params>
</syntax>

Some files were not shown because too many files have changed in this diff Show More