<?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>GetPlayerVal</title>
    <category>Get*Val</category>
    <version>5.1 OC</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 not specified, all sections will be searched for an entry of the specified name.</desc>
          <optional />
        </param>
        <param>
          <type>int</type>
          <name>player</name>
          <desc>Number of the player of which you want to retrieve an entry.</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>Retrieves properties of a player by way of the name under which they are stored in the Game.txt component of a savegame.</desc>
    <remark>Warning: the retrieved values may not be synchronization safe, meaning they may differ from computer to computer in a network game. Using these values may cause sync loss in a network game.</remark>
    <remark>Most useful applications for entry are already implemented in System.ocg/GetXVal.c.</remark>
    <examples>
      <example>
        <code><funclink>Log</funclink>(&quot;Player %d has %d objects!&quot;, player, GetPlrObjectsOwned(player));</code>
        <text>Writes the number of objects owned by this player into the log file.</text>
      </example>
    </examples>
    <related>
      <funclink>GetDefCoreVal</funclink>
      <funclink>GetObjectVal</funclink>
      <funclink>GetObjectInfoCoreVal</funclink>
      <funclink>GetActMapVal</funclink>
      <funclink>GetScenarioVal</funclink>
      <funclink>GetPlayerInfoCoreVal</funclink>
    </related>
  </func>
  <author>PeterW</author><date>2002-04</date>
</funcs>
