WoWInterface SVN RaidWatch2
[/] [trunk/] [RaidWatch/] [Documentation/] [files/] [Callback_plugin_RangeCheck.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>
<a href="../files/Callback_plugin_MPB.html">Callback_plugin_MPB.lua</a>
</li>
<li>
<a href="../files/Callback_plugin_Message.html">Callback_plugin_Message.lua</a>
</li>
<li><strong>Callback_plugin_RangeCheck.lua</strong></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_RangeCheck.lua</code></h1>
<h2>Functions</h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#RangeCheckFilterAddIcon">RangeCheckFilterAddIcon</a> (event, clearOld, ...)</td>
<td class="summary">Add icons to the raid mark filter.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#RangeCheckFilterAddName">RangeCheckFilterAddName</a> (event, clearOld, ...)</td>
<td class="summary">Add names tot he name filter </td>
</tr>
<tr>
<td class="name" nowrap><a href="#RangeCheckFilterClasses">RangeCheckFilterClasses</a> (event, turnOn)</td>
<td class="summary">Toggle class filter.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#RangeCheckFilterClear">RangeCheckFilterClear</a> (event)</td>
<td class="summary">Clear the current filtering settings.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#RangeCheckFilterIcons">RangeCheckFilterIcons</a> (event, turnOn)</td>
<td class="summary">Toggle the raid icon filter.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#RangeCheckFilterNames">RangeCheckFilterNames</a> (event, turnOn)</td>
<td class="summary">Toggle name filter.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#RangeCheckFilterRemoveName">RangeCheckFilterRemoveName</a> (event, ...)</td>
<td class="summary">Remove names from the name filter.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#RangeCheckHide">RangeCheckHide</a> (event, forced)</td>
<td class="summary">Hide the range check window </td>
</tr>
<tr>
<td class="name" nowrap><a href="#RangeCheckShow">RangeCheckShow</a> (event, show, range, force)</td>
<td class="summary">Shows the range check window </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="RangeCheckFilterAddIcon"></a><strong>RangeCheckFilterAddIcon</strong> (event, clearOld, ...)</dt>
<dd>
Add icons to the raid mark filter.
<h3>Parameters:</h3>
<ul>
<li>
<em >clearOld</em> (boolean): If true the the old raid mark filter will be cleared.
</li>
<li>
<em >...</em> (strings|numbers): Icons to be added to the filter, if passed strings they should be the upercase names (STAR, MOON...), else the number representing the mark.
</li>
</ul>
</dd>
<dt><a name="RangeCheckFilterAddName"></a><strong>RangeCheckFilterAddName</strong> (event, clearOld, ...)</dt>
<dd>
Add names tot he name filter
<h3>Parameters:</h3>
<ul>
<li>
<em >clearOld</em> (boolean): If true then the old name filter will be cleared.
</li>
<li>
<em >...</em> (strings): Names that should be added tot he filter.
</li>
</ul>
</dd>
<dt><a name="RangeCheckFilterClasses"></a><strong>RangeCheckFilterClasses</strong> (event, turnOn)</dt>
<dd>
Toggle class filter.
<h3>Parameters:</h3>
<ul>
<li>
<em >turnOn</em> (boolean): True to turn the filter on, false to turn off.
</li>
</ul>
</dd>
<dt><a name="RangeCheckFilterClear"></a><strong>RangeCheckFilterClear</strong> (event)</dt>
<dd>
Clear the current filtering settings. Note that the filter will not be cleared if the lock is set to true.
<h3>Parameters:</h3>
<ul>
</ul>
</dd>
<dt><a name="RangeCheckFilterIcons"></a><strong>RangeCheckFilterIcons</strong> (event, turnOn)</dt>
<dd>
Toggle the raid icon filter.
<h3>Parameters:</h3>
<ul>
<li>
<em >turnOn</em> (boolean): True to turn the filter on, false to turn off.
</li>
</ul>
</dd>
<dt><a name="RangeCheckFilterNames"></a><strong>RangeCheckFilterNames</strong> (event, turnOn)</dt>
<dd>
Toggle name filter.
<h3>Parameters:</h3>
<ul>
<li>
<em >turnOn</em> (boolean): True to turn the filter on, false to turn off.
</li>
</ul>
</dd>
<dt><a name="RangeCheckFilterRemoveName"></a><strong>RangeCheckFilterRemoveName</strong> (event, ...)</dt>
<dd>
Remove names from the name filter.
<h3>Parameters:</h3>
<ul>
<li>
<em >...</em> (strings): Names that should be removed.
</li>
</ul>
</dd>
<dt><a name="RangeCheckHide"></a><strong>RangeCheckHide</strong> (event, forced)</dt>
<dd>
Hide the range check window
<h3>Parameters:</h3>
<ul>
<li>
<em class="OptionalParam">forced</em> (boolean): If true then the lock or no autohide options will be overridden, mainly used for slash command.
</li>
</ul>
</dd>
<dt><a name="RangeCheckShow"></a><strong>RangeCheckShow</strong> (event, show, range, force)</dt>
<dd>
Shows the range check window
<h3>Parameters:</h3>
<ul>
<li>
<em >show</em> (boolean): If true the window will fade in, else fade out (if auto hide lock is not enabled)
</li>
<li>
<em class="OptionalParam">range</em> (number): The range the range check should be set to when shown, if not supplied the last used value will be used.
</li>
<li>
<em class="OptionalParam">force</em> (boolean): Will override the locked state of the range check, mainly used for slash command since that is then set manual and should not be prevented by the lock.
</li>
</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