Trang chủ Khám phá Trợ giúp
Đăng nhập
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Các tập tin Các vấn đề 0 Wiki
Tree: c282b77a58
Branches Tags
godot-docs
/
classes
/
[email protected]

[email protected] 44 KB
Lịch sử Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
    3. 

  3. 

  4. .. _class_@GDScript:
    5. 

  5. 

  6. @GDScript
    7. 

  7. =========
    8. 

  8. 

  9. **Category:** Core
    10. 

  10. 

  11. Brief Description
    12. 

  12. -----------------
    13. 

  13. 

  14. Built-in GDScript functions.
    15. 

  15. 

  16. Member Functions
    17. 

  17. ----------------
    18. 

  18. 

  19. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    20. 

  20. | :ref:`Color<class_color>`                      | :ref:`Color8<class_@GDScript_Color8>`  **(** :ref:`int<class_int>` r8, :ref:`int<class_int>` g8, :ref:`int<class_int>` b8, :ref:`int<class_int>` a8  **)** |
    21. 

  21. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    22. 

  22. | :ref:`Color<class_color>`                      | :ref:`ColorN<class_@GDScript_ColorN>`  **(** :ref:`String<class_string>` name, :ref:`float<class_float>` alpha  **)**                                      |
    23. 

  23. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    24. 

  24. | :ref:`float<class_float>`                      | :ref:`abs<class_@GDScript_abs>`  **(** :ref:`float<class_float>` s  **)**                                                                                  |
    25. 

  25. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    26. 

  26. | :ref:`float<class_float>`                      | :ref:`acos<class_@GDScript_acos>`  **(** :ref:`float<class_float>` s  **)**                                                                                |
    27. 

  27. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    28. 

  28. | :ref:`float<class_float>`                      | :ref:`asin<class_@GDScript_asin>`  **(** :ref:`float<class_float>` s  **)**                                                                                |
    29. 

  29. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    30. 

  30. | :ref:`Nil<class_nil>`                          | :ref:`assert<class_@GDScript_assert>`  **(** :ref:`bool<class_bool>` condition  **)**                                                                      |
    31. 

  31. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | :ref:`float<class_float>`                      | :ref:`atan<class_@GDScript_atan>`  **(** :ref:`float<class_float>` s  **)**                                                                                |
    33. 

  33. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | :ref:`float<class_float>`                      | :ref:`atan2<class_@GDScript_atan2>`  **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y  **)**                                                 |
    35. 

  35. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | :ref:`Variant<class_variant>`                  | :ref:`bytes2var<class_@GDScript_bytes2var>`  **(** :ref:`PoolByteArray<class_poolbytearray>` bytes  **)**                                                  |
    37. 

  37. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38. | :ref:`float<class_float>`                      | :ref:`ceil<class_@GDScript_ceil>`  **(** :ref:`float<class_float>` s  **)**                                                                                |
    39. 

  39. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40. | :ref:`String<class_string>`                    | :ref:`char<class_@GDScript_char>`  **(** :ref:`int<class_int>` ascii  **)**                                                                                |
    41. 

  41. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | :ref:`float<class_float>`                      | :ref:`clamp<class_@GDScript_clamp>`  **(** :ref:`float<class_float>` val, :ref:`float<class_float>` min, :ref:`float<class_float>` max  **)**              |
    43. 

  43. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. | :ref:`Object<class_object>`                    | :ref:`convert<class_@GDScript_convert>`  **(** :ref:`Variant<class_variant>` what, :ref:`int<class_int>` type  **)**                                       |
    45. 

  45. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. | :ref:`float<class_float>`                      | :ref:`cos<class_@GDScript_cos>`  **(** :ref:`float<class_float>` s  **)**                                                                                  |
    47. 

  47. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48. | :ref:`float<class_float>`                      | :ref:`cosh<class_@GDScript_cosh>`  **(** :ref:`float<class_float>` s  **)**                                                                                |
    49. 

  49. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    50. 

  50. | :ref:`float<class_float>`                      | :ref:`db2linear<class_@GDScript_db2linear>`  **(** :ref:`float<class_float>` db  **)**                                                                     |
    51. 

  51. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    52. 

  52. | :ref:`float<class_float>`                      | :ref:`decimals<class_@GDScript_decimals>`  **(** :ref:`float<class_float>` step  **)**                                                                     |
    53. 

  53. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    54. 

  54. | :ref:`float<class_float>`                      | :ref:`dectime<class_@GDScript_dectime>`  **(** :ref:`float<class_float>` value, :ref:`float<class_float>` amount, :ref:`float<class_float>` step  **)**    |
    55. 

  55. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    56. 

  56. | :ref:`float<class_float>`                      | :ref:`deg2rad<class_@GDScript_deg2rad>`  **(** :ref:`float<class_float>` deg  **)**                                                                        |
    57. 

  57. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    58. 

  58. | :ref:`Object<class_object>`                    | :ref:`dict2inst<class_@GDScript_dict2inst>`  **(** :ref:`Dictionary<class_dictionary>` dict  **)**                                                         |
    59. 

  59. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    60. 

  60. | :ref:`float<class_float>`                      | :ref:`ease<class_@GDScript_ease>`  **(** :ref:`float<class_float>` s, :ref:`float<class_float>` curve  **)**                                               |
    61. 

  61. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    62. 

  62. | :ref:`float<class_float>`                      | :ref:`exp<class_@GDScript_exp>`  **(** :ref:`float<class_float>` s  **)**                                                                                  |
    63. 

  63. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    64. 

  64. | :ref:`float<class_float>`                      | :ref:`floor<class_@GDScript_floor>`  **(** :ref:`float<class_float>` s  **)**                                                                              |
    65. 

  65. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    66. 

  66. | :ref:`float<class_float>`                      | :ref:`fmod<class_@GDScript_fmod>`  **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y  **)**                                                   |
    67. 

  67. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    68. 

  68. | :ref:`float<class_float>`                      | :ref:`fposmod<class_@GDScript_fposmod>`  **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y  **)**                                             |
    69. 

  69. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    70. 

  70. | :ref:`FuncRef<class_funcref>`                  | :ref:`funcref<class_@GDScript_funcref>`  **(** :ref:`Object<class_object>` instance, :ref:`String<class_string>` funcname  **)**                           |
    71. 

  71. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    72. 

  72. | :ref:`int<class_int>`                          | :ref:`hash<class_@GDScript_hash>`  **(** :ref:`Variant<class_variant>` var:Variant  **)**                                                                  |
    73. 

  73. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    74. 

  74. | :ref:`Dictionary<class_dictionary>`            | :ref:`inst2dict<class_@GDScript_inst2dict>`  **(** :ref:`Object<class_object>` inst  **)**                                                                 |
    75. 

  75. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    76. 

  76. | :ref:`Object<class_object>`                    | :ref:`instance_from_id<class_@GDScript_instance_from_id>`  **(** :ref:`int<class_int>` instance_id  **)**                                                  |
    77. 

  77. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    78. 

  78. | :ref:`float<class_float>`                      | :ref:`is_inf<class_@GDScript_is_inf>`  **(** :ref:`float<class_float>` s  **)**                                                                            |
    79. 

  79. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    80. 

  80. | :ref:`float<class_float>`                      | :ref:`is_nan<class_@GDScript_is_nan>`  **(** :ref:`float<class_float>` s  **)**                                                                            |
    81. 

  81. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    82. 

  82. | :ref:`float<class_float>`                      | :ref:`lerp<class_@GDScript_lerp>`  **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` weight  **)**             |
    83. 

  83. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    84. 

  84. | :ref:`float<class_float>`                      | :ref:`linear2db<class_@GDScript_linear2db>`  **(** :ref:`float<class_float>` nrg  **)**                                                                    |
    85. 

  85. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    86. 

  86. | :ref:`Resource<class_resource>`                | :ref:`load<class_@GDScript_load>`  **(** :ref:`String<class_string>` path  **)**                                                                           |
    87. 

  87. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    88. 

  88. | :ref:`float<class_float>`                      | :ref:`log<class_@GDScript_log>`  **(** :ref:`float<class_float>` s  **)**                                                                                  |
    89. 

  89. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    90. 

  90. | :ref:`float<class_float>`                      | :ref:`max<class_@GDScript_max>`  **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b  **)**                                                     |
    91. 

  91. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    92. 

  92. | :ref:`float<class_float>`                      | :ref:`min<class_@GDScript_min>`  **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b  **)**                                                     |
    93. 

  93. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    94. 

  94. | :ref:`int<class_int>`                          | :ref:`nearest_po2<class_@GDScript_nearest_po2>`  **(** :ref:`int<class_int>` val  **)**                                                                    |
    95. 

  95. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    96. 

  96. | :ref:`Variant<class_variant>`                  | :ref:`parse_json<class_@GDScript_parse_json>`  **(** :ref:`String<class_string>` json  **)**                                                               |
    97. 

  97. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    98. 

  98. | :ref:`float<class_float>`                      | :ref:`pow<class_@GDScript_pow>`  **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y  **)**                                                     |
    99. 

  99. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    100. 

  100. | :ref:`Resource<class_resource>`                | :ref:`preload<class_@GDScript_preload>`  **(** :ref:`String<class_string>` path  **)**                                                                     |
    101. 

  101. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    102. 

  102. | :ref:`Nil<class_nil>`                          | :ref:`print<class_@GDScript_print>`  **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ...  **)**                                    |
    103. 

  103. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    104. 

  104. | :ref:`Nil<class_nil>`                          | :ref:`print_stack<class_@GDScript_print_stack>`  **(** **)**                                                                                               |
    105. 

  105. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    106. 

  106. | :ref:`Nil<class_nil>`                          | :ref:`printerr<class_@GDScript_printerr>`  **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ...  **)**                              |
    107. 

  107. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    108. 

  108. | :ref:`Nil<class_nil>`                          | :ref:`printraw<class_@GDScript_printraw>`  **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ...  **)**                              |
    109. 

  109. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    110. 

  110. | :ref:`Nil<class_nil>`                          | :ref:`prints<class_@GDScript_prints>`  **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ...  **)**                                  |
    111. 

  111. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    112. 

  112. | :ref:`Nil<class_nil>`                          | :ref:`printt<class_@GDScript_printt>`  **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ...  **)**                                  |
    113. 

  113. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    114. 

  114. | :ref:`float<class_float>`                      | :ref:`rad2deg<class_@GDScript_rad2deg>`  **(** :ref:`float<class_float>` rad  **)**                                                                        |
    115. 

  115. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    116. 

  116. | :ref:`float<class_float>`                      | :ref:`rand_range<class_@GDScript_rand_range>`  **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to  **)**                                   |
    117. 

  117. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    118. 

  118. | :ref:`Array<class_array>`                      | :ref:`rand_seed<class_@GDScript_rand_seed>`  **(** :ref:`int<class_int>` seed  **)**                                                                       |
    119. 

  119. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    120. 

  120. | :ref:`float<class_float>`                      | :ref:`randf<class_@GDScript_randf>`  **(** **)**                                                                                                           |
    121. 

  121. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    122. 

  122. | :ref:`int<class_int>`                          | :ref:`randi<class_@GDScript_randi>`  **(** **)**                                                                                                           |
    123. 

  123. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    124. 

  124. | :ref:`Nil<class_nil>`                          | :ref:`randomize<class_@GDScript_randomize>`  **(** **)**                                                                                                   |
    125. 

  125. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    126. 

  126. | :ref:`Array<class_array>`                      | :ref:`range<class_@GDScript_range>`  **(** :ref:`Variant<class_variant>` ...  **)**                                                                        |
    127. 

  127. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    128. 

  128. | :ref:`float<class_float>`                      | :ref:`round<class_@GDScript_round>`  **(** :ref:`float<class_float>` s  **)**                                                                              |
    129. 

  129. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    130. 

  130. | :ref:`Nil<class_nil>`                          | :ref:`seed<class_@GDScript_seed>`  **(** :ref:`int<class_int>` seed  **)**                                                                                 |
    131. 

  131. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    132. 

  132. | :ref:`float<class_float>`                      | :ref:`sign<class_@GDScript_sign>`  **(** :ref:`float<class_float>` s  **)**                                                                                |
    133. 

  133. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    134. 

  134. | :ref:`float<class_float>`                      | :ref:`sin<class_@GDScript_sin>`  **(** :ref:`float<class_float>` s  **)**                                                                                  |
    135. 

  135. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    136. 

  136. | :ref:`float<class_float>`                      | :ref:`sinh<class_@GDScript_sinh>`  **(** :ref:`float<class_float>` s  **)**                                                                                |
    137. 

  137. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    138. 

  138. | :ref:`float<class_float>`                      | :ref:`sqrt<class_@GDScript_sqrt>`  **(** :ref:`float<class_float>` s  **)**                                                                                |
    139. 

  139. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    140. 

  140. | :ref:`float<class_float>`                      | :ref:`stepify<class_@GDScript_stepify>`  **(** :ref:`float<class_float>` s, :ref:`float<class_float>` step  **)**                                          |
    141. 

  141. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    142. 

  142. | :ref:`String<class_string>`                    | :ref:`str<class_@GDScript_str>`  **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ...  **)**                                        |
    143. 

  143. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    144. 

  144. | :ref:`Variant<class_variant>`                  | :ref:`str2var<class_@GDScript_str2var>`  **(** :ref:`String<class_string>` string  **)**                                                                   |
    145. 

  145. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    146. 

  146. | :ref:`float<class_float>`                      | :ref:`tan<class_@GDScript_tan>`  **(** :ref:`float<class_float>` s  **)**                                                                                  |
    147. 

  147. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    148. 

  148. | :ref:`float<class_float>`                      | :ref:`tanh<class_@GDScript_tanh>`  **(** :ref:`float<class_float>` s  **)**                                                                                |
    149. 

  149. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    150. 

  150. | :ref:`String<class_string>`                    | :ref:`to_json<class_@GDScript_to_json>`  **(** :ref:`Variant<class_variant>` var:Variant  **)**                                                            |
    151. 

  151. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    152. 

  152. | :ref:`bool<class_bool>`                        | :ref:`type_exists<class_@GDScript_type_exists>`  **(** :ref:`String<class_string>` type  **)**                                                             |
    153. 

  153. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    154. 

  154. | :ref:`int<class_int>`                          | :ref:`typeof<class_@GDScript_typeof>`  **(** :ref:`Variant<class_variant>` what  **)**                                                                     |
    155. 

  155. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    156. 

  156. | :ref:`Variant<class_variant>`                  | :ref:`validate_json<class_@GDScript_validate_json>`  **(** :ref:`String<class_string>` json  **)**                                                         |
    157. 

  157. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    158. 

  158. | :ref:`PoolByteArray<class_poolbytearray>`      | :ref:`var2bytes<class_@GDScript_var2bytes>`  **(** :ref:`Variant<class_variant>` var  **)**                                                                |
    159. 

  159. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    160. 

  160. | :ref:`String<class_string>`                    | :ref:`var2str<class_@GDScript_var2str>`  **(** :ref:`Variant<class_variant>` var  **)**                                                                    |
    161. 

  161. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    162. 

  162. | :ref:`WeakRef<class_weakref>`                  | :ref:`weakref<class_@GDScript_weakref>`  **(** :ref:`Object<class_object>` obj  **)**                                                                      |
    163. 

  163. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    164. 

  164. | :ref:`GDFunctionState<class_gdfunctionstate>`  | :ref:`yield<class_@GDScript_yield>`  **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` signal  **)**                                   |
    165. 

  165. +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
    166. 

  166. 

  167. Numeric Constants
    168. 

  168. -----------------
    169. 

  169. 

  170. - **PI** = **3.141593** --- Constant that represents how many times the diameter of a circumference fits around its perimeter.
    171. 

  171. - **INF** = **inf**
    172. 

  172. - **NAN** = **nan**
    173. 

  173. 

  174. Description
    175. 

  175. -----------
    176. 

  176. 

  177. This contains the list of built-in gdscript functions. Mostly math functions and other utilities. Everything else is expanded by objects.
    178. 

  178. 

  179. Member Function Description
    180. 

  180. ---------------------------
    181. 

  181. 

  182. .. _class_@GDScript_Color8:
    183. 

  183. 

  184. - :ref:`Color<class_color>`  **Color8**  **(** :ref:`int<class_int>` r8, :ref:`int<class_int>` g8, :ref:`int<class_int>` b8, :ref:`int<class_int>` a8  **)**
    185. 

  185. 

  186. Make a color from red, green, blue and alpha. Arguments can range from 0 to 255.
    187. 

  187. 

  188. .. _class_@GDScript_ColorN:
    189. 

  189. 

  190. - :ref:`Color<class_color>`  **ColorN**  **(** :ref:`String<class_string>` name, :ref:`float<class_float>` alpha  **)**
    191. 

  191. 

  192. .. _class_@GDScript_abs:
    193. 

  193. 

  194. - :ref:`float<class_float>`  **abs**  **(** :ref:`float<class_float>` s  **)**
    195. 

  195. 

  196. Remove sign (works for integer and float).
    197. 

  197. 

  198. .. _class_@GDScript_acos:
    199. 

  199. 

  200. - :ref:`float<class_float>`  **acos**  **(** :ref:`float<class_float>` s  **)**
    201. 

  201. 

  202. Arc-cosine.
    203. 

  203. 

  204. .. _class_@GDScript_asin:
    205. 

  205. 

  206. - :ref:`float<class_float>`  **asin**  **(** :ref:`float<class_float>` s  **)**
    207. 

  207. 

  208. Arc-sine.
    209. 

  209. 

  210. .. _class_@GDScript_assert:
    211. 

  211. 

  212. - :ref:`Nil<class_nil>`  **assert**  **(** :ref:`bool<class_bool>` condition  **)**
    213. 

  213. 

  214. Assert that the condition is true. If the condition is false, generates an error.
    215. 

  215. 

  216. .. _class_@GDScript_atan:
    217. 

  217. 

  218. - :ref:`float<class_float>`  **atan**  **(** :ref:`float<class_float>` s  **)**
    219. 

  219. 

  220. Arc-tangent.
    221. 

  221. 

  222. .. _class_@GDScript_atan2:
    223. 

  223. 

  224. - :ref:`float<class_float>`  **atan2**  **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y  **)**
    225. 

  225. 

  226. Arc-tangent that takes a 2D vector as argument, returns the full -pi to +pi range.
    227. 

  227. 

  228. .. _class_@GDScript_bytes2var:
    229. 

  229. 

  230. - :ref:`Variant<class_variant>`  **bytes2var**  **(** :ref:`PoolByteArray<class_poolbytearray>` bytes  **)**
    231. 

  231. 

  232. Decode a byte array back to a value.
    233. 

  233. 

  234. .. _class_@GDScript_ceil:
    235. 

  235. 

  236. - :ref:`float<class_float>`  **ceil**  **(** :ref:`float<class_float>` s  **)**
    237. 

  237. 

  238. Ceiling (rounds up to nearest integer).
    239. 

  239. 

  240. .. _class_@GDScript_char:
    241. 

  241. 

  242. - :ref:`String<class_string>`  **char**  **(** :ref:`int<class_int>` ascii  **)**
    243. 

  243. 

  244. .. _class_@GDScript_clamp:
    245. 

  245. 

  246. - :ref:`float<class_float>`  **clamp**  **(** :ref:`float<class_float>` val, :ref:`float<class_float>` min, :ref:`float<class_float>` max  **)**
    247. 

  247. 

  248. Clamp both values to a range.
    249. 

  249. 

  250. .. _class_@GDScript_convert:
    251. 

  251. 

  252. - :ref:`Object<class_object>`  **convert**  **(** :ref:`Variant<class_variant>` what, :ref:`int<class_int>` type  **)**
    253. 

  253. 

  254. Convert from a type to another in the best way possible. The "type" parameter uses the enum TYPE\_\* in :ref:`@Global Scope<class_@global scope>`.
    255. 

  255. 

  256. .. _class_@GDScript_cos:
    257. 

  257. 

  258. - :ref:`float<class_float>`  **cos**  **(** :ref:`float<class_float>` s  **)**
    259. 

  259. 

  260. Standard cosine function.
    261. 

  261. 

  262. .. _class_@GDScript_cosh:
    263. 

  263. 

  264. - :ref:`float<class_float>`  **cosh**  **(** :ref:`float<class_float>` s  **)**
    265. 

  265. 

  266. Hyperbolic cosine.
    267. 

  267. 

  268. .. _class_@GDScript_db2linear:
    269. 

  269. 

  270. - :ref:`float<class_float>`  **db2linear**  **(** :ref:`float<class_float>` db  **)**
    271. 

  271. 

  272. Convert from decibels to linear energy (audio).
    273. 

  273. 

  274. .. _class_@GDScript_decimals:
    275. 

  275. 

  276. - :ref:`float<class_float>`  **decimals**  **(** :ref:`float<class_float>` step  **)**
    277. 

  277. 

  278. Return the amount of decimals in the floating point value.
    279. 

  279. 

  280. .. _class_@GDScript_dectime:
    281. 

  281. 

  282. - :ref:`float<class_float>`  **dectime**  **(** :ref:`float<class_float>` value, :ref:`float<class_float>` amount, :ref:`float<class_float>` step  **)**
    283. 

  283. 

  284. Decreases time by a specified amount.
    285. 

  285. 

  286. .. _class_@GDScript_deg2rad:
    287. 

  287. 

  288. - :ref:`float<class_float>`  **deg2rad**  **(** :ref:`float<class_float>` deg  **)**
    289. 

  289. 

  290. Convert from degrees to radians.
    291. 

  291. 

  292. .. _class_@GDScript_dict2inst:
    293. 

  293. 

  294. - :ref:`Object<class_object>`  **dict2inst**  **(** :ref:`Dictionary<class_dictionary>` dict  **)**
    295. 

  295. 

  296. Convert a previously converted instances to dictionary back into an instance. Useful for deserializing.
    297. 

  297. 

  298. .. _class_@GDScript_ease:
    299. 

  299. 

  300. - :ref:`float<class_float>`  **ease**  **(** :ref:`float<class_float>` s, :ref:`float<class_float>` curve  **)**
    301. 

  301. 

  302. Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in.
    303. 

  303. 

  304. .. _class_@GDScript_exp:
    305. 

  305. 

  306. - :ref:`float<class_float>`  **exp**  **(** :ref:`float<class_float>` s  **)**
    307. 

  307. 

  308. Exponential logarithm.
    309. 

  309. 

  310. .. _class_@GDScript_floor:
    311. 

  311. 

  312. - :ref:`float<class_float>`  **floor**  **(** :ref:`float<class_float>` s  **)**
    313. 

  313. 

  314. Floor (rounds down to nearest integer).
    315. 

  315. 

  316. .. _class_@GDScript_fmod:
    317. 

  317. 

  318. - :ref:`float<class_float>`  **fmod**  **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y  **)**
    319. 

  319. 

  320. Module (remainder of x/y).
    321. 

  321. 

  322. .. _class_@GDScript_fposmod:
    323. 

  323. 

  324. - :ref:`float<class_float>`  **fposmod**  **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y  **)**
    325. 

  325. 

  326. Module (remainder of x/y) that wraps equally in positive and negative.
    327. 

  327. 

  328. .. _class_@GDScript_funcref:
    329. 

  329. 

  330. - :ref:`FuncRef<class_funcref>`  **funcref**  **(** :ref:`Object<class_object>` instance, :ref:`String<class_string>` funcname  **)**
    331. 

  331. 

  332. Return a reference to the specified function.
    333. 

  333. 

  334. .. _class_@GDScript_hash:
    335. 

  335. 

  336. - :ref:`int<class_int>`  **hash**  **(** :ref:`Variant<class_variant>` var:Variant  **)**
    337. 

  337. 

  338. Hash the variable passed and return an integer.
    339. 

  339. 

  340. .. _class_@GDScript_inst2dict:
    341. 

  341. 

  342. - :ref:`Dictionary<class_dictionary>`  **inst2dict**  **(** :ref:`Object<class_object>` inst  **)**
    343. 

  343. 

  344. Convert a script class instance to a dictionary (useful for serializing).
    345. 

  345. 

  346. .. _class_@GDScript_instance_from_id:
    347. 

  347. 

  348. - :ref:`Object<class_object>`  **instance_from_id**  **(** :ref:`int<class_int>` instance_id  **)**
    349. 

  349. 

  350. Get an object by its ID.
    351. 

  351. 

  352. .. _class_@GDScript_is_inf:
    353. 

  353. 

  354. - :ref:`float<class_float>`  **is_inf**  **(** :ref:`float<class_float>` s  **)**
    355. 

  355. 

  356. .. _class_@GDScript_is_nan:
    357. 

  357. 

  358. - :ref:`float<class_float>`  **is_nan**  **(** :ref:`float<class_float>` s  **)**
    359. 

  359. 

  360. .. _class_@GDScript_lerp:
    361. 

  361. 

  362. - :ref:`float<class_float>`  **lerp**  **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` weight  **)**
    363. 

  363. 

  364. Linear interpolates between two values by a normalized value.
    365. 

  365. 

  366. .. _class_@GDScript_linear2db:
    367. 

  367. 

  368. - :ref:`float<class_float>`  **linear2db**  **(** :ref:`float<class_float>` nrg  **)**
    369. 

  369. 

  370. Convert from linear energy to decibels (audio).
    371. 

  371. 

  372. .. _class_@GDScript_load:
    373. 

  373. 

  374. - :ref:`Resource<class_resource>`  **load**  **(** :ref:`String<class_string>` path  **)**
    375. 

  375. 

  376. Load a resource from the filesystem, pass a valid path as argument.
    377. 

  377. 

  378. .. _class_@GDScript_log:
    379. 

  379. 

  380. - :ref:`float<class_float>`  **log**  **(** :ref:`float<class_float>` s  **)**
    381. 

  381. 

  382. Natural logarithm.
    383. 

  383. 

  384. .. _class_@GDScript_max:
    385. 

  385. 

  386. - :ref:`float<class_float>`  **max**  **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b  **)**
    387. 

  387. 

  388. Return the maximum of two values.
    389. 

  389. 

  390. .. _class_@GDScript_min:
    391. 

  391. 

  392. - :ref:`float<class_float>`  **min**  **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b  **)**
    393. 

  393. 

  394. Return the minimum of two values.
    395. 

  395. 

  396. .. _class_@GDScript_nearest_po2:
    397. 

  397. 

  398. - :ref:`int<class_int>`  **nearest_po2**  **(** :ref:`int<class_int>` val  **)**
    399. 

  399. 

  400. Return the nearest larger power of 2 for an integer.
    401. 

  401. 

  402. .. _class_@GDScript_parse_json:
    403. 

  403. 

  404. - :ref:`Variant<class_variant>`  **parse_json**  **(** :ref:`String<class_string>` json  **)**
    405. 

  405. 

  406. Parse json text to a Variant (use :ref:`typeof<class_@GDScript_typeof>` to check if it is what you expect).
    407. 

  407. 

  408. .. _class_@GDScript_pow:
    409. 

  409. 

  410. - :ref:`float<class_float>`  **pow**  **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y  **)**
    411. 

  411. 

  412. Power function, x elevate to y.
    413. 

  413. 

  414. .. _class_@GDScript_preload:
    415. 

  415. 

  416. - :ref:`Resource<class_resource>`  **preload**  **(** :ref:`String<class_string>` path  **)**
    417. 

  417. 

  418. Preload a resource from the filesystem. The resource is loaded during script parsing.
    419. 

  419. 

  420. .. _class_@GDScript_print:
    421. 

  421. 

  422. - :ref:`Nil<class_nil>`  **print**  **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ...  **)**
    423. 

  423. 

  424. Print one or more arguments to strings in the best way possible to a console line.
    425. 

  425. 

  426. .. _class_@GDScript_print_stack:
    427. 

  427. 

  428. - :ref:`Nil<class_nil>`  **print_stack**  **(** **)**
    429. 

  429. 

  430. Print a stack track at code location, only works when running with debugger turned on.
    431. 

  431. 

  432. .. _class_@GDScript_printerr:
    433. 

  433. 

  434. - :ref:`Nil<class_nil>`  **printerr**  **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ...  **)**
    435. 

  435. 

  436. Print one or more arguments to strings in the best way possible to standard error line.
    437. 

  437. 

  438. .. _class_@GDScript_printraw:
    439. 

  439. 

  440. - :ref:`Nil<class_nil>`  **printraw**  **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ...  **)**
    441. 

  441. 

  442. Print one or more arguments to strings in the best way possible to console. No newline is added at the end.
    443. 

  443. 

  444. .. _class_@GDScript_prints:
    445. 

  445. 

  446. - :ref:`Nil<class_nil>`  **prints**  **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ...  **)**
    447. 

  447. 

  448. Print one or more arguments to the console with a space between each argument.
    449. 

  449. 

  450. .. _class_@GDScript_printt:
    451. 

  451. 

  452. - :ref:`Nil<class_nil>`  **printt**  **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ...  **)**
    453. 

  453. 

  454. Print one or more arguments to the console with a tab between each argument.
    455. 

  455. 

  456. .. _class_@GDScript_rad2deg:
    457. 

  457. 

  458. - :ref:`float<class_float>`  **rad2deg**  **(** :ref:`float<class_float>` rad  **)**
    459. 

  459. 

  460. Convert from radians to degrees.
    461. 

  461. 

  462. .. _class_@GDScript_rand_range:
    463. 

  463. 

  464. - :ref:`float<class_float>`  **rand_range**  **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to  **)**
    465. 

  465. 

  466. Random range, any floating point value between 'from' and 'to'.
    467. 

  467. 

  468. .. _class_@GDScript_rand_seed:
    469. 

  469. 

  470. - :ref:`Array<class_array>`  **rand_seed**  **(** :ref:`int<class_int>` seed  **)**
    471. 

  471. 

  472. Random from seed: pass a seed, and an array with both number and new seed is returned. "Seed" here refers to the internal state of the pseudo random number generator. The internal state of the current implementation is 64 bits.
    473. 

  473. 

  474. .. _class_@GDScript_randf:
    475. 

  475. 

  476. - :ref:`float<class_float>`  **randf**  **(** **)**
    477. 

  477. 

  478. Return a random floating point value between 0 and 1.
    479. 

  479. 

  480. .. _class_@GDScript_randi:
    481. 

  481. 

  482. - :ref:`int<class_int>`  **randi**  **(** **)**
    483. 

  483. 

  484. Return a random 32 bits integer value. To obtain a random value between 0 to N (where N is smaller than 2^32 - 1), you can use remainder. For example, to get a random integer between 0 and 19 inclusive, you can use randi() % 20.
    485. 

  485. 

  486. .. _class_@GDScript_randomize:
    487. 

  487. 

  488. - :ref:`Nil<class_nil>`  **randomize**  **(** **)**
    489. 

  489. 

  490. Randomize the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time.
    491. 

  491. 

  492. .. _class_@GDScript_range:
    493. 

  493. 

  494. - :ref:`Array<class_array>`  **range**  **(** :ref:`Variant<class_variant>` ...  **)**
    495. 

  495. 

  496. Return an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial, final-1, increment).
    497. 

  497. 

  498. .. _class_@GDScript_round:
    499. 

  499. 

  500. - :ref:`float<class_float>`  **round**  **(** :ref:`float<class_float>` s  **)**
    501. 

  501. 

  502. Round to nearest integer.
    503. 

  503. 

  504. .. _class_@GDScript_seed:
    505. 

  505. 

  506. - :ref:`Nil<class_nil>`  **seed**  **(** :ref:`int<class_int>` seed  **)**
    507. 

  507. 

  508. Set seed for the random number generator.
    509. 

  509. 

  510. .. _class_@GDScript_sign:
    511. 

  511. 

  512. - :ref:`float<class_float>`  **sign**  **(** :ref:`float<class_float>` s  **)**
    513. 

  513. 

  514. Return sign (-1 or +1).
    515. 

  515. 

  516. .. _class_@GDScript_sin:
    517. 

  517. 

  518. - :ref:`float<class_float>`  **sin**  **(** :ref:`float<class_float>` s  **)**
    519. 

  519. 

  520. Standard sine function.
    521. 

  521. 

  522. .. _class_@GDScript_sinh:
    523. 

  523. 

  524. - :ref:`float<class_float>`  **sinh**  **(** :ref:`float<class_float>` s  **)**
    525. 

  525. 

  526. Hyperbolic sine.
    527. 

  527. 

  528. .. _class_@GDScript_sqrt:
    529. 

  529. 

  530. - :ref:`float<class_float>`  **sqrt**  **(** :ref:`float<class_float>` s  **)**
    531. 

  531. 

  532. Square root.
    533. 

  533. 

  534. .. _class_@GDScript_stepify:
    535. 

  535. 

  536. - :ref:`float<class_float>`  **stepify**  **(** :ref:`float<class_float>` s, :ref:`float<class_float>` step  **)**
    537. 

  537. 

  538. Snap float value to a given step.
    539. 

  539. 

  540. .. _class_@GDScript_str:
    541. 

  541. 

  542. - :ref:`String<class_string>`  **str**  **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ...  **)**
    543. 

  543. 

  544. Convert one or more arguments to strings in the best way possible.
    545. 

  545. 

  546. .. _class_@GDScript_str2var:
    547. 

  547. 

  548. - :ref:`Variant<class_variant>`  **str2var**  **(** :ref:`String<class_string>` string  **)**
    549. 

  549. 

  550. Convert a formatted string that was returned by :ref:`var2str<class_@GDScript_var2str>` to the original value.
    551. 

  551. 

  552. .. _class_@GDScript_tan:
    553. 

  553. 

  554. - :ref:`float<class_float>`  **tan**  **(** :ref:`float<class_float>` s  **)**
    555. 

  555. 

  556. Standard tangent function.
    557. 

  557. 

  558. .. _class_@GDScript_tanh:
    559. 

  559. 

  560. - :ref:`float<class_float>`  **tanh**  **(** :ref:`float<class_float>` s  **)**
    561. 

  561. 

  562. Hyperbolic tangent.
    563. 

  563. 

  564. .. _class_@GDScript_to_json:
    565. 

  565. 

  566. - :ref:`String<class_string>`  **to_json**  **(** :ref:`Variant<class_variant>` var:Variant  **)**
    567. 

  567. 

  568. Convert a Variant to json text.
    569. 

  569. 

  570. .. _class_@GDScript_type_exists:
    571. 

  571. 

  572. - :ref:`bool<class_bool>`  **type_exists**  **(** :ref:`String<class_string>` type  **)**
    573. 

  573. 

  574. .. _class_@GDScript_typeof:
    575. 

  575. 

  576. - :ref:`int<class_int>`  **typeof**  **(** :ref:`Variant<class_variant>` what  **)**
    577. 

  577. 

  578. Return the internal type of the given Variant object, using the TYPE\_\* enum in :ref:`@Global Scope<class_@global scope>`.
    579. 

  579. 

  580. .. _class_@GDScript_validate_json:
    581. 

  581. 

  582. - :ref:`Variant<class_variant>`  **validate_json**  **(** :ref:`String<class_string>` json  **)**
    583. 

  583. 

  584. .. _class_@GDScript_var2bytes:
    585. 

  585. 

  586. - :ref:`PoolByteArray<class_poolbytearray>`  **var2bytes**  **(** :ref:`Variant<class_variant>` var  **)**
    587. 

  587. 

  588. Encode a variable value to a byte array.
    589. 

  589. 

  590. .. _class_@GDScript_var2str:
    591. 

  591. 

  592. - :ref:`String<class_string>`  **var2str**  **(** :ref:`Variant<class_variant>` var  **)**
    593. 

  593. 

  594. Convert a value to a formatted string that can later be parsed using :ref:`str2var<class_@GDScript_str2var>`.
    595. 

  595. 

  596. .. _class_@GDScript_weakref:
    597. 

  597. 

  598. - :ref:`WeakRef<class_weakref>`  **weakref**  **(** :ref:`Object<class_object>` obj  **)**
    599. 

  599. 

  600. Return a weak reference to an object.
    601. 

  601. 

  602. .. _class_@GDScript_yield:
    603. 

  603. 

  604. - :ref:`GDFunctionState<class_gdfunctionstate>`  **yield**  **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` signal  **)**
    605. 

  605. 

  606. Stop the function execution and return the current state. Call :ref:`GDFunctionState.resume<class_GDFunctionState_resume>` on the state to resume execution. This invalidates the state.
    607. 

  607. 

  608. Returns anything that was passed to the resume function call. If passed an object and a signal, the execution is resumed when the object's signal is emitted.
    609. 

  609. 

  610.