gdscript_functions.cpp 45 KB

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