php-doc-en/reference/swf/functions/swf-modifyobject.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.swf-modifyobject" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>swf_modifyobject</refname>
  <refpurpose>Modify an object</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>swf_modifyobject</methodname>
   <methodparam><type>int</type><parameter>depth</parameter></methodparam>
   <methodparam><type>int</type><parameter>how</parameter></methodparam>
  </methodsynopsis>
  <para>
   Updates the position and/or color of the object at the specified
   <parameter>depth</parameter>.  
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>depth</parameter></term>
     <listitem>
      <para>
       The depth, as an integer.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>how</parameter></term>
     <listitem>
      <para>
       Determines what is updated. <parameter>how</parameter> can either be
       the constant <constant>MOD_MATRIX</constant> or 
       <constant>MOD_COLOR</constant> or it can be a combination of both.
      </para>
      <para>
       <constant>MOD_COLOR</constant> uses the current mulcolor (specified by
       the function <function>swf_mulcolor</function>) and addcolor
       (specified by the function <function>swf_addcolor</function>) to color
       the object. <constant>MOD_MATRIX</constant> uses the current matrix to
       position the object.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->