Click above to get retro games delivered to your door ever month!

OBJ_TO_LAY()                                                        C_EXAM11
   Copies an object from one layer to another.

   Syntax
         nIndex = OBJ_TO_LAY(nIndex,nType [,nToLayer] [,xXOffset] [,nYOffset])

   Arguments
         nIndex          Object number.
         nType           Type of copy to perform.
                              0 - Copy to buffer and leave on current layer.
                              1 - Copy to buffer and erase on current layer.
         OPTIONAL PARAMETERS
         nToLayer        Layer to copy object.
         xXOffset        Add a horizontal value to all points in the object.
         nYOffset        Add a vertical value to all points in the object.

   Returns
         nIndex          Returns object number.

   Description
         OBJ_TO_LAY() copies an object to a different layer. Besides just
         moving objects from one layer to another, this function can be used
         to save an object that is being deleted to the hidden buffer (layer
         0) so it can be restored later if the user desires.

         nType determines whether the object is removed from the layer or
         leaves it and creates a duplicate.

         nIndex sets which object will be selected for changing layers. The
         object can be selected with the mouse then passed with HOT_INFO().
         If no parameter is passed as nIndex, the last object in the layer is
         selected.

         nToLayer sets the destination layer for the copy of the object.

         nXOffset and nYOffset adds horizontal and vertical offset values to
         the object resulting in the object being moved to a new position.