WoW:API ChangeChatColor: Difference between revisions

WoW:API ChangeChatColor (source)

325 bytes removed , 25 December 2006

m

__NOTOC__

Anonymous user

@@ Line 1: / Line 1: @@
-<center>'''ChangeChatColor''' ''-Documentation by [[user:Farmbuyer|Farmbuyer]]-''</center>
+{{wowapi}} __NOTOC__
+Changes the text color of the specified chat channel.  The "color wheel" popup calls this function to do the actual work, once the user is done with the popup.
   ChangeChatColor("channelname", red, green, blue);
-Changes the text color of the specified chat channel.  The "color wheel" popup
+==Parameters==
-calls this function to do the actual work, once the user is done with the popup.
+===Arguments===
-Note that the RGB values are fractions from 0 to 1.
-----
-;''Arguments''
-:(String "channelname", Number red, Number blue, Number green)
 :;channelname : String - Name of the channel as given in chat-cache.txt files.
-:;red, blue, green : Number - RGB values (as stored in chat-cache.txt divided by 255).
+:;red, blue, green : Number - RGB values (0-1, floats).
-----
-;''Returns''
-:unknown
-:;nil
-Current calls in Blizzard files make no use of a return function.
-----
-;''Example''
+==Example==
   ChangeChatColor("CHANNEL1", 255/255, 192/255, 192/255);
+===Result===
+Reset the General channel to the default (255,192,192, slightly off-white) color.
-would reset the General channel to the default (255,192,192, slightly off-white) color.
+==See Also==
+* [[API FontString SetTextColor|FontString:SetTextColor()]].
-See also [[API FontString SetTextColor|FontString:SetTextColor()]].
-----
-{{WoW API}}