Multi Theft Auto: Wiki - User contributions [en]

NL/Resource:Irc

2013-10-26T22:26:57Z

Mack Varial: /* Geëxporteerde functies */

{{Resource page}}
__NOTOC__
De "irc" resource zorgt voor een echobot die berichten zoals chatberichten output op een irc channel.
Informatie over "irc" of "Internet Relay Chat" kan gevonden worden op [http://nl.wikipedia.org/wiki/Internet_Relay_Chat Wikipedia.]

==Installatie==
Om deze resource aan de praat te krijgen op je Linux of Windows server, volg deze stappen:

* '''Installeer de sockets module'''
** '''Download de module''': Je kan deze module vinden op het [http://code.google.com/p/multitheftauto-modules/downloads/list mta-modules project]. Download het ml_sockets.dll bestand voor Windows en het ml_sockets.so bestand voor Linux
** '''Voeg de module toe in de MTA map''': Om deze module te laten moet deze in de volgende map geplaatst worden: mods/deathmatch/modules, als deze map niet bestaat, maak ze dan.
** '''Voeg de module toe aan het mtaserver.conf bestand''': Om de module te laden wanneer de server start, voeg dan dit lijntje <module src="ml_sockets.dll"/> voor Windows en dit lijntje <module src="ml_sockets.so"/> voor Linux toe aan je mtaserver.conf.
* '''Installeer de IRC resource'''
** '''Download de resource''': De IRC resource kan gevond worden op de [http://community.mtasa.com/index.php?p=resources&s=details&id=731 community], plaats de resource in de resources map.
** '''Pas het settings.xml bestand aan''': Open dit bestand en volg de instructies in het bestand om de bot te configureren.
** '''Pas het meta.xml bestand aan''': In dit bestand staan een aantal settings met betrekken tot reclame en ingame gui's, '''blijf van de rest!''' Je kan deze settings ook veranderen in je admin paneel wanneer de resource geladen is.
** '''Acl rechten''' De resource heeft een aantal rechten nodig om goed te werken waaronder: addBan, kickPlayer & callRemote. Als de resource niet genoeg rechten heeft verschijnt er een bericht in de console en kan de resource niet starten.

Nu kan je de resource starten, als de server aan het werken was tijdens deze bewerkingen doe dan eerst: /loadmodule ml_sockets.dll of /loadmodule ml_sockets.so en /refreshall voordat je /start irc doet.

==Het acl.xml bestand==
Het acl.xml bestand in de irc resource zorgt voor de acl rechten van irc commands.

Syntax
<syntaxhighlight lang="xml">
<command name="!kick" level="2" echoChannelOnly="true" />
</syntaxhighlight>

* De name is de command met uitroepteken
* De level is het minimum level dat de irc user moet hebben om de command te gebruiken.
* De echoChannelOnly bepaald ofdat je de command kan gebruiken buiten het echochannel

==Elementen==
Alle gebruikers, kanalen & servers gekend door de irc resource worden voorgestand door elementen
* Servers zijn de volgende elementen: 'irc-server'
* Channels zijn de volgende elementen: 'irc-channel'
* Users zijn de volgende elementen: 'irc-user'

==Level systeem==
De irc resource gebruikt geen irc modes systeem voor zijn acl, maar wel nummers.
* Owner (~) is nu level 5
* Super Operator (&) is nu level 4
* Operator (@) is nu level 3
* Helper (%) is nu level 2
* Voice (+) is nu level 1
Alle andere gebruikers zijn nu level 0

==Events==
Gedurende het irc proces worden een aantal events getriggerd om het je gemakkelijk te maken om extensies te schrijven.
Je moet wel addEvent("eventName") doen om ze te kunnen gebruiken.

{| class="wikitable" border="0"
|-
|width="200pt"|'''Naam'''
|width="200pt"|'''Source'''
|'''Parameters'''
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnecting'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCFailConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua">string reason</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserJoin'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string vhost</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserNickChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string oldNick, string newNick</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserPart'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason</syntaxhighlight>
|}
'''NOTE:''' 'theReason' kan nil zijn als 'theUser' gequit heeft zonder reden.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserKick'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason, user theKicker</syntaxhighlight>
|}
'''NOTE:''' 'theKicker' kan false zijn als 'theUser' gekickt was door een service zoals de nickserv.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserMode'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' kan false zijn als 'theUser' geopt was door een service zoals de chanserv

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCChannelMode'''
|width="200pt"|channel theIRCChannel
|<syntaxhighlight lang="lua">boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' kan false zijn als de mode geset was door een service zoals chanserv

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCLevelChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, number oldlevel, number newlevel</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserQuit'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theReason</syntaxhighlight>
|}

==Geëxporteerde functies==
Deze functies kunnen gebeld worden van andere resources om het schrijven van extensies mogelijk te maken
Gebruik de exports tabel of [[call]] om ze te gebruiken.

Voorbeeld 1:
<syntaxhighlight lang="lua">[Lua]
exports.irc:ircConnect("irc.gtanet.com","bot",6667)
</syntaxhighlight>
Voorbeeld 2:
<syntaxhighlight lang="lua">[Lua]
call(getResourceFromName("irc"),"ircConnect","irc.gtanet.com","bot",6667)
</syntaxhighlight>

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">returns</syntaxhighlight>
|width="150pt"|'''functie naam'''
|'''Parameters'''
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircHop'''
|<syntaxhighlight lang="lua">server theIRCServer, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSay'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircRaw'''
|<syntaxhighlight lang="lua">server theIRCServer, string theRaw</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircPart'''
|<syntaxhighlight lang="lua">channel theIRCChannel, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircJoin'''
|<syntaxhighlight lang="lua">server theIRCServer, string theChannelName, (string theChannelPassword)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircAction'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircNotice'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theUserChannel, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''outputIRC'''
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircConnect'''
|<syntaxhighlight lang="lua">string serverHost/IP, string nickname, (number serverPort), (string serverPassword), (boolean secure)</syntaxhighlight>
|-
|} '''NOTE:''' Secure connections are not available yet due to the module not suporting SSL yet.

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIdentify'''
|<syntaxhighlight lang="lua">server theIRCServer, string thePassword</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircReconnect'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircDisconnect'''
|<syntaxhighlight lang="lua">server theIRCServer, string theReason</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircChangeNick'''
|<syntaxhighlight lang="lua">server theIRCServer, string newNick</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServers'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerName'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerHost'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetServerPort'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerPass'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerNick'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsServerSecure'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServerChannels'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelServer'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannels'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelName'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannelUsers'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelTopic'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelFromName'''
|<syntaxhighlight lang="lua">string theChannelName</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|'''ircIsEchoChannel'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserNick'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetUsers'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserServer'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser, channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserVhost'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserFromNick'''
|<syntaxhighlight lang="lua">string theNickname</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetUserChannels'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|'''addIRCCommandHandler'''
|<syntaxhighlight lang="lua">string theCommandName, function theFunctionToCall/string functionName, (number minimumLevel), (boolean echoChannelOnly)</syntaxhighlight>
|-
|} '''NOTE:''' Gebruik een string met de functie naam als je deze functie gebruikt vanuit een andere resource, zorg ervoor dat deze functie geëxporteerd is

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetCommands'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetCommandLevel'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsCommandEchoChannelOnly'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

'''NOTE:''' Alle parameters die tussen haakjes staan zijn optioneel, zie [[optional arguments]]

==Commandos==
{| class="wikitable" border="0"
|-
|width="200pt"|'''commando'''
|width='100pt'|'''level'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!kick'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!uptime'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!say'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!s'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!m'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!players'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!pm'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!ts'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!getip'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!getserial'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!mute'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!unmute'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!mutes'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!freeze'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!unfreeze'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!kill'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!slap'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!ban'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!banip'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!banserial'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!banname'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!unbanip'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!unbanserial'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!unban'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!bans'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!commands'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!cmds'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!lua'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!run'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!crun'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!resources'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!start'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!restart'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!stop'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!account'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!community'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!money'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!health'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!wantedlevel'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!team'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!ping'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!modules'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!changemap'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!map'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!shutdown'''
|width='100pt'|'''5'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!password'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!gravity'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!weather'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!server'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!zone'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!refreshall'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!refresh'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!checkmap'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!country'''
|width='100pt'|'''2'''
|-
|}

==Aanpassen==
Gelieve de resource niet aan te passen, je kan ze breken. Schrijf extensies.

