summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas Karcher <t_karcher@posteo.de>2019-08-29 14:03:18 +0200
committerGitHub <noreply@github.com>2019-08-29 14:03:18 +0200
commit02ed79f7f7de99bc7dd2622fd44d17d658843026 (patch)
tree88eb407e873363a926044e43580ce47f95434257
parent9762372329253a5d89feac7705770eb2f8e0cc04 (diff)
Updated description for "stepify"
Mentioned the possibility to use stepify as a rounding function; +code examples
-rw-r--r--modules/gdscript/doc_classes/@GDScript.xml6
1 files changed, 5 insertions, 1 deletions
diff --git a/modules/gdscript/doc_classes/@GDScript.xml b/modules/gdscript/doc_classes/@GDScript.xml
index ad47323613..605a999d6a 100644
--- a/modules/gdscript/doc_classes/@GDScript.xml
+++ b/modules/gdscript/doc_classes/@GDScript.xml
@@ -1115,7 +1115,11 @@
<argument index="1" name="step" type="float">
</argument>
<description>
- Snaps float value [code]s[/code] to a given [code]step[/code].
+ Snaps float value [code]s[/code] to a given [code]step[/code]. This can also be used to round a floating point number to an arbitrary number of decimals.
+ [codeblock]
+ stepify(100, 32) # Returns 96
+ stepify(3.14159, 0.01) # Returns 3.14
+ [/codeblock]
</description>
</method>
<method name="str" qualifiers="vararg">