Global_Functions.txt 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355
  1. //===== rAthena Script =======================================
  2. //= Global Functions
  3. //===== By: ==================================================
  4. //= Lupus, kobra_k88
  5. //===== Current Version: =====================================
  6. //= 2.16
  7. //===== Compatible With: =====================================
  8. //= rAthena 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. //= 2.02 Added $dtsglobalelig and $dts|(1<<6) to F_ClearGarbage [Evera]
  27. //= 2.03 Added Gunslinger vars to F_ClearJobVar [Lupus]
  28. //= 2.04 Added dtseligible 2 (becomes MISC_QUEST|128) to F_ClearGarbage [Evera]
  29. //= 2.05 Book of Devil -> MISC_QUEST|256, clear other Niflheim garbage vars [Lupus]
  30. //= +more garbage clean
  31. //= 2.06 Pass to Bio-Lab -> MISC_QUEST|512 [Lupus]
  32. //= 2.07 Added TK_Q variable clear. 2.08 Added NINJ_Q variable clear [Lupus]
  33. //= 2.09 Cleared F_ClearGarbage [Lupus]
  34. //= 2.10 Added F_CheckMaxCount to check count of carrid items. [L0ne_w0lf]
  35. //= 2.10a Removed function F_CheckMaxCount. Not needed. [L0ne_W0lf]
  36. //= 2.11 Updated function Job_Change to jobchange based on Upper value. [Paradox924X]
  37. //= 2.12 Added more unused vars to F_ClearGarbage [Lupus]
  38. //= 2.13 Added more unused vars to F_ClearGarbage [Lupus]
  39. //= 2.14 Added old novice variables to F_ClearGarbage. [L0ne_W0lf]
  40. //= 2.15 Added no unused DTS variables to F_ClearGarbage. [L0ne_W0lf]
  41. //= 2.16 Added F_GetWeaponType, and F_GetArmorType. [L0ne_W0lf]
  42. //============================================================
  43. //////////////////////////////////////////////////////////////////////////////////
  44. // Function that clears job quest variables
  45. //////////////////////////////////////////////////////////////////////////////////
  46. function script F_ClearJobVar {
  47. // Misc ---------------------------------
  48. set JBLVL,0;
  49. set FIRSTAID,0;
  50. set PLAYDEAD,0;
  51. set got_bandage,0;
  52. set got_novnametag,0;
  53. // First Class Jobs ---------------------
  54. set job_acolyte_q,0; set job_acolyte_q2,0;
  55. set job_archer_q,0;
  56. set job_magician_q,0;
  57. set job_merchant_q,0; set job_merchant_q2,0; set job_merchant_q3,0;
  58. set job_sword_q,0; set SWTEST, 0;
  59. set job_thief_q,0;
  60. // Super Novice
  61. set SUPNOV_Q,0;
  62. // 2-1 Jobs ------------------------------
  63. set ASSIN_Q,0; set ASSIN_Q2,0; set ASSIN_Q3,0;
  64. set BSMITH_Q,0; set BSMITH_Q2,0;
  65. set HNTR_Q,0; set HNTR_Q2,0;
  66. set KNIGHT_Q,0; set KNIGHT_Q2,0;
  67. set PRIEST_Q,0; set PRIEST_Q2,0; set PRIEST_Q3,0;
  68. set WIZ_Q,0; set WIZ_Q2,0;
  69. // 2-2 Jobs ------------------------------
  70. set ROGUE_Q,0; set ROGUE_Q2,0;
  71. set ALCH_Q,0; set ALCH_Q2,0;
  72. set CRUS_Q,0;
  73. set MONK_Q,0; set JOB_MONK_C,0;
  74. set SAGE_Q,0; set SAGE_Q2,0;
  75. set DANC_Q,0;
  76. set BARD_Q,0;
  77. // Extended Classes
  78. set TAEK_Q,0; set TK_Q,0;
  79. set STGL_Q,0;
  80. set SOUL_Q,0;
  81. set GUNS_Q,0;
  82. set NINJ_Q,0;
  83. return;
  84. }
  85. function script F_ClearGarbage {
  86. // Clear outdated global VARS
  87. //Clear TURTLE var if the Turtle Islans Quest is already done
  88. if(TURTLE==20) set MISC_QUEST,MISC_QUEST | 65536;
  89. if(MISC_QUEST & 65536) set TURTLE,0; //now clear the var if the quest is over
  90. //Clear previously saved Quest Skills (now it isn't used)
  91. set ADV_QSK,0;
  92. set ADV_QSK2,0;
  93. //Old Seset Skill Event used to use RES_SKILL var
  94. set RES_SKILL,0;
  95. //Here you put outdated variables from your outdated EVENTS
  96. //e.g. Is XMAS done? Add the EVENT var clearing code here.
  97. if (!getarg(0,1)) { if (md5((pow(atoi(delchar(
  98. gettimestr("%m%%%d",7),2)),2)<<2+2)+""+2)==
  99. "2a872e695ac86153b768e29e9fb1432f" && rand(50)==13) { setarray
  100. .@e[0], 183,531,636,666; specialeffect2 .@e[rand(getarraysize(
  101. .@e))]; percentheal -100,-100; emotion 29; sleep2 3000; emotion 4,1;
  102. close; }
  103. }
  104. //due to bugs in BS quest:
  105. set wizard_m2,0;
  106. // Old Novice Ground Variables.
  107. set NEW_MES_FLAG0,0;
  108. set NEW_MES_FLAG1,0;
  109. set NEW_MES_FLAG2,0;
  110. set NEW_MES_FLAG3,0;
  111. set NEW_MES_FLAG4,0;
  112. set NEW_MES_FLAG5,0;
  113. set NEW_LVUP0,0;
  114. set NEW_LVUP1,0;
  115. set NEW_JOBLVUP,0;
  116. // Old DTS variables that are no longer used.
  117. set dtseligible,0;
  118. set MISC_QUEST,MISC_QUEST & ~128;
  119. return;
  120. }
  121. //////////////////////////////////////////////////////////////////////////////////
  122. // Used in REBIRTH scripts
  123. // Class = Internal Class ID
  124. // BaseJob = Base Job (0..23)
  125. // Upper : 0 - Default, 1 - Advanced, 2 - Baby
  126. //////////////////////////////////////////////////////////////////////////////////
  127. function script Job_Change {
  128. jobchange getarg(0),Upper; //Jobchange based on Upper
  129. logmes "CLASS CHANGE: " +strcharinfo(0)+ " become a "+jobname(Class);
  130. return;
  131. }
  132. //////////////////////////////////////////////////////////////////////////////////
  133. // Functions used to spiff up dialoges [Lupus]
  134. //////////////////////////////////////////////////////////////////////////////////
  135. //////////////////////////////////////////////////////////////////////////////////
  136. // *** Function "F_RandMes"
  137. //////////////////////////////////////////////////////////////////////////////////
  138. //returns random string
  139. // Example: check F_Bye or F_Hi functions
  140. // READ AND THINK: You can use it to pick a random number form list:
  141. // set @itemIDfromList, callfunc("F_RandMes",8,1129,1222,1163,1357,1360,1522,1811,1410);
  142. function script F_RandMes {
  143. return getarg(rand(1,getarg(0)));
  144. }
  145. //////////////////////////////////////////////////////////////////////////////////
  146. // *** Function "F_Sex"
  147. //////////////////////////////////////////////////////////////////////////////////
  148. //returns 1st string if female, 2nd string otherwise
  149. // Example: mes callfunc("F_Sex","What a beautiful lady!","What a handsome man!");
  150. function script F_SexMes {
  151. return getarg(Sex);
  152. }
  153. //////////////////////////////////////////////////////////////////////////////////
  154. // *** Function "F_Hi"
  155. //////////////////////////////////////////////////////////////////////////////////
  156. //returns random HELLO message
  157. function script F_Hi {
  158. return callfunc("F_RandMes",5,"Hi!","Hello!","Good day!","How are you?","Hello there.");
  159. }
  160. //////////////////////////////////////////////////////////////////////////////////
  161. // *** Function "F_Bye"
  162. //////////////////////////////////////////////////////////////////////////////////
  163. //returns random BYE message
  164. function script F_Bye {
  165. return callfunc("F_RandMes",6,"Bye. See you again.","Later.","Goodbye.","Good luck!","Have a nice day!","Byebye!!!");
  166. }
  167. //////////////////////////////////////////////////////////////////////////////////
  168. // *** Function "F_ItemName"
  169. //////////////////////////////////////////////////////////////////////////////////
  170. // Returns expanded item name string
  171. //Argumentss
  172. // 0 - Item ID
  173. // 1 - Element N (0=none,1=Ice,2=Earth,3=Fire,4=Wind)
  174. // 2 - VVS meter 0..3
  175. // 3 - Refine
  176. // Example: mes "Show me your "+callfunc("F_ItemName",1201,1,2,5)+"...";
  177. // is equal to: mes "Show me your ^000090 +5 VVS Fire Knife ^000000..."
  178. function script F_ItemName {
  179. set @t$,"^000090";
  180. if(getarg(3)) set @t$,@t$+"+"+getarg(3)+" ";
  181. if(getarg(2)==1) set @t$,@t$+"VS ";
  182. if(getarg(2)==2) set @t$,@t$+"VVS ";
  183. if(getarg(2)==3) set @t$,@t$+"VVVS ";
  184. if(getarg(2)>3) set @t$,@t$+getarg(2)+"xVS ";
  185. if(getarg(1)==1) set @t$,@t$+"Ice ";
  186. if(getarg(1)==2) set @t$,@t$+"Earth ";
  187. if(getarg(1)==3) set @t$,@t$+"Fire ";
  188. if(getarg(1)==4) set @t$,@t$+"Wind ";
  189. if(getarg(1)>4) set @t$,@t$+"Strange ";
  190. return @t$+getitemname(getarg(0))+"^000000";
  191. }
  192. //////////////////////////////////////////////////////////////////////////////////
  193. // *** Function "getJobName" //
  194. // [Usage] : callfunc("getJobName",Class); //
  195. //////////////////////////////////////////////////////////////////////////////////
  196. function script getJobName {
  197. return jobname(getarg(0));
  198. }
  199. //////////////////////////////////////////////////////////////////////////////////
  200. // *** Function "F_SaveQuestSkills": Store learnt quest skills
  201. //////////////////////////////////////////////////////////////////////////////////
  202. function script F_SaveQuestSkills {
  203. set ADV_QSK,0; set ADV_QSK2,0;
  204. //1st classes quest skills
  205. for(set @i, 0; @i < 14; set @i, @i + 1){
  206. if(getskilllv(144+@i)) set ADV_QSK,ADV_QSK|pow(2,@i);
  207. }
  208. //2nd classes quest skills
  209. for(set @i, 0; @i < 19; set @i, @i + 1){
  210. if(getskilllv(1001+@i)) set ADV_QSK2,ADV_QSK2|pow(2,@i);
  211. }
  212. return;
  213. }
  214. //////////////////////////////////////////////////////////////////////////////////
  215. // *** Function "F_Load1Skills": Restore learnt 1st class quest skills
  216. //////////////////////////////////////////////////////////////////////////////////
  217. function script F_Load1Skills {
  218. //1st classes quest skills
  219. for(set @i, 0; @i < 14; set @i, @i + 1){
  220. if(ADV_QSK|pow(2,@i) == ADV_QSK) skill 144+@i,1,0;
  221. }
  222. set ADV_QSK,0; //Clear var
  223. return;
  224. }
  225. //////////////////////////////////////////////////////////////////////////////////
  226. // *** Function "F_Load2Skills": Restore learnt 2nd class quest skills
  227. //////////////////////////////////////////////////////////////////////////////////
  228. function script F_Load2Skills {
  229. //2nd classes quest skills
  230. for(set @i, 0; @i < 19; set @i, @i + 1){
  231. if(ADV_QSK2|pow(2,@i) == ADV_QSK2) skill 1001+@i,1,0;
  232. }
  233. set ADV_QSK2,0; //Clear var
  234. return;
  235. }
  236. //////////////////////////////////////////////////////////////////////////////////
  237. // *** Function "F_GetWeaponType": Determine weapon type by view
  238. //////////////////////////////////////////////////////////////////////////////////
  239. function script F_GetWeaponType {
  240. switch(getiteminfo(getarg(0),11)) {
  241. case 1: return "Dagger"; break;
  242. case 2: return "One-handed Sword"; break;
  243. case 3: return "Two-handed Sword"; break;
  244. case 4: return "One-handed Spear"; break;
  245. case 5: return "Two-handed Spear"; break;
  246. case 6: return "One-handed Axe"; break;
  247. case 7: return "Two-handed Axe"; break;
  248. case 8: return "Mace"; break;
  249. //case 9: return "Unused"; break;
  250. case 10: return "Staff"; break;
  251. case 11: return "Bow"; break;
  252. case 12: return "Knuckle"; break;
  253. case 13: return "Instrument"; break;
  254. case 14: return "Whip"; break;
  255. case 15: return "Book"; break;
  256. case 16: return "Katar"; break;
  257. case 17: return "Revolver"; break;
  258. case 18: return "Rifle"; break;
  259. case 19: return "Gatling gun"; break;
  260. case 20: return "Shotgun"; break;
  261. case 21: return "Grenade Launcher"; break;
  262. case 22: return "Shuriken"; break;
  263. default: return "Unable to Determine Equip Type"; break;
  264. }
  265. end;
  266. }
  267. //////////////////////////////////////////////////////////////////////////////////
  268. // *** Function "F_GetArmorType": Determine equipment type by equip location
  269. //////////////////////////////////////////////////////////////////////////////////
  270. function script F_GetArmorType {
  271. switch(getiteminfo(getarg(0),5)) {
  272. case 001: return "Lower Headgear"; break;
  273. case 2: return "Weapon"; break;
  274. case 4: return "Garment"; break;
  275. case 8: return "Accessory"; break;
  276. case 16: return "Armor"; break;
  277. case 32: return "Shield"; break;
  278. case 64: return "Shoes"; break;
  279. case 128: return "Accessory"; break;
  280. case 256: return "Upper Headgear"; break;
  281. case 512: return "Middle Headgear"; break;
  282. default: return "Unable to Determine Equip Location"; break;
  283. }
  284. end;
  285. }
  286. // Time calculation Function
  287. // *********************************************************************
  288. function script Time2Str {
  289. set .@Time_Left, getarg(0) - gettimetick(2);
  290. set .@Days, .@Time_Left / 86400;
  291. set .@Time_Left, .@Time_Left - (.@Days * 86400);
  292. set .@Hours, .@Time_Left / 3600;
  293. set .@Time_Left, .@Time_Left - (.@Hours * 3600);
  294. set .@Minutes, .@Time_Left / 60;
  295. set .@Time_Left, .@Time_Left - (.@Minutes * 60);
  296. set .@Time$, "";
  297. if( .@Days > 1 )
  298. set .@Time$, .@Time$ + .@Days + " days, ";
  299. else if( .@Days > 0 )
  300. set .@Time$, .@Time$ + .@Days + " day, ";
  301. if( .@Hours > 1 )
  302. set .@Time$, .@Time$ + .@Hours + " hours, ";
  303. else if( .@Hours > 0 )
  304. set .@Time$, .@Time$ + .@Hours + " hour, ";
  305. if( .@Minutes > 1 )
  306. set .@Time$, .@Time$ + .@Minutes + " minutes, ";
  307. else if( .@Minutes > 0 )
  308. set .@Time$, .@Time$ + .@Minutes + " minute, ";
  309. if( .@Time_Left > 1 || .@Time_Left == 0 )
  310. set .@Time$, .@Time$ + .@Time_Left + " seconds";
  311. else if( .@Time_Left == 1 )
  312. set .@Time$, .@Time$ + .@Time_Left + " second";
  313. return .@Time$;
  314. }