==Contacteren==
De auteur (MCvarial) kan gecontacteerd worden op IRC (#mta,#mta.dutch)
Of via email (MCvarial@gmail.com)

[[en:Resource:Irc]]
[[ru:Resource:Irc]]

Resource:Irc

2013-10-26T22:25:33Z

Mack Varial: /* Exported functions */

{{Resource page}}
__NOTOC__
The "irc" resource provides an echobot that outputs information such as chatmessages on a irc channel.
Information about "irc" or "Internet Relay Chat" can be found on [http://en.wikipedia.org/wiki/Irc Wikipedia.]

==Installation==
To get this resource working on your Linux or Windows server, follow these steps:

* '''Install the sockets module'''
** '''Download the module''': You can download the module on the [http://code.google.com/p/multitheftauto-modules/downloads/list mta-modules project]. Download the ml_sockets.dll file for Windows and the ml_sockets.so file for Linux
** '''Put the module in the MTA folder''': In order for MTA to load the module it must be placed in the mods/deathmatch/modules folder, if this folder does not exist yet, make it.
** '''Add the module to the mtaserver.conf file''': To load the module when the MTA server starts, put this line <module src="ml_sockets.dll"/> in your config file for Windows and <module src="ml_sockets.so"/> in the config file for Linux.
* '''Install the IRC resource'''
** '''Download the resource''': The IRC resource can be found on the [http://community.mtasa.com/index.php?p=resources&s=details&id=731 community], put it in the resources folder.
** '''Mod the settings.xml file''': Open this file and follow the instructions inside to configure the IRC bot.
** '''Mod the meta.xml file''': In this file a few settings can be found regarding ads and ingame gui's, '''do not mod anything else!''' You can also change these settings in the admin panel once the resource has been loaded.
** '''Acl rights''' The resource needs a couple of acl rights in order to work properly, including addBan, kickPlayer & callRemote. Any missing rights will prevent the resource from loading and will output a message in the console.

Now you can run the resource, if the server was running during this installation proces you will have to do /loadmodule ml_sockets.dll or /loadmodule ml_sockets.so and /refreshall before doing /start irc

==The acl.xml file==
The acl.xml file inside the irc resource takes care of the acl rights for irc commands.

Syntax
<syntaxhighlight lang="xml">
<command name="!kick" level="2" echoChannelOnly="true" />
</syntaxhighlight>

* The name is the command including the exclamation mark
* The level is the minimum level the irc user needs to have in order to use this command
* The echoChannelOnly is wether the command can be used outside the echo channel

==Elements==
All users, channels & servers known by the irc resource are represented by elements.
* Servers are the following elements type: 'irc-server'
* Channels are the following elements type: 'irc-channel'
* Users are the following elements type: 'irc-user'

==Level system==
The irc resource doesn't use the irc modes system for its acl, instead the modes were replaced with numbers.
* Owner (~) is now level 5
* Super Operator (&) is now level 4
* Operator (@) is now level 3
* Helper (%) is now level 2
* Voice (+) is now level 1
All other users without a special mode are level 0

==Events==
During the irc proces some events are triggered to help you write extensions for the irc resource.
You may want to use addEvent("eventName") to use them.

{| class="wikitable" border="0"
|-
|width="200pt"|'''Name'''
|width="200pt"|'''Source'''
|'''Parameters'''
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnecting'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCFailConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua">string reason</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserJoin'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string vhost</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserNickChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string oldNick, string newNick</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserPart'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason</syntaxhighlight>
|}
'''NOTE:''' 'theReason' can be nil if 'theUser' has quit without a reason.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserKick'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason, user theKicker</syntaxhighlight>
|}
'''NOTE:''' 'theKicker' can be false if 'theUser' was kicked by a service like the NickServ.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserMode'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' can be false if 'theUser' was opped by a service like the NickServ.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCChannelMode'''
|width="200pt"|channel theIRCChannel
|<syntaxhighlight lang="lua">boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' can be false if the mode was set by a service like the NickServ.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCLevelChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, number oldlevel, number newlevel</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserQuit'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theReason</syntaxhighlight>
|}

==Exported functions==
These functions can be called from another resource to help you write extensions for the irc resource.
Use the exports table or [[call]] to use them

Example 1:
<syntaxhighlight lang="lua">[Lua]
exports.irc:ircConnect("irc.gtanet.com","bot",6667)
</syntaxhighlight>
Example 2:
<syntaxhighlight lang="lua">[Lua]
call(getResourceFromName("irc"),"ircConnect","irc.gtanet.com","bot",6667)
</syntaxhighlight>

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">returns</syntaxhighlight>
|width="150pt"|'''function name'''
|'''Parameters'''
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircHop'''
|<syntaxhighlight lang="lua">server theIRCServer, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSay'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircRaw'''
|<syntaxhighlight lang="lua">server theIRCServer, string theRaw</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircPart'''
|<syntaxhighlight lang="lua">channel theIRCChannel, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">irc-channel</syntaxhighlight>
|width='200pt'|'''ircJoin'''
|<syntaxhighlight lang="lua">server theIRCServer, string theChannelName, (string theChannelPassword)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircAction'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircNotice'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theUserChannel, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''outputIRC'''
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircConnect'''
|<syntaxhighlight lang="lua">string serverHost/IP, string nickname, (number serverPort), (string serverPassword), (boolean secure)</syntaxhighlight>
|-
|} '''NOTE:''' Secure connections are not available yet due to the module not suporting SSL yet.

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIdentify'''
|<syntaxhighlight lang="lua">server theIRCServer, string thePassword</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircReconnect'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircDisconnect'''
|<syntaxhighlight lang="lua">server theIRCServer, string theReason</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircChangeNick'''
|<syntaxhighlight lang="lua">server theIRCServer, string newNick</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServers'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerName'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerHost'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetServerPort'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerPass'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerNick'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsServerSecure'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServerChannels'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelServer'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannels'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelName'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannelUsers'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelTopic'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelFromName'''
|<syntaxhighlight lang="lua">string theChannelName</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|'''ircIsEchoChannel'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserNick'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetUsers'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserServer'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser, channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserVhost'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserFromNick'''
|<syntaxhighlight lang="lua">string theNickname</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|'''addIRCCommandHandler'''
|<syntaxhighlight lang="lua">string theCommandName, function theFunctionToCall/string functionName, (number minimumLevel), (boolean echoChannelOnly)</syntaxhighlight>
|-
|} '''NOTE:''' Use a string with the function name for the second argument if your are calling this function from another resource, also make sure the function is exported.

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetCommands'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetCommandLevel'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsCommandEchoChannelOnly'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

'''NOTE:''' All parameters that are between brackets are optional, see [[optional arguments]]

==Commands==
{| class="wikitable" border="0"
|-
|width="200pt"|'''command'''
|width='100pt'|'''level'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!kick'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!uptime'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!say'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!s'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!m'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!players'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!pm'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!ts'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!getip'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!getserial'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!mute'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!unmute'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!mutes'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!freeze'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!unfreeze'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!kill'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!slap'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!ban'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!banip'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!banserial'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!banname'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!unbanip'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!unbanserial'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!unban'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!bans'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!commands'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!cmds'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!lua'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!run'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!crun'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!resources'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!start'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!restart'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!stop'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!account'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!community'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!money'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!health'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!wantedlevel'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!team'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!ping'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!modules'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!changemap'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!map'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!shutdown'''
|width='100pt'|'''5'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!password'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!gravity'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!weather'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!server'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!zone'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!refreshall'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!refresh'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!checkmap'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!country'''
|width='100pt'|'''2'''
|-
|}

==Modding==
Please don't mod the resource, you might break it and cause it to malfunction or to spam errors.
If this happens you will not get any support.
Write extensions instead.

==Contact==
The author (MCvarial) can be contacted using IRC (#mta,#mta.dutch)
Or by email (MCvarial@gmail.com)

[[nl:Resource:Irc]]
[[ru:Resource:Irc]]

User:Mack Varial

2013-07-15T12:29:22Z

Mack Varial:

== TODO ==
* <strike>fix [http://community.mtasa.com/index.php?p=resources&s=details&id=731 irc resource]</strike>
* finish smartchat resource

NL/Resource:Irc

2013-07-15T12:06:41Z

Mack Varial:

{{Resource page}}
__NOTOC__
De "irc" resource zorgt voor een echobot die berichten zoals chatberichten output op een irc channel.
Informatie over "irc" of "Internet Relay Chat" kan gevonden worden op [http://nl.wikipedia.org/wiki/Internet_Relay_Chat Wikipedia.]

==Installatie==
Om deze resource aan de praat te krijgen op je Linux of Windows server, volg deze stappen:

* '''Installeer de sockets module'''
** '''Download de module''': Je kan deze module vinden op het [http://code.google.com/p/multitheftauto-modules/downloads/list mta-modules project]. Download het ml_sockets.dll bestand voor Windows en het ml_sockets.so bestand voor Linux
** '''Voeg de module toe in de MTA map''': Om deze module te laten moet deze in de volgende map geplaatst worden: mods/deathmatch/modules, als deze map niet bestaat, maak ze dan.
** '''Voeg de module toe aan het mtaserver.conf bestand''': Om de module te laden wanneer de server start, voeg dan dit lijntje <module src="ml_sockets.dll"/> voor Windows en dit lijntje <module src="ml_sockets.so"/> voor Linux toe aan je mtaserver.conf.
* '''Installeer de IRC resource'''
** '''Download de resource''': De IRC resource kan gevond worden op de [http://community.mtasa.com/index.php?p=resources&s=details&id=731 community], plaats de resource in de resources map.
** '''Pas het settings.xml bestand aan''': Open dit bestand en volg de instructies in het bestand om de bot te configureren.
** '''Pas het meta.xml bestand aan''': In dit bestand staan een aantal settings met betrekken tot reclame en ingame gui's, '''blijf van de rest!''' Je kan deze settings ook veranderen in je admin paneel wanneer de resource geladen is.
** '''Acl rechten''' De resource heeft een aantal rechten nodig om goed te werken waaronder: addBan, kickPlayer & callRemote. Als de resource niet genoeg rechten heeft verschijnt er een bericht in de console en kan de resource niet starten.

Nu kan je de resource starten, als de server aan het werken was tijdens deze bewerkingen doe dan eerst: /loadmodule ml_sockets.dll of /loadmodule ml_sockets.so en /refreshall voordat je /start irc doet.

==Het acl.xml bestand==
Het acl.xml bestand in de irc resource zorgt voor de acl rechten van irc commands.

Syntax
<syntaxhighlight lang="xml">
<command name="!kick" level="2" echoChannelOnly="true" />
</syntaxhighlight>

* De name is de command met uitroepteken
* De level is het minimum level dat de irc user moet hebben om de command te gebruiken.
* De echoChannelOnly bepaald ofdat je de command kan gebruiken buiten het echochannel

==Elementen==
Alle gebruikers, kanalen & servers gekend door de irc resource worden voorgestand door elementen
* Servers zijn de volgende elementen: 'irc-server'
* Channels zijn de volgende elementen: 'irc-channel'
* Users zijn de volgende elementen: 'irc-user'

==Level systeem==
De irc resource gebruikt geen irc modes systeem voor zijn acl, maar wel nummers.
* Owner (~) is nu level 5
* Super Operator (&) is nu level 4
* Operator (@) is nu level 3
* Helper (%) is nu level 2
* Voice (+) is nu level 1
Alle andere gebruikers zijn nu level 0

==Events==
Gedurende het irc proces worden een aantal events getriggerd om het je gemakkelijk te maken om extensies te schrijven.
Je moet wel addEvent("eventName") doen om ze te kunnen gebruiken.

{| class="wikitable" border="0"
|-
|width="200pt"|'''Naam'''
|width="200pt"|'''Source'''
|'''Parameters'''
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnecting'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCFailConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua">string reason</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserJoin'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string vhost</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserNickChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string oldNick, string newNick</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserPart'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason</syntaxhighlight>
|}
'''NOTE:''' 'theReason' kan nil zijn als 'theUser' gequit heeft zonder reden.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserKick'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason, user theKicker</syntaxhighlight>
|}
'''NOTE:''' 'theKicker' kan false zijn als 'theUser' gekickt was door een service zoals de nickserv.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserMode'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' kan false zijn als 'theUser' geopt was door een service zoals de chanserv

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCChannelMode'''
|width="200pt"|channel theIRCChannel
|<syntaxhighlight lang="lua">boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' kan false zijn als de mode geset was door een service zoals chanserv

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCLevelChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, number oldlevel, number newlevel</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserQuit'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theReason</syntaxhighlight>
|}

==Geëxporteerde functies==
Deze functies kunnen gebeld worden van andere resources om het schrijven van extensies mogelijk te maken
Gebruik de exports tabel of [[call]] om ze te gebruiken.

Voorbeeld 1:
<syntaxhighlight lang="lua">[Lua]
exports.irc:ircConnect("irc.gtanet.com","bot",6667)
</syntaxhighlight>
Voorbeeld 2:
<syntaxhighlight lang="lua">[Lua]
call(getResourceFromName("irc"),"ircConnect","irc.gtanet.com","bot",6667)
</syntaxhighlight>

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">returns</syntaxhighlight>
|width="150pt"|'''functie naam'''
|'''Parameters'''
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircHop'''
|<syntaxhighlight lang="lua">server theIRCServer, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSay'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircRaw'''
|<syntaxhighlight lang="lua">server theIRCServer, string theRaw</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircPart'''
|<syntaxhighlight lang="lua">channel theIRCChannel, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircJoin'''
|<syntaxhighlight lang="lua">server theIRCServer, string theChannelName, (string theChannelPassword)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircAction'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircNotice'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theUserChannel, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''outputIRC'''
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircConnect'''
|<syntaxhighlight lang="lua">string serverHost/IP, string nickname, (number serverPort), (string serverPassword), (boolean secure)</syntaxhighlight>
|-
|} '''NOTE:''' Secure connections are not available yet due to the module not suporting SSL yet.

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIdentify'''
|<syntaxhighlight lang="lua">server theIRCServer, string thePassword</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircReconnect'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircDisconnect'''
|<syntaxhighlight lang="lua">server theIRCServer, string theReason</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircChangeNick'''
|<syntaxhighlight lang="lua">server theIRCServer, string newNick</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServers'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerName'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerHost'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetServerPort'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerPass'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerNick'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsServerSecure'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServerChannels'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelServer'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannels'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelName'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannelUsers'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelTopic'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelFromName'''
|<syntaxhighlight lang="lua">string theChannelName</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|'''ircIsEchoChannel'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserNick'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetUsers'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserServer'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser, channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserVhost'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserFromNick'''
|<syntaxhighlight lang="lua">string theNickname</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetUserChannels'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|'''addIRCCommandHandler'''
|<syntaxhighlight lang="lua">string theCommandName, function theFunctionToCall/string functionName, (number minimumLevel), (boolean echoChannelOnly)</syntaxhighlight>
|-
|} '''NOTE:''' Gebruik een string met de functie naam als je deze functie gebruikt vanuit een andere resource, zorg ervoor dat deze functie geëxporteerd is

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetCommands'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetCommandLevel'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsCommandEchoChannelOnly'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

'''NOTE:''' Alle parameters die tussen haakjes staan zijn optioneel, zie [[optional arguments]]

==Commandos==
{| class="wikitable" border="0"
|-
|width="200pt"|'''commando'''
|width='100pt'|'''level'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!kick'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!uptime'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!say'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!s'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!m'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!players'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!pm'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!ts'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!getip'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!getserial'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!mute'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!unmute'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!mutes'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!freeze'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!unfreeze'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!kill'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!slap'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!ban'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!banip'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!banserial'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!banname'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!unbanip'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!unbanserial'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!unban'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!bans'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!commands'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!cmds'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!lua'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!run'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!crun'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!resources'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!start'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!restart'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!stop'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!account'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!community'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!money'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!health'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!wantedlevel'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!team'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!ping'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!modules'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!changemap'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!map'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!shutdown'''
|width='100pt'|'''5'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!password'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!gravity'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!weather'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!server'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!zone'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!refreshall'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!refresh'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!checkmap'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!country'''
|width='100pt'|'''2'''
|-
|}

==Aanpassen==
Gelieve de resource niet aan te passen, je kan ze breken. Schrijf extensies.

==Contacteren==
De auteur (MCvarial) kan gecontacteerd worden op IRC (#mta,#mta.dutch)
Of via email (MCvarial@gmail.com)

[[en:Resource:Irc]]
[[ru:Resource:Irc]]

Resource:Irc

2013-07-15T12:05:04Z

Mack Varial:

{{Resource page}}
__NOTOC__
The "irc" resource provides an echobot that outputs information such as chatmessages on a irc channel.
Information about "irc" or "Internet Relay Chat" can be found on [http://en.wikipedia.org/wiki/Irc Wikipedia.]

==Installation==
To get this resource working on your Linux or Windows server, follow these steps:

* '''Install the sockets module'''
** '''Download the module''': You can download the module on the [http://code.google.com/p/multitheftauto-modules/downloads/list mta-modules project]. Download the ml_sockets.dll file for Windows and the ml_sockets.so file for Linux
** '''Put the module in the MTA folder''': In order for MTA to load the module it must be placed in the mods/deathmatch/modules folder, if this folder does not exist yet, make it.
** '''Add the module to the mtaserver.conf file''': To load the module when the MTA server starts, put this line <module src="ml_sockets.dll"/> in your config file for Windows and <module src="ml_sockets.so"/> in the config file for Linux.
* '''Install the IRC resource'''
** '''Download the resource''': The IRC resource can be found on the [http://community.mtasa.com/index.php?p=resources&s=details&id=731 community], put it in the resources folder.
** '''Mod the settings.xml file''': Open this file and follow the instructions inside to configure the IRC bot.
** '''Mod the meta.xml file''': In this file a few settings can be found regarding ads and ingame gui's, '''do not mod anything else!''' You can also change these settings in the admin panel once the resource has been loaded.
** '''Acl rights''' The resource needs a couple of acl rights in order to work properly, including addBan, kickPlayer & callRemote. Any missing rights will prevent the resource from loading and will output a message in the console.

Now you can run the resource, if the server was running during this installation proces you will have to do /loadmodule ml_sockets.dll or /loadmodule ml_sockets.so and /refreshall before doing /start irc

==The acl.xml file==
The acl.xml file inside the irc resource takes care of the acl rights for irc commands.

Syntax
<syntaxhighlight lang="xml">
<command name="!kick" level="2" echoChannelOnly="true" />
</syntaxhighlight>

* The name is the command including the exclamation mark
* The level is the minimum level the irc user needs to have in order to use this command
* The echoChannelOnly is wether the command can be used outside the echo channel

==Elements==
All users, channels & servers known by the irc resource are represented by elements.
* Servers are the following elements type: 'irc-server'
* Channels are the following elements type: 'irc-channel'
* Users are the following elements type: 'irc-user'

==Level system==
The irc resource doesn't use the irc modes system for its acl, instead the modes were replaced with numbers.
* Owner (~) is now level 5
* Super Operator (&) is now level 4
* Operator (@) is now level 3
* Helper (%) is now level 2
* Voice (+) is now level 1
All other users without a special mode are level 0

==Events==
During the irc proces some events are triggered to help you write extensions for the irc resource.
You may want to use addEvent("eventName") to use them.

{| class="wikitable" border="0"
|-
|width="200pt"|'''Name'''
|width="200pt"|'''Source'''
|'''Parameters'''
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnecting'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCFailConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua">string reason</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserJoin'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string vhost</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserNickChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string oldNick, string newNick</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserPart'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason</syntaxhighlight>
|}
'''NOTE:''' 'theReason' can be nil if 'theUser' has quit without a reason.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserKick'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason, user theKicker</syntaxhighlight>
|}
'''NOTE:''' 'theKicker' can be false if 'theUser' was kicked by a service like the NickServ.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserMode'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' can be false if 'theUser' was opped by a service like the NickServ.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCChannelMode'''
|width="200pt"|channel theIRCChannel
|<syntaxhighlight lang="lua">boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' can be false if the mode was set by a service like the NickServ.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCLevelChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, number oldlevel, number newlevel</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserQuit'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theReason</syntaxhighlight>
|}

==Exported functions==
These functions can be called from another resource to help you write extensions for the irc resource.
Use the exports table or [[call]] to use them

Example 1:
<syntaxhighlight lang="lua">[Lua]
exports.irc:ircConnect("irc.gtanet.com","bot",6667)
</syntaxhighlight>
Example 2:
<syntaxhighlight lang="lua">[Lua]
call(getResourceFromName("irc"),"ircConnect","irc.gtanet.com","bot",6667)
</syntaxhighlight>

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">returns</syntaxhighlight>
|width="150pt"|'''function name'''
|'''Parameters'''
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircHop'''
|<syntaxhighlight lang="lua">server theIRCServer, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSay'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircRaw'''
|<syntaxhighlight lang="lua">server theIRCServer, string theRaw</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircPart'''
|<syntaxhighlight lang="lua">channel theIRCChannel, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircJoin'''
|<syntaxhighlight lang="lua">server theIRCServer, string theChannelName, (string theChannelPassword)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircAction'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircNotice'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theUserChannel, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''outputIRC'''
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircConnect'''
|<syntaxhighlight lang="lua">string serverHost/IP, string nickname, (number serverPort), (string serverPassword), (boolean secure)</syntaxhighlight>
|-
|} '''NOTE:''' Secure connections are not available yet due to the module not suporting SSL yet.

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIdentify'''
|<syntaxhighlight lang="lua">server theIRCServer, string thePassword</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircReconnect'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircDisconnect'''
|<syntaxhighlight lang="lua">server theIRCServer, string theReason</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircChangeNick'''
|<syntaxhighlight lang="lua">server theIRCServer, string newNick</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServers'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerName'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerHost'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetServerPort'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerPass'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerNick'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsServerSecure'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServerChannels'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelServer'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannels'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelName'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannelUsers'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelTopic'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelFromName'''
|<syntaxhighlight lang="lua">string theChannelName</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|'''ircIsEchoChannel'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserNick'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetUsers'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserServer'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser, channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserVhost'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserFromNick'''
|<syntaxhighlight lang="lua">string theNickname</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|'''addIRCCommandHandler'''
|<syntaxhighlight lang="lua">string theCommandName, function theFunctionToCall/string functionName, (number minimumLevel), (boolean echoChannelOnly)</syntaxhighlight>
|-
|} '''NOTE:''' Use a string with the function name for the second argument if your are calling this function from another resource, also make sure the function is exported.

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetCommands'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetCommandLevel'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsCommandEchoChannelOnly'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

'''NOTE:''' All parameters that are between brackets are optional, see [[optional arguments]]

==Commands==
{| class="wikitable" border="0"
|-
|width="200pt"|'''command'''
|width='100pt'|'''level'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!kick'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!uptime'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!say'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!s'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!m'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!players'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!pm'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!ts'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!getip'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!getserial'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!mute'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!unmute'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!mutes'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!freeze'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!unfreeze'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!kill'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!slap'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!ban'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!banip'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!banserial'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!banname'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!unbanip'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!unbanserial'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!unban'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!bans'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!commands'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!cmds'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!lua'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!run'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!crun'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!resources'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!start'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!restart'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!stop'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!account'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!community'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!money'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!health'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!wantedlevel'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!team'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!ping'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!modules'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!changemap'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!map'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!shutdown'''
|width='100pt'|'''5'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!password'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!gravity'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!weather'''
|width='100pt'|'''3'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!server'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!zone'''
|width='100pt'|'''0'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!refreshall'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!refresh'''
|width='100pt'|'''4'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!checkmap'''
|width='100pt'|'''2'''
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''!country'''
|width='100pt'|'''2'''
|-
|}

==Modding==
Please don't mod the resource, you might break it and cause it to malfunction or to spam errors.
If this happens you will not get any support.
Write extensions instead.

==Contact==
The author (MCvarial) can be contacted using IRC (#mta,#mta.dutch)
Or by email (MCvarial@gmail.com)

[[nl:Resource:Irc]]
[[ru:Resource:Irc]]

SetElementHealth

2013-07-08T15:35:56Z

Mack Varial:

{{Server client function}}
__NOTOC__
This function sets the health for the specified [[element]]. This can be a [[ped]], [[object]] or a [[vehicle]].

==Syntax==
<syntaxhighlight lang="lua">
bool setElementHealth ( element theElement, float newHealth )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The [[ped]], [[vehicle]] or [[object]] whose health you want to set.
*'''newHealth:''' A float indicating the new health to set for the element.

===Returns===
Returns ''true'' if the new health was set successfully, or ''false'' if invalid arguments were passed.

==Example==
<section name="Server" class="server" show="true">
This example adds a 'hpslap' console command that lets players "slap" others (doing 20 damage).
<syntaxhighlight lang="lua">
function hpSlap ( sourcePlayer, command, targetPlayerName )
-- check if the user has access to it first
if not hasObjectPermissionTo(sourcePlayer, "command.slap", false) then
outputChatBox ( "You cannot use this command.", sourcePlayer )
return false
end
-- look up the player to be slapped
local targetPlayer = getPlayerFromName ( targetPlayerName )
-- if there's a player with such name,
if targetPlayer then
-- subtract 20 from his health
setElementHealth ( targetPlayer, getElementHealth(targetPlayer) - 20 )
else
-- otherwise, output an error message
outputChatBox ( "There is no player named " .. targetPlayerName .. "!", sourcePlayer )
end
end
-- add our function as a handler for "hpslap"
addCommandHandler ( "hpslap", hpSlap )
</syntaxhighlight>
</section>

==See Also==
{{Element functions}}

SetElementHealth

2013-07-08T15:33:51Z

Mack Varial:

{{Server client function}}
__NOTOC__
This function sets the health for the specified [[element]]. This can be a [[player]], [[object]] or a [[vehicle]].

==Syntax==
<syntaxhighlight lang="lua">
bool setElementHealth ( element theElement, float newHealth )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The [[player]], [[vehicle]] or [[object]] whose health you want to set.
*'''newHealth:''' A float indicating the new health to set for the element.

===Returns===
Returns ''true'' if the new health was set successfully, or ''false'' if invalid arguments were passed.

==Example==
<section name="Server" class="server" show="true">
This example adds a 'hpslap' console command that lets players "slap" others (doing 20 damage).
<syntaxhighlight lang="lua">
function hpSlap ( sourcePlayer, command, targetPlayerName )
-- check if the user has access to it first
if not hasObjectPermissionTo(sourcePlayer, "command.slap", false) then
outputChatBox ( "You cannot use this command.", sourcePlayer )
return false
end
-- look up the player to be slapped
local targetPlayer = getPlayerFromName ( targetPlayerName )
-- if there's a player with such name,
if targetPlayer then
-- subtract 20 from his health
setElementHealth ( targetPlayer, getElementHealth(targetPlayer) - 20 )
else
-- otherwise, output an error message
outputChatBox ( "There is no player named " .. targetPlayerName .. "!", sourcePlayer )
end
end
-- add our function as a handler for "hpslap"
addCommandHandler ( "hpslap", hpSlap )
</syntaxhighlight>
</section>

==See Also==
{{Element functions}}

SetElementHealth

2013-07-08T15:32:39Z

Mack Varial: /* Syntax */

{{Server client function}}
__NOTOC__
This function sets the health for the specified [[element]]. This can be a [[player]] or a [[vehicle]].

==Syntax==
<syntaxhighlight lang="lua">
bool setElementHealth ( element theElement, float newHealth )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The [[player]], [[vehicle]] or [[object]] whose health you want to set.
*'''newHealth:''' A float indicating the new health to set for the element.

===Returns===
Returns ''true'' if the new health was set successfully, or ''false'' if invalid arguments were passed.

==Example==
<section name="Server" class="server" show="true">
This example adds a 'hpslap' console command that lets players "slap" others (doing 20 damage).
<syntaxhighlight lang="lua">
function hpSlap ( sourcePlayer, command, targetPlayerName )
-- check if the user has access to it first
if not hasObjectPermissionTo(sourcePlayer, "command.slap", false) then
outputChatBox ( "You cannot use this command.", sourcePlayer )
return false
end
-- look up the player to be slapped
local targetPlayer = getPlayerFromName ( targetPlayerName )
-- if there's a player with such name,
if targetPlayer then
-- subtract 20 from his health
setElementHealth ( targetPlayer, getElementHealth(targetPlayer) - 20 )
else
-- otherwise, output an error message
outputChatBox ( "There is no player named " .. targetPlayerName .. "!", sourcePlayer )
end
end
-- add our function as a handler for "hpslap"
addCommandHandler ( "hpslap", hpSlap )
</syntaxhighlight>
</section>

==See Also==
{{Element functions}}

Modules/bIRC

2013-06-21T10:09:25Z

Mack Varial:

<pageclass class="#0099AA" subcaption="Basic IRC Module"></pageclass>
{{Outdated|Development for this module seems to have halted, use [[resource:irc]] for now.}}

__NOTOC__
{{Module_Info|
name = ml_birc |
version = 1.0 |
author = [[User:Awwu|Awwu]] <awwugta@gmail.com> |
module_website = ''None'' |
download_link = ''Soon'' |
license = ''Unlicensed'' |
written_in = Unknown |
operating_system = Windows only |
compatible_with = 1.0 |
}}
Basic IRC module (bIRC) provides a fully functional server IRC echo for MTA:SA. It is currently available only for Windows servers on MTA:SA 1.0 (other versions untested).

==Installation==
Uncompress the file ml_birc.dll into your ''server\mods\deathmatch\modules\'' directory.

===mtaserver.conf===
Add the following line in your mtaserver.conf:
<syntaxhighlight lang="lua" lang="xml">
<module src="ml_birc" />
</syntaxhighlight>

==Provided scripting functionality==
{{ml_birc functions}}
{{ml_birc callbacks}}

[[ru:Modules/bIRC]]

Modules/SebasIRC

2013-06-21T10:09:11Z

Mack Varial:

{{Outdated|Development for this module has stopped, use [[resource:irc]] instead.}}

__NOTOC__
{{Module_Info|
name = ml_irc |
version = 1.0 |
author = [[User:Sebassje|x86]] <sebasdevelopment@gmx.com> |
module_website = ''[http://code.google.com/p/multitheftauto-modules/ Here]'' |
download_link = ''[http://multitheftauto-modules.googlecode.com/svn/branches/ml_irc-rewrite/output/ml_irc.dll Here]'' |
license = ''Unlicensed'' |
}}
This ml_irc is a module for your MTA:SA 1.x Windows server, that provides IRC echo.
* '''Note:''' The bot can't join multiple servers.

==Installation==
===Windows===
Uncompress the file ml_irc.dll into your ''server\mods\deathmatch\modules\'' directory.

===mtaserver.conf===
Add the following line in your mtaserver.conf:
<syntaxhighlight lang="xml">
<module src="ml_irc" />
</syntaxhighlight>

==See Also==
===Functions===
{{Modules/SebasIRC/Functions}}

===Events===
{{Modules/SebasIRC/Events}}

[[ru:Modules/SebasIRC]]

Modules/IRCEcho

2013-06-21T10:08:02Z

Mack Varial:

{{Outdated|This module only works on DP2.3, use [[resource:irc]] for now}}

{{Module_Info|
name = MTASA IRC Echo |
version = 2.1 |
author = [[User:VRocker|VRocker]] |
module_website = ''Not available'' |
download_link = [http://liberty-unleashed.co.uk/MTA/IRC%20Echo%20Script%20v2.zip Here] |
license = ''Unlicensed'' |
written_in = C++ |
operating_system = Cross-platform |
compatible_with = DP2.3 |
}}
MTASA IRC Echo is a module that provides an IRC echo for an MTASA server. It is available for both Windows and Linux.

==Installation==
===Windows===
Uncompress the file ml_ircecho.dll into your ''%PROGRAMFILES%\MTA San Andreas\server\mods\deathmatch\modules\'' directory.

Then, add the following line in mtaserver.conf:
<syntaxhighlight lang="xml">
<module src="ml_ircecho.dll" />
</syntaxhighlight>

===Linux===
Uncompress the file ml_ircecho.so into your ''%MTASERVER%\mods\deathmatch\modules\'' directory.

Then, add the following line in mtaserver.conf:
<syntaxhighlight lang="xml">
<module src="ml_ircecho.so" />
</syntaxhighlight>

==Functions==
{{Modules/IRCEcho/Functions}}

==Callbacks==
{{Modules/IRCEcho/Callbacks}}

[[ru:Modules/IRCEcho]]

NL/Resource:Irc

2012-04-21T18:00:19Z

Mack Varial:

{{Resource page}}
__NOTOC__
De "irc" resource zorgt voor een echobot die berichten zoals chatberichten output op een irc channel.
Informatie over "irc" of "Internet Relay Chat" kan gevonden worden op [http://nl.wikipedia.org/wiki/Internet_Relay_Chat Wikipedia.]

==Installatie==
Om deze resource aan de praat te krijgen op je Linux of Windows server, volg deze stappen:

* '''Installeer de sockets module'''
** '''Download de module''': Je kan deze module vinden op het [http://code.google.com/p/multitheftauto-modules/downloads/list mta-modules project]. Download het ml_sockets.dll bestand voor Windows en het ml_sockets.so bestand voor Linux
** '''Voeg de module toe in de MTA map''': Om deze module te laten moet deze in de volgende map geplaatst worden: mods/deathmatch/modules, als deze map niet bestaat, maak ze dan.
** '''Voeg de module toe aan het mtaserver.conf bestand''': Om de module te laden wanneer de server start, voeg dan dit lijntje <module src="ml_sockets.dll"/> voor Windows en dit lijntje <module src="ml_sockets.so"/> voor Linux toe aan je mtaserver.conf.
* '''Installeer de IRC resource'''
** '''Download de resource''': De IRC resource kan gevond worden op de [http://community.mtasa.com/index.php?p=resources&s=details&id=731 community], plaats de resource in de resources map.
** '''Pas het settings.xml bestand aan''': Open dit bestand en volg de instructies in het bestand om de bot te configureren.
** '''Pas het meta.xml bestand aan''': In dit bestand staan een aantal settings met betrekken tot reclame en ingame gui's, '''blijf van de rest!''' Je kan deze settings ook veranderen in je admin paneel wanneer de resource geladen is.
** '''Acl rechten''' De resource heeft een aantal rechten nodig om goed te werken waaronder: addBan, kickPlayer & callRemote. Als de resource niet genoeg rechten heeft verschijnt er een bericht in de console en kan de resource niet starten.

Nu kan je de resource starten, als de server aan het werken was tijdens deze bewerkingen doe dan eerst: /loadmodule ml_sockets.dll of /loadmodule ml_sockets.so en /refreshall voordat je /start irc doet.

==Het acl.xml bestand==
Het acl.xml bestand in de irc resource zorgt voor de acl rechten van irc commands.

Syntax
<syntaxhighlight lang="xml">
<command name="!kick" level="2" echoChannelOnly="true" />
</syntaxhighlight>

* De name is de command met uitroepteken
* De level is het minimum level dat de irc user moet hebben om de command te gebruiken.
* De echoChannelOnly bepaald ofdat je de command kan gebruiken buiten het echochannel

==Elementen==
Alle gebruikers, kanalen & servers gekend door de irc resource worden voorgestand door elementen
* Servers zijn de volgende elementen: 'irc-server'
* Channels zijn de volgende elementen: 'irc-channel'
* Users zijn de volgende elementen: 'irc-user'

==Level systeem==
De irc resource gebruikt geen irc modes systeem voor zijn acl, maar wel nummers.
* Owner (~) is nu level 5
* Super Operator (&) is nu level 4
* Operator (@) is nu level 3
* Helper (%) is nu level 2
* Voice (+) is nu level 1
Alle andere gebruikers zijn nu level 0

==Events==
Gedurende het irc proces worden een aantal events getriggerd om het je gemakkelijk te maken om extensies te schrijven.
Je moet wel addEvent("eventName") doen om ze te kunnen gebruiken.

{| class="wikitable" border="0"
|-
|width="200pt"|'''Naam'''
|width="200pt"|'''Source'''
|'''Parameters'''
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnecting'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCFailConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua">string reason</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserJoin'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string vhost</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserNickChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string oldNick, string newNick</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserPart'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason</syntaxhighlight>
|}
'''NOTE:''' 'theReason' kan nil zijn als 'theUser' gequit heeft zonder reden.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserKick'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason, user theKicker</syntaxhighlight>
|}
'''NOTE:''' 'theKicker' kan false zijn als 'theUser' gekickt was door een service zoals de nickserv.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserMode'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' kan false zijn als 'theUser' geopt was door een service zoals de chanserv

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCChannelMode'''
|width="200pt"|channel theIRCChannel
|<syntaxhighlight lang="lua">boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' kan false zijn als de mode geset was door een service zoals chanserv

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCLevelChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, number oldlevel, number newlevel</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserQuit'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theReason</syntaxhighlight>
|}

==Geëxporteerde functies==
Deze functies kunnen gebeld worden van andere resources om het schrijven van extensies mogelijk te maken
Gebruik de exports tabel of [[call]] om ze te gebruiken.

Voorbeeld 1:
<syntaxhighlight lang="lua">[Lua]
exports.irc:ircConnect("irc.gtanet.com","bot",6667)
</syntaxhighlight>
Voorbeeld 2:
<syntaxhighlight lang="lua">[Lua]
call(getResourceFromName("irc"),"ircConnect","irc.gtanet.com","bot",6667)
</syntaxhighlight>

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">returns</syntaxhighlight>
|width="150pt"|'''functie naam'''
|'''Parameters'''
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircHop'''
|<syntaxhighlight lang="lua">server theIRCServer, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSay'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircRaw'''
|<syntaxhighlight lang="lua">server theIRCServer, string theRaw</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircPart'''
|<syntaxhighlight lang="lua">channel theIRCChannel, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircJoin'''
|<syntaxhighlight lang="lua">server theIRCServer, string theChannelName, (string theChannelPassword)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircAction'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircNotice'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theUserChannel, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''outputIRC'''
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircConnect'''
|<syntaxhighlight lang="lua">string serverHost/IP, string nickname, (number serverPort), (string serverPassword), (boolean secure)</syntaxhighlight>
|-
|} '''NOTE:''' Secure connections are not available yet due to the module not suporting SSL yet.

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIdentify'''
|<syntaxhighlight lang="lua">server theIRCServer, string thePassword</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircReconnect'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircDisconnect'''
|<syntaxhighlight lang="lua">server theIRCServer, string theReason</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircChangeNick'''
|<syntaxhighlight lang="lua">server theIRCServer, string newNick</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServers'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerName'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerHost'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetServerPort'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerPass'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerNick'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsServerSecure'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServerChannels'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelServer'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannels'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelName'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannelUsers'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelTopic'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelFromName'''
|<syntaxhighlight lang="lua">string theChannelName</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|'''ircIsEchoChannel'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserNick'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetUsers'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserServer'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser, channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserVhost'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserFromNick'''
|<syntaxhighlight lang="lua">string theNickname</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetUserChannels'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|'''addIRCCommandHandler'''
|<syntaxhighlight lang="lua">string theCommandName, function theFunctionToCall/string functionName, (number minimumLevel), (boolean echoChannelOnly)</syntaxhighlight>
|-
|} '''NOTE:''' Gebruik een string met de functie naam als je deze functie gebruikt vanuit een andere resource, zorg ervoor dat deze functie geëxporteerd is

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetCommands'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetCommandLevel'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsCommandEchoChannelOnly'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

'''NOTE:''' Alle parameters die tussen haakjes staan zijn optioneel, zie [[optional arguments]]

==Aanpassen==
Gelieve de resource niet aan te passen, je kan ze breken. Schrijf extensies.

==Contacteren==
De auteur (MCvarial) kan gecontacteerd worden op IRC (#mta,#mta.dutch)
Of via email (MCvarial@gmail.com)

Resource:Irc

2012-04-21T17:58:31Z

Mack Varial: /* Exported functions */

{{Resource page}}
__NOTOC__
The "irc" resource provides an echobot that outputs information such as chatmessages on a irc channel.
Information about "irc" or "Internet Relay Chat" can be found on [http://en.wikipedia.org/wiki/Irc Wikipedia.]

==Installation==
To get this resource working on your Linux or Windows server, follow these steps:

* '''Install the sockets module'''
** '''Download the module''': You can download the module on the [http://code.google.com/p/multitheftauto-modules/downloads/list mta-modules project]. Download the ml_sockets.dll file for Windows and the ml_sockets.so file for Linux
** '''Put the module in the MTA folder''': In order for MTA to load the module it must be placed in the mods/deathmatch/modules folder, if this folder does not exist yet, make it.
** '''Add the module to the mtaserver.conf file''': To load the module when the MTA server starts, put this line <module src="ml_sockets.dll"/> in your config file for Windows and <module src="ml_sockets.so"/> in the config file for Linux.
* '''Install the IRC resource'''
** '''Download the resource''': The IRC resource can be found on the [http://community.mtasa.com/index.php?p=resources&s=details&id=731 community], put it in the resources folder.
** '''Mod the settings.xml file''': Open this file and follow the instructions inside to configure the IRC bot.
** '''Mod the meta.xml file''': In this file a few settings can be found regarding ads and ingame gui's, '''do not mod anything else!''' You can also change these settings in the admin panel once the resource has been loaded.
** '''Acl rights''' The resource needs a couple of acl rights in order to work properly, including addBan, kickPlayer & callRemote. Any missing rights will prevent the resource from loading and will output a message in the console.

Now you can run the resource, if the server was running during this installation proces you will have to do /loadmodule ml_sockets.dll or /loadmodule ml_sockets.so and /refreshall before doing /start irc

==The acl.xml file==
The acl.xml file inside the irc resource takes care of the acl rights for irc commands.

Syntax
<syntaxhighlight lang="xml">
<command name="!kick" level="2" echoChannelOnly="true" />
</syntaxhighlight>

* The name is the command including the exclamation mark
* The level is the minimum level the irc user needs to have in order to use this command
* The echoChannelOnly is wether the command can be used outside the echo channel

==Elements==
All users, channels & servers known by the irc resource are represented by elements.
* Servers are the following elements type: 'irc-server'
* Channels are the following elements type: 'irc-channel'
* Users are the following elements type: 'irc-user'

==Level system==
The irc resource doesn't use the irc modes system for its acl, instead the modes were replaced with numbers.
* Owner (~) is now level 5
* Super Operator (&) is now level 4
* Operator (@) is now level 3
* Helper (%) is now level 2
* Voice (+) is now level 1
All other users without a special mode are level 0

==Events==
During the irc proces some events are triggered to help you write extensions for the irc resource.
You may want to use addEvent("eventName") to use them.

{| class="wikitable" border="0"
|-
|width="200pt"|'''Name'''
|width="200pt"|'''Source'''
|'''Parameters'''
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnecting'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCFailConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua">string reason</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserJoin'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string vhost</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserNickChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string oldNick, string newNick</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserPart'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason</syntaxhighlight>
|}
'''NOTE:''' 'theReason' can be nil if 'theUser' has quit without a reason.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserKick'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason, user theKicker</syntaxhighlight>
|}
'''NOTE:''' 'theKicker' can be false if 'theUser' was kicked by a service like the NickServ.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserMode'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' can be false if 'theUser' was opped by a service like the NickServ.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCChannelMode'''
|width="200pt"|channel theIRCChannel
|<syntaxhighlight lang="lua">boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' can be false if the mode was set by a service like the NickServ.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCLevelChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, number oldlevel, number newlevel</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserQuit'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theReason</syntaxhighlight>
|}

==Exported functions==
These functions can be called from another resource to help you write extensions for the irc resource.
Use the exports table or [[call]] to use them

Example 1:
<syntaxhighlight lang="lua">[Lua]
exports.irc:ircConnect("irc.gtanet.com","bot",6667)
</syntaxhighlight>
Example 2:
<syntaxhighlight lang="lua">[Lua]
call(getResourceFromName("irc"),"ircConnect","irc.gtanet.com","bot",6667)
</syntaxhighlight>

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">returns</syntaxhighlight>
|width="150pt"|'''function name'''
|'''Parameters'''
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircHop'''
|<syntaxhighlight lang="lua">server theIRCServer, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSay'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircRaw'''
|<syntaxhighlight lang="lua">server theIRCServer, string theRaw</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircPart'''
|<syntaxhighlight lang="lua">channel theIRCChannel, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircJoin'''
|<syntaxhighlight lang="lua">server theIRCServer, string theChannelName, (string theChannelPassword)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircAction'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircNotice'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theUserChannel, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''outputIRC'''
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircConnect'''
|<syntaxhighlight lang="lua">string serverHost/IP, string nickname, (number serverPort), (string serverPassword), (boolean secure)</syntaxhighlight>
|-
|} '''NOTE:''' Secure connections are not available yet due to the module not suporting SSL yet.

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIdentify'''
|<syntaxhighlight lang="lua">server theIRCServer, string thePassword</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircReconnect'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircDisconnect'''
|<syntaxhighlight lang="lua">server theIRCServer, string theReason</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircChangeNick'''
|<syntaxhighlight lang="lua">server theIRCServer, string newNick</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServers'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerName'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerHost'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetServerPort'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerPass'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerNick'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsServerSecure'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServerChannels'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelServer'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannels'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelName'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannelUsers'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelTopic'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelFromName'''
|<syntaxhighlight lang="lua">string theChannelName</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|'''ircIsEchoChannel'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserNick'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetUsers'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserServer'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser, channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserVhost'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserFromNick'''
|<syntaxhighlight lang="lua">string theNickname</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|'''addIRCCommandHandler'''
|<syntaxhighlight lang="lua">string theCommandName, function theFunctionToCall/string functionName, (number minimumLevel), (boolean echoChannelOnly)</syntaxhighlight>
|-
|} '''NOTE:''' Use a string with the function name for the second argument if your are calling this function from another resource, also make sure the function is exported.

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetCommands'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetCommandLevel'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsCommandEchoChannelOnly'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

'''NOTE:''' All parameters that are between brackets are optional, see [[optional arguments]]

==Modding==
Please don't mod the resource, you might break it and cause it to malfunction or to spam errors.
If this happens you will not get any support.
Write extensions instead.

==Contact==
The author (MCvarial) can be contacted using IRC (#mta,#mta.dutch)
Or by email (MCvarial@gmail.com)

NL/Resource:Irc

2012-04-21T16:16:57Z

Mack Varial: /* Geëxporteerde functies */

{{Resource page}}
__NOTOC__
De "irc" resource zorgt voor een echobot die berichten zoals chatberichten output op een irc channel.
Informatie over "irc" of "Internet Relay Chat" kan gevonden worden op [http://nl.wikipedia.org/wiki/Internet_Relay_Chat Wikipedia.]

==Installatie==
Om deze resource aan de praat te krijgen op je Linux of Windows server, volg deze stappen:

* '''Installeer de sockets module'''
** '''Download de module''': Je kan deze module vinden op het [http://code.google.com/p/multitheftauto-modules/downloads/list mta-modules project]. Download het ml_sockets.dll bestand voor Windows en het ml_sockets.so bestand voor Linux
** '''Voeg de module toe in de MTA map''': Om deze module te laten moet deze in de volgende map geplaatst worden: mods/deathmatch/modules, als deze map niet bestaat, maak ze dan.
** '''Voeg de module toe aan het mtaserver.conf bestand''': Om de module te laden wanneer de server start, voeg dan dit lijntje <module src="ml_sockets.dll"/> voor Windows en dit lijntje <module src="ml_sockets.so"/> voor Linux toe aan je mtaserver.conf.
* '''Installeer de IRC resource'''
** '''Download de resource''': De IRC resource kan gevond worden op de [http://community.mtasa.com/index.php?p=resources&s=details&id=731 community], plaats de resource in de resources map.
** '''Pas het settings.xml bestand aan''': Open dit bestand en volg de instructies in het bestand om de bot te configureren.
** '''Pas het meta.xml bestand aan''': In dit bestand staan een aantal settings met betrekken tot reclame en ingame gui's, '''blijf van de rest!''' Je kan deze settings ook veranderen in je admin paneel wanneer de resource geladen is.
** '''Acl rechten''' De resource heeft een aantal rechten nodig om goed te werken waaronder: addBan, kickPlayer & callRemote. Als de resource niet genoeg rechten heeft verschijnt er een bericht in de console en kan de resource niet starten.

Nu kan je de resource starten, als de server aan het werken was tijdens deze bewerkingen doe dan eerst: /loadmodule ml_sockets.dll of /loadmodule ml_sockets.so en /refreshall voordat je /start irc doet.

==Het acl.xml bestand==
Het acl.xml bestand in de irc resource zorgt voor de acl rechten van irc commands.

Syntax
<syntaxhighlight lang="xml">
<command name="!kick" level="2" echoChannelOnly="true" />
</syntaxhighlight>

* De name is de command met uitroepteken
* De level is het minimum level dat de irc user moet hebben om de command te gebruiken.
* De echoChannelOnly bepaald ofdat je de command kan gebruiken buiten het echochannel

==Elementen==
Alle gebruikers, kanalen & servers gekend door de irc resource worden voorgestand door elementen
* Servers zijn de volgende elementen: 'irc-server'
* Channels zijn de volgende elementen: 'irc-channel'
* Users zijn de volgende elementen: 'irc-user'

==Level systeem==
De irc resource gebruikt geen irc modes systeem voor zijn acl, maar wel nummers.
* Owner (~) is nu level 5
* Super Operator (&) is nu level 4
* Operator (@) is nu level 3
* Helper (%) is nu level 2
* Voice (+) is nu level 1
Alle andere gebruikers zijn nu level 0

==Events==
Gedurende het irc proces worden een aantal events getriggerd om het je gemakkelijk te maken om extensies te schrijven.
Je moet wel addEvent("eventName") doen om ze te kunnen gebruiken.

{| class="wikitable" border="0"
|-
|width="200pt"|'''Naam'''
|width="200pt"|'''Source'''
|'''Parameters'''
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnecting'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCFailConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua">string reason</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserJoin'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string vhost</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserNickChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string oldNick, string newNick</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserPart'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason</syntaxhighlight>
|}
'''NOTE:''' 'theReason' kan nil zijn als 'theUser' gequit heeft zonder reden.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserKick'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason, user theKicker</syntaxhighlight>
|}
'''NOTE:''' 'theKicker' kan false zijn als 'theUser' gekickt was door een service zoals de nickserv.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserMode'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' kan false zijn als 'theUser' geopt was door een service zoals de chanserv

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCChannelMode'''
|width="200pt"|channel theIRCChannel
|<syntaxhighlight lang="lua">boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' kan false zijn als de mode geset was door een service zoals chanserv

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCLevelChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, number oldlevel, number newlevel</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserQuit'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theReason</syntaxhighlight>
|}

==Geëxporteerde functies==
Deze functies kunnen gebeld worden van andere resources om het schrijven van extensies mogelijk te maken
Gebruik de exports tabel of [[call]] om ze te gebruiken.

Voorbeeld 1:
<syntaxhighlight lang="lua">[Lua]
exports.irc:ircConnect("irc.gtanet.com","bot",6667)
</syntaxhighlight>
Voorbeeld 2:
<syntaxhighlight lang="lua">[Lua]
call(getResourceFromName("irc"),"ircConnect","irc.gtanet.com","bot",6667)
</syntaxhighlight>

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">returns</syntaxhighlight>
|width="150pt"|'''functie naam'''
|'''Parameters'''
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircHop'''
|<syntaxhighlight lang="lua">server theIRCServer, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSay'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircRaw'''
|<syntaxhighlight lang="lua">server theIRCServer, string theRaw</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircPart'''
|<syntaxhighlight lang="lua">channel theIRCChannel, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircJoin'''
|<syntaxhighlight lang="lua">server theIRCServer, string theChannelName, (string theChannelPassword)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircAction'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircNotice'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theUserChannel, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''outputIRC'''
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircConnect'''
|<syntaxhighlight lang="lua">string serverHost/IP, string nickname, (number serverPort), (string serverPassword), (boolean secure)</syntaxhighlight>
|-
|} '''NOTE:''' Secure connections are not available yet due to the module not suporting SSL yet.

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIdentify'''
|<syntaxhighlight lang="lua">server theIRCServer, string thePassword</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircReconnect'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircDisconnect'''
|<syntaxhighlight lang="lua">server theIRCServer, string theReason</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircChangeNick'''
|<syntaxhighlight lang="lua">server theIRCServer, string newNick</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServers'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerName'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerHost'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetServerPort'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerPass'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerNick'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsServerSecure'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServerChannels'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelServer'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannels'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelName'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannelUsers'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelTopic'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelFromName'''
|<syntaxhighlight lang="lua">string theChannelName</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|'''ircIsEchoChannel'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserNick'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetUsers'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserServer'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser, channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserVhost'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserFromNick'''
|<syntaxhighlight lang="lua">string theNickname</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetUserChannels'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|''''addIRCCommandHandler'''
|<syntaxhighlight lang="lua">string theCommandName, function theFunctionToCall, (number minimumLevel), (boolean echoChannelOnly)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetCommands'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetCommandLevel'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsCommandEchoChannelOnly'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

'''NOTE:''' Alle parameters die tussen haakjes staan zijn optioneel, zie [[optional arguments]]

==Aanpassen==
Gelieve de resource niet aan te passen, je kan ze breken. Schrijf extensies.

==Contacteren==
De auteur (MCvarial) kan gecontacteerd worden op IRC (#mta,#mta.dutch)
Of via email (MCvarial@gmail.com)

Resource:Irc

2012-04-21T16:14:42Z

Mack Varial: /* Exported functions */

{{Resource page}}
__NOTOC__
The "irc" resource provides an echobot that outputs information such as chatmessages on a irc channel.
Information about "irc" or "Internet Relay Chat" can be found on [http://en.wikipedia.org/wiki/Irc Wikipedia.]

==Installation==
To get this resource working on your Linux or Windows server, follow these steps:

* '''Install the sockets module'''
** '''Download the module''': You can download the module on the [http://code.google.com/p/multitheftauto-modules/downloads/list mta-modules project]. Download the ml_sockets.dll file for Windows and the ml_sockets.so file for Linux
** '''Put the module in the MTA folder''': In order for MTA to load the module it must be placed in the mods/deathmatch/modules folder, if this folder does not exist yet, make it.
** '''Add the module to the mtaserver.conf file''': To load the module when the MTA server starts, put this line <module src="ml_sockets.dll"/> in your config file for Windows and <module src="ml_sockets.so"/> in the config file for Linux.
* '''Install the IRC resource'''
** '''Download the resource''': The IRC resource can be found on the [http://community.mtasa.com/index.php?p=resources&s=details&id=731 community], put it in the resources folder.
** '''Mod the settings.xml file''': Open this file and follow the instructions inside to configure the IRC bot.
** '''Mod the meta.xml file''': In this file a few settings can be found regarding ads and ingame gui's, '''do not mod anything else!''' You can also change these settings in the admin panel once the resource has been loaded.
** '''Acl rights''' The resource needs a couple of acl rights in order to work properly, including addBan, kickPlayer & callRemote. Any missing rights will prevent the resource from loading and will output a message in the console.

Now you can run the resource, if the server was running during this installation proces you will have to do /loadmodule ml_sockets.dll or /loadmodule ml_sockets.so and /refreshall before doing /start irc

==The acl.xml file==
The acl.xml file inside the irc resource takes care of the acl rights for irc commands.

Syntax
<syntaxhighlight lang="xml">
<command name="!kick" level="2" echoChannelOnly="true" />
</syntaxhighlight>

* The name is the command including the exclamation mark
* The level is the minimum level the irc user needs to have in order to use this command
* The echoChannelOnly is wether the command can be used outside the echo channel

==Elements==
All users, channels & servers known by the irc resource are represented by elements.
* Servers are the following elements type: 'irc-server'
* Channels are the following elements type: 'irc-channel'
* Users are the following elements type: 'irc-user'

==Level system==
The irc resource doesn't use the irc modes system for its acl, instead the modes were replaced with numbers.
* Owner (~) is now level 5
* Super Operator (&) is now level 4
* Operator (@) is now level 3
* Helper (%) is now level 2
* Voice (+) is now level 1
All other users without a special mode are level 0

==Events==
During the irc proces some events are triggered to help you write extensions for the irc resource.
You may want to use addEvent("eventName") to use them.

{| class="wikitable" border="0"
|-
|width="200pt"|'''Name'''
|width="200pt"|'''Source'''
|'''Parameters'''
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnecting'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCFailConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua">string reason</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserJoin'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string vhost</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserNickChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string oldNick, string newNick</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserPart'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason</syntaxhighlight>
|}
'''NOTE:''' 'theReason' can be nil if 'theUser' has quit without a reason.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserKick'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason, user theKicker</syntaxhighlight>
|}
'''NOTE:''' 'theKicker' can be false if 'theUser' was kicked by a service like the NickServ.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserMode'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' can be false if 'theUser' was opped by a service like the NickServ.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCChannelMode'''
|width="200pt"|channel theIRCChannel
|<syntaxhighlight lang="lua">boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' can be false if the mode was set by a service like the NickServ.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCLevelChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, number oldlevel, number newlevel</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserQuit'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theReason</syntaxhighlight>
|}

==Exported functions==
These functions can be called from another resource to help you write extensions for the irc resource.
Use the exports table or [[call]] to use them

Example 1:
<syntaxhighlight lang="lua">[Lua]
exports.irc:ircConnect("irc.gtanet.com","bot",6667)
</syntaxhighlight>
Example 2:
<syntaxhighlight lang="lua">[Lua]
call(getResourceFromName("irc"),"ircConnect","irc.gtanet.com","bot",6667)
</syntaxhighlight>

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">returns</syntaxhighlight>
|width="150pt"|'''function name'''
|'''Parameters'''
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircHop'''
|<syntaxhighlight lang="lua">server theIRCServer, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSay'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircRaw'''
|<syntaxhighlight lang="lua">server theIRCServer, string theRaw</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircPart'''
|<syntaxhighlight lang="lua">channel theIRCChannel, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircJoin'''
|<syntaxhighlight lang="lua">server theIRCServer, string theChannelName, (string theChannelPassword)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircAction'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircNotice'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theUserChannel, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''outputIRC'''
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircConnect'''
|<syntaxhighlight lang="lua">string serverHost/IP, string nickname, (number serverPort), (string serverPassword), (boolean secure)</syntaxhighlight>
|-
|} '''NOTE:''' Secure connections are not available yet due to the module not suporting SSL yet.

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIdentify'''
|<syntaxhighlight lang="lua">server theIRCServer, string thePassword</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircReconnect'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircDisconnect'''
|<syntaxhighlight lang="lua">server theIRCServer, string theReason</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircChangeNick'''
|<syntaxhighlight lang="lua">server theIRCServer, string newNick</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServers'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerName'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerHost'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetServerPort'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerPass'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerNick'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsServerSecure'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServerChannels'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelServer'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannels'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelName'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannelUsers'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelTopic'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelFromName'''
|<syntaxhighlight lang="lua">string theChannelName</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|'''ircIsEchoChannel'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserNick'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetUsers'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserServer'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser, channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserVhost'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserFromNick'''
|<syntaxhighlight lang="lua">string theNickname</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|'''addIRCCommandHandler'''
|<syntaxhighlight lang="lua">string theCommandName, function theFunctionToCall, (number minimumLevel), (boolean echoChannelOnly)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetCommands'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetCommandLevel'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsCommandEchoChannelOnly'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

'''NOTE:''' All parameters that are between brackets are optional, see [[optional arguments]]

==Modding==
Please don't mod the resource, you might break it and cause it to malfunction or to spam errors.
If this happens you will not get any support.
Write extensions instead.

==Contact==
The author (MCvarial) can be contacted using IRC (#mta,#mta.dutch)
Or by email (MCvarial@gmail.com)

Resource:Irc

2012-04-19T21:40:51Z

Mack Varial:

{{Resource page}}
__NOTOC__
The "irc" resource provides an echobot that outputs information such as chatmessages on a irc channel.
Information about "irc" or "Internet Relay Chat" can be found on [http://en.wikipedia.org/wiki/Irc Wikipedia.]

==Installation==
To get this resource working on your Linux or Windows server, follow these steps:

* '''Install the sockets module'''
** '''Download the module''': You can download the module on the [http://code.google.com/p/multitheftauto-modules/downloads/list mta-modules project]. Download the ml_sockets.dll file for Windows and the ml_sockets.so file for Linux
** '''Put the module in the MTA folder''': In order for MTA to load the module it must be placed in the mods/deathmatch/modules folder, if this folder does not exist yet, make it.
** '''Add the module to the mtaserver.conf file''': To load the module when the MTA server starts, put this line <module src="ml_sockets.dll"/> in your config file for Windows and <module src="ml_sockets.so"/> in the config file for Linux.
* '''Install the IRC resource'''
** '''Download the resource''': The IRC resource can be found on the [http://community.mtasa.com/index.php?p=resources&s=details&id=731 community], put it in the resources folder.
** '''Mod the settings.xml file''': Open this file and follow the instructions inside to configure the IRC bot.
** '''Mod the meta.xml file''': In this file a few settings can be found regarding ads and ingame gui's, '''do not mod anything else!''' You can also change these settings in the admin panel once the resource has been loaded.
** '''Acl rights''' The resource needs a couple of acl rights in order to work properly, including addBan, kickPlayer & callRemote. Any missing rights will prevent the resource from loading and will output a message in the console.

Now you can run the resource, if the server was running during this installation proces you will have to do /loadmodule ml_sockets.dll or /loadmodule ml_sockets.so and /refreshall before doing /start irc

==The acl.xml file==
The acl.xml file inside the irc resource takes care of the acl rights for irc commands.

Syntax
<syntaxhighlight lang="xml">
<command name="!kick" level="2" echoChannelOnly="true" />
</syntaxhighlight>

* The name is the command including the exclamation mark
* The level is the minimum level the irc user needs to have in order to use this command
* The echoChannelOnly is wether the command can be used outside the echo channel

==Elements==
All users, channels & servers known by the irc resource are represented by elements.
* Servers are the following elements type: 'irc-server'
* Channels are the following elements type: 'irc-channel'
* Users are the following elements type: 'irc-user'

==Level system==
The irc resource doesn't use the irc modes system for its acl, instead the modes were replaced with numbers.
* Owner (~) is now level 5
* Super Operator (&) is now level 4
* Operator (@) is now level 3
* Helper (%) is now level 2
* Voice (+) is now level 1
All other users without a special mode are level 0

==Events==
During the irc proces some events are triggered to help you write extensions for the irc resource.
You may want to use addEvent("eventName") to use them.

{| class="wikitable" border="0"
|-
|width="200pt"|'''Name'''
|width="200pt"|'''Source'''
|'''Parameters'''
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnecting'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCFailConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua">string reason</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserJoin'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string vhost</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserNickChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string oldNick, string newNick</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserPart'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason</syntaxhighlight>
|}
'''NOTE:''' 'theReason' can be nil if 'theUser' has quit without a reason.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserKick'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason, user theKicker</syntaxhighlight>
|}
'''NOTE:''' 'theKicker' can be false if 'theUser' was kicked by a service like the NickServ.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserMode'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' can be false if 'theUser' was opped by a service like the NickServ.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCChannelMode'''
|width="200pt"|channel theIRCChannel
|<syntaxhighlight lang="lua">boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' can be false if the mode was set by a service like the NickServ.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCLevelChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, number oldlevel, number newlevel</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserQuit'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theReason</syntaxhighlight>
|}

==Exported functions==
These functions can be called from another resource to help you write extensions for the irc resource.
Use the exports table or [[call]] to use them

Example 1:
<syntaxhighlight lang="lua">[Lua]
exports.irc:ircConnect("irc.gtanet.com","bot",6667)
</syntaxhighlight>
Example 2:
<syntaxhighlight lang="lua">[Lua]
call(getResourceFromName("irc"),"ircConnect","irc.gtanet.com","bot",6667)
</syntaxhighlight>

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">returns</syntaxhighlight>
|width="150pt"|'''function name'''
|'''Parameters'''
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircHop'''
|<syntaxhighlight lang="lua">server theIRCServer, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSay'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircRaw'''
|<syntaxhighlight lang="lua">server theIRCServer, string theRaw</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircPart'''
|<syntaxhighlight lang="lua">channel theIRCChannel, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircJoin'''
|<syntaxhighlight lang="lua">server theIRCServer, string theChannelName, (string theChannelPassword)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircAction'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircNotice'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theUserChannel, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''outputIRC'''
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircConnect'''
|<syntaxhighlight lang="lua">string serverHost/IP, string nickname, (number serverPort), (string serverPassword), (boolean secure)</syntaxhighlight>
|-
|} '''NOTE:''' Secure connections are not available yet due to the module not suporting SSL yet.

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIdentify'''
|<syntaxhighlight lang="lua">server theIRCServer, string thePassword</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircReconnect'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircDisconnect'''
|<syntaxhighlight lang="lua">server theIRCServer, string theReason</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircChangeNick'''
|<syntaxhighlight lang="lua">server theIRCServer, string newNick</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServers'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerName'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerHost'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetServerPort'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerPass'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerNick'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsServerSecure'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServerChannels'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelServer'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannels'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelName'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannelUsers'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelTopic'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelFromName'''
|<syntaxhighlight lang="lua">string theChannelName</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|'''ircIsEchoChannel'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserNick'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetUsers'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserServer'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser, channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserVhost'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsUserSecure'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserFromNick'''
|<syntaxhighlight lang="lua">string theNickname</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserRealName'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetUserChannels'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|'''addIRCCommandHandler'''
|<syntaxhighlight lang="lua">string theCommandName, function theFunctionToCall, (number minimumLevel), (boolean echoChannelOnly)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetCommands'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetCommandLevel'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsCommandEchoChannelOnly'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

'''NOTE:''' All parameters that are between brackets are optional, see [[optional arguments]]

==Modding==
Please don't mod the resource, you might break it and cause it to malfunction or to spam errors.
If this happens you will not get any support.
Write extensions instead.

==Contact==
The author (MCvarial) can be contacted using IRC (#mta,#mta.dutch)
Or by email (MCvarial@gmail.com)

Resource:Race

2011-11-13T11:54:57Z

Mack Varial:

{{Resource page}}
__NOTOC__
The "race" gamemode organizes sprint or freeroam races for one or more players. It supports both maps from MTA:Race and maps in the MTA:SA DM map syntax that were created in the map editor.

==Ingame==
Playing race is quite straightforward. If there are checkpoints, drive from checkpoint to checkpoint and be the first to reach the finish line within the time. If there are no checkpoints, just drive around and have fun.

In races you may encounter three types of pickups which will have an effect on your vehicle:
*'''Repair pickups:''' this pickup looks like a wrench. If you drive over it, your vehicle will be restored to full health.
*'''Nitrous oxide pickups:''' a red NOS bottle. After you drive over one you can press the fire button (by default the left mouse button) to get a temporary speed boost.
*'''Vehicle change pickups:''' these display the name of a vehicle above them. As soon as you drive over a pickup your vehicle will be changed.

Lastly, if you get stuck during a race, you can enter the /kill command in the chatbox to kill yourself and respawn at the previous checkpoint.

==Converting MTA:Race maps==
Use the [http://files.mtasa.com/apps/1.0/raceconv.zip batch converter] to convert all your MTA:Race maps into MTA:SA maps in one go.

==Map syntax==
You can create race maps using the new MTA:SA [[Resource:editor|map editor]]. The map syntax is given here for reference.

===.map file===
<syntaxhighlight lang="xml">
<map>

<spawnpoint posX="X" posY="Y" posZ="Z" rotation="Rotation in degrees" vehicle="Vehicle ID" id="spawnpointID" [ paintjob="paintjob ID" upgrades="comma-separated list of upgrades" ] />


<checkpoint posX="X" posY="Y" posZ="Z" color="#FF0000" id="textual or numeric checkpoint ID" nextid="ID of checkpoint after this one" [ size="checkpoint size" vehicle="vehicle ID to change into" type="checkpoint/ring/cylinder/arrow/corona" paintjob="paintjob ID" upgrades="comma-separated list of upgrades" ] />


<object posX="X" posY="Y" posZ="Z" rotX="in degrees" rotY="in degrees" rotZ="in degrees" model="model ID" id="objectID" />


<pickup posX="X" posY="Y" posZ="Z" type="repair|nitro|vehiclechange" id="pickupID" [ vehicle="vehicle ID" paintjob="paintjob ID" upgrades="comma-separated list of upgrades" ] />
</map>
</syntaxhighlight>

===meta.xml===
<syntaxhighlight lang="xml">
<meta>
<info type="map" gamemodes="race" name="Map name" author="Author name" description="Map description" version="Map version number"/>
<race src="Map file.map"/>
<settings>
<setting name="#optionName" value="optionValue"/>
...
</settings>
</meta>
</syntaxhighlight>
The <setting>s correspond to options in MTA:Race syntax. For example, <time>4:0</time> in MTA:Race syntax would correspond to <setting name="#time" value="4:0"/> in DM syntax.

==Addons==
A Race 'addon' is no different from any other script resource, except that is has addon="race" in the <info> section of it's meta.xml file. This is simply to allow Race to identify it and put it in the /config menu for you. Addons communicate with Race via events. The current list of Race events and what they do are here:

==Events for version 0.8.3==
'''Note:''' You may have to add the events in your script using addEvent() if you want to use them.
===Server===

{| class="wikitable" border="0"
|-
|width="200pt"|'''Name'''
|width="60pt"|'''Source'''
|'''Parameters'''
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onPlayerReachCheckpoint'''
|width="60pt"|player
|<syntaxhighlight lang="lua">int checkpoint, int time_</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onPlayerPickUpRacePickup'''
|width="60pt"|player
|<syntaxhighlight lang="lua">int/string pickupID, string pickupType, int vehicleModel</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onMapStarting'''
|width="60pt"|
|<syntaxhighlight lang="lua">table mapInfo, table mapOptions, table gameOptions</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onPlayerFinish'''
|width="60pt"|player
|height="20pt"|<syntaxhighlight lang="lua">int rank, int time</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onPostFinish'''
|width="60pt"|
|height="38pt"|
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onPollStarting'''
|width="60pt"|
|<syntaxhighlight lang="lua">table poll</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onRaceStateChanging'''
|width="60pt"|
|<syntaxhighlight lang="lua">string newStateName, string oldStateName</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onPlayerRaceWasted'''
|width="60pt"|player
|<syntaxhighlight lang="lua">vehicle playersVehicle</syntaxhighlight>
|-
|}

===Client===

{| class="wikitable" border="0"
|-
|width="200pt"|'''onClientMapStarting'''
|width="60pt"|
|<syntaxhighlight lang="lua">table mapinfo</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onClientPlayerFinish'''
|width="60pt"|player
|height="38pt"|
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onClientPlayerOutOfTime'''
|width="60pt"|player
|height="38pt"|
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onClientMapStopping'''
|width="60pt"|
|height="38pt"|
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onClientScreenFadedOut'''
|width="60pt"|
|height="38pt"|
|-
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onClientScreenFadedIn'''
|width="60pt"|
|height="38pt"|
|-
|}

==Events for version 0.8.3 in detail==
'''Note:''' You may have to add the events in your script using addEvent() if you want to use them.
===onRaceStateChanging===
Triggered when the race resource starts doing something else.
===Parameters===
<syntaxhighlight lang="lua">string newState, string oldState</syntaxhighlight>
*'''newState:''' the new state
*'''oldState:''' the old state

Possible states:
* undefined
* NoMap
* LoadingMap
* PreGridCountdown
* GridCountdown
* Running
* MidMapVote
* SomeoneWon
* TimesUp
* EveryoneFinished
* PostFinish
* NextMapSelect
* NextMapVote
* ResourceStopping

===Source===
The root element.

===onPlayerReachCheckpoint===
Triggered when a player reaches any checkpoint but the last one.
====Parameters====
<syntaxhighlight lang="lua">int checkpoint, int time</syntaxhighlight>
*'''checkpoint:''' the number of the checkpoint the player went through. The first checkpoint has number 1.
*'''time:''' time since the race started, in milliseconds.

====Source====
The source is the player that reached the checkpoint.

===onPlayerFinish===
Triggered when a player reaches the last checkpoint (i.e. has finished the race)
====Parameters====
<syntaxhighlight lang="lua">int rank, int time</syntaxhighlight>
*'''rank:''' the player's rank. 1 means he won the race, 2 that he came in second place, etc.
*'''time:''' time since the race started, in milliseconds.

====Source====
The source is the player that finished the race.

===onPlayerPickUpRacePickup===
====Parameters====
<syntaxhighlight lang="lua">int/string pickupID, string pickupType, int vehicleModel</syntaxhighlight>
*'''pickupID:''' the number of the pickup in case of MTA:Race syntax (starting at 1), or the "id" attribute of the pickup in case of DM syntax.
*'''pickupType:''' the pickup type. Can be "nitro", "repair" or "vehiclechange".
*'''vehicleModel:''' if the pickup is of type vehiclechange, this is the vehicle model that it sets.

====Source====
The source is the player that picked up the pickup.

==Element data==
These element data are set on each player:
*'''race rank:''' the current position of the player in the race. 1 = first, 2 = second etc. Updated on a 1 second interval.
*'''race.checkpoint:''' the number of the checkpoint the player is ''heading for''. When the player spawns this number is 1, after he passed the first checkpoint it's 2, etc.
*'''race.finished:''' ''true'' if the player has finished, ''false'' if he's still racing.

This server only element data is set for the resource root element:
*'''info:''' which contains a table with these sub-tables: '''mapInfo''', '''mapOptions''' and '''gameOptions'''.

==Super Advanced Element data==
You can also set player element data to change the player collision status and render transparency:
<syntaxhighlight lang="lua">
e.g. setElementData( thePlayer, "overrideCollide.uniqueblah", 0, false ) -- Collide 'off' for this player
setElementData( thePlayer, "overrideCollide.uniqueblah", nil, false ) -- Collide 'default' for this player
setElementData( thePlayer, "overrideAlpha.uniqueblah", 120, false ) -- Alpha '120 maximum' for this player
setElementData( thePlayer, "overrideAlpha.uniqueblah", nil, false ) -- Alpha 'default' for this player
</syntaxhighlight>
Set 'uniqueblah' to whatever you like (up to 15 characters long)

==Exported Server functions==

{| class="wikitable" border="0"
|-
|width="80pt"|<syntaxhighlight lang="lua">int</syntaxhighlight>
|width="110pt"|'''getTimePassed'''
|height="38pt"|
|-
|}

{| class="wikitable" border="0"
|-
|width="80pt"|<syntaxhighlight lang="lua">int</syntaxhighlight>
|width="110pt"|'''getPlayerRank'''
|<syntaxhighlight lang="lua">player thePlayer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="80pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width="110pt"|'''isPlayerFinished'''
|<syntaxhighlight lang="lua">player thePlayer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="80pt"|<syntaxhighlight lang="lua">vehicle</syntaxhighlight>
|width="110pt"|'''getPlayerVehicle'''
|<syntaxhighlight lang="lua">player thePlayer</syntaxhighlight>
|-
|}

Modules/Sockets

2011-08-19T16:41:01Z

Mack Varial:

<pageclass class="#AA7592" subcaption="Sockets Module"></pageclass>
__NOTOC__
{{Module_Info|
name = ml_sockets |
version = 1.2 |
author = Gamesnert, x86 & MCvarial |
module_website = ''[http://code.google.com/p/multitheftauto-modules/ Here]'' |
download_link = ''[http://code.google.com/p/multitheftauto-modules/downloads/list Here]'' |
license = ''GPLv3'' |
written_in = C++ |
operating_system = Cross-platform |
compatible_with = 1.0.5 & 1.1
}}
This module provides socket related functions and events for MTA:SA.
Sockets provide various possibilities such as opening a webpage, connecting to irc etc.

==Installation==
===Windows===
Uncompress the file ml_sockets.dll into your ''server\mods\deathmatch\modules\'' directory.

===Linux===
Place the file ml_sockets.so into your ''server/mods/deathmatch/modules/'' directory.

===mtaserver.conf===
Add the following line in your mtaserver.conf:
<syntaxhighlight lang="xml">
<module src="ml_sockets" />
</syntaxhighlight>

==See Also==
===Functions===
{{Modules/Sockets/Functions}}

===Events===
{{Modules/Sockets/Events}}

===Resources===
*[[resource:irc]]
[[Category:Modules]]

GuiSetProperty

2011-08-19T11:53:27Z

Mack Varial:

{{Client function}}
__NOTOC__
This function sets the value of a specific CEGUI property of a GUI element. For a list of properties and their meaning, see the [http://cegui.org.uk/static/WindowsLookProperties.html CEGUI properties wiki page].

==Syntax==
<syntaxhighlight lang="lua">
bool guiSetProperty ( element guiElement, string property, string value )
</syntaxhighlight>

===Required Arguments===
*'''guiElement:''' the GUI element you wish to get a property of.
*'''property:''' the name of of property you want the value of.
*'''value:''' the new value for the property.

===Returns===
If the function succeeds it returns ''true'', if it fails it returns ''false''.

==Example==
This example creates a button when the resource starts and defines a console command that toggles it between enabled (clickable) and disabled (not clickable).
<syntaxhighlight lang="lua">

function onStart()
button = guiCreateButton( 20, 200, 150, 30, "Test", false )
end
addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource() ), onStart )

function toogleButton()
local currentState = guiGetProperty( button, "Disabled" )
if currentState == "False" then
guiSetProperty( button, "Disabled", "True" )
else
guiSetProperty( button, "Disabled", "False" )
end
end
addCommandHandler( "togglebtn", toogleButton )
</syntaxhighlight>

==See Also==
{{GUI functions}}

CreateVehicle

2011-08-15T09:29:14Z

Mack Varial:

{{Needs_Checking|Numberplates only seem to work for some vehicles, and then only for the front or rear plate only}}
{{Needs_Checking|Link near see also is broken}}
__NOTOC__
{{Server client function}}
This function creates a vehicle at the specified location.

Its worth noting that the position of the vehicle is the center point of the vehicle, not its base. As such, you need to ensure that the z value (vertical axis) is some height above the ground. You can find the exact height using the client side function [[getElementDistanceFromCentreOfMassToBaseOfModel]], or you can estimate it yourself and just spawn the vehicle so it drops to the ground.

'''Important Note:''' Vehicles (and other elements) created client-side are only seen by the client that created them, aren't synced and players cannot enter them. They are essentially for display only.

==Syntax==
<syntaxhighlight lang="lua">
vehicle createVehicle ( int model, float x, float y, float z, [float rx, float ry, float rz, string numberplate] )
</syntaxhighlight>

===Required Arguments===
* '''model''': The [[Vehicle IDs|vehicle ID]] of the vehicle being created.
* '''x''': A floating point number representing the X coordinate on the map.
* '''y''': A floating point number representing the Y coordinate on the map.
* '''z''': A floating point number representing the Z coordinate on the map.

===Optional Arguments===
{{OptionalArg}}
* '''rx''': A floating point number representing the rotation about the X axis in degrees.
* '''ry''': A floating point number representing the rotation about the Y axis in degrees.
* '''rz''': A floating point number representing the rotation about the Z axis in degrees.
* '''numberplate''': A string that will go on the number plate of the car (max 8 characters). This is only applicable to cars.

===Returns===
Returns the [[vehicle]] element that was created. Returns ''false'' if the arguments are incorrect, or if the vehicle limit of 65535 is exceeded.

==Using trains==
Trains are created using the createVehicle function. They are placed at the nearest point of the GTASA train pathing (railroad tracks) from their spawning point.

==Example==
<section name="Example 1: Server" class="server" show="true">
This script spawns a Rhino on top of one lucky individual.
<syntaxhighlight lang="lua">
function scriptCreateTank ( player, command )
local luckyBugger = getRandomPlayer() -- get a random player
local x, y, z = getElementPosition ( luckyBugger ) -- retrive the player's position
createVehicle ( 432, x, y, z + 10 ) -- create the tank 10 units above them
outputChatBox ( "You got Tank'd!", luckyBugger )
end
--Attach the 'scriptCreateTank' function to the "tank" command
addCommandHandler ( "tank", scriptCreateTank )
</syntaxhighlight>
</section>

<section name="Example 2: Client" class="client" show="true">
This script spawns a Rhino on top of the local player.
<syntaxhighlight lang="lua">
function scriptCreateTank ( commandName )
local luckyBugger = getLocalPlayer() -- get the local player
local x, y, z = getElementPosition ( luckyBugger ) -- retrive the player's position
createVehicle ( 432, x, y, z + 10 ) -- create the tank 10 units above them
outputChatBox ( "You got Tank'd!", 255, 0, 0)
end
--Attach the 'scriptCreateTank' function to the "tank" command
addCommandHandler ( "tank", scriptCreateTank )
</syntaxhighlight>
</section>

<section name="Example 3: Server" class="server" show="true">
This example creates a vehicle five units to the right of a player when they type ''createvehicle'' and its name in the console:
<syntaxhighlight lang="lua">
local distance = 5 --units

-- define our handler (we'll take a variable number of parameters where the name goes, because there are vehicle names with more than one word)
function consoleCreateVehicle ( sourcePlayer, commandName, ... )
-- if a player triggered it, not the admin,
if ( sourcePlayer ) then
-- calculate the position of the vehicle based on the player's position and rotation:
local x, y, z = getElementPosition ( sourcePlayer ) -- get the player's position
local rotZ = getPedRotation ( sourcePlayer ) -- get the player's rotation around the Z axis in degrees
x = x + ( ( math.cos ( math.rad ( rotZ ) ) ) * distance ) -- calculate the X position of the vehicle
y = y + ( ( math.sin ( math.rad ( rotZ ) ) ) * distance ) -- calculate the Y position of the vehicle

-- get the complete vehicle name by joining all passed parameters using Lua function table.concat
local vehicleName = table.concat({...}, " ")
-- get the vehicle's model ID from the name
local vehicleID = getVehicleModelFromName ( vehicleName )
-- if vehicle ID is valid,
if vehicleID then
-- create the vehicle using the information gathered above:
local newVehicle = createVehicle ( vehicleID, x, y, z, 0, 0, rotZ )
-- if vehicle creation failed, give the player a message
if not newVehicle then
outputConsole ( "Failed to create vehicle.", sourcePlayer )
end
end
end
end

-- Attach the 'consoleCreateVehicle' function to the "createvehicle" command
addCommandHandler ( "createvehicle", consoleCreateVehicle )
</syntaxhighlight>
</section>

==See Also==

{{IDs}}

{{Vehicle functions}}

User:Mack Varial

2011-08-14T20:02:18Z

Mack Varial:

Hi thar,

* I play mta as [SKC]MCvarial
* I am [http://www.teamskc.co.uk SKC] clan member
* I script for [http://mtasa.littlewhitey.com littlewhitey's server]
* I annoy people on #mta
* I help people on #mta.scripting if no one else is available

== TODO ==
* <strike>fix [http://community.mtasa.com/index.php?p=resources&s=details&id=731 irc resource]</strike>
* finish smileys resource
* finish web resource
* <strike>graduate</strike>
* learn C++
* <strike>actually contribute something to mta</strike>
* complete the sockets module
** fix ssl
** add listening sockets

User:Mack Varial

2011-08-14T10:20:35Z

Mack Varial: /* TODO */

Hi thar,

* I play mta as [SKC]MCvarial
* I am [http://www.teamskc.co.uk SKC] clan member
* I script for their servers
* I script for [http://mtasa.littlewhitey.com littlewhitey's server]
* I annoy people on #mta
* I help people on #mta.scripting if no one else is available

== TODO ==
* <strike>fix [http://community.mtasa.com/index.php?p=resources&s=details&id=731 irc resource]</strike>
* finish smileys resource
* finish web resource
* <strike>graduate</strike>
* learn C++
* <strike>actually contribute something to mta</strike>
* complete the sockets module
** fix ssl
** add listening sockets

Modules/cURL/curl strerror

2011-07-16T15:41:24Z

Mack Varial:

__NOTOC__
{{ModuleFunction|cURL}}
Returns a string with detailed information of an error.

==Syntax==
<syntaxhighlight lang="lua">
curl_strerror(curl handler, CURLcode code)
</syntaxhighlight>

==Required arguments==
* '''curl''' The curl handler
* '''code''' The curl code

==Returns==
The string containing the error, if the code was not found in the system it will return nil

==Example==
<syntaxhighlight lang="lua">
curl = curl_init();
if not curl then
outputDebugString("Can't connect to http://mtasa.com/ with cURL");
else
curl_setopt(curl, CURLOPT_URL, curl_escape(curl, "http://mtasa.com/"));
result = curl_perform(curl, {
writefunction = function(html)
-- Hell what should i do with html? :S
end,
});
print(curl_strerror(curl, result)); -- Since we know that mta exists, we sure get the text 'No error.'
curl_close(curl);
end
</syntaxhighlight>

==See also==
{{Modules/cURL/functions}}

Modules/cURL/curl close

2011-07-16T15:41:16Z

Mack Varial:

__NOTOC__
{{ModuleFunction|cURL}}
Closes the curl engine.

==Syntax==
<syntaxhighlight lang="lua">
curl_close(curl handler)
</syntaxhighlight>

==Required arguments==
* '''curl''' The curl handler

==Returns==
True on succes, false otherwise

==Example==
<syntaxhighlight lang="lua">
curl = curl_init("http://mtasa.com/");
if not curl then
outputDebugString("Can't connect to http://mtasa.com/ with cURL");
else
curl_close(curl);
end
</syntaxhighlight>

==See also==
{{Modules/cURL/functions}}

Modules/cURL/curl escape

2011-07-16T15:41:07Z

Mack Varial:

__NOTOC__
{{ModuleFunction|cURL}}
Escape url's. You wont need this function if you pass the url to curl_init.

==Syntax==
<syntaxhighlight lang="lua">
curl_escape(curl handler, string url)
</syntaxhighlight>

==Required arguments==
* '''curl''' The curl handler
* '''url''' The url you want to escape

==Returns==
The escaped url, if it fails it will return nil

==Example==
<syntaxhighlight lang="lua">
curl = curl_init();
if not curl then
outputDebugString("Can't connect to http://mtasa.com/ with cURL");
else
curl_setopt(curl, CURLOPT_URL, curl_escape(curl, "http://mtasa.com/"));
curl_close(curl);
end
</syntaxhighlight>

==See also==
{{Modules/cURL/functions}}

Modules/cURL/curl init

2011-07-16T15:40:58Z

Mack Varial:

{{Modules/cURL/func_page|
description = Initialize the curl engine.|
syntax = <syntaxhighlight lang="lua">curl curl_init([string url])</syntaxhighlight>|
required_arguments = *There are no required arguments.|
optional_arguments = * '''url''' The url which you want to connect too.|
returns = A valid curl handler on succes, otherwise it returns false|
example = <syntaxhighlight lang="lua">
curl = curl_init("http://mtasa.com/");
if not curl then
outputDebugString("Can't connect to http://mtasa.com/ with cURL");
else
// lets do something here.
end
</syntaxhighlight>
}}

Modules/cURL/curl perform

2011-07-16T15:40:39Z

Mack Varial:

__NOTOC__
{{ModuleFunction|cURL}}
Let cURL do his work now, by call this function.

==Syntax==
<syntaxhighlight lang="lua">
curl_perform(curl handler[, table callbackfunctions])
</syntaxhighlight>

==Required arguments==
* '''curl''' The curl handler

==Optional arguments==
* '''callbackfunctions''' A set with callback functions;
<syntaxhighlight lang="lua">
local callbacks = {
writefunction = function(data)
-- This is the actual return data from the call
end,
headerfunction = function(data)
-- This is the return headers from the call. (the webserver you call sends those headers back)
end
}
</syntaxhighlight>

==Returns==
Returns a curl code, if the code is CURLE_OK then your good. Other wise pass this code to curl_strerror, and then you will know what is going on.

==Example==
<syntaxhighlight lang="lua">
curl = curl_init();
if not curl then
outputDebugString("Can't connect to http://mtasa.com/ with cURL");
else
curl_setopt(curl, CURLOPT_URL, curl_escape(curl, "http://mtasa.com/"));
curl_perform(curl, {
writefunction = function(html)
-- Hell what should i do with html? :S
end,
});
curl_close(curl);
end
</syntaxhighlight>

==See also==
{{Modules/cURL/functions}}

Modules/cURL/curl setopt

2011-07-16T15:40:29Z

Mack Varial:

__NOTOC__
{{ModuleFunction|cURL}}
Set an curl option.

==Syntax==
<syntaxhighlight lang="lua">
curlcode curl_setopt(curl handler, curloption option, bool/number/string value)
</syntaxhighlight>

==Required arguments==
* '''handler''' The curl handler.
* '''option''' An curl option, al the options are found [[Modules/cURL/CURLOPT|here]]
* '''value''' The value, this can be a string, number or boolean. At the [[Modules/cURL/CURLOPT|curl option list]] you can find wich option needs a string, number or boolean.

==Returns==
Returns a curlcode. Nevermind it for now, i even don't know what it is. But it returns it.

==Example==
<syntaxhighlight lang="lua">
curl = curl_init("http://mtasa.com/");
if not curl then
outputDebugString("Can't connect to http://mtasa.com/ with cURL");
else
curl_setopt(curl, CURLOPT_POST, true);
curl_close(curl);
end
</syntaxhighlight>

==See also==
{{Modules/cURL/functions}}

Modules/cURL/curl cleanup

2011-07-16T15:39:33Z

Mack Varial:

__NOTOC__
{{ModuleFunction|cURL}}
Cleans up the curl handle.

==Syntax==
<syntaxhighlight lang="lua">
curl_cleanup(curl handler)
</syntaxhighlight>

==Required arguments==
* '''curl''' The curl handler

==Returns==
Nothing usefull

==Example==
<syntaxhighlight lang="lua">
curl = curl_init("http://mtasa.com/");
if not curl then
outputDebugString("Can't connect to http://mtasa.com/ with cURL");
else
curl_perform(curl);
curl_cleanup(curl);
curl_close(curl);
end
</syntaxhighlight>

==See also==
{{Modules/cURL/functions}}

Modules/bIRC

2011-07-16T15:37:52Z

Mack Varial:

<pageclass class="#0099AA" subcaption="Basic IRC Module"></pageclass>
<div style="border:3px solid red;margin-bottom:3px;padding-left:10px;"><div style="float:right;padding-right:5px;font-weight:bold;"></div>
''Note: Development for this module seems to have halted, use [[resource:irc]] for now.''
</div>
__NOTOC__
{{Module_Info|
name = ml_birc |
version = 1.0 |
author = [[User:Awwu|Awwu]] <awwugta@gmail.com> |
module_website = ''None'' |
download_link = ''Soon'' |
license = ''Unlicensed'' |
written_in = Unknown |
operating_system = Windows only |
compatible_with = 1.0 |
}}
Basic IRC module (bIRC) provides a fully functional server IRC echo for MTA:SA. It is currently available only for Windows servers on MTA:SA 1.0 (other versions untested).

==Installation==
Uncompress the file ml_birc.dll into your ''server\mods\deathmatch\modules\'' directory.

===mtaserver.conf===
Add the following line in your mtaserver.conf:
<syntaxhighlight lang="lua" lang="xml">
<module src="ml_birc" />
</syntaxhighlight>

==Provided scripting functionality==
{{ml_birc functions}}
{{ml_birc callbacks}}

[[Category:Modules]]

Modules/bIRC

2011-07-16T15:35:39Z

Mack Varial:

<pageclass class="#0099AA" subcaption="Basic IRC Module"></pageclass>
<div style="border:3px solid red;margin-bottom:3px;padding-left:10px;"><div style="float:right;padding-right:5px;font-weight:bold;"></div>
''Note: Development for this module seems to have halted, use resource:irc for now.''
</div>
__NOTOC__
{{Module_Info|
name = ml_birc |
version = 1.0 |
author = [[User:Awwu|Awwu]] <awwugta@gmail.com> |
module_website = ''None'' |
download_link = ''Soon'' |
license = ''Unlicensed'' |
written_in = Unknown |
operating_system = Windows only |
compatible_with = 1.0 |
}}
Basic IRC module (bIRC) provides a fully functional server IRC echo for MTA:SA. It is currently available only for Windows servers on MTA:SA 1.0 (other versions untested).

==Installation==
Uncompress the file ml_birc.dll into your ''server\mods\deathmatch\modules\'' directory.

===mtaserver.conf===
Add the following line in your mtaserver.conf:
<syntaxhighlight lang="lua" lang="xml">
<module src="ml_birc" />
</syntaxhighlight>

==Provided scripting functionality==
{{ml_birc functions}}
{{ml_birc callbacks}}

[[Category:Modules]]

Modules/SebasIRC

2011-07-16T15:33:37Z

Mack Varial:

{{ml_irc}}
<div style="border:3px solid red;margin-bottom:3px;padding-left:10px;"><div style="float:right;padding-right:5px;font-weight:bold;"></div>
''Note: Development for this module has stopped, use [[resource:irc]] instead.''
</div>
__NOTOC__
{{Module_Info|
name = ml_irc |
version = 1.0 |
author = [[User:Sebassje|x86]] <sebasdevelopment@gmx.com> |
module_website = ''[http://code.google.com/p/multitheftauto-modules/ Here]'' |
download_link = ''[http://multitheftauto-modules.googlecode.com/svn/branches/ml_irc-rewrite/output/ml_irc.dll Here]'' |
license = ''Unlicensed'' |
}}
This ml_irc is a module for your MTA:SA 1.x Windows server, that provides IRC echo.
* '''Note:''' The bot can't join multiple servers.

==Installation==
===Windows===
Uncompress the file ml_irc.dll into your ''server\mods\deathmatch\modules\'' directory.

===mtaserver.conf===
Add the following line in your mtaserver.conf:
<syntaxhighlight lang="xml">
<module src="ml_irc" />
</syntaxhighlight>

==See Also==
===Functions===
{{Modules/SebasIRC/Functions}}

===Events===
{{Modules/SebasIRC/Events}}

[[Category:Modules]]

Modules/IRCEcho

2011-07-16T15:33:09Z

Mack Varial:

<div style="border:3px solid red;margin-bottom:3px;padding-left:10px;"><div style="float:right;padding-right:5px;font-weight:bold;"></div>
''Note: This module only works on DP2.3, use [[resource:irc]] for now''
</div>

{{Module_Info|
name = MTASA IRC Echo |
version = 2.1 |
author = [[User:VRocker|VRocker]] |
module_website = ''Not available'' |
download_link = [http://liberty-unleashed.co.uk/MTA/IRC%20Echo%20Script%20v2.zip Here] |
license = ''Unlicensed'' |
written_in = C++ |
operating_system = Cross-platform |
compatible_with = DP2.3 |
}}
MTASA IRC Echo is a module that provides an IRC echo for an MTASA server. It is available for both Windows and Linux.

==Installation==
===Windows===
Uncompress the file ml_ircecho.dll into your ''%PROGRAMFILES%\MTA San Andreas\server\mods\deathmatch\modules\'' directory.

Then, add the following line in mtaserver.conf:
<syntaxhighlight lang="xml">
<module src="ml_ircecho.dll" />
</syntaxhighlight>

===Linux===
Uncompress the file ml_ircecho.so into your ''%MTASERVER%\mods\deathmatch\modules\'' directory.

Then, add the following line in mtaserver.conf:
<syntaxhighlight lang="xml">
<module src="ml_ircecho.so" />
</syntaxhighlight>

==Functions==
{{Modules/IRCEcho/Functions}}

==Callbacks==
{{Modules/IRCEcho/Callbacks}}

[[Category:Modules]]

Modules/IRCEcho

2011-07-16T15:31:42Z

Mack Varial:

{{Needs_Checking|Is this module still stable in 1.0/1.1? Seems to crash alot and unable to join channels.}}
{{Needs_Checking|Confirmed by x86, only works for DP2.3, use [[Resource:Irc]] for now}}

{{Module_Info|
name = MTASA IRC Echo |
version = 2.1 |
author = [[User:VRocker|VRocker]] |
module_website = ''Not available'' |
download_link = [http://liberty-unleashed.co.uk/MTA/IRC%20Echo%20Script%20v2.zip Here] |
license = ''Unlicensed'' |
written_in = C++ |
operating_system = Cross-platform |
compatible_with = DP2.3 |
}}
MTASA IRC Echo is a module that provides an IRC echo for an MTASA server. It is available for both Windows and Linux.

==Installation==
===Windows===
Uncompress the file ml_ircecho.dll into your ''%PROGRAMFILES%\MTA San Andreas\server\mods\deathmatch\modules\'' directory.

Then, add the following line in mtaserver.conf:
<syntaxhighlight lang="xml">
<module src="ml_ircecho.dll" />
</syntaxhighlight>

===Linux===
Uncompress the file ml_ircecho.so into your ''%MTASERVER%\mods\deathmatch\modules\'' directory.

Then, add the following line in mtaserver.conf:
<syntaxhighlight lang="xml">
<module src="ml_ircecho.so" />
</syntaxhighlight>

==Functions==
{{Modules/IRCEcho/Functions}}

==Callbacks==
{{Modules/IRCEcho/Callbacks}}

[[Category:Modules]]

User:Mack Varial

2011-06-29T09:15:01Z

Mack Varial: /* TODO */

Hi thar,

* I play mta as [SKC]MCvarial
* I am [http://www.teamskc.co.uk SKC] clan member
* I script for their servers
* I script for [http://mtasa.littlewhitey.com littlewhitey's server]
* I annoy people on #mta
* I help people on #mta.scripting if no one else is available

== TODO ==
* <strike>fix [http://community.mtasa.com/index.php?p=resources&s=details&id=731 irc resource]</strike>
* finish smileys resource
* finish web resource
* <strike>graduate</strike>
* learn C++
* actually contribute something to mta
* complete the sockets module
** fix ssl
** add listening sockets

User:Mack Varial

2011-05-07T16:10:22Z

Mack Varial:

Hi thar,

* I play mta as [SKC]MCvarial
* I am [http://www.teamskc.co.uk SKC] clan member
* I script for their servers
* I script for [http://mtasa.littlewhitey.com littlewhitey's server]
* I annoy people on #mta
* I help people on #mta.scripting if no one else is available

== TODO ==
* <strike>fix [http://community.mtasa.com/index.php?p=resources&s=details&id=731 irc resource]</strike>
* finish smileys resource
* finish web resource
* graduate
* learn C++
* actually contribute something to mta
* complete the sockets module
** fix ssl
** add listening sockets

Modules/SebasIRC

2011-05-04T14:39:49Z

Mack Varial:

{{ml_irc}}
<div style="border:3px solid red;margin-bottom:3px;padding-left:10px;"><div style="float:right;padding-right:5px;font-weight:bold;"></div>
''Note: Development for this module has stopped, use ml_sockets instead.''
</div>
__NOTOC__
{{Module_Info|
name = ml_irc |
version = 1.0 |
author = [[User:Sebassje|x86]] <sebasdevelopment@gmx.com> |
module_website = ''[http://code.google.com/p/multitheftauto-modules/ Here]'' |
download_link = ''[http://multitheftauto-modules.googlecode.com/svn/branches/ml_irc-rewrite/output/ml_irc.dll Here]'' |
license = ''Unlicensed'' |
}}
This ml_irc is a module for your MTA:SA 1.x Windows server, that provides IRC echo.
* '''Note:''' The bot can't join multiple servers.

==Installation==
===Windows===
Uncompress the file ml_irc.dll into your ''server\mods\deathmatch\modules\'' directory.

===mtaserver.conf===
Add the following line in your mtaserver.conf:
<syntaxhighlight lang="xml">
<module src="ml_irc" />
</syntaxhighlight>

==See Also==
===Functions===
{{Modules/SebasIRC/Functions}}

===Events===
{{Modules/SebasIRC/Events}}

[[Category:Modules]]

Modules/IRCEcho

2011-05-04T14:34:23Z

Mack Varial:

{{Needs_Checking|Is this module still stable in 1.0/1.1? Seems to crash alot and unable to join channels.}}

{{Module_Info|
name = MTASA IRC Echo |
version = 2.1 |
author = [[User:VRocker|VRocker]] |
module_website = ''Not available'' |
download_link = [http://liberty-unleashed.co.uk/MTA/IRC%20Echo%20Script%20v2.zip Here] |
license = ''Unlicensed'' |
}}
MTASA IRC Echo is a module that provides an IRC echo for an MTASA server. It is available for both Windows and Linux.

==Installation==
===Windows===
Uncompress the file ml_ircecho.dll into your ''%PROGRAMFILES%\MTA San Andreas\server\mods\deathmatch\modules\'' directory.

Then, add the following line in mtaserver.conf:
<syntaxhighlight lang="xml">
<module src="ml_ircecho.dll" />
</syntaxhighlight>

===Linux===
Uncompress the file ml_ircecho.so into your ''%MTASERVER%\mods\deathmatch\modules\'' directory.

Then, add the following line in mtaserver.conf:
<syntaxhighlight lang="xml">
<module src="ml_ircecho.so" />
</syntaxhighlight>

==Functions==
{{Modules/IRCEcho/Functions}}

==Callbacks==
{{Modules/IRCEcho/Callbacks}}

[[Category:Modules]]

User:Mack Varial

2011-02-26T15:40:48Z

Mack Varial:

Hi thar,

* I play mta as [SKC]MCvarial
* I am [http://www.teamskc.co.uk SKC] clan member
* I script for their servers (or that's atleast my intention)
* I script for [http://mtasa.littlewhitey.com littlewhitey's race server]
* I annoy people on #mta
* I help people on #mta.scripting if no one else is available

== TODO ==
* <strike>fix [http://community.mtasa.com/index.php?p=resources&s=details&id=731 irc resource]</strike>
* finish smileys resource
* finish web resource
* graduate
* get €70k
* learn C++
* actually contribute something to mta
* complete the sockets module
** fix ssl
** add listening sockets

User:Mack Varial

2011-02-12T23:22:43Z

Mack Varial:

Hi thar,

* I play mta as [SKC]MCvarial
* I am [http://www.teamskc.co.uk SKC] clan member
* I script for their servers (or that's atleast my intention)
* I script for [http://mtasa.littlewhitey.com littlewhitey's race server]
* I annoy people on #mta
* I help people on #mta.scripting if no one else is available

== TODO ==
* <strike>fix [http://community.mtasa.com/index.php?p=resources&s=details&id=731 irc resource]</strike>
* finish smileys resource
* finish web resource
* graduate
* learn C++
* actually contribute something to mta
* complete the sockets module
** fix ssl
** add listening sockets

Talk:Optional Arguments

2011-01-04T15:20:51Z

Mack Varial: Created page with ""Optional Arguments have one limitation. You cannot use any optional arguments unless all previous arguments are also supplied." What if you replace one of the previous argument..."

"Optional Arguments have one limitation. You cannot use any optional arguments unless all previous arguments are also supplied."

What if you replace one of the previous arguments with 'nil'? Atleast that works with addBan().

NL/Resource:Irc

2011-01-04T15:17:34Z

Mack Varial: Created page with "{{Resource page}} __NOTOC__ De "irc" resource zorgt voor een echobot die berichten zoals chatberichten output op een irc channel. Informatie over "irc" of "Internet Relay Chat" k..."

{{Resource page}}
__NOTOC__
De "irc" resource zorgt voor een echobot die berichten zoals chatberichten output op een irc channel.
Informatie over "irc" of "Internet Relay Chat" kan gevonden worden op [http://nl.wikipedia.org/wiki/Internet_Relay_Chat Wikipedia.]

==Installatie==
Om deze resource aan de praat te krijgen op je Linux of Windows server, volg deze stappen:

* '''Installeer de sockets module'''
** '''Download de module''': Je kan deze module vinden op het [http://code.google.com/p/multitheftauto-modules/downloads/list mta-modules project]. Download het ml_sockets.dll bestand voor Windows en het ml_sockets.so bestand voor Linux
** '''Voeg de module toe in de MTA map''': Om deze module te laten moet deze in de volgende map geplaatst worden: mods/deathmatch/modules, als deze map niet bestaat, maak ze dan.
** '''Voeg de module toe aan het mtaserver.conf bestand''': Om de module te laden wanneer de server start, voeg dan dit lijntje <module src="ml_sockets.dll"/> voor Windows en dit lijntje <module src="ml_sockets.so"/> voor Linux toe aan je mtaserver.conf.
* '''Installeer de IRC resource'''
** '''Download de resource''': De IRC resource kan gevond worden op de [http://community.mtasa.com/index.php?p=resources&s=details&id=731 community], plaats de resource in de resources map.
** '''Pas het settings.xml bestand aan''': Open dit bestand en volg de instructies in het bestand om de bot te configureren.
** '''Pas het meta.xml bestand aan''': In dit bestand staan een aantal settings met betrekken tot reclame en ingame gui's, '''blijf van de rest!''' Je kan deze settings ook veranderen in je admin paneel wanneer de resource geladen is.
** '''Acl rechten''' De resource heeft een aantal rechten nodig om goed te werken waaronder: addBan, kickPlayer & callRemote. Als de resource niet genoeg rechten heeft verschijnt er een bericht in de console en kan de resource niet starten.

Nu kan je de resource starten, als de server aan het werken was tijdens deze bewerkingen doe dan eerst: /loadmodule ml_sockets.dll of /loadmodule ml_sockets.so en /refreshall voordat je /start irc doet.

==Het acl.xml bestand==
Het acl.xml bestand in de irc resource zorgt voor de acl rechten van irc commands.

Syntax
<syntaxhighlight lang="xml">
<command name="!kick" level="2" echoChannelOnly="true" />
</syntaxhighlight>

* De name is de command met uitroepteken
* De level is het minimum level dat de irc user moet hebben om de command te gebruiken.
* De echoChannelOnly bepaald ofdat je de command kan gebruiken buiten het echochannel

==Elementen==
Alle gebruikers, kanalen & servers gekend door de irc resource worden voorgestand door elementen
* Servers zijn de volgende elementen: 'irc-server'
* Channels zijn de volgende elementen: 'irc-channel'
* Users zijn de volgende elementen: 'irc-user'

==Level systeem==
De irc resource gebruikt geen irc modes systeem voor zijn acl, maar wel nummers.
* Owner (~) is nu level 5
* Super Operator (&) is nu level 4
* Operator (@) is nu level 3
* Helper (%) is nu level 2
* Voice (+) is nu level 1
Alle andere gebruikers zijn nu level 0

==Events==
Gedurende het irc proces worden een aantal events getriggerd om het je gemakkelijk te maken om extensies te schrijven.
Je moet wel addEvent("eventName") doen om ze te kunnen gebruiken.

{| class="wikitable" border="0"
|-
|width="200pt"|'''Naam'''
|width="200pt"|'''Source'''
|'''Parameters'''
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnecting'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCFailConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua">string reason</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserJoin'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string vhost</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserNickChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string oldNick, string newNick</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserPart'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason</syntaxhighlight>
|}
'''NOTE:''' 'theReason' kan nil zijn als 'theUser' gequit heeft zonder reden.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserKick'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason, user theKicker</syntaxhighlight>
|}
'''NOTE:''' 'theKicker' kan false zijn als 'theUser' gekickt was door een service zoals de nickserv.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserMode'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' kan false zijn als 'theUser' geopt was door een service zoals de chanserv

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCChannelMode'''
|width="200pt"|channel theIRCChannel
|<syntaxhighlight lang="lua">boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' kan false zijn als de mode geset was door een service zoals chanserv

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCLevelChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, number oldlevel, number newlevel</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserQuit'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theReason</syntaxhighlight>
|}

==Geëxporteerde functies==
Deze functies kunnen gebeld worden van andere resources om het schrijven van extensies mogelijk te maken
Gebruik de exports tabel of [[call]] om ze te gebruiken.

Voorbeeld 1:
<syntaxhighlight lang="lua">[Lua]
exports.irc:ircConnect("irc.gtanet.com","bot",6667)
</syntaxhighlight>
Voorbeeld 2:
<syntaxhighlight lang="lua">[Lua]
call(getResourceFromName("irc"),"ircConnect","irc.gtanet.com","bot",6667)
</syntaxhighlight>

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">returns</syntaxhighlight>
|width="150pt"|'''functie naam'''
|'''Parameters'''
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircHop'''
|<syntaxhighlight lang="lua">server theIRCServer, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSay'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircRaw'''
|<syntaxhighlight lang="lua">server theIRCServer, string theRaw</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircPart'''
|<syntaxhighlight lang="lua">channel theIRCChannel, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircJoin'''
|<syntaxhighlight lang="lua">server theIRCServer, string theChannelName, (string theChannelPassword)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircAction'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircNotice'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theUserChannel, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''outputIRC'''
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircConnect'''
|<syntaxhighlight lang="lua">string serverHost/IP, string nickname, (number serverPort), (string serverPassword), (boolean secure)</syntaxhighlight>
|-
|} '''NOTE:''' Secure connections are not available yet due to the module not suporting SSL yet.

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIdentify'''
|<syntaxhighlight lang="lua">server theIRCServer, string thePassword</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircReconnect'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircDisconnect'''
|<syntaxhighlight lang="lua">server theIRCServer, string theReason</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircChangeNick'''
|<syntaxhighlight lang="lua">server theIRCServer, string newNick</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServers'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerName'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerHost'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetServerPort'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerPass'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerNick'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsServerSecure'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServerChannels'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelServer'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannels'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelName'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannelUsers'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelTopic'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelFromName'''
|<syntaxhighlight lang="lua">string theChannelName</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|'''ircIsEchoChannel'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsUserBot'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserNick'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetUsers'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserServer'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser, channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserVhost'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsUserSecure'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserFromNick'''
|<syntaxhighlight lang="lua">string theNickname</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserRealName'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetUserChannels'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|''''addIRCCommandHandler'''
|<syntaxhighlight lang="lua">string theCommandName, function theFunctionToCall, (number minimumLevel), (boolean echoChannelOnly)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetCommands'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetCommandLevel'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsCommandEchoChannelOnly'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

'''NOTE:''' Alle parameters die tussen haakjes staan zijn optioneel, zie [[optional arguments]]

==Aanpassen==
Gelieve de resource niet aan te passen, je kan ze breken. Schrijf extensies.

==Contacteren==
De auteur (MCvarial) kan gecontacteerd worden op IRC (#mta,#mta.dutch)
Of via email (MCvarial@gmail.com)

Resource:Irc

2011-01-04T14:48:59Z

Mack Varial: /* Modding */

{{Resource page}}
__NOTOC__
The "irc" resource provides an echobot that outputs information such as chatmessages on a irc channel.
Information about "irc" or "Internet Relay Chat" can be found on [http://en.wikipedia.org/wiki/Irc Wikipedia.]

==Installation==
To get this resource working on your Linux or Windows server, follow these steps:

* '''Install the sockets module'''
** '''Download the module''': You can download the module on the [http://code.google.com/p/multitheftauto-modules/downloads/list mta-modules project]. Download the ml_sockets.dll file for Windows and the ml_sockets.so file for Linux
** '''Put the module in the MTA folder''': In order for MTA to load the module it must be placed in the mods/deathmatch/modules folder, if this folder does not exist yet, make it.
** '''Add the module to the mtaserver.conf file''': To load the module when the MTA server starts, put this line <module src="ml_sockets.dll"/> in your config file for Windows and <module src="ml_sockets.so"/> in the config file for Linux.
* '''Install the IRC resource'''
** '''Download the resource''': The IRC resource can be found on the [http://community.mtasa.com/index.php?p=resources&s=details&id=731 community], put it in the resources folder.
** '''Mod the settings.xml file''': Open this file and follow the instructions inside to configure the IRC bot.
** '''Mod the meta.xml file''': In this file a few settings can be found regarding ads and ingame gui's, '''do not mod anything else!''' You can also change these settings in the admin panel once the resource has been loaded.
** '''Acl rights''' The resource needs a couple of acl rights in order to work properly, including addBan, kickPlayer & callRemote. Any missing rights will prevent the resource from loading and will output a message in the console.

Now you can run the resource, if the server was running during this installation proces you will have to do /loadmodule ml_sockets.dll or /loadmodule ml_sockets.so and /refreshall before doing /start irc

==The acl.xml file==
The acl.xml file inside the irc resource takes care of the acl rights for irc commands.

Syntax
<syntaxhighlight lang="xml">
<command name="!kick" level="2" echoChannelOnly="true" />
</syntaxhighlight>

* The name is the command including the exclamation mark
* The level is the minimum level the irc user needs to have in order to use this command
* The echoChannelOnly is wether the command can be used outside the echo channel

==Elements==
All users, channels & servers known by the irc resource are represented by elements.
* Servers are the following elements type: 'irc-server'
* Channels are the following elements type: 'irc-channel'
* Users are the following elements type: 'irc-user'

==Level system==
The irc resource doesn't use the irc modes system for its acl, instead the modes were replaced with numbers.
* Owner (~) is now level 5
* Super Operator (&) is now level 4
* Operator (@) is now level 3
* Helper (%) is now level 2
* Voice (+) is now level 1
All other users without a special mode are level 0

==Events==
During the irc proces some events are triggered to help you write extensions for the irc resource.
You may want to use addEvent("eventName") to use them.

{| class="wikitable" border="0"
|-
|width="200pt"|'''Name'''
|width="200pt"|'''Source'''
|'''Parameters'''
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnecting'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCFailConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua">string reason</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserJoin'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string vhost</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserNickChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string oldNick, string newNick</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserPart'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason</syntaxhighlight>
|}
'''NOTE:''' 'theReason' can be nil if 'theUser' has quit without a reason.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserKick'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason, user theKicker</syntaxhighlight>
|}
'''NOTE:''' 'theKicker' can be false if 'theUser' was kicked by a service like the NickServ.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserMode'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' can be false if 'theUser' was opped by a service like the NickServ.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCChannelMode'''
|width="200pt"|channel theIRCChannel
|<syntaxhighlight lang="lua">boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' can be false if the mode was set by a service like the NickServ.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCLevelChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, number oldlevel, number newlevel</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserQuit'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theReason</syntaxhighlight>
|}

==Exported functions==
These functions can be called from another resource to help you write extensions for the irc resource.
Use the exports table or [[call]] to use them

Example 1:
<syntaxhighlight lang="lua">[Lua]
exports.irc:ircConnect("irc.gtanet.com","bot",6667)
</syntaxhighlight>
Example 2:
<syntaxhighlight lang="lua">[Lua]
call(getResourceFromName("irc"),"ircConnect","irc.gtanet.com","bot",6667)
</syntaxhighlight>

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">returns</syntaxhighlight>
|width="150pt"|'''function name'''
|'''Parameters'''
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircHop'''
|<syntaxhighlight lang="lua">server theIRCServer, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSay'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircRaw'''
|<syntaxhighlight lang="lua">server theIRCServer, string theRaw</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircPart'''
|<syntaxhighlight lang="lua">channel theIRCChannel, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircJoin'''
|<syntaxhighlight lang="lua">server theIRCServer, string theChannelName, (string theChannelPassword)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircAction'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircNotice'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theUserChannel, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''outputIRC'''
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircConnect'''
|<syntaxhighlight lang="lua">string serverHost/IP, string nickname, (number serverPort), (string serverPassword), (boolean secure)</syntaxhighlight>
|-
|} '''NOTE:''' Secure connections are not available yet due to the module not suporting SSL yet.

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIdentify'''
|<syntaxhighlight lang="lua">server theIRCServer, string thePassword</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircReconnect'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircDisconnect'''
|<syntaxhighlight lang="lua">server theIRCServer, string theReason</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircChangeNick'''
|<syntaxhighlight lang="lua">server theIRCServer, string newNick</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServers'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerName'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerHost'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetServerPort'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerPass'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerNick'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsServerSecure'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServerChannels'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelServer'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannels'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelName'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannelUsers'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelTopic'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelFromName'''
|<syntaxhighlight lang="lua">string theChannelName</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|'''ircIsEchoChannel'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsUserBot'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserNick'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetUsers'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserServer'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser, channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserVhost'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsUserSecure'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserFromNick'''
|<syntaxhighlight lang="lua">string theNickname</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserRealName'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetUserChannels'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|''''addIRCCommandHandler'''
|<syntaxhighlight lang="lua">string theCommandName, function theFunctionToCall, (number minimumLevel), (boolean echoChannelOnly)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetCommands'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetCommandLevel'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsCommandEchoChannelOnly'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

'''NOTE:''' All parameters that are between brackets are optional, see [[optional arguments]]

==Modding==
Please don't mod the resource, you might break it and cause it to malfunction or to spam errors.
If this happens you will not get any support.
Write extensions instead.

==Contact==
The author (MCvarial) can be contacted using IRC (#mta,#mta.dutch)
Or by email (MCvarial@gmail.com)

Resource:Irc

2011-01-04T14:47:44Z

Mack Varial:

{{Resource page}}
__NOTOC__
The "irc" resource provides an echobot that outputs information such as chatmessages on a irc channel.
Information about "irc" or "Internet Relay Chat" can be found on [http://en.wikipedia.org/wiki/Irc Wikipedia.]

==Installation==
To get this resource working on your Linux or Windows server, follow these steps:

* '''Install the sockets module'''
** '''Download the module''': You can download the module on the [http://code.google.com/p/multitheftauto-modules/downloads/list mta-modules project]. Download the ml_sockets.dll file for Windows and the ml_sockets.so file for Linux
** '''Put the module in the MTA folder''': In order for MTA to load the module it must be placed in the mods/deathmatch/modules folder, if this folder does not exist yet, make it.
** '''Add the module to the mtaserver.conf file''': To load the module when the MTA server starts, put this line <module src="ml_sockets.dll"/> in your config file for Windows and <module src="ml_sockets.so"/> in the config file for Linux.
* '''Install the IRC resource'''
** '''Download the resource''': The IRC resource can be found on the [http://community.mtasa.com/index.php?p=resources&s=details&id=731 community], put it in the resources folder.
** '''Mod the settings.xml file''': Open this file and follow the instructions inside to configure the IRC bot.
** '''Mod the meta.xml file''': In this file a few settings can be found regarding ads and ingame gui's, '''do not mod anything else!''' You can also change these settings in the admin panel once the resource has been loaded.
** '''Acl rights''' The resource needs a couple of acl rights in order to work properly, including addBan, kickPlayer & callRemote. Any missing rights will prevent the resource from loading and will output a message in the console.

Now you can run the resource, if the server was running during this installation proces you will have to do /loadmodule ml_sockets.dll or /loadmodule ml_sockets.so and /refreshall before doing /start irc

==The acl.xml file==
The acl.xml file inside the irc resource takes care of the acl rights for irc commands.

Syntax
<syntaxhighlight lang="xml">
<command name="!kick" level="2" echoChannelOnly="true" />
</syntaxhighlight>

* The name is the command including the exclamation mark
* The level is the minimum level the irc user needs to have in order to use this command
* The echoChannelOnly is wether the command can be used outside the echo channel

==Elements==
All users, channels & servers known by the irc resource are represented by elements.
* Servers are the following elements type: 'irc-server'
* Channels are the following elements type: 'irc-channel'
* Users are the following elements type: 'irc-user'

==Level system==
The irc resource doesn't use the irc modes system for its acl, instead the modes were replaced with numbers.
* Owner (~) is now level 5
* Super Operator (&) is now level 4
* Operator (@) is now level 3
* Helper (%) is now level 2
* Voice (+) is now level 1
All other users without a special mode are level 0

==Events==
During the irc proces some events are triggered to help you write extensions for the irc resource.
You may want to use addEvent("eventName") to use them.

{| class="wikitable" border="0"
|-
|width="200pt"|'''Name'''
|width="200pt"|'''Source'''
|'''Parameters'''
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnecting'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCFailConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua">string reason</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserJoin'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string vhost</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserNickChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string oldNick, string newNick</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserPart'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason</syntaxhighlight>
|}
'''NOTE:''' 'theReason' can be nil if 'theUser' has quit without a reason.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserKick'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason, user theKicker</syntaxhighlight>
|}
'''NOTE:''' 'theKicker' can be false if 'theUser' was kicked by a service like the NickServ.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserMode'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' can be false if 'theUser' was opped by a service like the NickServ.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCChannelMode'''
|width="200pt"|channel theIRCChannel
|<syntaxhighlight lang="lua">boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

'''NOTE:''' 'theSetter' can be false if the mode was set by a service like the NickServ.

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCLevelChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, number oldlevel, number newlevel</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserQuit'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theReason</syntaxhighlight>
|}

==Exported functions==
These functions can be called from another resource to help you write extensions for the irc resource.
Use the exports table or [[call]] to use them

Example 1:
<syntaxhighlight lang="lua">[Lua]
exports.irc:ircConnect("irc.gtanet.com","bot",6667)
</syntaxhighlight>
Example 2:
<syntaxhighlight lang="lua">[Lua]
call(getResourceFromName("irc"),"ircConnect","irc.gtanet.com","bot",6667)
</syntaxhighlight>

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">returns</syntaxhighlight>
|width="150pt"|'''function name'''
|'''Parameters'''
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircHop'''
|<syntaxhighlight lang="lua">server theIRCServer, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSay'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircRaw'''
|<syntaxhighlight lang="lua">server theIRCServer, string theRaw</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircPart'''
|<syntaxhighlight lang="lua">channel theIRCChannel, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircJoin'''
|<syntaxhighlight lang="lua">server theIRCServer, string theChannelName, (string theChannelPassword)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircAction'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircNotice'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theUserChannel, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''outputIRC'''
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircConnect'''
|<syntaxhighlight lang="lua">string serverHost/IP, string nickname, (number serverPort), (string serverPassword), (boolean secure)</syntaxhighlight>
|-
|} '''NOTE:''' Secure connections are not available yet due to the module not suporting SSL yet.

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIdentify'''
|<syntaxhighlight lang="lua">server theIRCServer, string thePassword</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircReconnect'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircDisconnect'''
|<syntaxhighlight lang="lua">server theIRCServer, string theReason</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircChangeNick'''
|<syntaxhighlight lang="lua">server theIRCServer, string newNick</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServers'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerName'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerHost'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetServerPort'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerPass'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerNick'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsServerSecure'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServerChannels'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelServer'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannels'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelName'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannelUsers'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelTopic'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelFromName'''
|<syntaxhighlight lang="lua">string theChannelName</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|'''ircIsEchoChannel'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsUserBot'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserNick'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetUsers'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserServer'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser, channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserVhost'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsUserSecure'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserFromNick'''
|<syntaxhighlight lang="lua">string theNickname</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserRealName'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetUserChannels'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|''''addIRCCommandHandler'''
|<syntaxhighlight lang="lua">string theCommandName, function theFunctionToCall, (number minimumLevel), (boolean echoChannelOnly)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetCommands'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetCommandLevel'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsCommandEchoChannelOnly'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

'''NOTE:''' All parameters that are between brackets are optional, see [[optional arguments]]

==Modding==
Please don't mod the resource, you might break write extenstions instead.

==Contact==
The author (MCvarial) can be contacted using IRC (#mta,#mta.dutch)
Or by email (MCvarial@gmail.com)

Resource:Irc

2011-01-04T14:35:11Z

Mack Varial: Created page with "{{Resource page}} __NOTOC__ The "irc" resource provides an echobot that outputs information such as chatmessages on a irc channel. Information about "irc" or "Internet Relay Chat..."

{{Resource page}}
__NOTOC__
The "irc" resource provides an echobot that outputs information such as chatmessages on a irc channel.
Information about "irc" or "Internet Relay Chat" can be found on [http://en.wikipedia.org/wiki/Irc Wikipedia.]

==Installation==
To get this resource working on your Linux or Windows server, follow these steps:

* '''Install the sockets module'''
** '''Download the module''': You can download the module on the [[http://code.google.com/p/multitheftauto-modules/downloads/list mta-modules project]]. Download the ml_sockets.dll file for Windows and the ml_sockets.so file for Linux
** '''Put the module in the MTA folder''': In order for MTA to load the module it must be placed in the mods/deathmatch/modules folder, if this folder does not exist yet, make it.
** '''Add the module to the mtaserver.conf file''': To load the module when the MTA server starts, put this line <module src="ml_sockets.dll"/> in your config file for Windows and <module src="ml_sockets.so"/> in the config file for Linux.
* '''Install the IRC resource'''
** '''Download the resource''': The IRC resource can be found on the [http://community.mtasa.com/index.php?p=resources&s=details&id=731 community], put it in the resources folder.
** '''Mod the settings.xml file''': Open this file and follow the instructions inside to configure the IRC bot.
** '''Mod the meta.xml file''': In this file a few settings can be found regarding ads and ingame gui's, '''do not mod anything else!''' You can also change these settings in the admin panel once the resource has been loaded.
** '''Acl rights''' The resource needs a couple of acl rights in order to work properly, including addBan, kickPlayer & callRemote. Any missing rights will prevent the resource from loading and will output a message in the console.

Now you can run the resource, if the server was running during this installation proces you will have to do /loadmodule ml_sockets.dll or /loadmodule ml_sockets.so and /refreshall before doing /start irc

==The acl.xml file==
The acl.xml file inside the irc resource takes care of the acl rights for irc commands.

Syntax
<syntaxhighlight lang="xml">
<command name="!kick" level="2" echoChannelOnly="true" />
</syntaxhighlight>

* The name is the command including the exclamation mark
* The level is the minimum level the irc user needs to have in order to use this command
* The echoChannelOnly is wether the command can be used outside the echo channel

==Elements==
All users, channels & servers known by the irc resource are represented by elements.
* Servers are the following elements type: 'irc-server'
* Channels are the following elements type: 'irc-channel'
* Users are the following elements type: 'irc-user'

==Level system==
The irc resource doesn't use the irc modes system for its acl, instead the modes were replaced with numbers.
* Owner (~) is now level 5
* Super Operator (&) is now level 4
* Operator (@) is now level 3
* Helper (%) is now level 2
* Voice (+) is now level 1
All other users without a special mode are level 0

==Events==
During the irc proces some events are triggered to help you write extensions for the irc resource.
You may want to use addEvent("eventName") to use them.

{| class="wikitable" border="0"
|-
|width="200pt"|'''Name'''
|width="200pt"|'''Source'''
|'''Parameters'''
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnecting'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua"></syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCFailConnect'''
|width="200pt"|server theIRCServer
|<syntaxhighlight lang="lua">string reason</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserJoin'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string vhost</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserNickChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string oldNick, string newNick</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserPart'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserKick'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theReason, user theKicker</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCMessage'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCPrivateNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCNotice'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMessage</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserMode'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCChannelMode'''
|width="200pt"|channel theIRCChannel
|<syntaxhighlight lang="lua">boolean positive, string theMode, user theSetter</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCLevelChange'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">channel theIRCChannel, number oldlevel, number newlevel</syntaxhighlight>
|}

{| class="wikitable" border="0"
|-
|width="200pt"|'''onIRCUserQuit'''
|width="200pt"|user theIRCUser
|<syntaxhighlight lang="lua">string theReason</syntaxhighlight>
|}

==Exported functions==
These functions can be called from another resource to help you write extensions for the irc resource.
Use the exports table or [[call]] to use them

Example 1:
<syntaxhighlight lang="lua">[Lua]
exports.irc:ircConnect("irc.gtanet.com","bot",6667)
</syntaxhighlight>
Example 2:
<syntaxhighlight lang="lua">[Lua]
call(getResourceFromName("irc"),"ircConnect","irc.gtanet.com","bot",6667)
</syntaxhighlight>

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">returns</syntaxhighlight>
|width="150pt"|'''function name'''
|'''Parameters'''
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircHop'''
|<syntaxhighlight lang="lua">server theIRCServer, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSay'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircRaw'''
|<syntaxhighlight lang="lua">server theIRCServer, string theRaw</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircPart'''
|<syntaxhighlight lang="lua">channel theIRCChannel, (string theReason)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircJoin'''
|<syntaxhighlight lang="lua">server theIRCServer, string theChannelName, (string theChannelPassword)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircAction'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theIRCUser, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircNotice'''
|<syntaxhighlight lang="lua">channel theIRCChannel/user theUserChannel, string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''outputIRC'''
|<syntaxhighlight lang="lua">string theMessage</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircConnect'''
|<syntaxhighlight lang="lua">string serverHost/IP, string nickname, (number serverPort), (string serverPassword), (boolean secure)</syntaxhighlight>
|-
|} '''NOTE:''' Secure connections are not available yet due to the module not suporting SSL yet.

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIdentify'''
|<syntaxhighlight lang="lua">server theIRCServer, string thePassword</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircReconnect'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircDisconnect'''
|<syntaxhighlight lang="lua">server theIRCServer, string theReason</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircChangeNick'''
|<syntaxhighlight lang="lua">server theIRCServer, string newNick</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServers'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerName'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerHost'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetServerPort'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerPass'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetServerNick'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsServerSecure'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetServerChannels'''
|<syntaxhighlight lang="lua">server theIRCServer</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelServer'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannels'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelName'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelMode'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetChannelUsers'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetChannelTopic'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetChannelFromName'''
|<syntaxhighlight lang="lua">string theChannelName</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|'''ircIsEchoChannel'''
|<syntaxhighlight lang="lua">channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircSetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser, string theMode</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsUserBot'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserMode'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserNick'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetUsers'''
|<syntaxhighlight lang="lua">(server theIRCServer)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserServer'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetUserLevel'''
|<syntaxhighlight lang="lua">user theIRCUser, channel theIRCChannel</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserVhost'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsUserSecure'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">userdata</syntaxhighlight>
|width='200pt'|'''ircGetUserFromNick'''
|<syntaxhighlight lang="lua">string theNickname</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">string</syntaxhighlight>
|width='200pt'|'''ircGetUserRealName'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetUserChannels'''
|<syntaxhighlight lang="lua">user theIRCUser</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">bool</syntaxhighlight>
|width='200pt'|''''addIRCCommandHandler'''
|<syntaxhighlight lang="lua">string theCommandName, function theFunctionToCall, (number minimumLevel), (boolean echoChannelOnly)</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">table</syntaxhighlight>
|width='200pt'|'''ircGetCommands'''
|<syntaxhighlight lang="lua"></syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">number</syntaxhighlight>
|width='200pt'|'''ircGetCommandLevel'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

{| class="wikitable" border="0"
|-
|width="100pt"|<syntaxhighlight lang="lua">boolean</syntaxhighlight>
|width='200pt'|'''ircIsCommandEchoChannelOnly'''
|<syntaxhighlight lang="lua">string theCommand</syntaxhighlight>
|-
|}

'''NOTE:''' All parameters that are between brackets are optional, see [[optional arguments]]

==Modding==
Please don't mod the resource, you might break write extenstions instead.

==Contact==
The author (MCvarial) can be contacted using IRC (#mta,#mta.dutch)
Or by email (MCvarial@gmail.com)

User:Mack Varial

2010-11-11T10:43:59Z

Mack Varial:

Hi thar,

* I play mta as [SKC]MCvarial
* I am [http://www.teamskc.co.uk SKC] clan member
* I script for their servers (or that's atleast my intention)
* I script for [http://mtasa.littlewhitey.com littlewhitey's race server]
* I annoy people on #mta
* I help people on #mta.scripting if no one else is available

== TODO ==
* fix [http://community.mtasa.com/index.php?p=resources&s=details&id=731 irc resource]
* finish smileys resource
* finish web resource
* graduate
* learn C++
* actually contribute something to mta
* complete the sockets module
** fix ssl
** add listening sockets

User:Mack Varial

2010-11-11T10:40:11Z

Mack Varial:

Hi thar I'm no one!

== TODO ==
* fix [http://community.mtasa.com/index.php?p=resources&s=details&id=731 irc resource]
* finish smileys resource
* finish web resource
* graduate
* learn C++
* actually contribute something to mta
* complete the sockets module
** fix ssl
** add listening sockets

User:Mack Varial

2010-11-10T19:55:33Z

Mack Varial: Created page with "Trololo"

Trololo