Difference between revisions of "Echo"

From Scriptwiki
Jump to: navigation, search
 
m (Added @window to param list. Linked see also to aline)
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
Prints text in the specified window using the specified color.
 
Prints text in the specified window using the specified color.
  /echo [color] [-cdeghiNtsaqlbfnmr] [color name] [#channel|[=]nick] <text>
+
  /echo [color] [-cdeghiNtsaqlbfnmr] [color name] [#channel|[=]nick|@window] <text>
<table>
 
<tr><td><b>Switch</b></td><td><b>Meaning</b></td></tr>
 
<tr><td>s</td><td>If a channel/nickname isn't specified, it echoes to the status window.</td></tr>
 
<tr><td>d</td><td>If a channel/nickname isn't specified, it echoes to the single message window.</td></tr>
 
<tr><td>a</td><td>If a channel/nickname isn't specified, it echoes to the active window.</td></tr>
 
<tr><td>e</td><td>Encloses the line in the line spearators.</td></tr>
 
<tr><td>iN</td><td>Indents the wrapped line by N characters.</td></tr>
 
<tr><td>h</td><td>Forces lines to hard-wrap so resizing the window doesn't change the line.</td></tr>
 
<tr><td>t</td><td>Prefixes the line with a timestamp if global time stamping is on or timestamping is on for that window.</td></tr>
 
<tr><td>q</td><td>Makes it not display the text if called from an alias using the . prefix.</td></tr>
 
<tr><td>l</td><td>Makes it apply the highlight settings to the line that's displayed.</td></tr>
 
<tr><td>bf</td><td>Make it apply the beep/flash settings in the window it is echoing to.</td></tr>
 
<tr><td>n</td><td>Prevents the echo from hiliting the window switchbar icon.</td></tr>
 
<tr><td>m</td><td>Indicates that the line should be treated as a user message, not an event.</td></tr>
 
<tr><td>g</td><td>Prevents the line from being logged to the log file.</td></tr>
 
<tr><td>r</td><td>Applies the strip settings in the messages dialog.</td></tr>
 
<tr><td>c</td><td>Uses the specified color name from the colors dialog.</td></tr>
 
</table>
 
  
'''Note''' that this text is only displayed in your own window and isn't sent to the server.
+
{| style="width:100%"
 +
|-
 +
| style="width:10%" | '''''Switch''''' || style="width:90%" | '''''Meaning'''''
 +
|-
 +
| s      || If a channel/nickname isn't specified, it echoes to the status window.
 +
|-
 +
| d      || If a channel/nickname isn't specified, it echoes to the single message window.
 +
|-
 +
| a      || If a channel/nickname isn't specified, it echoes to the active window.
 +
|-
 +
| e      || Encloses the line in the line spearators.
 +
|-
 +
| iN    || Indents the wrapped line by N characters.
 +
|-
 +
| h      || Forces lines to hard-wrap so resizing the window doesn't change the line.
 +
|-
 +
| t      || Prefixes the line with a timestamp if global time stamping is on or timestamping is on for that window.
 +
|-
 +
| q      || Makes it not display the text if called from an alias using the . prefix.
 +
|-
 +
| l      || Makes it apply the highlight settings to the line that's displayed.
 +
|-
 +
| bf    || Make it apply the beep/flash settings in the window it is echoing to.
 +
|-
 +
| n      || Prevents the echo from hiliting the window switchbar icon.
 +
|-
 +
| m      || Indicates that the line should be treated as a user message, not an event.
 +
|-
 +
| g      || Prevents the line from being logged to the log file.
 +
|-
 +
| r      || Applies the strip settings in the messages dialog.
 +
|-
 +
| c      || Uses the specified color name from the colors dialog.
 +
|}
 +
 
 +
* '''Note''' that this text is only displayed in your own window and isn't sent to the server.
  
 
== Example ==
 
== Example ==
Line 27: Line 44:
 
  /echo -sb moo
 
  /echo -sb moo
 
This will print moo to the status window and applies the beep setting in the window.
 
This will print moo to the status window and applies the beep setting in the window.
  /echo 0,1 -g #help.script moo
+
  /echo 0 -g #help.script moo
This will print moo to the #help.script channel window in white on black background with preventing it from logging to the log file.
+
This will print moo to the #help.script channel window in white with preventing it from logging to the log file.
 +
/.echo -q hello
 +
This will not print anything (because of the "." and -q switch).
  
 
== See Also ==
 
== See Also ==
Take a look on [[Custom Windows]] to see how to print text to it.
+
* [[How do I customize mIRC's own output|How do I customize mIRC's own output]] by using echo at category [[:Category:Tutorials|Tutorials]].
 +
* [[Custom Windows]] to see how to print text to it.
 +
* [[Control_Codes]] for more information about colors.
 +
* [[Aline]] as an alternative to adding lines to custom windows
 +
 
 
[[Category:Commands]]
 
[[Category:Commands]]
 
 
{{Stub}}
 

Latest revision as of 20:28, 6 October 2008

Prints text in the specified window using the specified color.

/echo [color] [-cdeghiNtsaqlbfnmr] [color name] [#channel|[=]nick|@window] <text>
Switch Meaning
s If a channel/nickname isn't specified, it echoes to the status window.
d If a channel/nickname isn't specified, it echoes to the single message window.
a If a channel/nickname isn't specified, it echoes to the active window.
e Encloses the line in the line spearators.
iN Indents the wrapped line by N characters.
h Forces lines to hard-wrap so resizing the window doesn't change the line.
t Prefixes the line with a timestamp if global time stamping is on or timestamping is on for that window.
q Makes it not display the text if called from an alias using the . prefix.
l Makes it apply the highlight settings to the line that's displayed.
bf Make it apply the beep/flash settings in the window it is echoing to.
n Prevents the echo from hiliting the window switchbar icon.
m Indicates that the line should be treated as a user message, not an event.
g Prevents the line from being logged to the log file.
r Applies the strip settings in the messages dialog.
c Uses the specified color name from the colors dialog.
  • Note that this text is only displayed in your own window and isn't sent to the server.

Example

/echo -a moo

This will print moo to the active window.

/echo -sb moo

This will print moo to the status window and applies the beep setting in the window.

/echo 0 -g #help.script moo

This will print moo to the #help.script channel window in white with preventing it from logging to the log file.

/.echo -q hello

This will not print anything (because of the "." and -q switch).

See Also