Differences

This shows you the differences between two versions of the page.

--- visual3d:documentation:pipeline:pipeline_commands:get_pipeline_parameter_index_value [2024/07/12 14:06] – created sgranger
+++ visual3d:documentation:pipeline:pipeline_commands:get_pipeline_parameter_index_value [2026/04/30 14:04] (current) – wikisysop
@@ Line 1: / Line 1: @@
-====== Get_Pipeline_Parameter_Index_Value ======
+====== Get Pipeline Parameter Index Value ======
-Description: Allow accessing pipeline parameter "array values" by "index".
+This pipeline command allows users to access pipeline parameter "array values" by "index". It is particularly useful alongside the [[visual3d:documentation:pipeline:pipeline_commands:for_each_and_end_for_each|For_Each and End_For_Each]] commands to iterate through a second item list.
+===== Command Syntax =====
+The command can be found in the Pipeline Workshop within the Pipeline Control folder as so:
 <code>
 Get_Pipeline_Parameter_Index_Value
@@ Line 10: / Line 12: @@
 ;
 </code>
+===== Command Parameters =====
+The following table shows the command parameters that can be used to define the command and their descriptions:
+^ Parameter ^ Description ^
+| **Parameter Name** | A pipeline parameter name to allow access to the indexed item.|
+| **Parameter Value** | A list of items within which to index. |
+| **Index** | The index at which to pull an item from Parameter Value. |
 ===== Example =====
+This example demonstrates how to iterate through two matched lists, running_speed and filenames, and then tag each file with the corresponding running speed.
 <code>
@@ Line 27: / Line 38: @@
 /ITERATION_PARAMETER_NAME=file
 /ITERATION_PARAMETER_COUNT_NAME=increment
-/ITEMS=filenames
+/ITEMS=::filenames
 ;
@@ Line 49: / Line 60: @@
 ;
 </code>