summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc Gilleron <marc.gilleron@gmail.com>2019-01-31 15:44:29 +0100
committerMarc Gilleron <marc.gilleron@gmail.com>2019-01-31 15:52:17 +0100
commit08ea2aedd254d49d37240fbfe486f4ae50840f62 (patch)
tree00b564227c8fb236ff9fda18702e7d526cfe080b
parentc21ca98e4c6e6228adefcc696b3ff6a1104c678e (diff)
Explain how to use Expression inputs
-rw-r--r--doc/classes/Expression.xml2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/classes/Expression.xml b/doc/classes/Expression.xml
index b0a21d7f82..78623b359e 100644
--- a/doc/classes/Expression.xml
+++ b/doc/classes/Expression.xml
@@ -39,6 +39,7 @@
</argument>
<description>
Executes the expression that was previously parsed by [method parse] and returns the result. Before you use the returned object, you should check if the method failed by calling [method has_execute_failed].
+ If you defined input variables in [method parse], you can specify their values in the inputs array, in the same order.
</description>
</method>
<method name="get_error_text" qualifiers="const">
@@ -64,6 +65,7 @@
</argument>
<description>
Parses the expression and returns a [enum @GlobalScope.Error].
+ You can optionally specify names of variables that may appear in the expression with [code]input_names[/code], so that you can bind them when it gets executed.
</description>
</method>
</methods>