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

52 lines
2.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>GetObjectInfoCoreVal</title>
<category>Get*Val</category>
<version>4.9.1.0 GWE</version>
<syntax>
<rtype>any</rtype>
<params>
<param>
<type>string</type>
<name>entry</name>
<desc>Name of the entry to be retrieved.</desc>
</param>
<param>
<type>string</type>
<name>section</name>
<desc>Section of the entry to be retrieved. If 0, all sections will be searched for an entry of the specified name.</desc>
<optional />
</param>
<param>
<type>int</type>
<name>entry_number</name>
<desc>Index of the value to be retrieved if an entry contains multiple values.</desc>
<optional />
</param>
</params>
</syntax>
<desc>The InfoCore contains personal information of one crew member. It is stored in the player in a file with the extension oci. Accordingly, GetObjectInfoCoreVal returns a property of a crew member by its name in the InfoCore.</desc>
<remark>Most useful applications for entry are already implemented in System.ocg/GetXVal.c.</remark>
<examples>
<example>
<code>var exp = obj-&gt;GetObjCoreExperience();</code>
<text>Determines the experience of a crewmember. GetObjCoreExperience is a global function from GetXVal.c in the System.ocg (see remark).<br/> The above code responds to:</text>
<code>var exp = obj-&gt;GetObjectInfoCoreVal(&quot;Experience&quot;, &quot;ObjectInfo&quot;);</code>
</example>
</examples>
<related>
<funclink>GetDefCoreVal</funclink>
<funclink>GetObjectVal</funclink>
<funclink>GetActMapVal</funclink>
<funclink>GetScenarioVal</funclink>
<funclink>GetPlayerVal</funclink>
<funclink>GetPlayerInfoCoreVal</funclink>
</related>
</func>
<author>PeterW</author><date>2002-04</date>
</funcs>