This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
argus [2021/01/16 00:43] – rikudou | argus [2021/07/14 21:11] (current) – rikudou | ||
---|---|---|---|
Line 6: | Line 6: | ||
Argus is an advanced mechanic detection library that can be incorporated into other addons. Offers useful API that can detect various mechanics across fights. | Argus is an advanced mechanic detection library that can be incorporated into other addons. Offers useful API that can detect various mechanics across fights. | ||
- | Please join my discord if you require support, you can also view other addons created that use Argus here: https:// | + | Please join my discord if you require support, you can also view other addons created that use Argus here |
**If you are a new user, please watch this video first:** https:// | **If you are a new user, please watch this video first:** https:// | ||
Line 25: | Line 25: | ||
====== Documentation ====== | ====== Documentation ====== | ||
- | //italics// = type, __underline__ = optional | + | API Reference: [[argusdocs]] |
- | ===== Detection Functions ===== | + | |
- | * **'' | + | |
- | * Returns //table GroundAOE// of current AOEs that are cast on the ground where each **key is the entityID** source, and value is the GroundAOE structure (listed below). These are **not** attached to an entity (they do not originate from an entity centerpoint). **Also returns AOEs before the telegraphs are drawn, and returns AOEs with no telegraphs.** | + | |
- | * **'' | + | |
- | * Returns //table DirectionalAOE// | + | |
- | * **'' | + | |
- | * Returns //table// where each key is //number// entityID and each value is //table// tether. The list is all active tethers/ | + | |
- | * **'' | + | |
- | * Registers //func// into marker func list, and //func// will get called any time there is an overhead marker added to an entity. Function //func// should be defined with the following arguments: '' | + | |
- | * **'' | + | |
- | * Registers //func// into entity cast func list. This func will get called any time the **server** sends a successful entity cast packet to the client. This means that this function is almost 100% reliable to use. Function //func// should be defined with the following arguments '' | + | |
- | * **'' | + | |
- | * Registers //func// into entity channel func list. This func will get called any time the **server** sends a packet to the client, that entity has begun channeling. This means that the function is almost 100% reliable to use. Function //func// should be defined with the following arguments '' | + | |
- | + | ||
- | ===== Draw Functions ===== | + | |
- | * **'' | + | |
- | * returns //table// with keys '' | + | |
- | + | ||
- | local rectWorld = { | + | |
- | topleft = RenderManager: | + | |
- | bottomleft = RenderManager: | + | |
- | topright = RenderManager: | + | |
- | bottomright = RenderManager: | + | |
- | }</ | + | |
- | * **'' | + | |
- | * Draws a filled circle at **world coordinates** with the specified radius in radians. //U32 Color// can be retrieved from the function GUI: | + | |
- | * **'' | + | |
- | * Draws a filled cone at **world coordinates** an arc angle of //angle// radians and a radius of //radius// radians. //U32 Color// can be retrieved from the function GUI: | + | |
- | * **'' | + | |
- | * Draws a filled rectangle at **world coordinates** with //length// and //width// rotated around the center point //x, y, z// in the direction of // | + | |
- | * **'' | + | |
- | * Draws a filled **torus** aka donut at **world coordinates** with an inner radius or // | + | |
- | * **'' | + | |
- | * Draws a filled rectangle at **world coordinates** with //length// and //width// rotated around the center point //x, y, z// in the direction of // | + | |
- | * **'' | + | |
- | * Adds a filled circle for specified time //timeout// in ms. Argument //rgbfill// is a table that consists of '' | + | |
- | * **'' | + | |
- | * Adds a rectangle at position for //timeout// ms. Argument //rgbfill// is a table that consists of '' | + | |
- | * **'' | + | |
- | * Adds a cone at position for //timeout// ms. Argument //rgbfill// is a table that consists of '' | + | |
- | * **'' | + | |
- | * Adds a filled donut (torus) for specified time //timeout// in ms. Argument //rgbfill// is a table that consists of '' | + | |
- | * **'' | + | |
- | * Adds a cross at position for //timeout// ms. Argument //rgbfill// is a table that consists of '' | + | |
- | * **'' | + | |
- | * Deletes timed draw with specified uuid. | + | |
- | + | ||
- | + | ||
- | ===== Structures ===== | + | |
- | * **'' | + | |
- | * '' | + | |
- | * Circle AOE. | + | |
- | * '' | + | |
- | * Directional Cone/arc AOE | + | |
- | * '' | + | |
- | * Directional Line AOE | + | |
- | * '' | + | |
- | * Meteor mechanic (more damage the closer you are to the center), usually unavoidable | + | |
- | * '' | + | |
- | * Line AOE that's targeted to either a position, or specific entity. Argus will adjust the length and heading automatically. | + | |
- | * '' | + | |
- | * Donut AOE | + | |
- | * '' | + | |
- | * Cross AOE (new type to shadowbringers, | + | |
- | + | ||
- | * **''// | + | |
- | * ''// | + | |
- | * x position of AOE | + | |
- | * ''// | + | |
- | * y position of AOE | + | |
- | * ''// | + | |
- | * z position of AOE | + | |
- | * ''// | + | |
- | * Animation/ | + | |
- | * ''// | + | |
- | * Length/ | + | |
- | * ''// | + | |
- | * Width in yalms of aoe (0 for circles and cones etc) | + | |
- | * ''// | + | |
- | * Name of AOE | + | |
- | * ''// | + | |
- | * Unique identifier of AOE | + | |
- | * ''// | + | |
- | * AOE cast type/shape. See Cast Types (above) for more info. | + | |
- | * ''// | + | |
- | * ID of entity that current aoe is attached to, if found. Value is //nil// otherwise. | + | |
- | * **''// | + | |
- | * ''// | + | |
- | * x position of AOE | + | |
- | * ''// | + | |
- | * y position of AOE | + | |
- | * ''// | + | |
- | * z position of AOE | + | |
- | * ''// | + | |
- | * Animation/ | + | |
- | * ''// | + | |
- | * Direction the AOE is facing. | + | |
- | * ''// | + | |
- | * Length of AOE | + | |
- | * ''// | + | |
- | * Width of AOE, mostly used for Line AOES. **0 for cones and circles** | + | |
- | * ''// | + | |
- | * Name of AOE | + | |
- | * ''// | + | |
- | * Unique identifier of AOE | + | |
- | * ''// | + | |
- | * AOE cast type/shape. See Cast Types (above) for more info. | + | |
- | * ''// | + | |
- | * ID of entity that current aoe is attached to, if found. Value is //nil// otherwise. | + | |
===== Known Overhead Marker Types ===== | ===== Known Overhead Marker Types ===== |