From WikiChip
Difference between revisions of "mirc/commands/halt"
< mirc‎ | commands

m (Bot: Adding a template)
m (Compatibility: add missing version)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{mIRC menu}}
+
{{mirc title|/halt Command}}
The '''/halt command''' can be used to immediately stop any further processing. If used from within an event or from within an alias that originated from an event. Other events in other script files will continue to execute unless they are prefixed with the '&' access prefix. In such events, the {{mIRC|$halted}} identifier will be {{mIRC|$true}}.
+
The '''/halt command''' can be used to immediately stop any further processing in a script. If used from within an event (from within an alias that originated from an event), others events in others scripts files are still processed. You can use the & prefix event to prevent an event from being processed if /halt or /haltdef has been used in a previous event, you can also check the {{mIRC|$halted}} identifier from the event without using the & event prefix, which will be {{mIRC|$true}}
 +
 
 +
'''Note''': /halt inside an event stop the default processing if you are using the ^ event prefix
  
 
== Synopsis ==
 
== Synopsis ==
Line 30: Line 32:
  
 
== Compatibility ==
 
== Compatibility ==
Added:
+
{{mIRC compatibility|4.5}}
  
 
== See also ==
 
== See also ==
Line 40: Line 42:
 
{{mIRC command list}}
 
{{mIRC command list}}
  
[[Category:MIRC commands]]
+
[[Category:mIRC commands|halt command - mIRC]]

Latest revision as of 20:55, 21 January 2024

The /halt command can be used to immediately stop any further processing in a script. If used from within an event (from within an alias that originated from an event), others events in others scripts files are still processed. You can use the & prefix event to prevent an event from being processed if /halt or /haltdef has been used in a previous event, you can also check the $halted identifier from the event without using the & event prefix, which will be $true

Note: /halt inside an event stop the default processing if you are using the ^ event prefix

Synopsis[edit]

/halt

Switches[edit]

None

Parameters[edit]

None

Example[edit]

; /halt_example
alias halt_example {
  echo -a Some echo!
  halt_example2
  echo -a This echo command will never execute
}
alias halt_example2 {
  echo -a Example 2!
  ; kill the script
  halt
}

Will output:

Some echo!
Example 2!

Compatibility[edit]

Added: mIRC v4.5
Added on: 30 Jun 1996
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.


See also[edit]

v · d · e mIRC commands list

A /abook, /action, /add, /ajinvite, /alias, /aline, /ame, /amsg, /anick, /aop, /auser, /auto, /autojoin, /avoice, /away

B /background, /ban, /bcopy, /beep, /bindip, /bread, /break, /breplace, /bset, /btrunc, /bunset, /bwrite

C /channel, /clear, /clearall, /clearial, /cline, /clipboard, /close, /closechats, /closedccs, /closefserves, /closemsg, /cnick, /color, /colour, /comclose, /comlist, /commands, /comopen, /comreg, /continue, /copy, /creq, /ctcp, /ctcpreply, /ctcps

D /dcc, /dccserver, /dde, /ddeserver, /debug, /dec, /describe, /dialog, /did, /didtok, /disable, /disconnect, /dlevel, /dline, /dll, Template:mIRC/donotdisturb, /dns, /dqwindow, /drawcopy, /drawdot, /drawfill, /drawline, /drawpic, /drawrect, /drawreplace, /drawrot, /drawsave, /drawscroll, /drawsize /drawtext

E /ebeeps, /echo, /editbox, /else, /elseif, /emailaddr, /enable, /events, /exit

F /fclose, /filter, /findtext, /finger, /firewall, /flash, /flist, /flood, /flush, /flushini, /fnord, /font, /fopen, /fseek, /fsend, /fserve, /fullname, /fupdate, /fwrite

G /ghide, /gload, /gmove, /gopts, /goto, /gplay, /gpoint, /gqreq, /groups, /gshow, /gsize, /gstop, /gtalk, /gunload, /guser

H /hadd, /halt, /haltdef, /hdec, /hdel, /help, /hfree, /hinc, /hload, /hmake, /hotlink, /hop, /hsave

I /ial, /ialclear, /ialmark, /identd, /if, /ignore, /iline, /inc, /iuser

J /join

L /leave, /linesep, /links, /list, /load, /loadbuf, /localinfo, /log, /logview

M /maxdepth, /mdi, /me, /menubar, /mkdir, /mnick, /mode, /msg

N /noop, /notice, /notify

O /onotice, /omsg

P /pareline, /part, /partall, /pdcc, /perform, /play, /playctrl, /pop, /protect, /proxy, /pvoice

Q /qme, /qmsg, /query, /queryrn, /quit, /quote

R /raw, /registration, /reload, /remini, /remote, /remove, /rename, /renwin, /reseterror, /resetidle, /return, /returnex, /rlevel, /rline, /rmdir, /run, /ruser

S /save, /savebuf, /saveini, /say, /scid, /scon, /server, /set, /setlayer, /showmirc, /signal, /sline, /sockaccept, /sockclose, /socklist, /socklisten, /sockmark, /sockopen, /sockpause, /sockread, /sockrename, /sockudp, /sockwrite, /sound, /speak, /splay, /sreq, /strip, /switchbar

T /timer, /timestamp, /tip, /tips, /titlebar, /tnick, /tokenize, /toolbar, /topic /tray, /treebar

U /ulist, /unload, /unset, /unsetall, /updatenl, /url, /username, /uwho

V /var, /vcadd, /vcmd, /vcrem, /vol

W

X /xyzzy