gdscript_functions.cpp 44 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797
  1. /*************************************************************************/
  2. /* gdscript_functions.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2017 Godot Engine contributors (cf. AUTHORS.md) */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #include "gdscript_functions.h"
  31. #include "class_db.h"
  32. #include "func_ref.h"
  33. #include "gdscript.h"
  34. #include "io/json.h"
  35. #include "io/marshalls.h"
  36. #include "math_funcs.h"
  37. #include "os/os.h"
  38. #include "reference.h"
  39. #include "variant_parser.h"
  40. const char *GDScriptFunctions::get_func_name(Function p_func) {
  41. ERR_FAIL_INDEX_V(p_func, FUNC_MAX, "");
  42. static const char *_names[FUNC_MAX] = {
  43. "sin",
  44. "cos",
  45. "tan",
  46. "sinh",
  47. "cosh",
  48. "tanh",
  49. "asin",
  50. "acos",
  51. "atan",
  52. "atan2",
  53. "sqrt",
  54. "fmod",
  55. "fposmod",
  56. "floor",
  57. "ceil",
  58. "round",
  59. "abs",
  60. "sign",
  61. "pow",
  62. "log",
  63. "exp",
  64. "is_nan",
  65. "is_inf",
  66. "ease",
  67. "decimals",
  68. "stepify",
  69. "lerp",
  70. "inverse_lerp",
  71. "range_lerp",
  72. "dectime",
  73. "randomize",
  74. "randi",
  75. "randf",
  76. "rand_range",
  77. "seed",
  78. "rand_seed",
  79. "deg2rad",
  80. "rad2deg",
  81. "linear2db",
  82. "db2linear",
  83. "polar2cartesian",
  84. "cartesian2polar",
  85. "wrapi",
  86. "wrapf",
  87. "max",
  88. "min",
  89. "clamp",
  90. "nearest_po2",
  91. "weakref",
  92. "funcref",
  93. "convert",
  94. "typeof",
  95. "type_exists",
  96. "char",
  97. "str",
  98. "print",
  99. "printt",
  100. "prints",
  101. "printerr",
  102. "printraw",
  103. "var2str",
  104. "str2var",
  105. "var2bytes",
  106. "bytes2var",
  107. "range",
  108. "load",
  109. "inst2dict",
  110. "dict2inst",
  111. "validate_json",
  112. "parse_json",
  113. "to_json",
  114. "hash",
  115. "Color8",
  116. "ColorN",
  117. "print_stack",
  118. "instance_from_id",
  119. "len",
  120. };
  121. return _names[p_func];
  122. }
  123. void GDScriptFunctions::call(Function p_func, const Variant **p_args, int p_arg_count, Variant &r_ret, Variant::CallError &r_error) {
  124. r_error.error = Variant::CallError::CALL_OK;
  125. #ifdef DEBUG_ENABLED
  126. #define VALIDATE_ARG_COUNT(m_count) \
  127. if (p_arg_count < m_count) { \
  128. r_error.error = Variant::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS; \
  129. r_error.argument = m_count; \
  130. r_ret = Variant(); \
  131. return; \
  132. } \
  133. if (p_arg_count > m_count) { \
  134. r_error.error = Variant::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS; \
  135. r_error.argument = m_count; \
  136. r_ret = Variant(); \
  137. return; \
  138. }
  139. #define VALIDATE_ARG_NUM(m_arg) \
  140. if (!p_args[m_arg]->is_num()) { \
  141. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT; \
  142. r_error.argument = m_arg; \
  143. r_error.expected = Variant::REAL; \
  144. r_ret = Variant(); \
  145. return; \
  146. }
  147. #else
  148. #define VALIDATE_ARG_COUNT(m_count)
  149. #define VALIDATE_ARG_NUM(m_arg)
  150. #endif
  151. //using a switch, so the compiler generates a jumptable
  152. switch (p_func) {
  153. case MATH_SIN: {
  154. VALIDATE_ARG_COUNT(1);
  155. VALIDATE_ARG_NUM(0);
  156. r_ret = Math::sin((double)*p_args[0]);
  157. } break;
  158. case MATH_COS: {
  159. VALIDATE_ARG_COUNT(1);
  160. VALIDATE_ARG_NUM(0);
  161. r_ret = Math::cos((double)*p_args[0]);
  162. } break;
  163. case MATH_TAN: {
  164. VALIDATE_ARG_COUNT(1);
  165. VALIDATE_ARG_NUM(0);
  166. r_ret = Math::tan((double)*p_args[0]);
  167. } break;
  168. case MATH_SINH: {
  169. VALIDATE_ARG_COUNT(1);
  170. VALIDATE_ARG_NUM(0);
  171. r_ret = Math::sinh((double)*p_args[0]);
  172. } break;
  173. case MATH_COSH: {
  174. VALIDATE_ARG_COUNT(1);
  175. VALIDATE_ARG_NUM(0);
  176. r_ret = Math::cosh((double)*p_args[0]);
  177. } break;
  178. case MATH_TANH: {
  179. VALIDATE_ARG_COUNT(1);
  180. VALIDATE_ARG_NUM(0);
  181. r_ret = Math::tanh((double)*p_args[0]);
  182. } break;
  183. case MATH_ASIN: {
  184. VALIDATE_ARG_COUNT(1);
  185. VALIDATE_ARG_NUM(0);
  186. r_ret = Math::asin((double)*p_args[0]);
  187. } break;
  188. case MATH_ACOS: {
  189. VALIDATE_ARG_COUNT(1);
  190. VALIDATE_ARG_NUM(0);
  191. r_ret = Math::acos((double)*p_args[0]);
  192. } break;
  193. case MATH_ATAN: {
  194. VALIDATE_ARG_COUNT(1);
  195. VALIDATE_ARG_NUM(0);
  196. r_ret = Math::atan((double)*p_args[0]);
  197. } break;
  198. case MATH_ATAN2: {
  199. VALIDATE_ARG_COUNT(2);
  200. VALIDATE_ARG_NUM(0);
  201. VALIDATE_ARG_NUM(1);
  202. r_ret = Math::atan2((double)*p_args[0], (double)*p_args[1]);
  203. } break;
  204. case MATH_SQRT: {
  205. VALIDATE_ARG_COUNT(1);
  206. VALIDATE_ARG_NUM(0);
  207. r_ret = Math::sqrt((double)*p_args[0]);
  208. } break;
  209. case MATH_FMOD: {
  210. VALIDATE_ARG_COUNT(2);
  211. VALIDATE_ARG_NUM(0);
  212. VALIDATE_ARG_NUM(1);
  213. r_ret = Math::fmod((double)*p_args[0], (double)*p_args[1]);
  214. } break;
  215. case MATH_FPOSMOD: {
  216. VALIDATE_ARG_COUNT(2);
  217. VALIDATE_ARG_NUM(0);
  218. VALIDATE_ARG_NUM(1);
  219. r_ret = Math::fposmod((double)*p_args[0], (double)*p_args[1]);
  220. } break;
  221. case MATH_FLOOR: {
  222. VALIDATE_ARG_COUNT(1);
  223. VALIDATE_ARG_NUM(0);
  224. r_ret = Math::floor((double)*p_args[0]);
  225. } break;
  226. case MATH_CEIL: {
  227. VALIDATE_ARG_COUNT(1);
  228. VALIDATE_ARG_NUM(0);
  229. r_ret = Math::ceil((double)*p_args[0]);
  230. } break;
  231. case MATH_ROUND: {
  232. VALIDATE_ARG_COUNT(1);
  233. VALIDATE_ARG_NUM(0);
  234. r_ret = Math::round((double)*p_args[0]);
  235. } break;
  236. case MATH_ABS: {
  237. VALIDATE_ARG_COUNT(1);
  238. if (p_args[0]->get_type() == Variant::INT) {
  239. int64_t i = *p_args[0];
  240. r_ret = ABS(i);
  241. } else if (p_args[0]->get_type() == Variant::REAL) {
  242. double r = *p_args[0];
  243. r_ret = Math::abs(r);
  244. } else {
  245. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  246. r_error.argument = 0;
  247. r_error.expected = Variant::REAL;
  248. r_ret = Variant();
  249. }
  250. } break;
  251. case MATH_SIGN: {
  252. VALIDATE_ARG_COUNT(1);
  253. if (p_args[0]->get_type() == Variant::INT) {
  254. int64_t i = *p_args[0];
  255. r_ret = i < 0 ? -1 : (i > 0 ? +1 : 0);
  256. } else if (p_args[0]->get_type() == Variant::REAL) {
  257. real_t r = *p_args[0];
  258. r_ret = r < 0.0 ? -1.0 : (r > 0.0 ? +1.0 : 0.0);
  259. } else {
  260. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  261. r_error.argument = 0;
  262. r_error.expected = Variant::REAL;
  263. r_ret = Variant();
  264. }
  265. } break;
  266. case MATH_POW: {
  267. VALIDATE_ARG_COUNT(2);
  268. VALIDATE_ARG_NUM(0);
  269. VALIDATE_ARG_NUM(1);
  270. r_ret = Math::pow((double)*p_args[0], (double)*p_args[1]);
  271. } break;
  272. case MATH_LOG: {
  273. VALIDATE_ARG_COUNT(1);
  274. VALIDATE_ARG_NUM(0);
  275. r_ret = Math::log((double)*p_args[0]);
  276. } break;
  277. case MATH_EXP: {
  278. VALIDATE_ARG_COUNT(1);
  279. VALIDATE_ARG_NUM(0);
  280. r_ret = Math::exp((double)*p_args[0]);
  281. } break;
  282. case MATH_ISNAN: {
  283. VALIDATE_ARG_COUNT(1);
  284. VALIDATE_ARG_NUM(0);
  285. r_ret = Math::is_nan((double)*p_args[0]);
  286. } break;
  287. case MATH_ISINF: {
  288. VALIDATE_ARG_COUNT(1);
  289. VALIDATE_ARG_NUM(0);
  290. r_ret = Math::is_inf((double)*p_args[0]);
  291. } break;
  292. case MATH_EASE: {
  293. VALIDATE_ARG_COUNT(2);
  294. VALIDATE_ARG_NUM(0);
  295. VALIDATE_ARG_NUM(1);
  296. r_ret = Math::ease((double)*p_args[0], (double)*p_args[1]);
  297. } break;
  298. case MATH_DECIMALS: {
  299. VALIDATE_ARG_COUNT(1);
  300. VALIDATE_ARG_NUM(0);
  301. r_ret = Math::step_decimals((double)*p_args[0]);
  302. } break;
  303. case MATH_STEPIFY: {
  304. VALIDATE_ARG_COUNT(2);
  305. VALIDATE_ARG_NUM(0);
  306. VALIDATE_ARG_NUM(1);
  307. r_ret = Math::stepify((double)*p_args[0], (double)*p_args[1]);
  308. } break;
  309. case MATH_LERP: {
  310. VALIDATE_ARG_COUNT(3);
  311. VALIDATE_ARG_NUM(0);
  312. VALIDATE_ARG_NUM(1);
  313. VALIDATE_ARG_NUM(2);
  314. r_ret = Math::lerp((double)*p_args[0], (double)*p_args[1], (double)*p_args[2]);
  315. } break;
  316. case MATH_INVERSE_LERP: {
  317. VALIDATE_ARG_COUNT(3);
  318. VALIDATE_ARG_NUM(0);
  319. VALIDATE_ARG_NUM(1);
  320. VALIDATE_ARG_NUM(2);
  321. r_ret = Math::inverse_lerp((double)*p_args[0], (double)*p_args[1], (double)*p_args[2]);
  322. } break;
  323. case MATH_RANGE_LERP: {
  324. VALIDATE_ARG_COUNT(5);
  325. VALIDATE_ARG_NUM(0);
  326. VALIDATE_ARG_NUM(1);
  327. VALIDATE_ARG_NUM(2);
  328. VALIDATE_ARG_NUM(3);
  329. VALIDATE_ARG_NUM(4);
  330. r_ret = Math::range_lerp((double)*p_args[0], (double)*p_args[1], (double)*p_args[2], (double)*p_args[3], (double)*p_args[4]);
  331. } break;
  332. case MATH_DECTIME: {
  333. VALIDATE_ARG_COUNT(3);
  334. VALIDATE_ARG_NUM(0);
  335. VALIDATE_ARG_NUM(1);
  336. VALIDATE_ARG_NUM(2);
  337. r_ret = Math::dectime((double)*p_args[0], (double)*p_args[1], (double)*p_args[2]);
  338. } break;
  339. case MATH_RANDOMIZE: {
  340. Math::randomize();
  341. r_ret = Variant();
  342. } break;
  343. case MATH_RAND: {
  344. r_ret = Math::rand();
  345. } break;
  346. case MATH_RANDF: {
  347. r_ret = Math::randf();
  348. } break;
  349. case MATH_RANDOM: {
  350. VALIDATE_ARG_COUNT(2);
  351. VALIDATE_ARG_NUM(0);
  352. VALIDATE_ARG_NUM(1);
  353. r_ret = Math::random((double)*p_args[0], (double)*p_args[1]);
  354. } break;
  355. case MATH_SEED: {
  356. VALIDATE_ARG_COUNT(1);
  357. VALIDATE_ARG_NUM(0);
  358. uint64_t seed = *p_args[0];
  359. Math::seed(seed);
  360. r_ret = Variant();
  361. } break;
  362. case MATH_RANDSEED: {
  363. VALIDATE_ARG_COUNT(1);
  364. VALIDATE_ARG_NUM(0);
  365. uint64_t seed = *p_args[0];
  366. int ret = Math::rand_from_seed(&seed);
  367. Array reta;
  368. reta.push_back(ret);
  369. reta.push_back(seed);
  370. r_ret = reta;
  371. } break;
  372. case MATH_DEG2RAD: {
  373. VALIDATE_ARG_COUNT(1);
  374. VALIDATE_ARG_NUM(0);
  375. r_ret = Math::deg2rad((double)*p_args[0]);
  376. } break;
  377. case MATH_RAD2DEG: {
  378. VALIDATE_ARG_COUNT(1);
  379. VALIDATE_ARG_NUM(0);
  380. r_ret = Math::rad2deg((double)*p_args[0]);
  381. } break;
  382. case MATH_LINEAR2DB: {
  383. VALIDATE_ARG_COUNT(1);
  384. VALIDATE_ARG_NUM(0);
  385. r_ret = Math::linear2db((double)*p_args[0]);
  386. } break;
  387. case MATH_DB2LINEAR: {
  388. VALIDATE_ARG_COUNT(1);
  389. VALIDATE_ARG_NUM(0);
  390. r_ret = Math::db2linear((double)*p_args[0]);
  391. } break;
  392. case MATH_POLAR2CARTESIAN: {
  393. VALIDATE_ARG_COUNT(2);
  394. VALIDATE_ARG_NUM(0);
  395. VALIDATE_ARG_NUM(1);
  396. double r = *p_args[0];
  397. double th = *p_args[1];
  398. r_ret = Vector2(r * Math::cos(th), r * Math::sin(th));
  399. } break;
  400. case MATH_CARTESIAN2POLAR: {
  401. VALIDATE_ARG_COUNT(2);
  402. VALIDATE_ARG_NUM(0);
  403. VALIDATE_ARG_NUM(1);
  404. double x = *p_args[0];
  405. double y = *p_args[1];
  406. r_ret = Vector2(Math::sqrt(x * x + y * y), Math::atan2(y, x));
  407. } break;
  408. case MATH_WRAP: {
  409. VALIDATE_ARG_COUNT(3);
  410. r_ret = Math::wrapi((int64_t)*p_args[0], (int64_t)*p_args[1], (int64_t)*p_args[2]);
  411. } break;
  412. case MATH_WRAPF: {
  413. VALIDATE_ARG_COUNT(3);
  414. r_ret = Math::wrapf((double)*p_args[0], (double)*p_args[1], (double)*p_args[2]);
  415. } break;
  416. case LOGIC_MAX: {
  417. VALIDATE_ARG_COUNT(2);
  418. if (p_args[0]->get_type() == Variant::INT && p_args[1]->get_type() == Variant::INT) {
  419. int64_t a = *p_args[0];
  420. int64_t b = *p_args[1];
  421. r_ret = MAX(a, b);
  422. } else {
  423. VALIDATE_ARG_NUM(0);
  424. VALIDATE_ARG_NUM(1);
  425. real_t a = *p_args[0];
  426. real_t b = *p_args[1];
  427. r_ret = MAX(a, b);
  428. }
  429. } break;
  430. case LOGIC_MIN: {
  431. VALIDATE_ARG_COUNT(2);
  432. if (p_args[0]->get_type() == Variant::INT && p_args[1]->get_type() == Variant::INT) {
  433. int64_t a = *p_args[0];
  434. int64_t b = *p_args[1];
  435. r_ret = MIN(a, b);
  436. } else {
  437. VALIDATE_ARG_NUM(0);
  438. VALIDATE_ARG_NUM(1);
  439. real_t a = *p_args[0];
  440. real_t b = *p_args[1];
  441. r_ret = MIN(a, b);
  442. }
  443. } break;
  444. case LOGIC_CLAMP: {
  445. VALIDATE_ARG_COUNT(3);
  446. if (p_args[0]->get_type() == Variant::INT && p_args[1]->get_type() == Variant::INT && p_args[2]->get_type() == Variant::INT) {
  447. int64_t a = *p_args[0];
  448. int64_t b = *p_args[1];
  449. int64_t c = *p_args[2];
  450. r_ret = CLAMP(a, b, c);
  451. } else {
  452. VALIDATE_ARG_NUM(0);
  453. VALIDATE_ARG_NUM(1);
  454. VALIDATE_ARG_NUM(2);
  455. real_t a = *p_args[0];
  456. real_t b = *p_args[1];
  457. real_t c = *p_args[2];
  458. r_ret = CLAMP(a, b, c);
  459. }
  460. } break;
  461. case LOGIC_NEAREST_PO2: {
  462. VALIDATE_ARG_COUNT(1);
  463. VALIDATE_ARG_NUM(0);
  464. int64_t num = *p_args[0];
  465. r_ret = next_power_of_2(num);
  466. } break;
  467. case OBJ_WEAKREF: {
  468. VALIDATE_ARG_COUNT(1);
  469. if (p_args[0]->get_type() != Variant::OBJECT) {
  470. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  471. r_error.argument = 0;
  472. r_error.expected = Variant::OBJECT;
  473. r_ret = Variant();
  474. return;
  475. }
  476. if (p_args[0]->is_ref()) {
  477. REF r = *p_args[0];
  478. if (!r.is_valid()) {
  479. r_ret = Variant();
  480. return;
  481. }
  482. Ref<WeakRef> wref = memnew(WeakRef);
  483. wref->set_ref(r);
  484. r_ret = wref;
  485. } else {
  486. Object *obj = *p_args[0];
  487. if (!obj) {
  488. r_ret = Variant();
  489. return;
  490. }
  491. Ref<WeakRef> wref = memnew(WeakRef);
  492. wref->set_obj(obj);
  493. r_ret = wref;
  494. }
  495. } break;
  496. case FUNC_FUNCREF: {
  497. VALIDATE_ARG_COUNT(2);
  498. if (p_args[0]->get_type() != Variant::OBJECT) {
  499. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  500. r_error.argument = 0;
  501. r_error.expected = Variant::OBJECT;
  502. r_ret = Variant();
  503. return;
  504. }
  505. if (p_args[1]->get_type() != Variant::STRING && p_args[1]->get_type() != Variant::NODE_PATH) {
  506. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  507. r_error.argument = 1;
  508. r_error.expected = Variant::STRING;
  509. r_ret = Variant();
  510. return;
  511. }
  512. Ref<FuncRef> fr = memnew(FuncRef);
  513. fr->set_instance(*p_args[0]);
  514. fr->set_function(*p_args[1]);
  515. r_ret = fr;
  516. } break;
  517. case TYPE_CONVERT: {
  518. VALIDATE_ARG_COUNT(2);
  519. VALIDATE_ARG_NUM(1);
  520. int type = *p_args[1];
  521. if (type < 0 || type >= Variant::VARIANT_MAX) {
  522. r_ret = RTR("Invalid type argument to convert(), use TYPE_* constants.");
  523. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  524. r_error.argument = 0;
  525. r_error.expected = Variant::INT;
  526. return;
  527. } else {
  528. r_ret = Variant::construct(Variant::Type(type), p_args, 1, r_error);
  529. }
  530. } break;
  531. case TYPE_OF: {
  532. VALIDATE_ARG_COUNT(1);
  533. r_ret = p_args[0]->get_type();
  534. } break;
  535. case TYPE_EXISTS: {
  536. VALIDATE_ARG_COUNT(1);
  537. r_ret = ClassDB::class_exists(*p_args[0]);
  538. } break;
  539. case TEXT_CHAR: {
  540. VALIDATE_ARG_COUNT(1);
  541. VALIDATE_ARG_NUM(0);
  542. CharType result[2] = { *p_args[0], 0 };
  543. r_ret = String(result);
  544. } break;
  545. case TEXT_STR: {
  546. String str;
  547. for (int i = 0; i < p_arg_count; i++) {
  548. String os = p_args[i]->operator String();
  549. if (i == 0)
  550. str = os;
  551. else
  552. str += os;
  553. }
  554. r_ret = str;
  555. } break;
  556. case TEXT_PRINT: {
  557. String str;
  558. for (int i = 0; i < p_arg_count; i++) {
  559. str += p_args[i]->operator String();
  560. }
  561. //str+="\n";
  562. print_line(str);
  563. r_ret = Variant();
  564. } break;
  565. case TEXT_PRINT_TABBED: {
  566. String str;
  567. for (int i = 0; i < p_arg_count; i++) {
  568. if (i)
  569. str += "\t";
  570. str += p_args[i]->operator String();
  571. }
  572. //str+="\n";
  573. print_line(str);
  574. r_ret = Variant();
  575. } break;
  576. case TEXT_PRINT_SPACED: {
  577. String str;
  578. for (int i = 0; i < p_arg_count; i++) {
  579. if (i)
  580. str += " ";
  581. str += p_args[i]->operator String();
  582. }
  583. //str+="\n";
  584. print_line(str);
  585. r_ret = Variant();
  586. } break;
  587. case TEXT_PRINTERR: {
  588. String str;
  589. for (int i = 0; i < p_arg_count; i++) {
  590. str += p_args[i]->operator String();
  591. }
  592. //str+="\n";
  593. print_error(str);
  594. r_ret = Variant();
  595. } break;
  596. case TEXT_PRINTRAW: {
  597. String str;
  598. for (int i = 0; i < p_arg_count; i++) {
  599. str += p_args[i]->operator String();
  600. }
  601. //str+="\n";
  602. OS::get_singleton()->print("%s", str.utf8().get_data());
  603. r_ret = Variant();
  604. } break;
  605. case VAR_TO_STR: {
  606. VALIDATE_ARG_COUNT(1);
  607. String vars;
  608. VariantWriter::write_to_string(*p_args[0], vars);
  609. r_ret = vars;
  610. } break;
  611. case STR_TO_VAR: {
  612. VALIDATE_ARG_COUNT(1);
  613. if (p_args[0]->get_type() != Variant::STRING) {
  614. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  615. r_error.argument = 0;
  616. r_error.expected = Variant::STRING;
  617. r_ret = Variant();
  618. return;
  619. }
  620. VariantParser::StreamString ss;
  621. ss.s = *p_args[0];
  622. String errs;
  623. int line;
  624. Error err = VariantParser::parse(&ss, r_ret, errs, line);
  625. if (err != OK) {
  626. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  627. r_error.argument = 0;
  628. r_error.expected = Variant::STRING;
  629. r_ret = "Parse error at line " + itos(line) + ": " + errs;
  630. return;
  631. }
  632. } break;
  633. case VAR_TO_BYTES: {
  634. VALIDATE_ARG_COUNT(1);
  635. PoolByteArray barr;
  636. int len;
  637. Error err = encode_variant(*p_args[0], NULL, len);
  638. if (err) {
  639. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  640. r_error.argument = 0;
  641. r_error.expected = Variant::NIL;
  642. r_ret = "Unexpected error encoding variable to bytes, likely unserializable type found (Object or RID).";
  643. return;
  644. }
  645. barr.resize(len);
  646. {
  647. PoolByteArray::Write w = barr.write();
  648. encode_variant(*p_args[0], w.ptr(), len);
  649. }
  650. r_ret = barr;
  651. } break;
  652. case BYTES_TO_VAR: {
  653. VALIDATE_ARG_COUNT(1);
  654. if (p_args[0]->get_type() != Variant::POOL_BYTE_ARRAY) {
  655. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  656. r_error.argument = 0;
  657. r_error.expected = Variant::POOL_BYTE_ARRAY;
  658. r_ret = Variant();
  659. return;
  660. }
  661. PoolByteArray varr = *p_args[0];
  662. Variant ret;
  663. {
  664. PoolByteArray::Read r = varr.read();
  665. Error err = decode_variant(ret, r.ptr(), varr.size(), NULL);
  666. if (err != OK) {
  667. r_ret = RTR("Not enough bytes for decoding bytes, or invalid format.");
  668. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  669. r_error.argument = 0;
  670. r_error.expected = Variant::POOL_BYTE_ARRAY;
  671. return;
  672. }
  673. }
  674. r_ret = ret;
  675. } break;
  676. case GEN_RANGE: {
  677. switch (p_arg_count) {
  678. case 0: {
  679. r_error.error = Variant::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  680. r_error.argument = 1;
  681. r_ret = Variant();
  682. } break;
  683. case 1: {
  684. VALIDATE_ARG_NUM(0);
  685. int count = *p_args[0];
  686. Array arr;
  687. if (count <= 0) {
  688. r_ret = arr;
  689. return;
  690. }
  691. Error err = arr.resize(count);
  692. if (err != OK) {
  693. r_error.error = Variant::CallError::CALL_ERROR_INVALID_METHOD;
  694. r_ret = Variant();
  695. return;
  696. }
  697. for (int i = 0; i < count; i++) {
  698. arr[i] = i;
  699. }
  700. r_ret = arr;
  701. } break;
  702. case 2: {
  703. VALIDATE_ARG_NUM(0);
  704. VALIDATE_ARG_NUM(1);
  705. int from = *p_args[0];
  706. int to = *p_args[1];
  707. Array arr;
  708. if (from >= to) {
  709. r_ret = arr;
  710. return;
  711. }
  712. Error err = arr.resize(to - from);
  713. if (err != OK) {
  714. r_error.error = Variant::CallError::CALL_ERROR_INVALID_METHOD;
  715. r_ret = Variant();
  716. return;
  717. }
  718. for (int i = from; i < to; i++)
  719. arr[i - from] = i;
  720. r_ret = arr;
  721. } break;
  722. case 3: {
  723. VALIDATE_ARG_NUM(0);
  724. VALIDATE_ARG_NUM(1);
  725. VALIDATE_ARG_NUM(2);
  726. int from = *p_args[0];
  727. int to = *p_args[1];
  728. int incr = *p_args[2];
  729. if (incr == 0) {
  730. r_ret = RTR("step argument is zero!");
  731. r_error.error = Variant::CallError::CALL_ERROR_INVALID_METHOD;
  732. return;
  733. }
  734. Array arr;
  735. if (from >= to && incr > 0) {
  736. r_ret = arr;
  737. return;
  738. }
  739. if (from <= to && incr < 0) {
  740. r_ret = arr;
  741. return;
  742. }
  743. //calculate how many
  744. int count = 0;
  745. if (incr > 0) {
  746. count = ((to - from - 1) / incr) + 1;
  747. } else {
  748. count = ((from - to - 1) / -incr) + 1;
  749. }
  750. Error err = arr.resize(count);
  751. if (err != OK) {
  752. r_error.error = Variant::CallError::CALL_ERROR_INVALID_METHOD;
  753. r_ret = Variant();
  754. return;
  755. }
  756. if (incr > 0) {
  757. int idx = 0;
  758. for (int i = from; i < to; i += incr) {
  759. arr[idx++] = i;
  760. }
  761. } else {
  762. int idx = 0;
  763. for (int i = from; i > to; i += incr) {
  764. arr[idx++] = i;
  765. }
  766. }
  767. r_ret = arr;
  768. } break;
  769. default: {
  770. r_error.error = Variant::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS;
  771. r_error.argument = 3;
  772. r_ret = Variant();
  773. } break;
  774. }
  775. } break;
  776. case RESOURCE_LOAD: {
  777. VALIDATE_ARG_COUNT(1);
  778. if (p_args[0]->get_type() != Variant::STRING) {
  779. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  780. r_error.argument = 0;
  781. r_error.expected = Variant::STRING;
  782. r_ret = Variant();
  783. } else {
  784. r_ret = ResourceLoader::load(*p_args[0]);
  785. }
  786. } break;
  787. case INST2DICT: {
  788. VALIDATE_ARG_COUNT(1);
  789. if (p_args[0]->get_type() == Variant::NIL) {
  790. r_ret = Variant();
  791. } else if (p_args[0]->get_type() != Variant::OBJECT) {
  792. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  793. r_error.argument = 0;
  794. r_ret = Variant();
  795. } else {
  796. Object *obj = *p_args[0];
  797. if (!obj) {
  798. r_ret = Variant();
  799. } else if (!obj->get_script_instance() || obj->get_script_instance()->get_language() != GDScriptLanguage::get_singleton()) {
  800. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  801. r_error.argument = 0;
  802. r_error.expected = Variant::DICTIONARY;
  803. r_ret = RTR("Not a script with an instance");
  804. return;
  805. } else {
  806. GDScriptInstance *ins = static_cast<GDScriptInstance *>(obj->get_script_instance());
  807. Ref<GDScript> base = ins->get_script();
  808. if (base.is_null()) {
  809. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  810. r_error.argument = 0;
  811. r_error.expected = Variant::DICTIONARY;
  812. r_ret = RTR("Not based on a script");
  813. return;
  814. }
  815. GDScript *p = base.ptr();
  816. Vector<StringName> sname;
  817. while (p->_owner) {
  818. sname.push_back(p->name);
  819. p = p->_owner;
  820. }
  821. sname.invert();
  822. if (!p->path.is_resource_file()) {
  823. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  824. r_error.argument = 0;
  825. r_error.expected = Variant::DICTIONARY;
  826. r_ret = Variant();
  827. r_ret = RTR("Not based on a resource file");
  828. return;
  829. }
  830. NodePath cp(sname, Vector<StringName>(), false);
  831. Dictionary d;
  832. d["@subpath"] = cp;
  833. d["@path"] = p->path;
  834. p = base.ptr();
  835. while (p) {
  836. for (Set<StringName>::Element *E = p->members.front(); E; E = E->next()) {
  837. Variant value;
  838. if (ins->get(E->get(), value)) {
  839. String k = E->get();
  840. if (!d.has(k)) {
  841. d[k] = value;
  842. }
  843. }
  844. }
  845. p = p->_base;
  846. }
  847. r_ret = d;
  848. }
  849. }
  850. } break;
  851. case DICT2INST: {
  852. VALIDATE_ARG_COUNT(1);
  853. if (p_args[0]->get_type() != Variant::DICTIONARY) {
  854. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  855. r_error.argument = 0;
  856. r_error.expected = Variant::DICTIONARY;
  857. r_ret = Variant();
  858. return;
  859. }
  860. Dictionary d = *p_args[0];
  861. if (!d.has("@path")) {
  862. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  863. r_error.argument = 0;
  864. r_error.expected = Variant::OBJECT;
  865. r_ret = RTR("Invalid instance dictionary format (missing @path)");
  866. return;
  867. }
  868. Ref<Script> scr = ResourceLoader::load(d["@path"]);
  869. if (!scr.is_valid()) {
  870. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  871. r_error.argument = 0;
  872. r_error.expected = Variant::OBJECT;
  873. r_ret = RTR("Invalid instance dictionary format (can't load script at @path)");
  874. return;
  875. }
  876. Ref<GDScript> gdscr = scr;
  877. if (!gdscr.is_valid()) {
  878. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  879. r_error.argument = 0;
  880. r_error.expected = Variant::OBJECT;
  881. r_ret = Variant();
  882. r_ret = RTR("Invalid instance dictionary format (invalid script at @path)");
  883. return;
  884. }
  885. NodePath sub;
  886. if (d.has("@subpath")) {
  887. sub = d["@subpath"];
  888. }
  889. for (int i = 0; i < sub.get_name_count(); i++) {
  890. gdscr = gdscr->subclasses[sub.get_name(i)];
  891. if (!gdscr.is_valid()) {
  892. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  893. r_error.argument = 0;
  894. r_error.expected = Variant::OBJECT;
  895. r_ret = Variant();
  896. r_ret = RTR("Invalid instance dictionary (invalid subclasses)");
  897. return;
  898. }
  899. }
  900. r_ret = gdscr->_new(NULL, 0, r_error);
  901. GDScriptInstance *ins = static_cast<GDScriptInstance *>(static_cast<Object *>(r_ret)->get_script_instance());
  902. Ref<GDScript> gd_ref = ins->get_script();
  903. for (Map<StringName, GDScript::MemberInfo>::Element *E = gd_ref->member_indices.front(); E; E = E->next()) {
  904. if (d.has(E->key())) {
  905. ins->members[E->get().index] = d[E->key()];
  906. }
  907. }
  908. } break;
  909. case VALIDATE_JSON: {
  910. VALIDATE_ARG_COUNT(1);
  911. if (p_args[0]->get_type() != Variant::STRING) {
  912. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  913. r_error.argument = 0;
  914. r_error.expected = Variant::STRING;
  915. r_ret = Variant();
  916. return;
  917. }
  918. String errs;
  919. int errl;
  920. Error err = JSON::parse(*p_args[0], r_ret, errs, errl);
  921. if (err != OK) {
  922. r_ret = itos(errl) + ":" + errs;
  923. } else {
  924. r_ret = "";
  925. }
  926. } break;
  927. case PARSE_JSON: {
  928. VALIDATE_ARG_COUNT(1);
  929. if (p_args[0]->get_type() != Variant::STRING) {
  930. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  931. r_error.argument = 0;
  932. r_error.expected = Variant::STRING;
  933. r_ret = Variant();
  934. return;
  935. }
  936. String errs;
  937. int errl;
  938. Error err = JSON::parse(*p_args[0], r_ret, errs, errl);
  939. if (err != OK) {
  940. r_ret = Variant();
  941. }
  942. } break;
  943. case TO_JSON: {
  944. VALIDATE_ARG_COUNT(1);
  945. r_ret = JSON::print(*p_args[0]);
  946. } break;
  947. case HASH: {
  948. VALIDATE_ARG_COUNT(1);
  949. r_ret = p_args[0]->hash();
  950. } break;
  951. case COLOR8: {
  952. if (p_arg_count < 3) {
  953. r_error.error = Variant::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  954. r_error.argument = 3;
  955. r_ret = Variant();
  956. return;
  957. }
  958. if (p_arg_count > 4) {
  959. r_error.error = Variant::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS;
  960. r_error.argument = 4;
  961. r_ret = Variant();
  962. return;
  963. }
  964. VALIDATE_ARG_NUM(0);
  965. VALIDATE_ARG_NUM(1);
  966. VALIDATE_ARG_NUM(2);
  967. Color color((float)*p_args[0] / 255.0f, (float)*p_args[1] / 255.0f, (float)*p_args[2] / 255.0f);
  968. if (p_arg_count == 4) {
  969. VALIDATE_ARG_NUM(3);
  970. color.a = (float)*p_args[3] / 255.0f;
  971. }
  972. r_ret = color;
  973. } break;
  974. case COLORN: {
  975. if (p_arg_count < 1) {
  976. r_error.error = Variant::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  977. r_error.argument = 1;
  978. r_ret = Variant();
  979. return;
  980. }
  981. if (p_arg_count > 2) {
  982. r_error.error = Variant::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS;
  983. r_error.argument = 2;
  984. r_ret = Variant();
  985. return;
  986. }
  987. if (p_args[0]->get_type() != Variant::STRING) {
  988. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  989. r_error.argument = 0;
  990. r_ret = Variant();
  991. } else {
  992. Color color = Color::named(*p_args[0]);
  993. if (p_arg_count == 2) {
  994. VALIDATE_ARG_NUM(1);
  995. color.a = *p_args[1];
  996. }
  997. r_ret = color;
  998. }
  999. } break;
  1000. case PRINT_STACK: {
  1001. ScriptLanguage *script = GDScriptLanguage::get_singleton();
  1002. for (int i = 0; i < script->debug_get_stack_level_count(); i++) {
  1003. print_line("Frame " + itos(i) + " - " + script->debug_get_stack_level_source(i) + ":" + itos(script->debug_get_stack_level_line(i)) + " in function '" + script->debug_get_stack_level_function(i) + "'");
  1004. };
  1005. } break;
  1006. case INSTANCE_FROM_ID: {
  1007. VALIDATE_ARG_COUNT(1);
  1008. if (p_args[0]->get_type() != Variant::INT && p_args[0]->get_type() != Variant::REAL) {
  1009. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  1010. r_error.argument = 0;
  1011. r_error.expected = Variant::INT;
  1012. r_ret = Variant();
  1013. break;
  1014. }
  1015. uint32_t id = *p_args[0];
  1016. r_ret = ObjectDB::get_instance(id);
  1017. } break;
  1018. case LEN: {
  1019. VALIDATE_ARG_COUNT(1);
  1020. switch (p_args[0]->get_type()) {
  1021. case Variant::STRING: {
  1022. String d = *p_args[0];
  1023. r_ret = d.length();
  1024. } break;
  1025. case Variant::DICTIONARY: {
  1026. Dictionary d = *p_args[0];
  1027. r_ret = d.size();
  1028. } break;
  1029. case Variant::ARRAY: {
  1030. Array d = *p_args[0];
  1031. r_ret = d.size();
  1032. } break;
  1033. case Variant::POOL_BYTE_ARRAY: {
  1034. PoolVector<uint8_t> d = *p_args[0];
  1035. r_ret = d.size();
  1036. } break;
  1037. case Variant::POOL_INT_ARRAY: {
  1038. PoolVector<int> d = *p_args[0];
  1039. r_ret = d.size();
  1040. } break;
  1041. case Variant::POOL_REAL_ARRAY: {
  1042. PoolVector<real_t> d = *p_args[0];
  1043. r_ret = d.size();
  1044. } break;
  1045. case Variant::POOL_STRING_ARRAY: {
  1046. PoolVector<String> d = *p_args[0];
  1047. r_ret = d.size();
  1048. } break;
  1049. case Variant::POOL_VECTOR2_ARRAY: {
  1050. PoolVector<Vector2> d = *p_args[0];
  1051. r_ret = d.size();
  1052. } break;
  1053. case Variant::POOL_VECTOR3_ARRAY: {
  1054. PoolVector<Vector3> d = *p_args[0];
  1055. r_ret = d.size();
  1056. } break;
  1057. case Variant::POOL_COLOR_ARRAY: {
  1058. PoolVector<Color> d = *p_args[0];
  1059. r_ret = d.size();
  1060. } break;
  1061. default: {
  1062. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  1063. r_error.argument = 0;
  1064. r_error.expected = Variant::OBJECT;
  1065. r_ret = Variant();
  1066. r_ret = RTR("Object can't provide a length.");
  1067. }
  1068. }
  1069. } break;
  1070. case FUNC_MAX: {
  1071. ERR_FAIL();
  1072. } break;
  1073. }
  1074. }
  1075. bool GDScriptFunctions::is_deterministic(Function p_func) {
  1076. //man i couldn't have chosen a worse function name,
  1077. //way too controversial..
  1078. switch (p_func) {
  1079. case MATH_SIN:
  1080. case MATH_COS:
  1081. case MATH_TAN:
  1082. case MATH_SINH:
  1083. case MATH_COSH:
  1084. case MATH_TANH:
  1085. case MATH_ASIN:
  1086. case MATH_ACOS:
  1087. case MATH_ATAN:
  1088. case MATH_ATAN2:
  1089. case MATH_SQRT:
  1090. case MATH_FMOD:
  1091. case MATH_FPOSMOD:
  1092. case MATH_FLOOR:
  1093. case MATH_CEIL:
  1094. case MATH_ROUND:
  1095. case MATH_ABS:
  1096. case MATH_SIGN:
  1097. case MATH_POW:
  1098. case MATH_LOG:
  1099. case MATH_EXP:
  1100. case MATH_ISNAN:
  1101. case MATH_ISINF:
  1102. case MATH_EASE:
  1103. case MATH_DECIMALS:
  1104. case MATH_STEPIFY:
  1105. case MATH_LERP:
  1106. case MATH_INVERSE_LERP:
  1107. case MATH_RANGE_LERP:
  1108. case MATH_DECTIME:
  1109. case MATH_DEG2RAD:
  1110. case MATH_RAD2DEG:
  1111. case MATH_LINEAR2DB:
  1112. case MATH_DB2LINEAR:
  1113. case MATH_POLAR2CARTESIAN:
  1114. case MATH_CARTESIAN2POLAR:
  1115. case MATH_WRAP:
  1116. case MATH_WRAPF:
  1117. case LOGIC_MAX:
  1118. case LOGIC_MIN:
  1119. case LOGIC_CLAMP:
  1120. case LOGIC_NEAREST_PO2:
  1121. case TYPE_CONVERT:
  1122. case TYPE_OF:
  1123. case TYPE_EXISTS:
  1124. case TEXT_CHAR:
  1125. case TEXT_STR:
  1126. case COLOR8:
  1127. case LEN:
  1128. // enable for debug only, otherwise not desirable - case GEN_RANGE:
  1129. return true;
  1130. default:
  1131. return false;
  1132. }
  1133. return false;
  1134. }
  1135. MethodInfo GDScriptFunctions::get_info(Function p_func) {
  1136. #ifdef TOOLS_ENABLED
  1137. //using a switch, so the compiler generates a jumptable
  1138. switch (p_func) {
  1139. case MATH_SIN: {
  1140. MethodInfo mi("sin", PropertyInfo(Variant::REAL, "s"));
  1141. mi.return_val.type = Variant::REAL;
  1142. return mi;
  1143. } break;
  1144. case MATH_COS: {
  1145. MethodInfo mi("cos", PropertyInfo(Variant::REAL, "s"));
  1146. mi.return_val.type = Variant::REAL;
  1147. return mi;
  1148. } break;
  1149. case MATH_TAN: {
  1150. MethodInfo mi("tan", PropertyInfo(Variant::REAL, "s"));
  1151. mi.return_val.type = Variant::REAL;
  1152. return mi;
  1153. } break;
  1154. case MATH_SINH: {
  1155. MethodInfo mi("sinh", PropertyInfo(Variant::REAL, "s"));
  1156. mi.return_val.type = Variant::REAL;
  1157. return mi;
  1158. } break;
  1159. case MATH_COSH: {
  1160. MethodInfo mi("cosh", PropertyInfo(Variant::REAL, "s"));
  1161. mi.return_val.type = Variant::REAL;
  1162. return mi;
  1163. } break;
  1164. case MATH_TANH: {
  1165. MethodInfo mi("tanh", PropertyInfo(Variant::REAL, "s"));
  1166. mi.return_val.type = Variant::REAL;
  1167. return mi;
  1168. } break;
  1169. case MATH_ASIN: {
  1170. MethodInfo mi("asin", PropertyInfo(Variant::REAL, "s"));
  1171. mi.return_val.type = Variant::REAL;
  1172. return mi;
  1173. } break;
  1174. case MATH_ACOS: {
  1175. MethodInfo mi("acos", PropertyInfo(Variant::REAL, "s"));
  1176. mi.return_val.type = Variant::REAL;
  1177. return mi;
  1178. } break;
  1179. case MATH_ATAN: {
  1180. MethodInfo mi("atan", PropertyInfo(Variant::REAL, "s"));
  1181. mi.return_val.type = Variant::REAL;
  1182. return mi;
  1183. } break;
  1184. case MATH_ATAN2: {
  1185. MethodInfo mi("atan2", PropertyInfo(Variant::REAL, "x"), PropertyInfo(Variant::REAL, "y"));
  1186. mi.return_val.type = Variant::REAL;
  1187. return mi;
  1188. } break;
  1189. case MATH_SQRT: {
  1190. MethodInfo mi("sqrt", PropertyInfo(Variant::REAL, "s"));
  1191. mi.return_val.type = Variant::REAL;
  1192. return mi;
  1193. } break;
  1194. case MATH_FMOD: {
  1195. MethodInfo mi("fmod", PropertyInfo(Variant::REAL, "x"), PropertyInfo(Variant::REAL, "y"));
  1196. mi.return_val.type = Variant::REAL;
  1197. return mi;
  1198. } break;
  1199. case MATH_FPOSMOD: {
  1200. MethodInfo mi("fposmod", PropertyInfo(Variant::REAL, "x"), PropertyInfo(Variant::REAL, "y"));
  1201. mi.return_val.type = Variant::REAL;
  1202. return mi;
  1203. } break;
  1204. case MATH_FLOOR: {
  1205. MethodInfo mi("floor", PropertyInfo(Variant::REAL, "s"));
  1206. mi.return_val.type = Variant::REAL;
  1207. return mi;
  1208. } break;
  1209. case MATH_CEIL: {
  1210. MethodInfo mi("ceil", PropertyInfo(Variant::REAL, "s"));
  1211. mi.return_val.type = Variant::REAL;
  1212. return mi;
  1213. } break;
  1214. case MATH_ROUND: {
  1215. MethodInfo mi("round", PropertyInfo(Variant::REAL, "s"));
  1216. mi.return_val.type = Variant::REAL;
  1217. return mi;
  1218. } break;
  1219. case MATH_ABS: {
  1220. MethodInfo mi("abs", PropertyInfo(Variant::REAL, "s"));
  1221. mi.return_val.type = Variant::REAL;
  1222. return mi;
  1223. } break;
  1224. case MATH_SIGN: {
  1225. MethodInfo mi("sign", PropertyInfo(Variant::REAL, "s"));
  1226. mi.return_val.type = Variant::REAL;
  1227. return mi;
  1228. } break;
  1229. case MATH_POW: {
  1230. MethodInfo mi("pow", PropertyInfo(Variant::REAL, "x"), PropertyInfo(Variant::REAL, "y"));
  1231. mi.return_val.type = Variant::REAL;
  1232. return mi;
  1233. } break;
  1234. case MATH_LOG: {
  1235. MethodInfo mi("log", PropertyInfo(Variant::REAL, "s"));
  1236. mi.return_val.type = Variant::REAL;
  1237. return mi;
  1238. } break;
  1239. case MATH_EXP: {
  1240. MethodInfo mi("exp", PropertyInfo(Variant::REAL, "s"));
  1241. mi.return_val.type = Variant::REAL;
  1242. return mi;
  1243. } break;
  1244. case MATH_ISNAN: {
  1245. MethodInfo mi("is_nan", PropertyInfo(Variant::REAL, "s"));
  1246. mi.return_val.type = Variant::BOOL;
  1247. return mi;
  1248. } break;
  1249. case MATH_ISINF: {
  1250. MethodInfo mi("is_inf", PropertyInfo(Variant::REAL, "s"));
  1251. mi.return_val.type = Variant::BOOL;
  1252. return mi;
  1253. } break;
  1254. case MATH_EASE: {
  1255. MethodInfo mi("ease", PropertyInfo(Variant::REAL, "s"), PropertyInfo(Variant::REAL, "curve"));
  1256. mi.return_val.type = Variant::REAL;
  1257. return mi;
  1258. } break;
  1259. case MATH_DECIMALS: {
  1260. MethodInfo mi("decimals", PropertyInfo(Variant::REAL, "step"));
  1261. mi.return_val.type = Variant::REAL;
  1262. return mi;
  1263. } break;
  1264. case MATH_STEPIFY: {
  1265. MethodInfo mi("stepify", PropertyInfo(Variant::REAL, "s"), PropertyInfo(Variant::REAL, "step"));
  1266. mi.return_val.type = Variant::REAL;
  1267. return mi;
  1268. } break;
  1269. case MATH_LERP: {
  1270. MethodInfo mi("lerp", PropertyInfo(Variant::REAL, "from"), PropertyInfo(Variant::REAL, "to"), PropertyInfo(Variant::REAL, "weight"));
  1271. mi.return_val.type = Variant::REAL;
  1272. return mi;
  1273. } break;
  1274. case MATH_INVERSE_LERP: {
  1275. MethodInfo mi("inverse_lerp", PropertyInfo(Variant::REAL, "from"), PropertyInfo(Variant::REAL, "to"), PropertyInfo(Variant::REAL, "value"));
  1276. mi.return_val.type = Variant::REAL;
  1277. return mi;
  1278. } break;
  1279. case MATH_RANGE_LERP: {
  1280. MethodInfo mi("range_lerp", PropertyInfo(Variant::REAL, "value"), PropertyInfo(Variant::REAL, "istart"), PropertyInfo(Variant::REAL, "istop"), PropertyInfo(Variant::REAL, "ostart"), PropertyInfo(Variant::REAL, "ostop"));
  1281. mi.return_val.type = Variant::REAL;
  1282. return mi;
  1283. } break;
  1284. case MATH_DECTIME: {
  1285. MethodInfo mi("dectime", PropertyInfo(Variant::REAL, "value"), PropertyInfo(Variant::REAL, "amount"), PropertyInfo(Variant::REAL, "step"));
  1286. mi.return_val.type = Variant::REAL;
  1287. return mi;
  1288. } break;
  1289. case MATH_RANDOMIZE: {
  1290. MethodInfo mi("randomize");
  1291. mi.return_val.type = Variant::NIL;
  1292. return mi;
  1293. } break;
  1294. case MATH_RAND: {
  1295. MethodInfo mi("randi");
  1296. mi.return_val.type = Variant::INT;
  1297. return mi;
  1298. } break;
  1299. case MATH_RANDF: {
  1300. MethodInfo mi("randf");
  1301. mi.return_val.type = Variant::REAL;
  1302. return mi;
  1303. } break;
  1304. case MATH_RANDOM: {
  1305. MethodInfo mi("rand_range", PropertyInfo(Variant::REAL, "from"), PropertyInfo(Variant::REAL, "to"));
  1306. mi.return_val.type = Variant::REAL;
  1307. return mi;
  1308. } break;
  1309. case MATH_SEED: {
  1310. MethodInfo mi("seed", PropertyInfo(Variant::INT, "seed"));
  1311. mi.return_val.type = Variant::NIL;
  1312. return mi;
  1313. } break;
  1314. case MATH_RANDSEED: {
  1315. MethodInfo mi("rand_seed", PropertyInfo(Variant::INT, "seed"));
  1316. mi.return_val.type = Variant::ARRAY;
  1317. return mi;
  1318. } break;
  1319. case MATH_DEG2RAD: {
  1320. MethodInfo mi("deg2rad", PropertyInfo(Variant::REAL, "deg"));
  1321. mi.return_val.type = Variant::REAL;
  1322. return mi;
  1323. } break;
  1324. case MATH_RAD2DEG: {
  1325. MethodInfo mi("rad2deg", PropertyInfo(Variant::REAL, "rad"));
  1326. mi.return_val.type = Variant::REAL;
  1327. return mi;
  1328. } break;
  1329. case MATH_LINEAR2DB: {
  1330. MethodInfo mi("linear2db", PropertyInfo(Variant::REAL, "nrg"));
  1331. mi.return_val.type = Variant::REAL;
  1332. return mi;
  1333. } break;
  1334. case MATH_DB2LINEAR: {
  1335. MethodInfo mi("db2linear", PropertyInfo(Variant::REAL, "db"));
  1336. mi.return_val.type = Variant::REAL;
  1337. return mi;
  1338. } break;
  1339. case MATH_POLAR2CARTESIAN: {
  1340. MethodInfo mi("polar2cartesian", PropertyInfo(Variant::REAL, "r"), PropertyInfo(Variant::REAL, "th"));
  1341. mi.return_val.type = Variant::VECTOR2;
  1342. return mi;
  1343. } break;
  1344. case MATH_CARTESIAN2POLAR: {
  1345. MethodInfo mi("cartesian2polar", PropertyInfo(Variant::REAL, "x"), PropertyInfo(Variant::REAL, "y"));
  1346. mi.return_val.type = Variant::VECTOR2;
  1347. return mi;
  1348. } break;
  1349. case MATH_WRAP: {
  1350. MethodInfo mi("wrapi", PropertyInfo(Variant::INT, "value"), PropertyInfo(Variant::INT, "min"), PropertyInfo(Variant::INT, "max"));
  1351. mi.return_val.type = Variant::INT;
  1352. return mi;
  1353. } break;
  1354. case MATH_WRAPF: {
  1355. MethodInfo mi("wrapf", PropertyInfo(Variant::REAL, "value"), PropertyInfo(Variant::REAL, "min"), PropertyInfo(Variant::REAL, "max"));
  1356. mi.return_val.type = Variant::REAL;
  1357. return mi;
  1358. } break;
  1359. case LOGIC_MAX: {
  1360. MethodInfo mi("max", PropertyInfo(Variant::REAL, "a"), PropertyInfo(Variant::REAL, "b"));
  1361. mi.return_val.type = Variant::REAL;
  1362. return mi;
  1363. } break;
  1364. case LOGIC_MIN: {
  1365. MethodInfo mi("min", PropertyInfo(Variant::REAL, "a"), PropertyInfo(Variant::REAL, "b"));
  1366. mi.return_val.type = Variant::REAL;
  1367. return mi;
  1368. } break;
  1369. case LOGIC_CLAMP: {
  1370. MethodInfo mi("clamp", PropertyInfo(Variant::REAL, "val"), PropertyInfo(Variant::REAL, "min"), PropertyInfo(Variant::REAL, "max"));
  1371. mi.return_val.type = Variant::REAL;
  1372. return mi;
  1373. } break;
  1374. case LOGIC_NEAREST_PO2: {
  1375. MethodInfo mi("nearest_po2", PropertyInfo(Variant::INT, "val"));
  1376. mi.return_val.type = Variant::INT;
  1377. return mi;
  1378. } break;
  1379. case OBJ_WEAKREF: {
  1380. MethodInfo mi("weakref", PropertyInfo(Variant::OBJECT, "obj"));
  1381. mi.return_val.type = Variant::OBJECT;
  1382. mi.return_val.name = "WeakRef";
  1383. return mi;
  1384. } break;
  1385. case FUNC_FUNCREF: {
  1386. MethodInfo mi("funcref", PropertyInfo(Variant::OBJECT, "instance"), PropertyInfo(Variant::STRING, "funcname"));
  1387. mi.return_val.type = Variant::OBJECT;
  1388. mi.return_val.name = "FuncRef";
  1389. return mi;
  1390. } break;
  1391. case TYPE_CONVERT: {
  1392. MethodInfo mi("convert", PropertyInfo(Variant::NIL, "what"), PropertyInfo(Variant::INT, "type"));
  1393. mi.return_val.type = Variant::OBJECT;
  1394. return mi;
  1395. } break;
  1396. case TYPE_OF: {
  1397. MethodInfo mi("typeof", PropertyInfo(Variant::NIL, "what"));
  1398. mi.return_val.type = Variant::INT;
  1399. return mi;
  1400. } break;
  1401. case TYPE_EXISTS: {
  1402. MethodInfo mi("type_exists", PropertyInfo(Variant::STRING, "type"));
  1403. mi.return_val.type = Variant::BOOL;
  1404. return mi;
  1405. } break;
  1406. case TEXT_CHAR: {
  1407. MethodInfo mi("char", PropertyInfo(Variant::INT, "ascii"));
  1408. mi.return_val.type = Variant::STRING;
  1409. return mi;
  1410. } break;
  1411. case TEXT_STR: {
  1412. MethodInfo mi("str");
  1413. mi.return_val.type = Variant::STRING;
  1414. mi.flags |= METHOD_FLAG_VARARG;
  1415. return mi;
  1416. } break;
  1417. case TEXT_PRINT: {
  1418. MethodInfo mi("print");
  1419. mi.return_val.type = Variant::NIL;
  1420. mi.flags |= METHOD_FLAG_VARARG;
  1421. return mi;
  1422. } break;
  1423. case TEXT_PRINT_TABBED: {
  1424. MethodInfo mi("printt");
  1425. mi.return_val.type = Variant::NIL;
  1426. mi.flags |= METHOD_FLAG_VARARG;
  1427. return mi;
  1428. } break;
  1429. case TEXT_PRINT_SPACED: {
  1430. MethodInfo mi("prints");
  1431. mi.return_val.type = Variant::NIL;
  1432. mi.flags |= METHOD_FLAG_VARARG;
  1433. return mi;
  1434. } break;
  1435. case TEXT_PRINTERR: {
  1436. MethodInfo mi("printerr");
  1437. mi.return_val.type = Variant::NIL;
  1438. mi.flags |= METHOD_FLAG_VARARG;
  1439. return mi;
  1440. } break;
  1441. case TEXT_PRINTRAW: {
  1442. MethodInfo mi("printraw");
  1443. mi.return_val.type = Variant::NIL;
  1444. mi.flags |= METHOD_FLAG_VARARG;
  1445. return mi;
  1446. } break;
  1447. case VAR_TO_STR: {
  1448. MethodInfo mi("var2str", PropertyInfo(Variant::NIL, "var"));
  1449. mi.return_val.type = Variant::STRING;
  1450. return mi;
  1451. } break;
  1452. case STR_TO_VAR: {
  1453. MethodInfo mi(Variant::NIL, "str2var", PropertyInfo(Variant::STRING, "string"));
  1454. mi.return_val.type = Variant::NIL;
  1455. mi.return_val.usage |= PROPERTY_USAGE_NIL_IS_VARIANT;
  1456. return mi;
  1457. } break;
  1458. case VAR_TO_BYTES: {
  1459. MethodInfo mi("var2bytes", PropertyInfo(Variant::NIL, "var"));
  1460. mi.return_val.type = Variant::POOL_BYTE_ARRAY;
  1461. return mi;
  1462. } break;
  1463. case BYTES_TO_VAR: {
  1464. MethodInfo mi(Variant::NIL, "bytes2var", PropertyInfo(Variant::POOL_BYTE_ARRAY, "bytes"));
  1465. mi.return_val.type = Variant::NIL;
  1466. mi.return_val.usage |= PROPERTY_USAGE_NIL_IS_VARIANT;
  1467. return mi;
  1468. } break;
  1469. case GEN_RANGE: {
  1470. MethodInfo mi("range");
  1471. mi.return_val.type = Variant::ARRAY;
  1472. mi.flags |= METHOD_FLAG_VARARG;
  1473. return mi;
  1474. } break;
  1475. case RESOURCE_LOAD: {
  1476. MethodInfo mi("load", PropertyInfo(Variant::STRING, "path"));
  1477. mi.return_val.type = Variant::OBJECT;
  1478. mi.return_val.name = "Resource";
  1479. return mi;
  1480. } break;
  1481. case INST2DICT: {
  1482. MethodInfo mi("inst2dict", PropertyInfo(Variant::OBJECT, "inst"));
  1483. mi.return_val.type = Variant::DICTIONARY;
  1484. return mi;
  1485. } break;
  1486. case DICT2INST: {
  1487. MethodInfo mi("dict2inst", PropertyInfo(Variant::DICTIONARY, "dict"));
  1488. mi.return_val.type = Variant::OBJECT;
  1489. return mi;
  1490. } break;
  1491. case VALIDATE_JSON: {
  1492. MethodInfo mi("validate_json", PropertyInfo(Variant::STRING, "json"));
  1493. mi.return_val.type = Variant::STRING;
  1494. return mi;
  1495. } break;
  1496. case PARSE_JSON: {
  1497. MethodInfo mi(Variant::NIL, "parse_json", PropertyInfo(Variant::STRING, "json"));
  1498. mi.return_val.type = Variant::NIL;
  1499. mi.return_val.usage |= PROPERTY_USAGE_NIL_IS_VARIANT;
  1500. return mi;
  1501. } break;
  1502. case TO_JSON: {
  1503. MethodInfo mi("to_json", PropertyInfo(Variant::NIL, "var"));
  1504. mi.return_val.type = Variant::STRING;
  1505. return mi;
  1506. } break;
  1507. case HASH: {
  1508. MethodInfo mi("hash", PropertyInfo(Variant::NIL, "var"));
  1509. mi.return_val.type = Variant::INT;
  1510. return mi;
  1511. } break;
  1512. case COLOR8: {
  1513. MethodInfo mi("Color8", PropertyInfo(Variant::INT, "r8"), PropertyInfo(Variant::INT, "g8"), PropertyInfo(Variant::INT, "b8"), PropertyInfo(Variant::INT, "a8"));
  1514. mi.return_val.type = Variant::COLOR;
  1515. return mi;
  1516. } break;
  1517. case COLORN: {
  1518. MethodInfo mi("ColorN", PropertyInfo(Variant::STRING, "name"), PropertyInfo(Variant::REAL, "alpha"));
  1519. mi.return_val.type = Variant::COLOR;
  1520. return mi;
  1521. } break;
  1522. case PRINT_STACK: {
  1523. MethodInfo mi("print_stack");
  1524. mi.return_val.type = Variant::NIL;
  1525. return mi;
  1526. } break;
  1527. case INSTANCE_FROM_ID: {
  1528. MethodInfo mi("instance_from_id", PropertyInfo(Variant::INT, "instance_id"));
  1529. mi.return_val.type = Variant::OBJECT;
  1530. return mi;
  1531. } break;
  1532. case LEN: {
  1533. MethodInfo mi("len", PropertyInfo(Variant::NIL, "var"));
  1534. mi.return_val.type = Variant::INT;
  1535. return mi;
  1536. } break;
  1537. case FUNC_MAX: {
  1538. ERR_FAIL_V(MethodInfo());
  1539. } break;
  1540. }
  1541. #endif
  1542. return MethodInfo();
  1543. }