API Tree.Traverse: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	Traverse
Updates the object to step depth-first through the tree
- HANDLE	Object
The object to update with the next object
- HANDLE	Root
An optional root object the traversal will not step above
- NONE	Return

Detailed description

Examples

Calling in a calculation

Add to a calculation icon:
```
::Tree.Traverse(return_object, root)
```

@@ Line 1: / Line 1: @@
+{| class="mtx-class-macrotable wikitable"
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''Traverse'''
+|-
+| colspan="2" | Updates the object to step depth-first through the tree&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Object
+|-
+| colspan="2" | The object to update with the next object&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Root
+|-
+| colspan="2" | An optional root object the traversal will not step above&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<sidebar>API Contents</sidebar>
+==Detailed description==
-Updates the object to step depth-first through the tree
-<div style="width:25%; float:right" class="toc">
-====Class hierarchy====
-[[API Tree|Tree]]
-:[[API Tree|Traverse]]
-</div>
-__TOC__
-==Parameters==
-[[Variable Types|HANDLE]] ''Object''
-:The object to update with the next object
-:''This parameter is returned back to the caller''
-[[Variable Types|HANDLE]] ''Root''
-:An optional root object the traversal will not step above
-:''The default value for this parameter is: '''''0'''
-==Return value==
-''This call does not return a value''
-==Detailed description==
-''<span style="color:red;">No additional information</span>''
@@ Line 32: / Line 29: @@
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::Tree.Traverse(return_object, root)</pre>
-''<span style="color:red;">No additional examples</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation