diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2022-10-25 18:31:01 +0200 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2022-10-27 02:50:37 +0200 |
| commit | 7d7b4210f6b1be4f1f1142ff529e2eec7530671e (patch) | |
| tree | 21c87c4b275aa4d68a8e25e61c008ec8b6b3c1ac /doc/classes/Vector4i.xml | |
| parent | 69e5ad7f098730207249218236486e7ffa72f17f (diff) | |
| download | redot-engine-7d7b4210f6b1be4f1f1142ff529e2eec7530671e.tar.gz | |
Document the Vector3 and Vector4i classes
Diffstat (limited to 'doc/classes/Vector4i.xml')
| -rw-r--r-- | doc/classes/Vector4i.xml | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/classes/Vector4i.xml b/doc/classes/Vector4i.xml index 3eea93ce1f..e9ac5b9475 100644 --- a/doc/classes/Vector4i.xml +++ b/doc/classes/Vector4i.xml @@ -133,12 +133,20 @@ <return type="Vector4i" /> <param index="0" name="right" type="Vector4i" /> <description> + Gets the remainder of each component of the [Vector4i] with the components of the given [Vector4i]. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using [method @GlobalScope.posmod] instead if you want to handle negative numbers. + [codeblock] + print(Vector4i(10, -20, 30, -40) % Vector4i(7, 8, 9, 10)) # Prints "(3, -4, 3, 0)" + [/codeblock] </description> </operator> <operator name="operator %"> <return type="Vector4i" /> <param index="0" name="right" type="int" /> <description> + Gets the remainder of each component of the [Vector4i] with the the given [int]. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using [method @GlobalScope.posmod] instead if you want to handle negative numbers. + [codeblock] + print(Vector4i(10, -20, 30, -40) % 7) # Prints "(3, -6, 2, -5)" + [/codeblock] </description> </operator> <operator name="operator *"> |