diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2019-06-25 14:13:16 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-06-25 14:13:16 +0200 |
| commit | 7a56873271c6254d7583cf8dad52c410d7edcdca (patch) | |
| tree | b329d121125a28ccbc67b506b45e7a84c66eb99a | |
| parent | 2644f47e509b1fd5ec542d82bc183379195a7050 (diff) | |
| parent | 4c137bebe827789e7af568e9544be9660b93fdda (diff) | |
Merge pull request #30060 from Chaosus/wrap_doc_improvement
Extends wrapi/wrapf docs
| -rw-r--r-- | modules/gdscript/doc_classes/@GDScript.xml | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/modules/gdscript/doc_classes/@GDScript.xml b/modules/gdscript/doc_classes/@GDScript.xml index b6de5dbf62..3eaee53789 100644 --- a/modules/gdscript/doc_classes/@GDScript.xml +++ b/modules/gdscript/doc_classes/@GDScript.xml @@ -1241,6 +1241,16 @@ # infinite loop between 0.0 and 0.99 f = wrapf(f + 0.1, 0.0, 1.0) [/codeblock] + [codeblock] + # infinite rotation (in radians) + angle = wrapf(angle + 0.1, 0.0, TAU) + [/codeblock] + Note: If you just want to wrap between 0.0 and [code]n[/code] (where [code]n[/code] is a positive float value) then it's better for performance to use [method fmod] method like [code]fmod(number, n)[/code]. + The usage of [code]wrapf[/code] is more flexible than using the [method fmod] approach by giving the user a simple control over the minimum value. It also fully supports negative numbers, e.g. + [codeblock] + # infinite rotation (in radians) + angle = wrapf(angle + 0.1, -PI, PI) + [/codeblock] </description> </method> <method name="wrapi"> @@ -1267,6 +1277,12 @@ # infinite loop between 0 and 9 frame = wrapi(frame + 1, 0, 10) [/codeblock] + Note: If you just want to wrap between 0 and [code]n[/code] (where [code]n[/code] is a positive integer value) then it's better for performance to use modulo operator like [code]number % n[/code]. + The usage of [code]wrapi[/code] is more flexible than using the modulo approach by giving the user a simple control over the minimum value. It also fully supports negative numbers, e.g. + [codeblock] + # result is -2 + var result = wrapi(-6, -5, -1) + [/codeblock] </description> </method> <method name="yield"> |