Difference between revisions of "Lua:BroadCastMessage"

From Fortress Forever Wiki
Jump to navigationJump to search
(New page: {{Infobox manual/Header}} ==BroadCastMessage== Sends a large text message to everyone on the server. ===Usage=== <pre>BroadCastMessage(message)</pre> ===Input=== message(string) the mes...)
 
m
 
Line 5: Line 5:
  
 
===Usage===
 
===Usage===
<pre>BroadCastMessage(message)</pre>
+
<pre>
 +
BroadCastMessage( message, duration )
 +
BroadCastMessage( message, duration, colorid )
 +
BroadCastMessage( message, duration, colorstring )</pre>
  
 
===Input===
 
===Input===
message(string) the message to display. Type in your own message, or use an entry from resource\FortressForever_english.txt
+
* message(string) the message to display. Type in your own message, or use an entry from resource\FortressForever_english.txt
 
+
* duration(int) number of seconds to display
 +
* colorid(int) preset colors. See [[Lua:Flags#Color]]
 +
* colorstring(string) An RGB color string, e.g. "255 255 255"
 
===Output===
 
===Output===
 
Returns nothing
 
Returns nothing
  
 
===Example===
 
===Example===
<pre>BroadCastMessage("Welcome to the greatest map evar!!1!")</pre>
+
<pre>BroadCastMessage("Welcome to the greatest map evar!!1!", 10, Color.kRed)</pre>
  
 
[[Category:Lua_Commands]]
 
[[Category:Lua_Commands]]
 
[[Category:Messages]]
 
[[Category:Messages]]
 
{{Infobox manual/Footer}}
 
{{Infobox manual/Footer}}

Latest revision as of 23:34, 15 February 2010


BroadCastMessage

Sends a large text message to everyone on the server.

Usage

BroadCastMessage( message, duration )
BroadCastMessage( message, duration, colorid )
BroadCastMessage( message, duration, colorstring )

Input

  • message(string) the message to display. Type in your own message, or use an entry from resource\FortressForever_english.txt
  • duration(int) number of seconds to display
  • colorid(int) preset colors. See Lua:Flags#Color
  • colorstring(string) An RGB color string, e.g. "255 255 255"

Output

Returns nothing

Example

BroadCastMessage("Welcome to the greatest map evar!!1!", 10, Color.kRed)