Global_Functions.txt 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457
  1. //===== eAthena Script =======================================
  2. //= Global Functions
  3. //===== By: ==================================================
  4. //= Lupus, kobra_k88
  5. //===== Current Version: =====================================
  6. //= 2.01
  7. //===== Compatible With: =====================================
  8. //= eAthena 1.0
  9. //===== Description: =========================================
  10. //= <Description>
  11. //===== Additional Comments: =================================
  12. //= Added F_ClearJobVar - on getting a new job it clears all Job Quest variables
  13. //= Removed individual job check functions as they were redundant [kobra_k88]
  14. //= 1.3 Added Job Change Function for Baby/Normal Classes
  15. //= 1.3b a fix, due to const.txt change [Lupus]
  16. //= 1.4 Added Is_Taekwon_Class: Taekwondo, Star Knight(Gladiator),Soul Linker [Lupus]
  17. //= 1.5 Added clear of Bard Quest variables. 1.5a updated [Lupus]
  18. //= 1.6 Added F_RandMes, F_SexMes, F_Hi, F_Bye functions [Lupus]
  19. //= Moved here useful function 'getJobName'
  20. //= 1.7 Added "F_ItemName" function, added a great sample for "F_ItemName"
  21. //= 1.8 Added Job Vars clear for Extended classes: TK,SL,SG [Lupus]
  22. //= 1.9 Added "F_ClearGarbage" func that clears outdated, wasted variables [Lupus]
  23. //= 1.91 Added "F_SaveQuestSkills","F_Load?Skills" functions [Lupus]
  24. //= 2.0 Fixed F_Save/LoadQuestSkills functions. Had to split in into 2 vars [Lupus]
  25. //= 2.01 Added $talk to F_ClearGarbage [Evera]
  26. //============================================================
  27. //////////////////////////////////////////////////////////////////////////////////
  28. // Function that clears job quest variables
  29. //////////////////////////////////////////////////////////////////////////////////
  30. function script F_ClearJobVar {
  31. // Misc ---------------------------------
  32. set JBLVL,0;
  33. // First Class Jobs ---------------------
  34. set job_acolyte_q,0; set job_acolyte_q2,0;
  35. set job_archer_q,0;
  36. set job_magician_q,0;
  37. set job_merchant_q,0; set job_merchant_q2,0; set job_merchant_q3,0;
  38. set job_sword_q,0; set SWTEST, 0;
  39. set job_thief_q,0;
  40. // Super Novice
  41. set SUPNOV_Q,0;
  42. // 2-1 Jobs ------------------------------
  43. set ASSIN_Q,0; set ASSIN_Q2,0;
  44. set BSMITH_Q,0; set BSMITH_Q2,0;
  45. set HNTR_Q,0; set HNTR_Q2,0;
  46. set KNIGHT_Q,0; set KNIGHT_Q2,0;
  47. set PRIEST_Q,0; set PRIEST_Q2,0; set PRIEST_Q3,0;
  48. set WIZ_Q,0; set WIZ_Q2,0;
  49. // 2-2 Jobs ------------------------------
  50. set ROGUE_Q,0; set ROGUE_Q2,0;
  51. set ALCH_Q,0; set ALCH_Q2,0;
  52. set CRUS_Q,0;
  53. set MONK_Q,0; set JOB_MONK_C,0;
  54. set SAGE_Q,0; set SAGE_Q2,0;
  55. set DANC_Q,0;
  56. set BARD_Q,0;
  57. // Extended Classes
  58. set TAEK_Q,0;
  59. set STGL_Q,0;
  60. set SOUL_Q,0;
  61. return;
  62. }
  63. function script F_ClearGarbage {
  64. // Clear outdated global VARS
  65. if($talk) set $talk,0;
  66. if(MARIANNE) {set MISC_QUEST,MISC_QUEST | 1; set MARIANNE,0;}
  67. set MEAT,0; set MORRISON,0;
  68. set BUNYBND,0; set TEMPESTRA,0;
  69. set sewer_prt,0; set iz_move_alberta,0;
  70. if(nif_q_done) {set nif_q_done,0; set MISC_QUEST,MISC_QUEST | 64;}
  71. if(MORGEN >= 2) {set MISC_QUEST,MISC_QUEST | 4; set MORGEN,0;}
  72. set nif_t,0;
  73. set QSK1,0; set QSK2,0; set QSK3,0; set QSK4,0;
  74. return;
  75. }
  76. //////////////////////////////////////////////////////////////////////////////////
  77. // Used in REBIRTH scripts
  78. // Class = Internal Class ID
  79. // BaseJob = Base Job (0..23)
  80. // Upper : 0 - Default, 1 - Advanced, 2 - Baby
  81. //////////////////////////////////////////////////////////////////////////////////
  82. function script Job_Change {
  83. if (Upper<2)
  84. jobchange getarg(0); // Common jobchange
  85. else
  86. jobchange getarg(0) + Job_Baby; //Change Job For Baby Class
  87. return;
  88. }
  89. //////////////////////////////////////////////////////////////////////////////////
  90. // FOT BACKWISE COMPATIBILITY: Functions used to check a players job class
  91. // HOW TO USE:
  92. // i.e. We need all holy classes but monks
  93. // if ( callfunc("Is_Holy_Class") && callfunc("Is_Monk")==0 ) goto L_Start;
  94. //////////////////////////////////////////////////////////////////////////////////
  95. //////////////////////////////////////////////////////////////////////////////////
  96. // returns 1 if the player is either Aco,Monk,Priest,Aco High,High Priest,
  97. // Champion, 0 otherwise
  98. //////////////////////////////////////////////////////////////////////////////////
  99. function script Is_Holy_Class {
  100. return ( BaseJob==Job_Acolyte || BaseJob==Job_Priest || BaseJob==Job_Monk );
  101. }
  102. //////////////////////////////////////////////////////////////////////////////////
  103. // returns 1 if the player is either Archer,Hunter,Bard,Dancer,Archer High,Sniper,
  104. // Clown,Gypsy, 0 otherwise
  105. //////////////////////////////////////////////////////////////////////////////////
  106. function script Is_Bow_Class {
  107. return ( BaseJob==Job_Archer || BaseJob==Job_Hunter || BaseJob==Job_Bard || BaseJob==Job_Dancer );
  108. }
  109. //////////////////////////////////////////////////////////////////////////////////
  110. // returns 1 if the player is either Mage,Wizard,Sage,Mage High,High Wizard,
  111. // Professor, 0 otherwise
  112. //////////////////////////////////////////////////////////////////////////////////
  113. function script Is_Magic_Class {
  114. return ( BaseJob==Job_Mage || BaseJob==Job_Wizard || BaseJob==Job_Sage );
  115. }
  116. //////////////////////////////////////////////////////////////////////////////////
  117. // returns 1 if the player is either Merc,Blacksmith,Alchemist,Merc High,
  118. // Whitesmith,Creator, 0 otherwise
  119. //////////////////////////////////////////////////////////////////////////////////
  120. function script Is_Merc_Class {
  121. return ( BaseJob==Job_Merchant || BaseJob==Job_Blacksmith || BaseJob==Job_Alchem );
  122. }
  123. //////////////////////////////////////////////////////////////////////////////////
  124. // returns 1 if the player is either Thief,Assassin,Rogue,Thief High, Assassin Cross
  125. // Stalker, 0 otherwise
  126. //////////////////////////////////////////////////////////////////////////////////
  127. function script Is_Thief_Class {
  128. return ( BaseJob==Job_Thief || BaseJob==Job_Assassin || BaseJob==Job_Rogue );
  129. }
  130. //////////////////////////////////////////////////////////////////////////////////
  131. // returns 1 if the player is either Swordy,Knight,Crusader,Swordy High,
  132. // Lord Knight,Paladin, 0 otherwise
  133. //////////////////////////////////////////////////////////////////////////////////
  134. function script Is_Sword_Class {
  135. return ( BaseJob==Job_Swordman || BaseJob==Job_Knight || BaseJob==Job_Knight2 || BaseJob==Job_Crusader || BaseJob==Job_Crusader2 );
  136. }
  137. //////////////////////////////////////////////////////////////////////////////////
  138. // returns 1 if the player is either Taekwon, Star Gladiator,Soul Linker, 0 otherwise
  139. // these classes can't be adopted nor reborn ()
  140. //////////////////////////////////////////////////////////////////////////////////
  141. function script Is_Taekwon_Class {
  142. return ( Class==Job_Taekwon || Class==Job_Star_Gladiator || Class==Job_Star_Gladiator2 || Class==Job_Soul_Linker );
  143. }
  144. //////////////////////////////////////////////////////////////////////////////////
  145. // Functions used to spiff up dialoges [Lupus]
  146. //////////////////////////////////////////////////////////////////////////////////
  147. //////////////////////////////////////////////////////////////////////////////////
  148. // *** Function "F_RandMes"
  149. //////////////////////////////////////////////////////////////////////////////////
  150. //returns random string
  151. // Example: check F_Bye or F_Hi functions
  152. // READ AND THINK: You can use it to pick a random number form list:
  153. // set @itemIDfromList, callfunc("F_RandMes",8,1129,1222,1163,1357,1360,1522,1811,1410);
  154. function script F_RandMes {
  155. return getarg(rand(1,getarg(0)));
  156. }
  157. //////////////////////////////////////////////////////////////////////////////////
  158. // *** Function "F_Sex"
  159. //////////////////////////////////////////////////////////////////////////////////
  160. //returns 1st string if female, 2nd string otherwise
  161. // Example: mes callfunc("F_Sex","What a beautiful lady!","What a handsom man!");
  162. function script F_SexMes {
  163. return getarg(Sex);
  164. }
  165. //////////////////////////////////////////////////////////////////////////////////
  166. // *** Function "F_Hi"
  167. //////////////////////////////////////////////////////////////////////////////////
  168. //returns random HELLO message
  169. function script F_Hi {
  170. return callfunc("F_RandMes",5,"Hi!","Hello!","Good day!","How are you?","Hello there.");
  171. }
  172. //////////////////////////////////////////////////////////////////////////////////
  173. // *** Function "F_Bye"
  174. //////////////////////////////////////////////////////////////////////////////////
  175. //returns random BYE message
  176. function script F_Bye {
  177. return callfunc("F_RandMes",6,"Bye. See you again.","Later.","Goodbye.","Good luck!","Have a nice day!","Byebye!!!");
  178. }
  179. //////////////////////////////////////////////////////////////////////////////////
  180. // *** Function "F_ItemName"
  181. //////////////////////////////////////////////////////////////////////////////////
  182. // Returns expanded item name string
  183. //Argumentss
  184. // 0 - Item ID
  185. // 1 - Element N (0=none,1=Ice,2=Earth,3=Fire,4=Wind)
  186. // 2 - VVS meter 0..3
  187. // 3 - Refine
  188. // Example: mes "Show me your "+callfunc("F_ItemName",1201,1,2,5)+"...";
  189. // is equal to: mes "Show me your ^000090 +5 VVS Fire Knife ^000000..."
  190. function script F_ItemName {
  191. set @t$,"^000090";
  192. if(getarg(3)) set @t$,@t$+"+"+getarg(3)+" ";
  193. if(getarg(2)==1) set @t$,@t$+"VS ";
  194. if(getarg(2)==2) set @t$,@t$+"VVS ";
  195. if(getarg(2)==3) set @t$,@t$+"VVVS ";
  196. if(getarg(2)>3) set @t$,@t$+getarg(2)+"xVS ";
  197. if(getarg(1)==1) set @t$,@t$+"Ice ";
  198. if(getarg(1)==2) set @t$,@t$+"Earth ";
  199. if(getarg(1)==3) set @t$,@t$+"Fire ";
  200. if(getarg(1)==4) set @t$,@t$+"Wind ";
  201. if(getarg(1)>4) set @t$,@t$+"Strange ";
  202. return @t$+getitemname(getarg(0))+"^000000";
  203. }
  204. //////////////////////////////////////////////////////////////////////////////////
  205. // *** Function "getJobName" //
  206. // [Usage] : callfunc("getJobName",Class); //
  207. //////////////////////////////////////////////////////////////////////////////////
  208. function script getJobName {
  209. switch(getarg(0)){
  210. case Job_Novice:
  211. return "Novice";
  212. case Job_Swordman:
  213. return "Swordman";
  214. case Job_Mage:
  215. return "Magician";
  216. case Job_Archer:
  217. return "Archer";
  218. case Job_Acolyte:
  219. return "Acolyte";
  220. case Job_Merchant:
  221. return "Merchant";
  222. case Job_Thief:
  223. return "Thief";
  224. case Job_Knight:
  225. case Job_Knight2:
  226. return "Knight";
  227. case Job_Priest:
  228. return "Priest";
  229. case Job_Wizard:
  230. return "Wizard";
  231. case Job_Blacksmith:
  232. return "Blacksmith";
  233. case Job_Hunter:
  234. return "Hunter";
  235. case Job_Assassin:
  236. return "Assassin";
  237. case Job_Crusader:
  238. case Job_Crusader2:
  239. return "Crusader";
  240. case Job_Monk:
  241. return "Monk";
  242. case Job_Sage:
  243. return "Sage";
  244. case Job_Rogue:
  245. return "Rogue";
  246. case Job_Alchem:
  247. return "Alchemist";
  248. case Job_Bard:
  249. return "Bard";
  250. case Job_Dancer:
  251. return "Dancer";
  252. case Job_SuperNovice:
  253. return "Super Novice";
  254. case Job_Gunslinger:
  255. return "Gunsligner";
  256. case Job_Ninja:
  257. return "Ninja";
  258. case Job_Xmas:
  259. return "Xmas";
  260. case Job_Novice_High:
  261. return "Novice High";
  262. case Job_Swordman_High:
  263. return "Swordman High";
  264. case Job_Mage_High:
  265. return "Magician High";
  266. case Job_Archer_High:
  267. return "Archer High";
  268. case Job_Acolyte_High:
  269. return "Acolyte High";
  270. case Job_Merchant_High:
  271. return "Merchant High";
  272. case Job_Thief_High:
  273. return "Thief High";
  274. case Job_Lord_Knight:
  275. case Job_Lord_Knight2:
  276. return "Lord Knight";
  277. case Job_High_Priest:
  278. return "High Priest";
  279. case Job_High_Wizard:
  280. return "High Wizard";
  281. case Job_Whitesmith:
  282. return "Whitesmith";
  283. case Job_Sniper:
  284. return "Sniper";
  285. case Job_Assassin_Cross:
  286. return "Assassin Cross";
  287. case Job_Paladin:
  288. case Job_Paladin2:
  289. return "Paladin";
  290. case Job_Champion:
  291. return "Champion";
  292. case Job_Professor:
  293. return "Professor";
  294. case Job_Stalker:
  295. return "Stalker";
  296. case Job_Creator:
  297. return "Creator";
  298. case Job_Clown:
  299. return "Clown";
  300. case Job_Gypsy:
  301. return "Gypsy";
  302. case Job_Baby:
  303. return "Baby";
  304. case Job_Baby_Swordman:
  305. return "Baby Swordman";
  306. case Job_Baby_Mage:
  307. return "Baby Magician";
  308. case Job_Baby_Archer:
  309. return "Baby Archer";
  310. case Job_Baby_Acolyte:
  311. return "Baby Acolyte";
  312. case Job_Baby_Merchant:
  313. return "Baby Merchant";
  314. case Job_Baby_Thief:
  315. return "Baby Thief";
  316. case Job_Baby_Knight:
  317. case Job_Baby_Knight2:
  318. return "Baby Knight";
  319. case Job_Baby_Priest:
  320. return "Baby Priest";
  321. case Job_Baby_Wizard:
  322. return "Baby Wizard";
  323. case Job_Baby_Blacksmith:
  324. return "Baby Blacksmith";
  325. case Job_Baby_Hunter:
  326. return "Baby Hunter";
  327. case Job_Baby_Assassin:
  328. return "Baby Assassin";
  329. case Job_Baby_Crusader:
  330. case Job_Baby_Crusader2:
  331. return "Baby Crusader";
  332. case Job_Baby_Monk:
  333. return "Baby Monk";
  334. case Job_Baby_Sage:
  335. return "Baby Sage";
  336. case Job_Baby_Rogue:
  337. return "Baby Rogue";
  338. case Job_Baby_Alchem:
  339. return "Baby Alchemist";
  340. case Job_Baby_Bard:
  341. return "Baby Bard";
  342. case Job_Baby_Dancer:
  343. return "Baby Dancer";
  344. case Job_Super_Baby:
  345. return "Super Baby";
  346. case Job_Taekwon:
  347. if(Sex == 0)
  348. return "Taekwon Girl";
  349. else
  350. return "Taekwon Boy";
  351. case Job_Star_Gladiator:
  352. case Job_Star_Gladiator2:
  353. return "Star Gladiator";
  354. case Job_Soul_Linker:
  355. return "Soul Linker";
  356. case Job_Ninja:
  357. return "Ninja";
  358. case Job_Gunslinger:
  359. return "Gunslinger";
  360. case Job_Xmas:
  361. return "Christmas";
  362. case Option_Wedding:
  363. if(Sex == 0)
  364. return "Bride";
  365. else
  366. return "Bridegroom";
  367. default:
  368. return "omghaxor";
  369. }
  370. }
  371. //////////////////////////////////////////////////////////////////////////////////
  372. // *** Function "F_SaveQuestSkills": Store learnt quest skills
  373. //////////////////////////////////////////////////////////////////////////////////
  374. function script F_SaveQuestSkills {
  375. set ADV_QSK,0; set ADV_QSK2,0;
  376. //1st classes quest skills
  377. for(set @i, 0; @i < 14; set @i, @i + 1){
  378. if(getskilllv(144+@i)) set ADV_QSK,ADV_QSK|pow(2,@i);
  379. }
  380. //2nd classes quest skills
  381. for(set @i, 0; @i < 19; set @i, @i + 1){
  382. if(getskilllv(1001+@i)) set ADV_QSK2,ADV_QSK2|pow(2,@i);
  383. }
  384. return;
  385. }
  386. //////////////////////////////////////////////////////////////////////////////////
  387. // *** Function "F_Load1Skills": Restore learnt 1st class quest skills
  388. //////////////////////////////////////////////////////////////////////////////////
  389. function script F_Load1Skills {
  390. //1st classes quest skills
  391. for(set @i, 0; @i < 14; set @i, @i + 1){
  392. if(ADV_QSK|pow(2,@i) == ADV_QSK) skill 144+@i,1,0;
  393. }
  394. set ADV_QSK,0; //Clear var
  395. return;
  396. }
  397. //////////////////////////////////////////////////////////////////////////////////
  398. // *** Function "F_Load2Skills": Restore learnt 2nd class quest skills
  399. //////////////////////////////////////////////////////////////////////////////////
  400. function script F_Load2Skills {
  401. //2nd classes quest skills
  402. for(set @i, 0; @i < 19; set @i, @i + 1){
  403. if(ADV_QSK2|pow(2,@i) == ADV_QSK2) skill 1001+@i,1,0;
  404. }
  405. set ADV_QSK2,0; //Clear var
  406. return;
  407. }