mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-09 10:09:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #68050 from Anutrix/int-float-docs

Browse Source 
Added missing docs to built-in types float and int
This commit is contained in:
Max Hilbrunner 2022-10-30 18:48:23 +01:00 committed by GitHub
commit aaa931659e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/classes/float.xml
View File

@ -114,12 +114,17 @@
<return type="Vector4" />
<param index="0" name="right" type="Vector4" />
<description>
Multiplies each component of the [Vector4] by the given [float].
</description>
</operator>
<operator name="operator *">
<return type="Vector4" />
<param index="0" name="right" type="Vector4i" />
<description>
Multiplies each component of the [Vector4i] by the given [float]. Returns a [Vector4].
[codeblock]
print(0.9 * Vector4i(10, 15, 20, -10)) # Prints "(9, 13.5, 18, -9)"
[/codeblock]
</description>
</operator>
<operator name="operator *">
@ -140,12 +145,20 @@
<return type="float" />
<param index="0" name="right" type="float" />
<description>
Raises a [float] to a power of a [float].
[codeblock]
print(39.0625**0.25) # 2.5
[/codeblock]
</description>
</operator>
<operator name="operator **">
<return type="float" />
<param index="0" name="right" type="int" />
<description>
Raises a [float] to a power of an [int]. The result is a [float].
[codeblock]
print(0.9**3) # 0.729
[/codeblock]
</description>
</operator>
<operator name="operator +">

10
doc/classes/int.xml
View File

@ -161,12 +161,14 @@
<return type="Vector4" />
<param index="0" name="right" type="Vector4" />
<description>
Multiplies each component of the [Vector4] by the given [int].
</description>
</operator>
<operator name="operator *">
<return type="Vector4i" />
<param index="0" name="right" type="Vector4i" />
<description>
Multiplies each component of the [Vector4i] by the given [int].
</description>
</operator>
<operator name="operator *">
@ -187,12 +189,20 @@
<return type="float" />
<param index="0" name="right" type="float" />
<description>
Raises an [int] to a power of a [float]. The result is a [float].
[codeblock]
print(8**0.25) # 1.68179283050743
[/codeblock]
</description>
</operator>
<operator name="operator **">
<return type="int" />
<param index="0" name="right" type="int" />
<description>
Raises an [int] to a power of a [int].
[codeblock]
print(5**5) # 3125
[/codeblock]
</description>
</operator>
<operator name="operator +">