WoWInterface SVN RaidWatch2
[/] [trunk/] [RaidWatch/] [Documentation/] [files/] [Callback_plugin_MPB.html] - Rev 22
Compare with Previous | Blame | View Log
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<title>Reference</title>
<link rel="stylesheet" href="../luadoc.css" type="text/css" />
<!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<div id="navigation">
<h1>LuaDoc</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<!-- Module list -->
<!-- File list -->
<h1>Files</h1>
<ul>
<li>
<a href="../files/Callback_Core.html">Callback_Core.lua</a>
</li>
<li>
<a href="../files/Callback_Options.html">Callback_Options.lua</a>
</li>
<li>
<a href="../files/Callback_plugin_Bars.html">Callback_plugin_Bars.lua</a>
</li>
<li>
<a href="../files/Callback_plugin_Direction.html">Callback_plugin_Direction.lua</a>
</li>
<li>
<a href="../files/Callback_plugin_Flash.html">Callback_plugin_Flash.lua</a>
</li>
<li><strong>Callback_plugin_MPB.lua</strong></li>
<li>
<a href="../files/Callback_plugin_Message.html">Callback_plugin_Message.lua</a>
</li>
<li>
<a href="../files/Callback_plugin_RangeCheck.html">Callback_plugin_RangeCheck.lua</a>
</li>
<li>
<a href="../files/Callback_plugin_Warning.html">Callback_plugin_Warning.lua</a>
</li>
</ul>
</div> <!-- id="navigation" -->
<div id="content">
<h1>File <code>Callback_plugin_MPB.lua</code></h1>
<h2>Functions</h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#MPBExternal">MPBExternal</a> (event, id, func, anchorID, markers, icon)</td>
<td class="summary">Show a frame that is updated from an external function.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#MPBExternalHide">MPBExternalHide</a> (event, id)</td>
<td class="summary">Hide a frame that is updated from external function.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#MPBHealthByID">MPBHealthByID</a> (event, id, anchorID, markers, icon)</td>
<td class="summary">Show a health frame that tracks CID, GUID or UID for its health status.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#MPBHealthHideByID">MPBHealthHideByID</a> (event, id)</td>
<td class="summary">Hide a health frame by ID.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#MPBPowerByID">MPBPowerByID</a> (event, id, anchorID, markers, icon)</td>
<td class="summary">Show a power farme that tracks CID, GUID or UID for its power status.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#MPBPowerHideByID">MPBPowerHideByID</a> (event, id)</td>
<td class="summary">ide a power frame by ID.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#MPBSpellStackAura">MPBSpellStackAura</a> (event, id, spell, maxStacks, anchorID, buffType, markers, icon)</td>
<td class="summary">Show a frame that tracks stacks by Aura.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#MPBSpellStackCombat">MPBSpellStackCombat</a> (event, id, spells, maxStacks, anchorID, markers, icon)</td>
<td class="summary">Show frame that tracks stacks by monitoring the combat log.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#MPBSpellStackHide">MPBSpellStackHide</a> (event, id)</td>
<td class="summary">Hide a frame that is tracking spell stacks by aura or combat log.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
Parameters in <em class="OptionalParam">red</em> are optional.
<dl class="function">
<dt><a name="MPBExternal"></a><strong>MPBExternal</strong> (event, id, func, anchorID, markers, icon)</dt>
<dd>
Show a frame that is updated from an external function.
<h3>Parameters:</h3>
<ul>
<li>
<em >id</em> (string): A unique ID for the bar to interact with it later.
</li>
<li>
<em >func</em> (function): The function that returns the values, the function must return: current, max, name. Where name is the name showing up on the frame.
</li>
<li>
<em class="OptionalParam">anchorID</em> (string): The anchor that the frame should show up on, The default one will be selected if none passed or if not found.
</li>
<li>
<em class="OptionalParam">markers</em> (table): This table sets the markers on the bar, each marker in the table should be a number between 0-100 representing the percentage.
</li>
<li>
<em class="OptionalParam">icon</em> (string): Texture path to the icon to use, if none passed, no icon will be shown.
</li>
</ul>
<h3>Usage:</h3>
<ul><pre class=example>RW.Callbacks:Fire("MPBExternal", "SomeUpdater", function() return currentStacks, maxStacks, "Spell of Doom!" end, nil, nil, select(3, GetSpellInfo(35356)))</pre></ul>
</dd>
<dt><a name="MPBExternalHide"></a><strong>MPBExternalHide</strong> (event, id)</dt>
<dd>
Hide a frame that is updated from external function.
<h3>Parameters:</h3>
<ul>
<li>
<em >id</em> (string): The unique ID set when showing the frame.
</li>
</ul>
<h3>Usage:</h3>
<ul><pre class=example>RW.Callbacks:Fire("MPBExternalHide", "SomeUpdater")</pre></ul>
</dd>
<dt><a name="MPBHealthByID"></a><strong>MPBHealthByID</strong> (event, id, anchorID, markers, icon)</dt>
<dd>
Show a health frame that tracks CID, GUID or UID for its health status.
<h3>Parameters:</h3>
<ul>
<li>
<em >id</em> (numbe|string): The creature ID, global unique ID or Uint ID to track.
</li>
<li>
<em class="OptionalParam">anchorID</em> (string): The name of the anchor where the frame should show up. If said anchor does not exist the default one will be used.
</li>
<li>
<em class="OptionalParam">markers</em> (table): This table sets the markers on the bar, each marker in the table should be a number between 0-100 representing the percentage.
</li>
<li>
<em class="OptionalParam">icon</em> (string): Texture path to the icon to use, overrides 3D-model and unit texture.
</li>
</ul>
<h3>Usage:</h3>
<ul><pre class=example>RW.Callbacks:Fire("MPBHealthByID", "0xF130007F1E002489", nil, {75, 25})</pre></ul>
</dd>
<dt><a name="MPBHealthHideByID"></a><strong>MPBHealthHideByID</strong> (event, id)</dt>
<dd>
Hide a health frame by ID.
<h3>Parameters:</h3>
<ul>
<li>
<em >id</em> (number|string): The CID, GUID or UID to the frame to hide.
</li>
</ul>
<h3>Usage:</h3>
<ul><pre class=example>RW.Callbacks:Fire("MPBHealthHideByID", "0xF130007F1E002489")</pre></ul>
</dd>
<dt><a name="MPBPowerByID"></a><strong>MPBPowerByID</strong> (event, id, anchorID, markers, icon)</dt>
<dd>
Show a power farme that tracks CID, GUID or UID for its power status.
<h3>Parameters:</h3>
<ul>
<li>
<em >id</em> (numbe|string): The creature ID, global unique ID or Uint ID to track.
</li>
<li>
<em class="OptionalParam">anchorID</em> (string): The name of the anchor where the frame should show up. If said anchor does not exist the default one will be used.
</li>
<li>
<em class="OptionalParam">markers</em> (table): This table sets the markers on the bar, each marker in the table should be a number between 0-100 representing the percentage.
</li>
<li>
<em class="OptionalParam">icon</em> (string): Texture path to the icon to use, overrides 3D-model and unit texture.
</li>
</ul>
<h3>Usage:</h3>
<ul><pre class=example>RW.Callbacks:Fire("MPBPowerByID", "boss1", nil, {75, 25})</pre></ul>
</dd>
<dt><a name="MPBPowerHideByID"></a><strong>MPBPowerHideByID</strong> (event, id)</dt>
<dd>
ide a power frame by ID.
<h3>Parameters:</h3>
<ul>
<li>
<em >id</em> (number|string): The CID, GUID or UID to the frame to hide.
</li>
</ul>
<h3>Usage:</h3>
<ul><pre class=example>RW.Callbacks:Fire("MPBPowerHideByID", "boss1")</pre></ul>
</dd>
<dt><a name="MPBSpellStackAura"></a><strong>MPBSpellStackAura</strong> (event, id, spell, maxStacks, anchorID, buffType, markers, icon)</dt>
<dd>
Show a frame that tracks stacks by Aura.
<h3>Parameters:</h3>
<ul>
<li>
<em >id</em> (numbe|string): The creature ID, global unique ID or Uint ID to track.
</li>
<li>
<em >spell</em> (number): The spell to track stacks for.
</li>
<li>
<em >maxStacks</em> (number): The number of maximum stacks this spell can have, used for presentation.
</li>
<li>
<em class="OptionalParam">anchorID</em> (string): The anchor that the frame should show up on, The default one will be selected if none passed or if not found.
</li>
<li>
<em class="OptionalParam">buffType</em> (string): "HARMFULL" or "HELPFULL". "HARMFULL" is the default if non passed.
</li>
<li>
<em class="OptionalParam">markers</em> (table): This table sets the markers on the bar, each marker in the table should be a number between 0-100 representing the percentage.
</li>
<li>
<em class="OptionalParam">icon</em> (string): Texture path to the icon to use, if none passed the icon for the spell will be used.
</li>
</ul>
<h3>Usage:</h3>
<ul><pre class=example>RW.Callbacks:Fire("MPBSpellStackAura", "boss1", 22455, 10, nil, "HARMFULL")</pre></ul>
</dd>
<dt><a name="MPBSpellStackCombat"></a><strong>MPBSpellStackCombat</strong> (event, id, spells, maxStacks, anchorID, markers, icon)</dt>
<dd>
Show frame that tracks stacks by monitoring the combat log.
<h3>Parameters:</h3>
<ul>
<li>
<em >id</em> (numbe|string): The creature ID, global unique ID or Uint ID to track.
</li>
<li>
<em >spells</em> (number|table): The spell(s) to track stacks for. Pass several if its can be different spell IDs for the same spell (heroic and normal mode spells).
</li>
<li>
<em class="OptionalParam">anchorID</em> (string): The anchor that the frame should show up on, The default one will be selected if none passed or if not found.
</li>
<li>
<em class="OptionalParam">markers</em> (table): This table sets the markers on the bar, each marker in the table should be a number between 0-100 representing the percentage.
</li>
<li>
<em class="OptionalParam">icon</em> (string): Texture path to the icon to use, if none passed the icon for the spell will be used.
</li>
</ul>
<h3>Usage:</h3>
<ul><pre class=example>RW.Callbacks:Fire("MPBSpellStackCombat", "boss1", {24255, 24256}, 10, nil, {20, 80})</pre></ul>
</dd>
<dt><a name="MPBSpellStackHide"></a><strong>MPBSpellStackHide</strong> (event, id)</dt>
<dd>
Hide a frame that is tracking spell stacks by aura or combat log.
<h3>Parameters:</h3>
<ul>
<li>
<em >id</em> (number|string): The CID, GUID or UID to the frame to hide.
</li>
</ul>
<h3>Usage:</h3>
<ul><pre class=example>RW.Callbacks:Fire("MPBSpellStackHide", "boss1")</pre></ul>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
WoWInterface
AddOn Sites
© 2004 - 2022 MMOUI
vBulletin © 2024, Jelsoft Enterprises Ltd