WoWInterface SVN RaidWatch2

[/] [trunk/] [RaidWatch/] [Documentation/] [files/] [Callback_plugin_Direction.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><strong>Callback_plugin_Direction.lua</strong></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>
                <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_Direction.lua</code></h1>







<h2>Functions</h2>
<table class="function_list">

        <tr>
        <td class="name" nowrap><a href="#DirectionHide">DirectionHide</a>&nbsp;(event, id)</td>
        <td class="summary">Hides one specific arrow </td>
        </tr>

        <tr>
        <td class="name" nowrap><a href="#DirectionHideAll">DirectionHideAll</a>&nbsp;(event)</td>
        <td class="summary">Hides all current direction arrows.</td>
        </tr>

        <tr>
        <td class="name" nowrap><a href="#DirectionReached">DirectionReached</a>&nbsp;(event, id)</td>
        <td class="summary">Triggered when the target is reached, or when out of danager range if away was set </td>
        </tr>

        <tr>
        <td class="name" nowrap><a href="#DirectionToNameOrUnit">DirectionToNameOrUnit</a>&nbsp;(event, id, uID, tName, away, extra, icon)</td>
        <td class="summary">Shows a direction arrow towards a unit or a player by name </td>
        </tr>

        <tr>
        <td class="name" nowrap><a href="#DirectionToPosition">DirectionToPosition</a>&nbsp;(event, id, x, y, away, extra, icon)</td>
        <td class="summary">Shows a direction arrow towards a point.</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="DirectionHide"></a><strong>DirectionHide</strong>&nbsp;(event, id)</dt>
<dd>
Hides one specific arrow


<h3>Parameters:</h3>
<ul>
        
        <li>
          <em >id</em> (string): The ID of the arrow that should be hidden.
        </li>
        
</ul>








</dd>




<dt><a name="DirectionHideAll"></a><strong>DirectionHideAll</strong>&nbsp;(event)</dt>
<dd>
Hides all current direction arrows.


<h3>Parameters:</h3>
<ul>
        
</ul>








</dd>




<dt><a name="DirectionReached"></a><strong>DirectionReached</strong>&nbsp;(event, id)</dt>
<dd>
Triggered when the target is reached, or when out of danager range if away was set


<h3>Parameters:</h3>
<ul>
        
        <li>
          <em >id</em> (string): The identification of the direction that was reached.
        </li>
        
</ul>








</dd>




<dt><a name="DirectionToNameOrUnit"></a><strong>DirectionToNameOrUnit</strong>&nbsp;(event, id, uID, tName, away, extra, icon)</dt>
<dd>
Shows a direction arrow towards a unit or a player by name


<h3>Parameters:</h3>
<ul>
        
        <li>
          <em >id</em> (string): Identofication of the arrow, used when interacting with the arrow later, (hiding).
        </li>
        
        <li>
          <em >uID</em> (string): A unit indetifier to wich the arrow should point. Have to be a unit within your party, (party1..n or raid1..n).
        </li>
        
        <li>
          <em class="OptionalParam">tName</em> (string): Secondary way of finding the target, if no uID or an incorrect uID is supplied it will try and find the uID from this name.
        </li>
        
        <li>
          <em class="OptionalParam">away</em> (number): A number representing the safe distance, that is when the distance to the target is greater then away it will be greem else fade towards red the closer the target is. If nill is passed the arrow will point towards the target instead.
        </li>
        
        <li>
          <em class="OptionalParam">extra</em> (string|number): String or SpellID that will be used to put an extra tag to the arrow, if it is a spellID the icon will also be used.
        </li>
        
        <li>
          <em class="OptionalParam">icon</em> (string|number): Texture path or spellID.
        </li>
        
</ul>




<h3>Usage:</h3>
<ul><pre class=example>RW.Callbacks:Fire("DirectionToNameOrUnit", arrow1, raid5, nil, 24323)</pre></ul>





</dd>




<dt><a name="DirectionToPosition"></a><strong>DirectionToPosition</strong>&nbsp;(event, id, x, y, away, extra, icon)</dt>
<dd>
Shows a direction arrow towards a point.


<h3>Parameters:</h3>
<ul>
        
        <li>
          <em >id</em> (string): Identofication of the arrow, used when interacting with the arrow later, (hiding).
        </li>
        
        <li>
          <em >x</em> (number): The X position.
        </li>
        
        <li>
          <em >y</em> (number): The Y position.
        </li>
        
        <li>
          <em class="OptionalParam">away</em> (number): A number representing the safe distance, that is when the distance to the target is greater then away it will be greem else fade towards red the closer the target is. If nill is passed the arrow will point towards the target instead.
        </li>
        
        <li>
          <em class="OptionalParam">extra</em> (string|number): String or SpellID that will be used to put an extra tag to the arrow, if it is a spellID the icon will also be used.
        </li>
        
        <li>
          <em class="OptionalParam">icon</em> (string|number): Texture path or spellID.
        </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>

Compare with Previous | Blame