This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
mashlib [2021/05/08 17:35] – masshirodev | mashlib [2021/12/25 22:01] (current) – masshirodev | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | A collection of useful | + | ===== MashLib ===== |
- | + | A collection of useful | |
- | Feel free to use them for your personal stuff! | + | |
==== Support ==== | ==== Support ==== | ||
- | If you need support with this library or just wanna chat, join my [[https:// | + | If you need support with this library or just wanna chat, join my [Discord Server](https:// |
==== Structure ==== | ==== Structure ==== | ||
- | |||
- | Updated on 08-05-2021. | ||
- | |||
<code lua> | <code lua> | ||
MashLib = { | MashLib = { | ||
Helpers, -- Helpful stuff | Helpers, -- Helpful stuff | ||
System, -- FFXIV related stuff (servers, regions, etc) | System, -- FFXIV related stuff (servers, regions, etc) | ||
- | Powershell, -- Powershell related | + | Powershell, -- Powershell related |
- | Space, -- Spatial related stuff | + | |
Character, -- Character related stuff | Character, -- Character related stuff | ||
API, -- API Requests | API, -- API Requests | ||
Crafting, -- Crafting related stuff | Crafting, -- Crafting related stuff | ||
Gathering, -- Gathering related stuff | Gathering, -- Gathering related stuff | ||
- | Logging, -- In-dept logging | ||
Misc, -- Temporary values | Misc, -- Temporary values | ||
Battle, -- Battle related stuff | Battle, -- Battle related stuff | ||
+ | Hacks, -- Useful hacks | ||
Hunt, -- The Hunt related stuff | Hunt, -- The Hunt related stuff | ||
- | | + | |
+ | Space, -- 2D and 3D space related stuff | ||
} | } | ||
</ | </ | ||
+ | ==== API ==== | ||
=== Helpers === | === Helpers === | ||
<code lua> | <code lua> | ||
Line 35: | Line 32: | ||
@return {string} | @return {string} | ||
]] | ]] | ||
- | MashLib.Helpers.GetTime(type) | + | function |
+ | |||
+ | --[[ | ||
+ | Get current date | ||
+ | @param {type} type ' | ||
+ | @return {string} | ||
+ | ]] | ||
+ | function MashLib.Helpers.GetDate(type) | ||
--[[ | --[[ | ||
Line 42: | Line 46: | ||
@return {int} | @return {int} | ||
]] | ]] | ||
- | MashLib.Helpers.TimeSince(time) | + | function |
--[[ | --[[ | ||
Line 49: | Line 53: | ||
@returns {table} | @returns {table} | ||
]] | ]] | ||
- | MashLib.Helpers.GetKeyInfo(key) | + | function |
--[[ | --[[ | ||
Line 57: | Line 61: | ||
@returns {string} | @returns {string} | ||
]] | ]] | ||
- | MashLib.Helpers.GetMapName(id, | + | function |
--[[ | --[[ | ||
Line 64: | Line 68: | ||
@returns {int} | @returns {int} | ||
]] | ]] | ||
- | MashLib.Helpers.ToFixed(float, | + | function |
--[[ | --[[ | ||
Line 71: | Line 75: | ||
@returns {int} | @returns {int} | ||
]] | ]] | ||
- | MashLib.Helpers.SizeOf(tbl) | + | function |
--[[ | --[[ | ||
Line 78: | Line 82: | ||
@returns {int} | @returns {int} | ||
]] | ]] | ||
- | MashLib.Helpers.HandleCoolDowns(time) | + | function |
--[[ | --[[ | ||
Line 85: | Line 89: | ||
@returns {int} | @returns {int} | ||
]] | ]] | ||
- | MashLib.Helpers.GetMax(tbl) | + | function |
--[[ | --[[ | ||
Line 92: | Line 96: | ||
@returns {int} | @returns {int} | ||
]] | ]] | ||
- | MashLib.Helpers.GetMin(tbl) | + | function |
--[[ | --[[ | ||
Line 98: | Line 102: | ||
@returns {table} | @returns {table} | ||
]] | ]] | ||
- | MashLib.Helpers.GetNormalizationTable() | + | function |
--[[ | --[[ | ||
Line 104: | Line 108: | ||
@returns {table} | @returns {table} | ||
]] | ]] | ||
- | MashLib.Helpers.GetSpecialCharTable() | + | function |
--[[ | --[[ | ||
Line 112: | Line 116: | ||
@returns {string} | @returns {string} | ||
]] | ]] | ||
- | MashLib.Helpers.Normalize(string, | + | function |
--[[ | --[[ | ||
Line 119: | Line 123: | ||
@returns {string} | @returns {string} | ||
]] | ]] | ||
- | MashLib.Helpers.GetFileNameFromPath(path) | + | function |
--[[ | --[[ | ||
Line 125: | Line 129: | ||
@param {string} inputstr | @param {string} inputstr | ||
@param {string} separator | @param {string} separator | ||
+ | @param {string} datatype | ||
@returns {string} | @returns {string} | ||
]] | ]] | ||
- | MashLib.Helpers.SplitString(inputstr, | + | function |
+ | |||
+ | --[[ | ||
+ | Join table into a string | ||
+ | @param {string} delimiter | ||
+ | @param {table} table | ||
+ | @returns {table} | ||
+ | ]] | ||
+ | function MashLib.Helpers.Join(delimiter, | ||
--[[ | --[[ | ||
Line 135: | Line 148: | ||
@returns {string} | @returns {string} | ||
]] | ]] | ||
- | MashLib.Helpers.LimitLength(string, | + | function |
--[[ | --[[ | ||
Line 142: | Line 155: | ||
@returns {boolean} | @returns {boolean} | ||
]] | ]] | ||
- | MashLib.Helpers.ValidateEmail(str) | + | function |
+ | |||
+ | --[[ | ||
+ | Returns the percentage of a value | ||
+ | @param {number} percent | ||
+ | @param {number} value | ||
+ | @returns {number} | ||
+ | ]] | ||
+ | function MashLib.Helpers.PercentOf(percent, | ||
+ | |||
+ | --[[ | ||
+ | Removes a value from a table | ||
+ | @param {table} table | ||
+ | @param {string} value | ||
+ | @returns {table} | ||
+ | ]] | ||
+ | function MashLib.Helpers.RemoveByValue(table, | ||
+ | |||
+ | --[[ | ||
+ | Gets a key/value from a value | ||
+ | @param {table} table | ||
+ | @param {string} value | ||
+ | @param {boolean} keyonly | ||
+ | @returns {table} | ||
+ | ]] | ||
+ | function MashLib.Helpers.GetByValue(table, | ||
+ | |||
+ | --[[ | ||
+ | Formats a number with commas | ||
+ | @param {string} number | ||
+ | @returns {string} | ||
+ | ]] | ||
+ | function MashLib.Helpers.FormatNumber(number) | ||
+ | |||
+ | --[[ | ||
+ | Escapes slashes / | ||
+ | @param {string} string | ||
+ | ]] | ||
+ | function MashLib.Helpers.EscapeSlash(string) | ||
+ | |||
+ | --[[ | ||
+ | Returns the first entry in a table | ||
+ | @param {table} table | ||
+ | @param {bool} key | ||
+ | ]] | ||
+ | function MashLib.Helpers.First(table, | ||
+ | |||
+ | --[[ | ||
+ | Returns the last entry in a table | ||
+ | @param {table} table | ||
+ | @param {bool} key | ||
+ | ]] | ||
+ | function MashLib.Helpers.Last(table, | ||
+ | |||
+ | --[[ | ||
+ | Returns the table without empty key/ | ||
+ | @param {table} table | ||
+ | @return {table} | ||
+ | ]] | ||
+ | function MashLib.Helpers.DeleteEmpty(table) | ||
+ | |||
+ | --[[ | ||
+ | Returns a table without the key/value passed | ||
+ | @param {table} table | ||
+ | @param {string} key | ||
+ | @return {table} | ||
+ | ]] | ||
+ | function MashLib.Helpers.DeleteByKey(table, | ||
+ | |||
+ | --[[ | ||
+ | Returns a table without the key/value passed | ||
+ | @param {table} table | ||
+ | @param {any} value | ||
+ | @return {table} | ||
+ | ]] | ||
+ | function MashLib.Helpers.DeleteByValue(table, | ||
+ | |||
+ | --[[ | ||
+ | Returns minion' | ||
+ | @param {int} questId | ||
+ | @return {int} | ||
+ | ]] | ||
+ | function MashLib.Helpers.GetMinionQuestId(questId) | ||
</ | </ | ||
Line 151: | Line 247: | ||
@returns {Table} | @returns {Table} | ||
]] | ]] | ||
- | MashLib.System.GetCommonKeys() | + | function |
--[[ | --[[ | ||
Line 158: | Line 254: | ||
@returns {table} | @returns {table} | ||
]] | ]] | ||
- | MashLib.System.GetServer(id) | + | function |
--[[ | --[[ | ||
Line 165: | Line 261: | ||
@returns {table} | @returns {table} | ||
]] | ]] | ||
- | MashLib.System.GetChannelList() | + | function |
--[[ | --[[ | ||
Line 171: | Line 267: | ||
@returns {table} | @returns {table} | ||
]] | ]] | ||
- | MashLib.System.GetChannel(id) | + | function |
--[[ | --[[ | ||
Line 178: | Line 274: | ||
@returns {string} | @returns {string} | ||
]] | ]] | ||
- | MashLib.System.GetRegion(id) | + | function |
--[[ | --[[ | ||
Line 185: | Line 281: | ||
@returns {string} | @returns {string} | ||
]] | ]] | ||
- | MashLib.System.GetJob(id) | + | function |
--[[ | --[[ | ||
Line 192: | Line 288: | ||
@returns {int} | @returns {int} | ||
]] | ]] | ||
- | MashLib.System.GetJobId(name) | + | function |
--[[ | --[[ | ||
Line 199: | Line 295: | ||
@returns {int} | @returns {int} | ||
]] | ]] | ||
- | MashLib.System.GetJobList(dominion) | + | function |
--[[ | --[[ | ||
Line 205: | Line 301: | ||
@returns {boolean} | @returns {boolean} | ||
]] | ]] | ||
- | MashLib.System.CheckLogin() | + | function |
--[[ | --[[ | ||
- | Get current | + | |
+ | @returns {boolean} | ||
+ | ]] | ||
+ | function MashLib.System.IsLoading() | ||
+ | |||
+ | --[[ | ||
+ | | ||
@param {string} name | @param {string} name | ||
@return {int} | @return {int} | ||
]] | ]] | ||
- | MashLib.System.GetMapId(name) | + | function |
--[[ | --[[ | ||
Line 219: | Line 321: | ||
@return {table} | @return {table} | ||
]] | ]] | ||
- | MashLib.System.GetMap(id) | + | function |
--[[ | --[[ | ||
Line 226: | Line 328: | ||
@return {variant} Code return | @return {variant} Code return | ||
]] | ]] | ||
- | MashLib.System.Require(filePath) | + | function |
--[[ | --[[ | ||
Line 233: | Line 335: | ||
@return {int} | @return {int} | ||
]] | ]] | ||
- | MashLib.System.GetMapIDFromTerritoryID(id) | + | function |
--[[ | --[[ | ||
Line 240: | Line 342: | ||
@return {table} | @return {table} | ||
]] | ]] | ||
- | MashLib.System.GetExpansionList(type) | + | function |
--[[ | --[[ | ||
Line 247: | Line 349: | ||
@return {table} | @return {table} | ||
]] | ]] | ||
- | MashLib.System.GetExpansionByID(expansionid) | + | function |
--[[ | --[[ | ||
Line 255: | Line 357: | ||
@return {table} | @return {table} | ||
]] | ]] | ||
- | MashLib.System.GetFilesInside(folder) | + | function |
+ | |||
+ | --[[ | ||
+ | Changes to and enables Assist Bot Mode | ||
+ | ]] | ||
+ | function MashLib.System.EnableAssistMode() | ||
+ | |||
+ | --[[ | ||
+ | Disables Bot Mode | ||
+ | ]] | ||
+ | function MashLib.System.TurnOffBotMode() | ||
+ | |||
+ | --[[ | ||
+ | Searchs for an action by Name | ||
+ | @param {int} type | ||
+ | @param {string} name | ||
+ | ]] | ||
+ | function MashLib.System.SearchAction(type, | ||
+ | |||
+ | --[[ | ||
+ | Searchs for an action by Id | ||
+ | @param {int} type | ||
+ | @param {int} id | ||
+ | ]] | ||
+ | function MashLib.System.SearchActionById(type, | ||
+ | |||
+ | --[[ | ||
+ | Searchs for an entity nearby | ||
+ | @param {int} contentId | ||
+ | ]] | ||
+ | function MashLib.System.FindEntityAroundPlayer(contentId) | ||
</ | </ | ||
Line 264: | Line 396: | ||
@param {string} path | @param {string} path | ||
]] | ]] | ||
- | MashLib.Powershell.ExecuteFile(path) | + | function |
--[[ | --[[ | ||
Line 271: | Line 403: | ||
@param {string} path on system | @param {string} path on system | ||
]] | ]] | ||
- | MashLib.Powershell.DownloadFile(url, | + | function |
--[[ | --[[ | ||
Line 277: | Line 409: | ||
@param {string} url | @param {string} url | ||
]] | ]] | ||
- | MashLib.Powershell.OpenLink(url) | + | function |
+ | |||
+ | --[[ | ||
+ | Executes a command on powershell | ||
+ | @param {string} command | ||
+ | ]] | ||
+ | function MashLib.Powershell.Execute(command) | ||
+ | |||
+ | --[[ | ||
+ | Plays a sound | ||
+ | @NOTE: Not yet implemented | ||
+ | ]] | ||
+ | function MashLib.Powershell.PlaySound() | ||
</ | </ | ||
- | === Space === | + | === Character |
<code lua> | <code lua> | ||
--[[ | --[[ | ||
- | | + | |
- | @param {table} | + | @return |
]] | ]] | ||
- | MashLib.Space.MoveTo(coords) | + | function |
--[[ | --[[ | ||
- | | + | |
+ | @return {table} | ||
]] | ]] | ||
- | MashLib.Space.Stop() | + | function |
--[[ | --[[ | ||
- | | + | |
- | Thanks | + | @param {int} aetheryteid |
- | @param {table} coords | + | |
- | @param {int} radius | + | |
- | @return {table} | + | |
]] | ]] | ||
- | MashLib.Space.RandomPosCloseToCoords(coords, radius) | + | function |
--[[ | --[[ | ||
- | | + | |
- | Thanks | + | @param {int} mapid |
- | @param | + | |
- | @param {table} pos2 | + | |
- | @param {bool} ignoreradius | + | |
- | @return | + | |
]] | ]] | ||
- | MashLib.Space.Distance2D(pos, pos2, ignoreradius) | + | function |
--[[ | --[[ | ||
- | | + | |
- | Thanks | + | @param {int} mapid |
- | @param | + | |
- | @param {table} pos2 | + | |
- | @param {bool} ignoreradius | + | |
- | @return | + | |
]] | ]] | ||
- | MashLib.Space.Distance3D(pos, pos2, ignoreradius) | + | function |
--[[ | --[[ | ||
- | | + | |
- | @param {int} territoryid | + | @return |
- | @param {table} world coords -> x, z | + | |
- | @param optinal {int} mapid | + | |
]] | ]] | ||
- | MashLib.Space.SetMapFlag(territoryid, | + | function |
--[[ | --[[ | ||
- | | + | |
- | @return | + | @param {int} id |
]] | ]] | ||
- | MashLib.Space.GetMapFlag() | + | function |
+ | </ | ||
+ | === Character.Inventory === | ||
+ | <code lua> | ||
--[[ | --[[ | ||
- | | + | |
- | @param | + | @param {int} id |
- | @param optional {bool} exact | + | @returns |
- | @return | + | ResultObject |
+ | .category | ||
+ | .uicategory | ||
+ | .searchcategory | ||
+ | .name | ||
+ | .max | ||
+ | .level | ||
+ | .requiredlevel | ||
+ | .canequip | ||
+ | .equipslot | ||
+ | .class | ||
+ | .price | ||
+ | .rarity | ||
+ | .isunique | ||
+ | .desynthvalue | ||
+ | .replairclassjob | ||
+ | .repairitem | ||
+ | .iscollectable | ||
+ | .isuntradeable | ||
+ | .isbinding | ||
]] | ]] | ||
- | MashLib.Space.WorldToMap(coords, exact) | + | function |
--[[ | --[[ | ||
- | | + | |
- | Thanks to Kali and Kitano <3 | + | @param {string} search |
- | @BUG! https:// | + | @param {string} norepeat |
- | @param {table} map coords | + | |
- | @param {int} scale | + | |
- | @return {table} | + | |
]] | ]] | ||
- | MashLib.Space.MapToWorld(coords, mapid) | + | function |
--[[ | --[[ | ||
- | | + | |
- | @param {int} mapid | + | @param {string} search |
- | @return {int} | + | @param {string} norepeat |
+ | @return {table} items | ||
]] | ]] | ||
- | MashLib.Space.GetMapScale(id) | + | function |
- | </ | + | |
- | === Character === | ||
- | <code lua> | ||
--[[ | --[[ | ||
- | Get the list of buffs on your character | + | Get item from inventory by Id if quantity == 1 |
+ | @param {string} id | ||
@return {table} | @return {table} | ||
]] | ]] | ||
- | MashLib.Character.GetBuffList() | + | function |
--[[ | --[[ | ||
- | | + | |
- | @param {int} aetheryteid | + | @param {string} |
+ | @param {string} norepeat | ||
+ | @return {table} | ||
]] | ]] | ||
- | MashLib.Character.TeleportTo(aetheryteid) | + | function |
--[[ | --[[ | ||
- | | + | |
- | @return | + | @param {string} inventory |
+ | @param {string} search | ||
+ | @param | ||
+ | @return {table} items | ||
]] | ]] | ||
- | MashLib.Character.IsCastingTeleport() | + | function |
--[[ | --[[ | ||
- | | + | |
- | @param {int} id | + | @param {int} inventory |
+ | @param {int} slot | ||
+ | @param {int} toinventory | ||
+ | @param {int} toslot | ||
]] | ]] | ||
- | MashLib.Character.SetMoveModeTo(id) | + | function |
+ | |||
+ | --[[ | ||
+ | Move an item object to another slot | ||
+ | @param {int} toinventory | ||
+ | @param {int} toslot | ||
+ | ]] | ||
+ | function MashLib.Character.Inventory.MoveObject(object, toinventory, | ||
</ | </ | ||
Line 396: | Line 561: | ||
@return {table} | @return {table} | ||
]] | ]] | ||
- | MashLib.API.GetEndpoint(name) | + | function |
</ | </ | ||
Line 406: | Line 571: | ||
@return {table} | @return {table} | ||
]] | ]] | ||
- | MashLib.Crafting.GetCondition(name) | + | function |
</ | </ | ||
=== Gathering === | === Gathering === | ||
+ | === Battle === | ||
<code lua> | <code lua> | ||
- | -- Nothing yet | + | --[[ |
+ | Get an encounter info by ID | ||
+ | @param {int} id | ||
+ | @return {table} | ||
+ | ]] | ||
+ | function MashLib.Battle.GetEncounter(id) | ||
+ | |||
+ | --[[ | ||
+ | Get a list of skills on a specific job | ||
+ | @param {int} job | ||
+ | @return {table} | ||
+ | ]] | ||
+ | function MashLib.Battle.GetSkillListByJobID(job) | ||
</ | </ | ||
- | === Logging | + | === Hacks === |
<code lua> | <code lua> | ||
--[[ | --[[ | ||
- | | + | |
- | @param {table} target | + | @param {int|nil} fly |
- | @return | + | @param {int|nil} walk |
+ | @param | ||
]] | ]] | ||
- | MashLib.Logging.Entity(target) | + | function |
</ | </ | ||
- | === Battle | + | === Hunt === |
<code lua> | <code lua> | ||
--[[ | --[[ | ||
- | Get an encounter info by ID | + | Get a mark's name by it's id |
- | @param {int} id | + | @param {string} expansion |
- | @return | + | @param {string} rank |
+ | @param {int} contentid | ||
+ | @retun {string} | ||
]] | ]] | ||
- | MashLib.Battle.GetEncounter(id) | + | function |
--[[ | --[[ | ||
- | Get encounter | + | Get mark list |
+ | @param {string} expansion | ||
+ | @param {string} rank | ||
+ | @retun {table} | ||
+ | ]] | ||
+ | function MashLib.Hunt.GetMarkList(expansion, | ||
+ | |||
+ | --[[ | ||
+ | Gets the mark list on a map | ||
+ | @param {int} mapid | ||
+ | @retun {table} | ||
+ | ]] | ||
+ | function MashLib.Hunt.GetMarkListOnMap(mapid) | ||
+ | |||
+ | --[[ | ||
+ | Gets the mark list per map | ||
+ | @param {string} option | to_combo | ||
+ | @retun {table} | ||
+ | ]] | ||
+ | function MashLib.Hunt.GetMarkListPerMap(option) | ||
+ | </ | ||
+ | |||
+ | === Space === | ||
+ | <code lua> | ||
+ | --[[ | ||
+ | Moves character to coords | ||
+ | @param {table} coords | ||
+ | ]] | ||
+ | function MashLib.Space.MoveTo(coords) | ||
+ | |||
+ | --[[ | ||
+ | Stops character from moving | ||
+ | ]] | ||
+ | function MashLib.Space.Stop() | ||
+ | |||
+ | --[[ | ||
+ | Get random coordinates around another coordinates, | ||
+ | Thanks to Kitanoi <3 | ||
+ | @param {table} coords | ||
+ | @param {int} radius | ||
@return {table} | @return {table} | ||
]] | ]] | ||
- | MashLib.Battle.GetEncounterList() | + | function |
--[[ | --[[ | ||
- | | + | |
- | @return {int} id | + | Thanks to Kali <3 |
+ | @param {table} pos | ||
+ | @param {table} pos2 | ||
+ | @param {bool} ignoreradius | ||
+ | @return {int} | ||
]] | ]] | ||
- | MashLib.Battle.GetLastCastID() | + | function |
--[[ | --[[ | ||
- | | + | |
- | @param {int} job | + | Thanks to Kali <3 |
- | @param {string} name | + | @param {table} pos |
- | @return {int} id | + | @param {table} pos2 |
+ | @param {bool} ignoreradius | ||
+ | @return {int} | ||
]] | ]] | ||
- | MashLib.Battle.GetSkillId(job, name) | + | function |
--[[ | --[[ | ||
- | | + | |
- | @param {int} job | + | @param {int} territoryid |
- | @param {id} id | + | @param {table} world coords -> x, z |
- | @return | + | @param optinal |
]] | ]] | ||
- | MashLib.Battle.GetSkillInfoById(job, id) | + | function |
--[[ | --[[ | ||
- | | + | |
- | @param {int} job | + | |
@return {table} | @return {table} | ||
]] | ]] | ||
- | MashLib.Battle.GetSkillListByJobID(job) | + | function |
--[[ | --[[ | ||
- | | + | |
- | @param {int} job | + | @param |
- | @param {boolean} to_combo | + | @param |
- | @param {int} specific job id | + | @param |
@return {table} | @return {table} | ||
]] | ]] | ||
- | MashLib.Battle.GetSkillListWithCD(to_combo, specific) | + | function |
- | </ | + | |
- | === Hunt === | ||
- | <code lua> | ||
--[[ | --[[ | ||
- | | + | |
- | | + | |
- | @param {string} rank | + | @param {table} map coords |
- | @param {int} contentid | + | @param {int} scale |
- | @retun {string} | + | @return |
]] | ]] | ||
- | MashLib.Hunt.GetMarkNameByID(expansion, rank, contentid) | + | function |
- | </ | + | |
- | === Hacks === | ||
- | <code lua> | ||
--[[ | --[[ | ||
- | | + | |
- | @param {int} fly | + | @param {int} mapid |
- | @param {int} walk | + | @return |
- | @param | + | |
]] | ]] | ||
- | MashLib.Hacks.Speed.Set(fly, walk, mount) | + | function |
+ | </ | ||
+ | === Logging === | ||
+ | <code lua> | ||
--[[ | --[[ | ||
- | | + | |
+ | @param {table} target | ||
+ | @return {table} | ||
]] | ]] | ||
- | MashLib.Hacks.Speed.Reset() | + | function |
</ | </ |