maxmustermann/godot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge pull request #34360 from timothyqiu/gdscript-func-docs

Browse source 
Updates docs for GDScript built-in functions
This commit is contained in:
Rémi Verschelde 2019-12-15 12:33:38 +01:00 committed by GitHub
parent 389b7939bf 468fcd80bb
commit e9474715c0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
modules/gdscript/doc_classes/@GDScript.xml
View file

@ -168,14 +168,16 @@
<method name="char">
<return type="String">
</return>
<argument index="0" name="ascii" type="int">
<argument index="0" name="code" type="int">
</argument>
<description>
Returns a character as a String of the given ASCII code.
Returns a character as a String of the given Unicode code point (which is compatible with ASCII code).
[codeblock]
a = char(65) # a is "A"
a = char(65 + 32) # a is "a"
a = char(8364) # a is "€"
[/codeblock]
This is the inverse of [method ord].
</description>
</method>
<method name="clamp">
@ -702,6 +704,13 @@
<argument index="0" name="char" type="String">
</argument>
<description>
Returns an integer representing the Unicode code point of the given Unicode character [code]char[/code].
[codeblock]
a = ord("A") # a is 65
a = ord("a") # a is 97
a = ord("€") # a is 8364
[/codeblock]
This is the inverse of [method char].
</description>
</method>
<method name="parse_json">
@ -937,7 +946,7 @@
<return type="int">
</return>
<description>
Returns a random unsigned 32 bit integer. Use remainder to obtain a random value in the interval [code][0, N][/code] (where N is smaller than 2^32 -1).
Returns a random unsigned 32 bit integer. Use remainder to obtain a random value in the interval [code][0, N - 1][/code] (where N is smaller than 2^32).
[codeblock]
randi() # Returns random integer between 0 and 2^32 - 1
randi() % 20 # Returns random integer between 0 and 19

2
modules/gdscript/gdscript_functions.cpp
View file

@ -1855,7 +1855,7 @@ MethodInfo GDScriptFunctions::get_info(Function p_func) {
} break;
case TEXT_CHAR: {
MethodInfo mi("char", PropertyInfo(Variant::INT, "ascii"));
MethodInfo mi("char", PropertyInfo(Variant::INT, "code"));
mi.return_val.type = Variant::STRING;
return mi;