Global_Functions.txt 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610
  1. //===== rAthena Script =======================================
  2. //= Global Functions
  3. //===== By: ==================================================
  4. //= Lupus, kobra_k88
  5. //===== Current Version: =====================================
  6. //= 2.25
  7. //===== Compatible With: =====================================
  8. //= rAthena Project
  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. //= 2.2 Added "F_GetPlural", "F_InsertPlural", "F_InsertArticle", "F_InsertComma", "F_GetNumSuffix". [Euphy]
  45. //= Standardized descriptions, updated 'F_GetArmorType'.
  46. //= 2.21 Added format string to "F_InsertPlural" and more checks to "F_GetPlural". [Euphy]
  47. //= 2.22 Further improvements to "F_GetPlural". [Euphy]
  48. //= 2.23 Completed article function and added "F_GetArticle". [Euphy]
  49. //= 2.24 Added functions to check for equipment swap hacks. [Euphy]
  50. //= 2.25 Added "F_CanOpenStorage" and "F_CanChangeJob". [secretdataz]
  51. //============================================================
  52. //////////////////////////////////////////////////////////////////////////////////
  53. // Clears job quest variables.
  54. // -- callfunc "F_ClearJobVar"
  55. //////////////////////////////////////////////////////////////////////////////////
  56. function script F_ClearJobVar {
  57. // Misc ---------------------------------
  58. set JBLVL,0;
  59. set FIRSTAID,0;
  60. set PLAYDEAD,0;
  61. set got_bandage,0;
  62. set got_novnametag,0;
  63. // First Class Jobs ---------------------
  64. set job_acolyte_q,0; set job_acolyte_q2,0;
  65. set job_archer_q,0;
  66. set job_magician_q,0;
  67. set job_merchant_q,0; set job_merchant_q2,0; set job_merchant_q3,0;
  68. set job_sword_q,0; set SWTEST, 0;
  69. set job_thief_q,0;
  70. // Super Novice
  71. set SUPNOV_Q,0;
  72. // 2-1 Jobs ------------------------------
  73. set ASSIN_Q,0; set ASSIN_Q2,0; set ASSIN_Q3,0;
  74. set BSMITH_Q,0; set BSMITH_Q2,0;
  75. set HNTR_Q,0; set HNTR_Q2,0;
  76. set KNIGHT_Q,0; set KNIGHT_Q2,0;
  77. set PRIEST_Q,0; set PRIEST_Q2,0; set PRIEST_Q3,0;
  78. set WIZ_Q,0; set WIZ_Q2,0;
  79. // 2-2 Jobs ------------------------------
  80. set ROGUE_Q,0; set ROGUE_Q2,0;
  81. set ALCH_Q,0; set ALCH_Q2,0;
  82. set CRUS_Q,0;
  83. set MONK_Q,0; set JOB_MONK_C,0;
  84. set SAGE_Q,0; set SAGE_Q2,0;
  85. set DANC_Q,0;
  86. set BARD_Q,0;
  87. // Extended Classes
  88. set TAEK_Q,0; set TK_Q,0;
  89. set STGL_Q,0;
  90. set SOUL_Q,0;
  91. set GUNS_Q,0;
  92. set NINJ_Q,0;
  93. return;
  94. }
  95. //////////////////////////////////////////////////////////////////////////////////
  96. // Clears other unused variables.
  97. // -- callfunc "F_ClearGarbage"
  98. //////////////////////////////////////////////////////////////////////////////////
  99. function script F_ClearGarbage {
  100. // Clear outdated global VARS
  101. //Clear TURTLE var if the Turtle Islans Quest is already done
  102. if(TURTLE==20) set MISC_QUEST,MISC_QUEST | 65536;
  103. if(MISC_QUEST & 65536) set TURTLE,0; //now clear the var if the quest is over
  104. //Clear previously saved Quest Skills (now it isn't used)
  105. set ADV_QSK,0;
  106. set ADV_QSK2,0;
  107. //Old Reset Skill Event used to use RES_SKILL var
  108. set RES_SKILL,0;
  109. //Here you put outdated variables from your outdated EVENTS
  110. //e.g. Is XMAS done? Add the EVENT var clearing code here.
  111. //due to bugs in BS quest:
  112. set wizard_m2,0;
  113. // Old Novice Ground Variables.
  114. set NEW_MES_FLAG0,0;
  115. set NEW_MES_FLAG1,0;
  116. set NEW_MES_FLAG2,0;
  117. set NEW_MES_FLAG3,0;
  118. set NEW_MES_FLAG4,0;
  119. set NEW_MES_FLAG5,0;
  120. set NEW_LVUP0,0;
  121. set NEW_LVUP1,0;
  122. set NEW_JOBLVUP,0;
  123. // Old DTS variables that are no longer used.
  124. set dtseligible,0;
  125. set MISC_QUEST,MISC_QUEST & ~128;
  126. return;
  127. }
  128. //////////////////////////////////////////////////////////////////////////////////
  129. // Job change based on Upper value (normal, advanced, baby).
  130. // -- callfunc "Job_Change",<Class value>;
  131. // See Job_* constants in 'db/const.txt' for Class values.
  132. //////////////////////////////////////////////////////////////////////////////////
  133. function script Job_Change {
  134. jobchange getarg(0),Upper;
  135. // logmes "CLASS CHANGE: " +strcharinfo(0)+ " become a "+jobname(Class);
  136. return;
  137. }
  138. //////////////////////////////////////////////////////////////////////////////////
  139. // Functions used to spiff up dialoges [Lupus]
  140. //////////////////////////////////////////////////////////////////////////////////
  141. //////////////////////////////////////////////////////////////////////////////////
  142. // Returns a random argument.
  143. // -- callfunc "F_Rand",arg0,arg1,...
  144. // Example:
  145. // // You can use it to pick a random number from a list:
  146. // set @itemIDfromList, callfunc("F_Rand",1129,1222,1163,1357,1360,1522,1811,1410);
  147. //////////////////////////////////////////////////////////////////////////////////
  148. function script F_Rand {
  149. return getarg(rand(getargcount()));
  150. }
  151. //////////////////////////////////////////////////////////////////////////////////
  152. // Returns 1st argument if female, 2nd argument if male.
  153. // -- callfunc "F_Sex",argFemale,argMale
  154. // Example:
  155. // mes callfunc("F_Sex","What a beautiful lady!","What a handsome man!");
  156. //////////////////////////////////////////////////////////////////////////////////
  157. function script F_SexMes {
  158. return getarg(Sex);
  159. }
  160. //////////////////////////////////////////////////////////////////////////////////
  161. // Returns random "hello" and "goodbye" messages.
  162. // -- callfunc "F_Hi"
  163. // -- callfunc "F_Bye"
  164. //////////////////////////////////////////////////////////////////////////////////
  165. function script F_Hi {
  166. return callfunc("F_Rand","Hi!","Hello!","Good day!","How are you?","Hello there.");
  167. }
  168. function script F_Bye {
  169. return callfunc("F_Rand","Bye. See you again.","Later.","Goodbye.","Good luck!","Have a nice day!","Byebye!!!");
  170. }
  171. //////////////////////////////////////////////////////////////////////////////////
  172. // Returns expanded item name string.
  173. // -- callfunc "F_ItemName",<item ID>,{<element>{,<VVS meter 0..3>{,<refine rate>}}}
  174. // Elements: 0=none, 1=Ice, 2=Earth, 3=Fire, 4=Wind
  175. // Example:
  176. // // Displays "Show me your ^000090+5 VVS Fire Knife^000000..."
  177. // mes "Show me your "+callfunc("F_ItemName",1201,1,2,5)+"...";
  178. //////////////////////////////////////////////////////////////////////////////////
  179. function script F_ItemName {
  180. if (getarg(3,0))
  181. set .@t$,"+"+getarg(3)+" ";
  182. switch (getarg(2,0)) {
  183. case 0: break;
  184. case 1: set .@t$,.@t$+"VS "; break;
  185. case 2: set .@t$,.@t$+"VVS "; break;
  186. case 3: set .@t$,.@t$+"VVVS "; break;
  187. default: set .@t$,.@t$+getarg(2)+"xVS "; break;
  188. }
  189. switch (getarg(1,0)) {
  190. case 0: break;
  191. case 1: set .@t$,.@t$+"Ice "; break;
  192. case 2: set .@t$,.@t$+"Earth "; break;
  193. case 3: set .@t$,.@t$+"Fire "; break;
  194. case 4: set .@t$,.@t$+"Wind "; break;
  195. default: set .@t$,.@t$+"Strange "; break;
  196. }
  197. return "^000090"+.@t$+getitemname(getarg(0))+"^000000";
  198. }
  199. //////////////////////////////////////////////////////////////////////////////////
  200. // Stores learnt quest skills as variables ADV_QSK and ADV_QSK2.
  201. // -- callfunc "F_SaveQuestSkills"
  202. //
  203. // Restores learnt 1st class quest skills.
  204. // -- callfunc "F_Load1Skills"
  205. //
  206. // Restores learnt 2nd class quest skills.
  207. // -- callfunc "F_Load2Skills"
  208. //////////////////////////////////////////////////////////////////////////////////
  209. function script F_SaveQuestSkills {
  210. set ADV_QSK,0; set ADV_QSK2,0;
  211. //1st classes quest skills
  212. for(set .@i, 0; .@i < 14; set .@i, .@i + 1){
  213. if(getskilllv(144+.@i)) set ADV_QSK,ADV_QSK|pow(2,.@i);
  214. }
  215. //2nd classes quest skills
  216. for(set .@i, 0; .@i < 19; set .@i, .@i + 1){
  217. if(getskilllv(1001+.@i)) set ADV_QSK2,ADV_QSK2|pow(2,.@i);
  218. }
  219. return;
  220. }
  221. function script F_Load1Skills {
  222. for(set .@i, 0; .@i < 14; set .@i, .@i + 1){
  223. if(ADV_QSK|pow(2,.@i) == ADV_QSK) skill 144+.@i,1,0;
  224. }
  225. set ADV_QSK,0; //Clear var
  226. return;
  227. }
  228. function script F_Load2Skills {
  229. for(set .@i, 0; .@i < 19; set .@i, .@i + 1){
  230. if(ADV_QSK2|pow(2,.@i) == ADV_QSK2) skill 1001+.@i,1,0;
  231. }
  232. set ADV_QSK2,0; //Clear var
  233. return;
  234. }
  235. //////////////////////////////////////////////////////////////////////////////////
  236. // Returns weapon type, based on view.
  237. // -- callfunc "F_GetWeaponType",<weapon ID>
  238. //
  239. // Returns equipment type, based on equip location.
  240. // -- callfunc "F_GetArmorType",<item ID>
  241. //////////////////////////////////////////////////////////////////////////////////
  242. function script F_GetWeaponType {
  243. switch(getiteminfo(getarg(0),11)) {
  244. case 1: return "Dagger"; break;
  245. case 2: return "One-handed Sword"; break;
  246. case 3: return "Two-handed Sword"; break;
  247. case 4: return "One-handed Spear"; break;
  248. case 5: return "Two-handed Spear"; break;
  249. case 6: return "One-handed Axe"; break;
  250. case 7: return "Two-handed Axe"; break;
  251. case 8: return "Mace"; break;
  252. //case 9: return "Unused"; break;
  253. case 10: return "Staff"; break;
  254. case 11: return "Bow"; break;
  255. case 12: return "Knuckle"; break;
  256. case 13: return "Instrument"; break;
  257. case 14: return "Whip"; break;
  258. case 15: return "Book"; break;
  259. case 16: return "Katar"; break;
  260. case 17: return "Revolver"; break;
  261. case 18: return "Rifle"; break;
  262. case 19: return "Gatling gun"; break;
  263. case 20: return "Shotgun"; break;
  264. case 21: return "Grenade Launcher"; break;
  265. case 22: return "Shuriken"; break;
  266. default: return "Unknown Weapon"; break;
  267. }
  268. end;
  269. }
  270. function script F_GetArmorType {
  271. switch(getiteminfo(getarg(0),5)) {
  272. case 001: return "Lower Headgear"; break;
  273. case 2: return callfunc("F_GetWeaponType",getarg(0)); 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 136: return "Accessory"; break; //8+128
  281. case 256: return "Upper Headgear"; break;
  282. case 512: return "Middle Headgear"; break;
  283. case 1024: return "Costume Upper Headgear"; break;
  284. case 2048: return "Costume Midle Headgear"; break;
  285. case 4096: return "Costume Lower Headgear"; break;
  286. case 8192: return "Costume Garment"; break;
  287. case 32768: return "Ammo"; break;
  288. case 65536: return "Shadow Armor"; break;
  289. case 131072: return "Shadow Weapon"; break;
  290. case 262144: return "Shadow Shield"; break;
  291. case 524288: return "Shadow Shoes"; break;
  292. case 1048576: return "Shadow Accessory"; break;
  293. case 2097152: return "Shadow Accessory"; break;
  294. case 3145728: return "Shadow Accessory"; break; //1048576+2097152
  295. default: return "Unknown Equip"; break;
  296. }
  297. end;
  298. }
  299. //////////////////////////////////////////////////////////////////////////////////
  300. // Returns time remaining in a readable format.
  301. // The argument is subtracted from UNIX epoch time, or 'gettimetick(2)'.
  302. // -- callfunc "Time2Str",<tick in UNIX epoch time>
  303. // Example:
  304. // // Displays "Time left: 1 day, 1 hour, 8 minutes, 20 seconds"
  305. // set .@Timer, gettimetick(2) + 90500;
  306. // mes "Time left: " + callfunc("Time2Str",.@Timer);
  307. //////////////////////////////////////////////////////////////////////////////////
  308. function script Time2Str {
  309. set .@Time_Left, getarg(0) - gettimetick(2);
  310. set .@Days, .@Time_Left / 86400;
  311. set .@Time_Left, .@Time_Left - (.@Days * 86400);
  312. set .@Hours, .@Time_Left / 3600;
  313. set .@Time_Left, .@Time_Left - (.@Hours * 3600);
  314. set .@Minutes, .@Time_Left / 60;
  315. set .@Time_Left, .@Time_Left - (.@Minutes * 60);
  316. set .@Time$, "";
  317. if( .@Days > 1 )
  318. set .@Time$, .@Time$ + .@Days + " days, ";
  319. else if( .@Days > 0 )
  320. set .@Time$, .@Time$ + .@Days + " day, ";
  321. if( .@Hours > 1 )
  322. set .@Time$, .@Time$ + .@Hours + " hours, ";
  323. else if( .@Hours > 0 )
  324. set .@Time$, .@Time$ + .@Hours + " hour, ";
  325. if( .@Minutes > 1 )
  326. set .@Time$, .@Time$ + .@Minutes + " minutes, ";
  327. else if( .@Minutes > 0 )
  328. set .@Time$, .@Time$ + .@Minutes + " minute, ";
  329. if( .@Time_Left > 1 || .@Time_Left == 0 )
  330. set .@Time$, .@Time$ + .@Time_Left + " seconds";
  331. else if( .@Time_Left == 1 )
  332. set .@Time$, .@Time$ + .@Time_Left + " second";
  333. return .@Time$;
  334. }
  335. //////////////////////////////////////////////////////////////////////////////////
  336. // Checks if equipment has been swapped (i.e. via hacks).
  337. // The function checks the current equipment at a position against the supplied
  338. // values, and logs any mismatches.
  339. // Returns 0 if match, 1 if mismatch.
  340. // -- callfunc "F_IsEquipIDHack",<equip position>,<equip ID>
  341. // -- callfunc "F_IsEquipRefineHack",<equip position>,<refine>
  342. // -- callfunc "F_IsEquipCardHack",<equip position>,<card 0>,<card 1>,<card 2>,<card 3>
  343. //////////////////////////////////////////////////////////////////////////////////
  344. function script F_IsEquipIDHack {
  345. set .@id_chk, getequipid(getarg(0));
  346. set .@id, getarg(1);
  347. if (.@id != .@id_chk) {
  348. logmes "Hack: Tried to swap equip " + getitemname(.@id) + " for " + getitemname(.@id_chk) + ".";
  349. return 1;
  350. }
  351. return 0;
  352. }
  353. function script F_IsEquipRefineHack {
  354. set .@refine_chk, getequiprefinerycnt(getarg(0));
  355. set .@refine, getarg(1);
  356. if (.@refine != .@refine_chk) {
  357. logmes "Hack: Tried to swap equip with refine +" + .@refine + " for +" + .@refine_chk + ".";
  358. return 1;
  359. }
  360. return 0;
  361. }
  362. function script F_IsEquipCardHack {
  363. set .@pos, getarg(0);
  364. for (set .@i,0; .@i < 4; set .@i, .@i+1) {
  365. set .@card, getarg(.@i + 1);
  366. set .@card_chk, getequipcardid(.@pos, .@i);
  367. if (.@card != .@card_chk) {
  368. logmes "Hack: Tried to swap card " + getitemname(.@card) + " for " + getitemname(.@card_chk) + ".";
  369. return 1;
  370. }
  371. }
  372. return 0;
  373. }
  374. //////////////////////////////////////////////////////////////////////////////////
  375. // Functions for text manipulation [Euphy]
  376. //////////////////////////////////////////////////////////////////////////////////
  377. //////////////////////////////////////////////////////////////////////////////////
  378. // Returns the plural of a noun - works in most cases, but not for everything!
  379. // -- callfunc "F_GetPlural","<noun>"{,<0:normal/1:uppercase>}
  380. // Examples:
  381. // callfunc("F_GetPlural","dog") // returns "dogs"
  382. // callfunc("F_GetPlural","fox",1) // returns "FOXES"
  383. // callfunc("F_GetPlural","knife") // returns "knives"
  384. // callfunc("F_GetPlural","Piece of Cake") // returns "Pieces of Cake"
  385. //
  386. // Returns the plural of a noun if the given number is not 1.
  387. // -- callfunc "F_InsertPlural",<number>,"<noun>"{,<0:normal/1:uppercase>{,"<format string>"}}
  388. // Format string uses sprintf(), and MUST contain %d (arg0) and %s (arg1), in that order.
  389. // Examples:
  390. // callfunc("F_InsertPlural",1,"dog") // returns "1 dog"
  391. // callfunc("F_InsertPlural",3,"fox",1) // returns "3 FOXES"
  392. // // returns "^FF00005^000000 knives"
  393. // callfunc("F_InsertPlural",5,"knife",0,"^FF0000%d^000000 %s")
  394. //////////////////////////////////////////////////////////////////////////////////
  395. function script F_GetPlural {
  396. set .@str$, getarg(0);
  397. if (countstr(.@str$," ")) { // multiple words
  398. explode(.@tmp$,.@str$," ");
  399. set .@size, getarraysize(.@tmp$);
  400. // if format is "... of|in|on ...", pluralize preceding word; else pluralize last word
  401. if (compare(.@str$," of ") || compare(.@str$," in ") || compare(.@str$," on ")) {
  402. for (set .@i,1; .@i<.@size; set .@i,.@i+1) {
  403. if (getstrlen(.@tmp$[.@i]) == 2 && compare("of|in|on",.@tmp$[.@i]))
  404. break;
  405. set .@index, .@index + 1;
  406. }
  407. } else
  408. set .@index, .@size - 1;
  409. set .@str$, .@tmp$[.@index];
  410. set .@tmp$[.@index],"%s";
  411. set .@format$, implode(.@tmp$," ");
  412. } else
  413. set .@format$, "%s";
  414. set .@strlen, getstrlen(.@str$);
  415. if (.@strlen < 3) // prevent errors
  416. return ((getarg(1,0)) ? strtoupper(sprintf(.@format$,.@str$)) : sprintf(.@format$,.@str$));
  417. setarray .@suffix$[0], charat(.@str$,.@strlen - 1), substr(.@str$,.@strlen - 2,.@strlen - 1);
  418. if (!compare("abcdefghijklmnopqrstuvwxyz",.@suffix$[0])) { // last character is not a letter
  419. set .@result$, .@str$;
  420. }
  421. // common exceptions --> singular form == plural form
  422. else if (compare("fish|glasses|sunglasses|clothes|boots|shoes|greaves|sandals|wings|ears",.@str$)) {
  423. set .@result$, .@str$;
  424. }
  425. // ends in -s, -x, -z, -ch, -sh --> add -es
  426. else if (.@suffix$[0] == "s" || .@suffix$[0] == "x" || .@suffix$[0] == "z" ||
  427. .@suffix$[1] == "ch" || .@suffix$[1] == "sh") {
  428. set .@result$, .@str$ + "es";
  429. }
  430. // ends in -f, -fe --> remove -f, -fe --> add -ves
  431. else if ((.@suffix$[0] == "f" || .@suffix$[1] == "fe") && .@suffix$[1] != "ff") {
  432. if (compare("belief|cliff|chief|dwarf|grief|gulf|proof|roof",.@str$))
  433. set .@result$, .@str$ + "s"; // exceptions --> add -s
  434. else
  435. set .@result$, substr(.@str$,0,.@strlen - 2 - (.@suffix$[1] == "fe")) + "ves";
  436. }
  437. // ends in consonant + -y --> remove -y --> add -ies
  438. else if (.@suffix$[0] == "y" && !compare("aeiou",charat(.@suffix$[1],0))) {
  439. set .@result$, delchar(.@str$,.@strlen - 1) + "ies";
  440. }
  441. // ends in -o --> exceptions --> add -es
  442. else if (.@suffix$[0] == "o" &&
  443. compare("buffalo|domino|echo|grotto|halo|hero|mango|mosquito|potato|tomato|tornado|torpedo|veto|volcano",.@str$)) {
  444. set .@result$, .@str$ + "es";
  445. }
  446. // default --> add -s
  447. else {
  448. set .@result$, .@str$ + "s";
  449. }
  450. return ((getarg(1,0)) ? strtoupper(sprintf(.@format$,.@result$)) : sprintf(.@format$,.@result$));
  451. }
  452. function script F_InsertPlural {
  453. return sprintf(getarg(3,"%d %s"), getarg(0), ((getarg(0) == 1) ? getarg(1) : callfunc("F_GetPlural",getarg(1),getarg(2,0))));
  454. }
  455. //////////////////////////////////////////////////////////////////////////////////
  456. // Returns 'a' or 'an' based on a word.
  457. // -- callfunc "F_GetArticle","<noun>";
  458. // Examples:
  459. // callfunc("F_GetArticle","Apple") // returns "an"
  460. // callfunc("F_GetArticle","dog") // returns "a"
  461. //
  462. // Returns 'a' or 'an' based on a word, followed by the word.
  463. // -- callfunc "F_InsertArticle","<word>"{,<0:lowercase a/1:uppercase A>}
  464. // Examples:
  465. // callfunc("F_InsertArticle","Apple") // returns "an Apple"
  466. // callfunc("F_InsertArticle","dog",1) // returns "A dog"
  467. //////////////////////////////////////////////////////////////////////////////////
  468. function script F_GetArticle {
  469. set .@str$, strtolower(getarg(0));
  470. // not a word
  471. if (!charisalpha(.@str$,0))
  472. return "a";
  473. // 1-letter words
  474. if (getstrlen(.@str$) == 1) {
  475. if (strpos("aefhilmnorsx",.@str$) > -1)
  476. return "an";
  477. else
  478. return "a";
  479. }
  480. // special cases
  481. if (preg_match("(euler|hour(?!i)|heir|honest|hono)",.@str$))
  482. return "an";
  483. // consonants
  484. if (preg_match("^[^aeiouy]",.@str$))
  485. return "a";
  486. // special vowel forms
  487. if (preg_match("^e[uw]",.@str$) || preg_match("^onc?e\b",.@str$) || preg_match("^uni([^nmd]|mo)",.@str$) || preg_match("^u[bcfhjkqrst][aeiou]",.@str$))
  488. return "a";
  489. if (preg_match("^ut[th]",.@str$))
  490. return "an";
  491. // special capitals (rare)
  492. //if (preg_match("^U[NK][AIEO]?",getarg(0)))
  493. // return "a";
  494. // vowels
  495. if (preg_match("^[aeiou]",.@str$))
  496. return "an";
  497. // y... (rare)
  498. //if (preg_match("^(y(b[lor]|cl[ea]|fere|gg|p[ios]|rou|tt))",.@str$))
  499. // return "an";
  500. return "a";
  501. }
  502. function script F_InsertArticle {
  503. set .@article$, callfunc("F_GetArticle",getarg(0));
  504. return sprintf("%s %s", ((getarg(1,0)) ? replacestr(.@article$,"a","A") : .@article$), getarg(0));
  505. }
  506. //////////////////////////////////////////////////////////////////////////////////
  507. // Returns a number with commas between every three digits.
  508. // -- callfunc "F_InsertComma",<number>
  509. // Examples:
  510. // callfunc("F_InsertComma",7777777) // returns "7,777,777"
  511. //////////////////////////////////////////////////////////////////////////////////
  512. function script F_InsertComma {
  513. set .@str$, getarg(0);
  514. for (set .@i,getstrlen(.@str$)-3; .@i>0; set .@i,.@i-3)
  515. set .@str$, insertchar(.@str$,",",.@i);
  516. return .@str$;
  517. }
  518. //////////////////////////////////////////////////////////////////////////////////
  519. // Returns a number with a '-st', '-nd', '-rd', or '-th' suffix.
  520. // -- callfunc "F_GetNumSuffix",<number>
  521. // Examples:
  522. // callfunc("F_GetNumSuffix",1) // returns "1st"
  523. // callfunc("F_GetNumSuffix",11) // returns "11th"
  524. // callfunc("F_GetNumSuffix",32) // returns "32nd"
  525. //////////////////////////////////////////////////////////////////////////////////
  526. function script F_GetNumSuffix {
  527. set .@n, getarg(0);
  528. set .@mod, .@n % 10;
  529. if (.@mod == 1 && .@n != 11) return .@n+"st";
  530. else if (.@mod == 2 && .@n != 12) return .@n+"nd";
  531. else if (.@mod == 3 && .@n != 13) return .@n+"rd";
  532. else return .@n+"th";
  533. }
  534. //////////////////////////////////////////////////////////////////////////////////
  535. // Indicate if attached player can open storage
  536. //////////////////////////////////////////////////////////////////////////////////
  537. function script F_CanOpenStorage {
  538. return (!basicskillcheck() || !(getskilllv("NV_BASIC") < 6 && getskilllv("SU_BASIC_SKILL") < 1));
  539. }
  540. //////////////////////////////////////////////////////////////////////////////////
  541. // Indicate if attached player can advance to class 1 by checking
  542. // basic skill level 9.
  543. //////////////////////////////////////////////////////////////////////////////////
  544. function script F_CanChangeJob {
  545. return (!basicskillcheck() || getskilllv("NV_BASIC") > 8);
  546. }