asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve GDScript range() description

Browse source
This commit is contained in:
kobewi 2024-10-16 18:04:54 +02:00
parent af77100e39
commit ac322196e3
1 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -8,6 +8,7 @@
For the list of the global functions and constants see [@GlobalScope]. For the list of the global functions and constants see [@GlobalScope].
</description> </description>
<tutorials> <tutorials>
<link title="GDScript basics">$DOCS_URL/tutorials/scripting/gdscript/gdscript_basics.html</link>
<link title="GDScript exports">$DOCS_URL/tutorials/scripting/gdscript/gdscript_exports.html</link> <link title="GDScript exports">$DOCS_URL/tutorials/scripting/gdscript/gdscript_exports.html</link>
</tutorials> </tutorials>
<methods> <methods>
@ -220,6 +221,7 @@
[code]range(b: int, n: int, s: int)[/code]: Starts from [code]b[/code], increases/decreases by steps of [code]s[/code], and stops [i]before[/i] [code]n[/code]. The arguments [code]b[/code] and [code]n[/code] are [b]inclusive[/b] and [b]exclusive[/b], respectively. The argument [code]s[/code] [b]can[/b] be negative, but not [code]0[/code]. If [code]s[/code] is [code]0[/code], an error message is printed. [code]range(b: int, n: int, s: int)[/code]: Starts from [code]b[/code], increases/decreases by steps of [code]s[/code], and stops [i]before[/i] [code]n[/code]. The arguments [code]b[/code] and [code]n[/code] are [b]inclusive[/b] and [b]exclusive[/b], respectively. The argument [code]s[/code] [b]can[/b] be negative, but not [code]0[/code]. If [code]s[/code] is [code]0[/code], an error message is printed.
[method range] converts all arguments to [int] before processing. [method range] converts all arguments to [int] before processing.
[b]Note:[/b] Returns an empty array if no value meets the value constraint (e.g. [code]range(2, 5, -1)[/code] or [code]range(5, 5, 1)[/code]). [b]Note:[/b] Returns an empty array if no value meets the value constraint (e.g. [code]range(2, 5, -1)[/code] or [code]range(5, 5, 1)[/code]).
[b]Note:[/b] If [method range] is used in a [code]for[/code] loop, the array is not allocated.
[b]Examples:[/b] [b]Examples:[/b]
[codeblock] [codeblock]
print(range(4)) # Prints [0, 1, 2, 3] print(range(4)) # Prints [0, 1, 2, 3]