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

Document how to use logarithm of base 10 with log()

Browse source 
(cherry picked from commit 3c4f0ca9c6)
This commit is contained in:
Hugo Locurcio 2023-03-24 21:10:43 +01:00 committed by Rémi Verschelde
parent 268f83e07f
commit 9cde5e2977
No known key found for this signature in database
GPG key ID: C3336907360768E1
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -556,8 +556,8 @@
<return type="float" />
<argument index="0" name="s" type="float" />
<description>
Natural logarithm. The amount of time needed to reach a certain level of continuous growth.
[b]Note:[/b] This is not the same as the "log" function on most calculators, which uses a base 10 logarithm.
Returns the [url=https://en.wikipedia.org/wiki/Natural_logarithm]natural logarithm[/url] of [code]s[/code] (base [url=https://en.wikipedia.org/wiki/E_(mathematical_constant)][i]e[/i][/url], with [i]e[/i] being approximately 2.71828). This is the amount of time needed to reach a certain level of continuous growth.
[b]Note:[/b] This is not the same as the "log" function on most calculators, which uses a base 10 logarithm. To use base 10 logarithm, use [code]log(x) / log(10)[/code].
[codeblock]
log(10) # Returns 2.302585
[/codeblock]