User Tools

Site Tools



mashlib

This is an old revision of the document!


Table of Contents

A collection of useful commands that are going to be necessary to run my future addons.

Structure

  MashLib = {
      Helpers, -- Helpful stuff
      System, -- FFXIV related stuff (servers, regions, etc)
      Character, -- Character related stuff
      API, -- API Requests
      Crafting, -- Crafting related stuff
      Gathering, -- Gathering related stuff
      Misc, -- Temporary values
      Battle, -- Battle related stuff
      Hacks -- Useful hacks
  }

A collection of useful commands that are going to be necessary to run my future addons.

Structure

MashLib = {
    Helpers, -- Helpful stuff
    System, -- FFXIV related stuff (servers, regions, etc)
    Character, -- Character related stuff
    API, -- API Requests
    Crafting, -- Crafting related stuff
    Gathering, -- Gathering related stuff
    Misc, -- Temporary values
    Battle, -- Battle related stuff
    Hacks -- Useful hacks
}

API

# Helpers
# Prints to the console (or file if enabled)
# log -> Text to log
# type -> string or block
MashLib.Helpers.Log(log, type)
# Returns the time
# type -> epoch or formatted
MashLib.Helpers.GetTime(type)
# Returns the time since
MashLib.Helpers.TimeSince(time)
# Plays a soung -- NOT YET IMPLEMENTED
MashLib.Helpers.PlaySound()
# Returns this keyboard key's info
MashLib.Helpers.GetKeyInfo(key)
# System
# Get an Encounter by ID
MashLib.Battle.GetEncounter(id)
# Get a Job by ID
MashLib.System.GetJob(id)
# Get the Job's ID by Name
MashLib.System.GetJobId(name)
# Get a Server by ID
MashLib.System.GetServer(id)
# Get a Region by Datacenter ID
MashLib.System.GetRegion(id)
# Returns the usable (most common) keys from keyboard
MashLib.System.GetUsableKeys()
# Character 
# Returns this character's buff list
MashLib.Character.GetBuffList()
# API
# Get the API's info by Name
MashLib.API.GetEndpoint(name)
# Crafting
# Gets a specific Condition's info by name, like it's name in chinese, per example.
MashLib.Crafting.GetCondition(name)
# Gathering
# Battle
# Gets the encounter's info by ID
MashLib.Battle.GetEncounter(id)
# Hacks
# Sets speed hacks
# Default values -> 20, 6, 9
MashLib.Hacks.SpeedHacks.Set(fly, walk, mount)
# Resets speed hacks to default values
MashLib.Hacks.SpeedHacks.Reset()
mashlib.1610108596.txt.gz · Last modified: 2021/01/08 12:23 by masshirodev