<!-- Converted to DocBook/SGML by Kevin Conder -->
<refentry id="xscansmap">
  <refmeta>
    <refentrytitle>xscansmap</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>xscansmap</refname>
    <refpurpose>
      Allows the position and velocity of a node in a scanned process to be read.
      <indexterm id="IndexXscansmap"><primary>xscansmap</primary></indexterm>
    </refpurpose>
  </refnamediv>
  
  <refsect1>
    <title>Description</title>
    <para>
      Allows the position and velocity of a node in a scanned process to be read.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>xscansmap</command> kpos, kvel, iscan, kamp, kvamp [, iwhich]</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>iscan</emphasis> -- which scan process to read
    </para>

    <para>
      <emphasis>iwhich</emphasis> (optional) -- which node to sense. The default is 0.
    </para>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>kpos</emphasis> -- the node's postion.
    </para>

    <para>
      <emphasis>kvel</emphasis> -- the node's velocity.
    </para>

    <para>
      <emphasis>kamp</emphasis> -- amount to amplify the <emphasis>kpos</emphasis> value.
    </para>

    <para>
      <emphasis>kvamp</emphasis> -- amount to amplify the <emphasis>kvel</emphasis> value.
    </para>

    <para>
      The internal state of a node is read. This includes its position and velocity. They are amplified by the <emphasis>kamp</emphasis> and <emphasis>kvamp</emphasis> values.
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>New in version 4.21</para>
    <para>November 2002. Thanks to &namerasmus; for pointing this opcode out.</para>
  </refsect1>
</refentry>
