summaryrefslogtreecommitdiff
path: root/modules/visual_script/doc_classes/VisualScriptIterator.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2017-11-15 19:23:20 +0100
committerRémi Verschelde <rverschelde@gmail.com>2017-11-15 21:29:33 +0100
commit677e95d8d189a62e6473b43989012a8258f193a4 (patch)
treea68e77b5d7bd8a319131e632da91f6b86acf7768 /modules/visual_script/doc_classes/VisualScriptIterator.xml
parente7701bb2de30c554f52dc9d3f0110b4001ae18ad (diff)
doc: Make all module docs self-contained
Diffstat (limited to 'modules/visual_script/doc_classes/VisualScriptIterator.xml')
-rw-r--r--modules/visual_script/doc_classes/VisualScriptIterator.xml24
1 files changed, 24 insertions, 0 deletions
diff --git a/modules/visual_script/doc_classes/VisualScriptIterator.xml b/modules/visual_script/doc_classes/VisualScriptIterator.xml
new file mode 100644
index 0000000000..fc905d6c39
--- /dev/null
+++ b/modules/visual_script/doc_classes/VisualScriptIterator.xml
@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="VisualScriptIterator" inherits="VisualScriptNode" category="Core" version="3.0-alpha">
+ <brief_description>
+ Steps through items in a given input.
+ </brief_description>
+ <description>
+ This node steps through each item in a given input. Input can be any sequence data type, such as an [Array] or [String]. When each item has been processed, execution passed out the [code]exit[/code] Sequence port.
+ [b]Input Ports:[/b]
+ - Sequence: [code]for (elem) in (input)[/code]
+ - Data (variant): [code]input[/code]
+ [b]Output Ports:[/b]
+ - Sequence: [code]each[/code]
+ - Sequence: [code]exit[/code]
+ - Data (variant): [code]elem[/code]
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ </methods>
+ <constants>
+ </constants>
+</class>