Index | PAL Intro | Commands | Registers | Indices | Stack | Macros | Classes | Attributes | Errors

tree_clone - Clone branches in the nexus

CONTENTS

Synopsis
Description
Cloning Tree Arrays
Error Handling
Examples
See Also
Author

tree/clone ![target], ![source]
tree/bclone ![target], ![source]

Clones objects, and recursively their children, to a new location in the nexus.

The tree/clone instruction clones all child objects attached underneath ![source], copying them underneath ![target].

The tree/bclone instruction includes the base object in the copy.

Exploded tree arrays can be cloned with tree/clone and tree/bclone, as they are objects attached to the nexus like any other.

Imploded tree arrays are entire tree structures attached to a single object, and therefore cannot be cloned using these instructions. To clone an imploded tree array, use obj/clone or attr/direct. See obj_clone(5) and attr_direct(5).

For more information about tree arrays, see ps_tree(5).

A runtime error is generated if an argument is of the wrong type, or if a referenced object does not exist in the nexus.

It is also an error if the ![target] node already has any child objects.

tree/clone ![.prose.error2], ![.prose.error]
	Copies hierarchy underneath .prose.error to .prose.error2. Note that the object .prose.error2 must already exist.
tree/bclone P5, PULL
	Copies the object identified by the topmost item in the program stack and all of its children underneath the object referenced in register P5.

pal_commands(5), pal_registers(5), pal_indices(5), ps_tree(5), obj_clone(5), attr_direct(5),
PROSE Assembly Language at prose.sourceforge.net.

Copyright (c) 2002-2015 Mark R. Bannister <cambridge@users.sourceforge.net>.

This is free software and can be downloaded from prose.sourceforge.net; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.