WoWInterface SVN RaidWatch2

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







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

        <tr>
        <td class="name" nowrap><a href="#MessageShow">MessageShow</a>&nbsp;(event, text, r, g, b, a, icon, sound, module)</td>
        <td class="summary">Show a new message as popup </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="MessageShow"></a><strong>MessageShow</strong>&nbsp;(event, text, r, g, b, a, icon, sound, module)</dt>
<dd>
Show a new message as popup


<h3>Parameters:</h3>
<ul>
        
        <li>
          <em >text</em> (string): The text to be shown
        </li>
        
        <li>
          <em class="OptionalParam">r</em> (number): Red component to the color
        </li>
        
        <li>
          <em class="OptionalParam">g</em> (number): Green component to the color
        </li>
        
        <li>
          <em class="OptionalParam">b</em> (number): Blue component to the color
        </li>
        
        <li>
          <em class="OptionalParam">a</em> (number): Alpha component to the color
        </li>
        
        <li>
          <em class="OptionalParam">icon</em> (string): Texture to be used as the icon for the message.
        </li>
        
        <li>
          <em class="OptionalParam">sound</em> (string): Sound clip to play when showing the message (LSM name).
        </li>
        
        <li>
          <em class="OptionalParam">module</em> (plugin|bossmod): If output to chatframe is enabled, the message will prefix the message with the given plugin/boss.
        </li>
        
</ul>




<h3>Usage:</h3>
<ul><pre class=example>RW.Callbacks:Fire("MessageShow", "Hurry Up!", nil, nil, nil, nil, "Bell", RW:GetBoss("Freya"))</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>

Compare with Previous | Blame