Global_Functions.txt 12 KB

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