Editing mirc/on events/on text

The '''on text''' event is a mIRC event that triggers when a remote user (I.E. not the local user) receives a channel or a query message.

== Synopsis ==
<source lang="mIRC">
on <level>:text:<matchtext>:<target>:<commands>
</source>

== Level ==
* '''<level>''' - The appropriate [[access levels - mIRC|access level]] for the event.

== Matchtext ==

A '''<matchtext>''' is a text pattern that mIRC will use to compare with something. Inside the on text event, the matchtext parameter is every user message. In general, there is only one matchtext parameter per event, you can also find matchtext parameter in others area of the mIRC scripting language, like in the {{mIRC|/filter}} command for example. An event only triggers if its matchtext parameter matches the appropriate data (user message, notice and server message etc..)

=== Wildcard text pattern ===
The matchtext can contain wild characters: 
* * - matches any text
* ? - matches any single letter
* & - matches any single word

For Example: 
* !test - the matchtext will only match if the ONLY word is "!test"
* !test* - the matchtext will match if the text starts with "!test"
* *!test - the matchtext will match if the text ends with the word "!test"
* *!test* - the matchtext will match any text that has "!test" in it (anywhere)
* !test & - the matchtext will match any text that start with the word test !test and his only followed by a second word

=== The basic text pattern ===
The most basic on text event is the normal wildcard pattern:

<syntaxhighlight lang="mIRC">on *:text:!help:#:{
  notice $nick For Help just state your question and pastebin any relevant code.
}</syntaxhighlight>

Sometimes we want to get the user's input. We can use the & to match a single word (in this case it will be a name, although it doesn't matter)

<syntaxhighlight lang="mIRC">on *:text:!color &:?:{
  var %color = $gettok(white black red blue brown yellow orange green, $rand(1, 8), 32)
  msg $chan $2's random color is: %color $+ .
}</syntaxhighlight>

=== RegEx text pattern ===
The matchtext parameter can also be a Regular Expression Pattern by using the {{mIRC|Access levels#Level_prefixes|'$' event prefix}}. 

Example:

<syntaxhighlight lang="mIRC">on $*:text:/^!test$/i:#:{
  msg $chan Test Worked!
}</syntaxhighlight>

=== Dynamic text pattern ===
Text matched patterns can also be dynamic, for example your name at the time of the execution ($me), a variable or time. In order for mIRC to know to evaluate the expression, it must be enclosed by the $() identifier. 

Example:

<syntaxhighlight lang="mIRC">on *:text:$(*slaps $me $+ *):#:{
  describe $chan Slaps $nick with dried-up sandwich!
}</syntaxhighlight>

Or 

<syntaxhighlight lang="mIRC">on *:text:$(!example * $+ %match $+ *):#:{
  describe $chan This is an example, $+ $nick $+ !
}</syntaxhighlight>

If the entire match text pattern contains a SINGLE variable, the $() is not required, this technique can also be used for any other parameter of an event. 

Example:

<syntaxhighlight lang="mIRC">;Assume %text is set to !cool
on *:text:%text:#:{
  msg $chan I am the coolest! 
}</syntaxhighlight>

It is also possible to use regular expressions with dynamic match text.

<syntaxhighlight lang="mIRC">on $*:text:$(/^!slaps $me $+ /Si):#:{
  describe $chan Slaps $nick with dried-up sandwich!
}</syntaxhighlight>

== Target ==
The target parameter of the event defines the locations of where the event can be triggered from. For example, the on text event can be triggered by a channel message or by a query.

* ? - defines query location
* # - defines channel location
* * - defines both query and channel locations
* %var - A variable containing a channel or a list of channels is also acceptable 

Example:

<syntaxhighlight lang="mIRC">;let %chan equal #mSL,#help,#supprt
on *:text:!hi:%chan:{
  notice $nick Hello!
}</syntaxhighlight>

== See also==
* [[List of on events - mIRC|List of on events]]
* [[List of identifiers - mIRC|List of identifiers]]
* [[List of commands - mIRC|List of commands]]

{{DEFAULTSORT:text, on mIRC}}
{{mIRC on event list}}

[[Category:MIRC on events|text]]