Modules/SebasIRC/ircDisconnect: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with '{{ml_irc}} __NOTOC__ {{ModuleFunction|SebasIRC}} This function disconnects the server from the IRC server it's connected to. ==Syntax== <syntaxhighlight lang="lua"> bool ircDisconnect() </cod…')
 
No edit summary
Line 7: Line 7:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool ircDisconnect()
bool ircDisconnect( [ string reason = "MTABot" ] )
</syntaxhighlight>
</syntaxhighlight>
===Optional Arguments===
{{OptionalArg}}
*'''reason :''' The quit reason.


===Returns===
===Returns===

Revision as of 18:44, 10 August 2009


Package-x-generic.png This function is provided by the external module SebasIRC. You must install this module to use this function.


This function disconnects the server from the IRC server it's connected to.

Syntax

bool ircDisconnect( [ string reason = "MTABot" ] )

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • reason : The quit reason.

Returns

Returns true if successfully disconnected from the server, false otherwise.

Example

-- Example here

See also

Connection:

Channel:

Bot: