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

37 lines
1.0 KiB
XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!DOCTYPE funcs
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<title>BoundBy</title>
<category>Arithmetics</category>
<version>1.0 OC</version>
<syntax>
<rtype>int</rtype>
<params>
<param>
<type>int</type>
<name>value</name>
<desc>Value to be compared.</desc>
</param>
<param>
<type>int</type>
<name>lower_bound</name>
<desc>Lower limit.</desc>
</param>
<param>
<type>int</type>
<name>upper_bound</name>
<desc>Upper limit.</desc>
</param>
</params>
</syntax>
<desc>Returns value if it is within the given boundaries (value &gt;= lower_bound and value &lt;= upper_bound). Otherwise returns the applicable limit.</desc>
<related>
<funclink>Inside</funclink>
</related>
</func>
<author>jwk</author><date>2002-04</date>
</funcs>