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

docs: constants are not displayed with brackets in the documentation anymore

Tobias Zwick 2011-06-30 17:25:22 +02:00
parent ad8f294362
commit 21b722475e
69 changed files with 138 additions and 202 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/clonk.dtd
View File

@ -2,8 +2,9 @@
<!ENTITY % text "a | img | emlink | funclink | em | code | strong">
<!ELEMENT funcs (func+, (author, date)+)>
<!ELEMENT funcs ((func | const)+, (author, date)+)>
<!ELEMENT func (title, deprecated?, category, subcat*, version, deprecated?, syntax, desc, remark*, examples?, related?)>
<!ELEMENT const (title, deprecated?, category, subcat*, version, deprecated?, syntax, desc, remark*, examples?, related?)>
<!ELEMENT title (#PCDATA)>
<!ELEMENT category (#PCDATA)>
<!ELEMENT subcat (#PCDATA)>

6
docs/clonk.xsl
View File

@ -40,7 +40,7 @@
<xsl:template match="script">
<xsl:copy><xsl:apply-templates select="@*|node()" /></xsl:copy>
</xsl:template>
<xsl:template match="func" mode="head">
<xsl:template match="func|const" mode="head">
<xsl:apply-templates mode="head" />
</xsl:template>
<xsl:template match="*" mode="head" />
@ -100,7 +100,7 @@
</html>
</xsl:template>
<xsl:template match="func">
<xsl:template match="func|const">
<h1>
<xsl:attribute name="id"><xsl:value-of select="title" /></xsl:attribute>
<xsl:value-of select="title" /><xsl:apply-templates select="deprecated" />
@ -154,7 +154,7 @@
<span class="type"><xsl:apply-templates select="rtype" /></span>
<xsl:if test="not(contains(rtype[1],'&amp;'))"><xsl:text>&#160;</xsl:text></xsl:if>
<xsl:value-of select="../title" />
(<xsl:apply-templates select="params" />);
<xsl:if test="parent::func">(<xsl:apply-templates select="params" />);</xsl:if>
</div>
</xsl:template>

2
docs/de.po
View File

@ -17240,7 +17240,7 @@ msgid "Area that is dug free during this action. If 1, the area covered by the o
msgstr "Freigraben während dieser Aktion. Objektrechteck 1, sonst Kreisradius."
#: sdk/definition/actmap.xml:145(col)
msgid Specifies the animation to be played in the mesh of the object. Works only if the object uses a mesh for its graphics. If given all of Facet, FacetBase, FacetTopFace and FacetTargetStretch are ignored. The Length times Delay possible animation phases are mapped linearly on the animation length. If Delay equals 0 only Length will be used and the animation does not play automatically. See <emlink href=\"definition/animations.html\">Animationen</emlink> for further documentation on animations."
msgid "Specifies the animation to be played in the mesh of the object. Works only if the object uses a mesh for its graphics. If given all of Facet, FacetBase, FacetTopFace and FacetTargetStretch are ignored. The Length times Delay possible animation phases are mapped linearly on the animation length. If Delay equals 0 only Length will be used and the animation does not play automatically. See <emlink href=\"definition/animations.html\">Animationen</emlink> for further documentation on animations."
msgstr "Bestimmt die auszuführende Animation im Mesh des Objekts. Funktioniert nur wenn ein solches vorhanden ist. Wenn gegeben werden Facet, FacetBase, FacetTopFace und FacetTargetStretch ignoriert. Die Length mal Delay verschiedenen Animationsphasen werden linear auf die Länge der Animation abgebildet. Wenn Delay 0 ist wird nur Length verwendet und die Animation spielt nicht automatisch. Siehe <emlink href=\"definition/animations.html\">Animationen</emlink> für weitergehende Dokumentation zu Animationen."
#: sdk/console.xml:6(title)

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

@ -3,18 +3,17 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>C4D_All</title>
<category>Objects</category>
<subcat>Category</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object category: all categories.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<related>
<funclink>GetCategory</funclink>
<funclink>SetCategory</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-01</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>C4D_Background</title>
<category>Objects</category>
<subcat>Category</subcat>
<version>5.1 OC</version>
<syntax><rtype>int </rtype></syntax>
<desc>Object category: object is drawn behind the landscape. Useful for effects like clouds or celestial bodies.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>This category does not work in the old 8 bit graphics system.</remark>
<examples>
<example>
@ -24,6 +23,6 @@
<funclink>GetDefinition</funclink>
<funclink>C4D_Parallax</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2003-06</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>C4D_Goal</title>
<category>Objects</category>
<subcat>Category</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object category: game goal.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code>var obj;
@ -24,6 +23,6 @@ while (obj=<funclink>FindObject</funclink>(0, 0,0,0,0, 0, 0,0, 0, obj))
<funclink>GetCategory</funclink>
<funclink>SetCategory</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-01</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>C4D_Living</title>
<category>Objects</category>
<subcat>Category</subcat>
<version>5.1 OC</version>
<syntax><rtype>int </rtype></syntax>
<desc>Object category: living being.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>GetPlrKnowledge</funclink>(0, 0, 0, C4D_Living( ));</code>
@ -24,6 +23,6 @@
<funclink>GetPlrKnowledge</funclink>
<funclink>GetDefinition</funclink>
</related>
</func>
</const>
<author>Günther</author><date>2002-02</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>C4D_Object</title>
<category>Objects</category>
<subcat>Category</subcat>
<version>5.1 OC</version>
<syntax><rtype>int </rtype></syntax>
<desc>Object category: small item.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>GetDefinition</funclink>(0, C4D_Object( ));</code>
@ -24,6 +23,6 @@
<funclink>GetPlrKnowledge</funclink>
<funclink>GetDefinition</funclink>
</related>
</func>
</const>
<author>Günther</author><date>2002-02</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>C4D_Parallax</title>
<category>Objects</category>
<subcat>Category</subcat>
<version>5.1 OC</version>
<syntax><rtype>int </rtype></syntax>
<desc>Object category: the object moves parallax with respect to the landscape. This means that the apparent object position changes depending on the scroll position of the viewport. This can be used to have objects apparently moving in the far background or to create status overlays.<br/>Parallax deviation from the normal location is specified in percent and stored in an array in the <emlink href="definition/properties.html#Parallaxity"><code>Parallaxity</code> property</emlink> of the object (<code>Parallaxity[0]</code> for horizontal, <code>Parallaxity[1]</code> for vertical deviation). This means for normal location these two values should be 100. A value of 0 will lock the object to the viewport. For parallax background object use values between 0 and 100. Object positions can also be negative values. Those objects will then be aligned with the right or bottom edge of the screen respectively.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>this</funclink>.<emlink href="definition/properties.html#Plane">Plane</emlink> = -1000;
@ -27,6 +26,6 @@
<funclink>C4D_Background</funclink>
<funclink>SetSkyParallax</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2003-06</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>C4D_Rule</title>
<category>Objects</category>
<subcat>Category</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object category: rule object.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code>for(var obj in <funclink>FindObjects</funclink>(<funclink>Find_Category</funclink>(C4D_Rule)))
@ -22,6 +21,6 @@
<funclink>GetCategory</funclink>
<funclink>SetCategory</funclink>
</related>
</func>
</const>
<author>jwk</author><date>2002-04</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>C4D_StaticBack</title>
<category>Objects</category>
<subcat>Category</subcat>
<version>5.1 OC</version>
<syntax><rtype>int </rtype></syntax>
<desc>Object category: immovable background object.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>SetCategory</funclink>(C4D_StaticBack, this);</code>
@ -21,6 +20,6 @@
<funclink>GetCategory</funclink>
<funclink>SetCategory</funclink>
</related>
</func>
</const>
<author>jwk</author><date>2002-04</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>C4D_Structure</title>
<category>Objects</category>
<subcat>Category</subcat>
<version>5.1 OC</version>
<syntax><rtype>int </rtype></syntax>
<desc>Object category: building.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>GetPlrKnowledge</funclink>(0, 0, 0, C4D_Structure);</code>
@ -21,6 +20,6 @@
<funclink>GetCategory</funclink>
<funclink>SetCategory</funclink>
</related>
</func>
</const>
<author>jwk</author><date>2002-04</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>C4D_Vehicle</title>
<category>Objects</category>
<subcat>Category</subcat>
<version>5.1 OC</version>
<syntax><rtype>int </rtype></syntax>
<desc>Object category: vehicle.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>GetPlrKnowledge</funclink>(0, 0, 0, C4D_Vehicle);</code>
@ -21,6 +20,6 @@
<funclink>GetCategory</funclink>
<funclink>SetCategory</funclink>
</related>
</func>
</const>
<author>jwk</author><date>2002-04</date>
</funcs>

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

@ -3,13 +3,12 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>C4V_Array</title>
<category>Variables</category>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Data type: array.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>if</funclink> (<funclink>GetType</funclink>(x) != C4V_Array) x = <funclink>CreateArray</funclink>();</code>
@ -17,6 +16,6 @@
</example>
</examples>
<related><funclink>GetType</funclink></related>
</func>
</const>
<author>Clonk-Karl</author><date>2008-12</date>
</funcs>

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

@ -3,13 +3,12 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>C4V_Bool</title>
<category>Variables</category>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Data type: boolean value (true or false).</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>if</funclink> (<funclink>GetType</funclink>(x) == C4V_Bool) <funclink>Log</funclink>(&quot;x=%d&quot;, x);</code>
@ -17,6 +16,6 @@
</example>
</examples>
<related><funclink>GetType</funclink></related>
</func>
</const>
<author>Sven2</author><date>2002-04</date>
</funcs>

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

@ -3,13 +3,12 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>C4V_C4Object</title>
<category>Variables</category>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Data type: object pointer.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>if</funclink> (x &amp;&amp; <funclink>GetType</funclink>(x)==C4V_C4Object) <funclink>Log</funclink>(&quot;x=%s&quot;, <funclink>GetName</funclink>(x));</code>
@ -17,6 +16,6 @@
</example>
</examples>
<related><funclink>GetType</funclink></related>
</func>
</const>
<author>Sven2</author><date>2002-04</date>
</funcs>

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

@ -3,13 +3,12 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>C4V_Int</title>
<category>Variables</category>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Data type: integer.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>if</funclink> (<funclink>GetType</funclink>(x) == C4V_Int) <funclink>Log</funclink>(&quot;x=%d&quot;, x);</code>
@ -17,6 +16,6 @@
</example>
</examples>
<related><funclink>GetType</funclink></related>
</func>
</const>
<author>Sven2</author><date>2002-04</date>
</funcs>

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

@ -3,13 +3,12 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>C4V_Nil</title>
<category>Variables</category>
<version>5.2 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Data type: nil.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>if</funclink> (<funclink>GetType</funclink>(<funclink>Par</funclink>()) == C4V_Nil) return();</code>
@ -17,6 +16,6 @@
</example>
</examples>
<related><funclink>GetType</funclink></related>
</func>
</const>
<author>Sven2</author><date>2002-04</date>
</funcs>

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

@ -3,13 +3,12 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>C4V_PropList</title>
<category>Variables</category>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Data type: Proplist.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>if</funclink> (<funclink>GetType</funclink>(x) == C4V_PropList) x.foo=bar;</code>
@ -17,6 +16,6 @@
</example>
</examples>
<related><funclink>GetType</funclink></related>
</func>
</const>
<author>Günther</author><date>2011-05</date>
</funcs>

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

@ -3,13 +3,12 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>C4V_String</title>
<category>Variables</category>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Data type: string.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>if</funclink> (x &amp;&amp; <funclink>GetType</funclink>(x)==C4V_String) <funclink>Log</funclink>(&quot;x=%s&quot;, x);</code>
@ -17,6 +16,6 @@
</example>
</examples>
<related><funclink>GetType</funclink></related>
</func>
</const>
<author>Sven2</author><date>2002-04</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>COMD_Down</title>
<category>Objects</category>
<subcat>Movement</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Movement direction: up. For more information see <funclink>SetComDir</funclink>.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>SetComDir</funclink>(COMD_Up, <funclink>FindObject</funclink>(BLMP));</code>
@ -21,6 +20,6 @@
<funclink>GetComDir</funclink>
<funclink>SetComDir</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-04</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>COMD_DownLeft</title>
<category>Objects</category>
<subcat>Movement</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Movement direction: diagonally down and to the left. For more information see <funclink>SetComDir</funclink>.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>SetComDir</funclink>(COMD_Up, <funclink>FindObject</funclink>(BLMP));</code>
@ -21,6 +20,6 @@
<funclink>GetComDir</funclink>
<funclink>SetComDir</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-04</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>COMD_DownRight</title>
<category>Objects</category>
<subcat>Movement</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Movement direction: diagonally down and to the right. For more information see <funclink>SetComDir</funclink>.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>SetComDir</funclink>(COMD_Up, <funclink>FindObject</funclink>(BLMP));</code>
@ -21,6 +20,6 @@
<funclink>GetComDir</funclink>
<funclink>SetComDir</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-04</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>COMD_Left</title>
<category>Objects</category>
<subcat>Movement</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Movement direction: up. For more information see <funclink>SetComDir</funclink>.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>SetComDir</funclink>(COMD_Up, <funclink>FindObject</funclink>(BLMP));</code>
@ -21,6 +20,6 @@
<funclink>GetComDir</funclink>
<funclink>SetComDir</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-04</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>COMD_None</title>
<category>Objects</category>
<subcat>Movement</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Movement direction: stop. For more information see <funclink>SetComDir</funclink>.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>COMD_None and <funclink>COMD_Stop</funclink> are identical and have the value 0.</remark>
<examples>
<example>
@ -23,6 +22,6 @@
<funclink>SetComDir</funclink>
<funclink>COMD_Stop</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2003-06</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>COMD_Right</title>
<category>Objects</category>
<subcat>Movement</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Movement direction: up. For more information see <funclink>SetComDir</funclink>.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>SetComDir</funclink>(COMD_Right, <funclink>FindObject</funclink>(Find_ID(BLMP)));</code>
@ -21,6 +20,6 @@
<funclink>GetComDir</funclink>
<funclink>SetComDir</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-04</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>COMD_Stop</title>
<category>Objects</category>
<subcat>Movement</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Movement direction: stop. For more information see <funclink>SetComDir</funclink>.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark><funclink>COMD_None</funclink> and COMD_Stop are identical and have the value 0.</remark>
<examples>
<example>
@ -23,6 +22,6 @@
<funclink>SetComDir</funclink>
<funclink>COMD_None</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2003-06</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>COMD_Up</title>
<category>Objects</category>
<subcat>Movement</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Movement direction: up. For more information see <funclink>SetComDir</funclink>.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>SetComDir</funclink>(COMD_Up, <funclink>FindObject</funclink>(BLMP));</code>
@ -21,6 +20,6 @@
<funclink>GetComDir</funclink>
<funclink>SetComDir</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-04</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>COMD_UpLeft</title>
<category>Objects</category>
<subcat>Movement</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Movement direction: diagonally up and to the left. For more information see <funclink>SetComDir</funclink>.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>SetComDir</funclink>(COMD_Up, <funclink>FindObject</funclink>(BLMP));</code>
@ -21,6 +20,6 @@
<funclink>GetComDir</funclink>
<funclink>SetComDir</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-04</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>COMD_UpRight</title>
<category>Objects</category>
<subcat>Movement</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Movement direction: diagonally up and to the right. For more information see <funclink>SetComDir</funclink>.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>SetComDir</funclink>(COMD_Up, <funclink>FindObject</funclink>(BLMP));</code>
@ -21,6 +20,6 @@
<funclink>GetComDir</funclink>
<funclink>SetComDir</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-04</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>DIR_Left</title>
<category>Objects</category>
<subcat>Activity</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Constant for <funclink>SetDir</funclink>/<funclink>GetDir</funclink>: direction left</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>SetComDir</funclink>(<funclink>COMD_None</funclink>, <funclink>GetCursor</funclink>());
@ -23,6 +22,6 @@
<funclink>GetDir</funclink>
<funclink>SetDir</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2001-11</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>DIR_Right</title>
<category>Objects</category>
<subcat>Activity</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Constant for <funclink>SetDir</funclink>/<funclink>GetDir</funclink>: direction right</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>SetComDir</funclink>(<funclink>COMD_None</funclink>(), <funclink>GetCursor</funclink>();
@ -23,6 +22,6 @@
<funclink>GetDir</funclink>
<funclink>SetDir</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2001-11</date>
</funcs>

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

@ -3,13 +3,12 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>NO_OWNER</title>
<category>Player</category>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Player number: no player. This constant can be used to indicate 'no ownership' in cases such as <funclink>CreateObject</funclink> or <placeholder-2/>.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>CreateObject</funclink>(Firestone, 100,100, NO_OWNER);</code>
@ -20,6 +19,6 @@
<funclink>SetOwner</funclink>
<funclink>GetOwner</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2005-01</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_Alive</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: live living being.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
@ -18,6 +17,6 @@
<emlink href="definition/ocf.html">Object character flags</emlink>
<funclink>OCF_Living</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,20 +3,19 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_AttractLightning</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: the object attracts lightning. See <emlink href="definition/defcore.html">DefCore</emlink> entry "AttractLightning".</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
<funclink>FindObject</funclink>
<emlink href="definition/ocf.html">Object character flags</emlink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,20 +3,19 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_Available</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: this object can theoretically be acquired by a clonk, meaning it is either uncontained or in a container to which the clonk can have access.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
<funclink>FindObject</funclink>
<emlink href="definition/ocf.html">Object character flags</emlink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,20 +3,19 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_Chop</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: chopable object, usually trees.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
<funclink>FindObject</funclink>
<emlink href="definition/ocf.html">Object character flags</emlink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_Collectible</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: collectible object.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
@ -19,6 +18,6 @@
<funclink>OCF_Collection</funclink>
<funclink>Collect</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_Collection</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: the object has a collection area, is not rotated or incomplete, and the contents has not reached the CollectionLimit.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
@ -19,6 +18,6 @@
<funclink>OCF_Collectible</funclink>
<funclink>Collect</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_Construct</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: construction site</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
@ -18,6 +17,6 @@
<emlink href="definition/ocf.html">Object character flags</emlink>
<funclink>OCF_Fullcon</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,20 +3,19 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_Container</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: the object is a container with theoreticall accessible contents (e.g. a building with entrance, transport vehicle...)</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
<funclink>FindObject</funclink>
<emlink href="definition/ocf.html">Object character flags</emlink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_CrewMember</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: the object can be made a crew member or already is a crew member, meaning the corresponding DefCore flag is set and the object is alive.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>
For more information and examples on the use of these constants see <emlink href="definition/ocf.html">object character flags</emlink>.<br/> Objects with the OCF_CrewMember are handled specially in various ways:<br/>
<ul>
@ -31,6 +30,6 @@
<funclink>FindObject</funclink>
<emlink href="definition/ocf.html">Object character flags</emlink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,20 +3,19 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_Edible</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: Edible object. This flag is set by <emlink href="definition/defcore.html">DefCore</emlink> entry "Edible".</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
<funclink>FindObject</funclink>
<emlink href="definition/ocf.html">Object character flags</emlink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,20 +3,19 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_Entrance</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: The object has an active entrance area. For this there must be a defined entrance area (see <emlink href="definition/defcore.html">DefCore.txt</emlink>), the object must be complete and not rotated too far.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
<funclink>FindObject</funclink>
<emlink href="definition/ocf.html">Object character flags</emlink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,20 +3,19 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_Exclusive</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: the object blocks (covers) objects behind it and prevents other objects from being built in front. This flag is set by <emlink href="definition/defcore.html">DefCore</emlink> entry "Exclusive".</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
<funclink>FindObject</funclink>
<emlink href="definition/ocf.html">Object character flags</emlink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_Fullcon</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: object is 100% complete, i.e. the object is not a construction site or growing animal.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
@ -21,6 +20,6 @@
<funclink>DoCon</funclink>
<funclink>SetCon</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,20 +3,19 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_Grab</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: object can be grabbed.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
<funclink>FindObject</funclink>
<emlink href="definition/ocf.html">Object character flags</emlink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_HitSpeed1</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: object is moving at at least 1.5 pixels per frame.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
@ -20,6 +19,6 @@
<funclink>OCF_HitSpeed3</funclink>
<funclink>OCF_HitSpeed4</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_HitSpeed2</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: object is moving at at least 2 pixels per frame.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
@ -20,6 +19,6 @@
<funclink>OCF_HitSpeed3</funclink>
<funclink>OCF_HitSpeed4</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_HitSpeed3</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: object is moving at at least 6 pixels per frame.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
@ -20,6 +19,6 @@
<funclink>OCF_HitSpeed2</funclink>
<funclink>OCF_HitSpeed4</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_HitSpeed4</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: object is moving at at least 8 pixels per frame.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
@ -20,6 +19,6 @@
<funclink>OCF_HitSpeed2</funclink>
<funclink>OCF_HitSpeed3</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_InFree</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: the object's center is free.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
@ -18,6 +17,6 @@
<emlink href="definition/ocf.html">Object character flags</emlink>
<funclink>Stuck</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_InLiquid</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: the object is submerged in a liquid.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
@ -18,6 +17,6 @@
<emlink href="definition/ocf.html">Object character flags</emlink>
<funclink>GBackLiquid</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_InSolid</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: the object's center is stuck in solid matter.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
@ -19,6 +18,6 @@
<funclink>GBackSolid</funclink>
<funclink>Stuck</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_Inflammable</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: object can be incinerated.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
@ -18,6 +17,6 @@
<emlink href="definition/ocf.html">Object character flags</emlink>
<funclink>OCF_OnFire</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_Living</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: a living being. Notice: dead animals are still OCF_Living. To check for live animals use <funclink>OCF_Alive</funclink>.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
@ -18,6 +17,6 @@
<emlink href="definition/ocf.html">Object character flags</emlink>
<funclink>OCF_Alive</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_NotContained</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: object is outside, not contained.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
@ -18,6 +17,6 @@
<funclink>Find_NoContainer</funclink>
<emlink href="definition/ocf.html">Object character flags</emlink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_OnFire</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: a burning object.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
@ -18,6 +17,6 @@
<emlink href="definition/ocf.html">Object character flags</emlink>
<funclink>OCF_Inflammable</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,20 +3,19 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_Prey</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: prey for certain animals (usual prey are wipfs, clonks etc.)</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
<funclink>FindObject</funclink>
<emlink href="definition/ocf.html">Object character flags</emlink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,20 +3,19 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>OCF_Rotate</title>
<category>Objects</category>
<subcat>OCF</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Object character flag: object can be rotated.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<remark>For more information and examples regarding these constants see <emlink href="definition/ocf.html">object character flags</emlink>.</remark>
<related>
<funclink>GetOCF</funclink>
<funclink>FindObject</funclink>
<emlink href="definition/ocf.html">Object character flags</emlink>
</related>
</func>
</const>
<author>Sven2</author><date>2002-05</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>SkyPar_Keep</title>
<category>Sky</category>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Constant for <funclink>SetSkyParallax</funclink>.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<related><funclink>SetSkyParallax</funclink></related>
</func>
</const>
<author>Sven2</author><date>2002-04</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>VIS_All</title>
<category>Objects</category>
<subcat>Visibility</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Constant for <funclink>GetVisibility</funclink>/<funclink>SetVisibility</funclink>. The object is visible for all. This is the default value 0 and kann logically not be combined with other VIS_x values.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code>for(var obj in FindObjects()) SetVisibility(VIS_All, obj);</code>
@ -27,6 +26,6 @@
<funclink>VIS_God</funclink>
<funclink>VIS_Local</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2001-11</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>VIS_Allies</title>
<category>Objects</category>
<subcat>Visibility</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Constant for <funclink>GetVisibility</funclink>/<funclink>SetVisibility</funclink>. The object is visible for all allies of the owner.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code>for(var obj in FindObjects(Find_OCF(<funclink>OCF_CrewMember</funclink>))) SetVisibility(VIS_Owner | VIS_Allies, obj);</code>
@ -27,6 +26,6 @@
<funclink>VIS_God</funclink>
<funclink>VIS_Local</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2001-11</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>VIS_Enemies</title>
<category>Objects</category>
<subcat>Visibility</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Constant for <funclink>GetVisibility</funclink>/<funclink>SetVisibility</funclink>. The object is visible for all enemires of the owner.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code>for(var obj in FindObjects(Find_ID(Flagpole))) SetVisibility(VIS_Enemies | VIS_God, obj);
@ -28,6 +27,6 @@
<funclink>VIS_God</funclink>
<funclink>VIS_Local</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2001-11</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>VIS_God</title>
<category>Objects</category>
<subcat>Visibility</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Constant for <funclink>GetVisibility</funclink>/<funclink>SetVisibility</funclink>. The object is only visible in general viewports (editor or observer viewports).</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code>SetVisibility(VIS_God, FindObject(Find_ID(Chest)));</code>
@ -27,6 +26,6 @@
<funclink>VIS_Enemies</funclink>
<funclink>VIS_Local</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2001-11</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>VIS_Local</title>
<category>Objects</category>
<subcat>Visibility</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Constant for <funclink>GetVisibility</funclink>/<funclink>SetVisibility</funclink>. The object's visibility depends on the values in the object's indexed local variables. Each local variable may contain bits for 32 players in a bit mask.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code><funclink>Local</funclink>(0)=9; SetVisibility(VIS_Local());</code>
@ -35,6 +34,6 @@
<funclink>VIS_Enemies</funclink>
<funclink>VIS_God</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2001-11</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>VIS_None</title>
<category>Objects</category>
<subcat>Visibility</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Constant for <funclink>GetVisibility</funclink>/<funclink>SetVisibility</funclink>. The object is not visible for anybody.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code>for(var obj in FindObjects(Find_ID(Wipf))) SetVisibility(VIS_None, obj);</code>
@ -27,6 +26,6 @@
<funclink>VIS_God</funclink>
<funclink>VIS_Local</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2001-11</date>
</funcs>

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

@ -3,14 +3,13 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>VIS_Owner</title>
<category>Objects</category>
<subcat>Visibility</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Constant for <funclink>GetVisibility</funclink>/<funclink>SetVisibility</funclink>. The object is visible for its owner.</desc>
<remark>This value is also defined as a constant. Thus the parameter brackets can be omitted.</remark>
<examples>
<example>
<code>for(var obj in FindObjects(Find_OCF(<funclink>OCF_CrewMember</funclink>))) SetVisibility(VIS_Owner, obj);</code>
@ -27,6 +26,6 @@
<funclink>VIS_God</funclink>
<funclink>VIS_Local</funclink>
</related>
</func>
</const>
<author>Sven2</author><date>2001-11</date>
</funcs>

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

@ -3,7 +3,7 @@
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<const>
<title>this</title>
<category>Objects</category>
<version>5.1 OC</version>
@ -17,6 +17,6 @@ myid = this-&gt;<funclink>GetID</funclink>();</code>
<text>Stores the ID of the calling object in the thread local variable myid.</text>
</example>
</examples>
</func>
</const>
<author>jwk</author><date>2002-04</date>
</funcs>