summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2020-04-17 15:46:23 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2020-07-14 17:07:10 +0200
commit878f03d8e3452b0d18bc1b693af6029fdbacb92b (patch)
tree6cf284d21f57e244bcdf495dde44669fd26ebeac /doc
parente387278b3bfb9c24a244a86f71483c4e40d521f1 (diff)
Mention C# gotchas in Object's dynamic call/set/connect methods
This closes #34015.
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/Object.xml5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml
index 8d08688b41..3d8c2c5eb0 100644
--- a/doc/classes/Object.xml
+++ b/doc/classes/Object.xml
@@ -97,6 +97,7 @@
[codeblock]
call("set", "position", Vector2(42.0, 0.0))
[/codeblock]
+ [b]Note:[/b] In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).
</description>
</method>
<method name="call_deferred" qualifiers="vararg">
@@ -109,6 +110,7 @@
[codeblock]
call_deferred("set", "position", Vector2(42.0, 0.0))
[/codeblock]
+ [b]Note:[/b] In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).
</description>
</method>
<method name="callv">
@@ -203,6 +205,7 @@
</argument>
<description>
Returns the [Variant] value of the given [code]property[/code]. If the [code]property[/code] doesn't exist, this will return [code]null[/code].
+ [b]Note:[/b] In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).
</description>
</method>
<method name="get_class" qualifiers="const">
@@ -402,6 +405,7 @@
</argument>
<description>
Assigns a new value to the given property. If the [code]property[/code] does not exist, nothing will happen.
+ [b]Note:[/b] In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).
</description>
</method>
<method name="set_block_signals">
@@ -422,6 +426,7 @@
</argument>
<description>
Assigns a new value to the given property, after the current frame's physics step. This is equivalent to calling [method set] via [method call_deferred], i.e. [code]call_deferred("set", property, value)[/code].
+ [b]Note:[/b] In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).
</description>
</method>
<method name="set_indexed">