gdscript_functions.cpp 45 KB

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