gdscript_functions.cpp 44 KB

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