summaryrefslogtreecommitdiff
path: root/doc/classes/Expression.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/Expression.xml')
-rw-r--r--doc/classes/Expression.xml35
1 files changed, 13 insertions, 22 deletions
diff --git a/doc/classes/Expression.xml b/doc/classes/Expression.xml
index d777c6fd9d..809a5bb80c 100644
--- a/doc/classes/Expression.xml
+++ b/doc/classes/Expression.xml
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
-<class name="Expression" inherits="Reference" version="4.0">
+<class name="Expression" inherits="RefCounted" version="4.0">
<brief_description>
A class that stores an expression you can execute.
</brief_description>
@@ -12,9 +12,9 @@
var expression = Expression.new()
func _ready():
- $LineEdit.connect("text_entered", self, "_on_text_entered")
+ $LineEdit.connect("text_submitted", self, "_on_text_submitted")
- func _on_text_entered(command):
+ func _on_text_submitted(command):
var error = expression.parse(command)
if error != OK:
print(expression.get_error_text())
@@ -28,7 +28,7 @@
public override void _Ready()
{
- GetNode("LineEdit").Connect("text_entered", this, nameof(OnTextEntered));
+ GetNode("LineEdit").Connect("text_submitted", this, nameof(OnTextEntered));
}
private void OnTextEntered(string command)
@@ -52,40 +52,31 @@
</tutorials>
<methods>
<method name="execute">
- <return type="Variant">
- </return>
- <argument index="0" name="inputs" type="Array" default="[ ]">
- </argument>
- <argument index="1" name="base_instance" type="Object" default="null">
- </argument>
- <argument index="2" name="show_error" type="bool" default="true">
- </argument>
+ <return type="Variant" />
+ <argument index="0" name="inputs" type="Array" default="[]" />
+ <argument index="1" name="base_instance" type="Object" default="null" />
+ <argument index="2" name="show_error" type="bool" default="true" />
<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">
- <return type="String">
- </return>
+ <return type="String" />
<description>
Returns the error text if [method parse] has failed.
</description>
</method>
<method name="has_execute_failed" qualifiers="const">
- <return type="bool">
- </return>
+ <return type="bool" />
<description>
Returns [code]true[/code] if [method execute] has failed.
</description>
</method>
<method name="parse">
- <return type="int" enum="Error">
- </return>
- <argument index="0" name="expression" type="String">
- </argument>
- <argument index="1" name="input_names" type="PackedStringArray" default="PackedStringArray( )">
- </argument>
+ <return type="int" enum="Error" />
+ <argument index="0" name="expression" type="String" />
+ <argument index="1" name="input_names" type="PackedStringArray" default="PackedStringArray()" />
<description>
Parses the expression and returns an [enum Error] code.
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.