Multi Theft Auto: Wiki - User contributions [en]

Modules/IRCEcho/ircIsVoice

2008-01-13T19:20:01Z

Mountnl:

__NOTOC__
{{ModuleFunction|IRCEcho}}
Can be used to check if the user has Voice or higher

==Syntax==
<syntaxhighlight lang="lua">
function ircIsVoice ( IRCConnection irc, string channel, string nick )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection
* '''channel:''' The channel that you want to check on
* '''nick:''' The person that you want to check on

==Example==
'''Example 1:''' This script can be used from irc, so that people with voice or higher can use !say
<syntaxhighlight lang="lua">
function irc_onPrivMsg( szChannel, szNick, szText )
if string.find( szText, "!say" ) == 1 then
if ( ircIsVoice( pIRC, szChannel, szNick ) ) then
local Message = string.sub(szText, 5)
outputChatBox("* " .. szNick .. " [IRC]: " .. Message)
end
end
end
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/ircIsHalfop

2008-01-13T19:19:45Z

Mountnl:

__NOTOC__
{{ModuleFunction|IRCEcho}}
Can be used to check if the user has Halfop or higher

==Syntax==
<syntaxhighlight lang="lua">
function ircIsHalfop ( IRCConnection irc, string channel, string nick )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection
* '''channel:''' The channel that you want to check on
* '''nick:''' The person that you want to check on

==Example==
'''Example 1:''' This script can be used from irc, so that people with Halfop or higher can use !asay
<syntaxhighlight lang="lua">
function irc_onPrivMsg( szChannel, szNick, szText )
if string.find( szText, "!asay" ) == 1 then
if ( ircIsHalfop( pIRC, szChannel, szNick ) ) then
local Message = string.sub(szText, 6)
outputChatBox("The admin says: " .. Message, getRootResource(), 255, 0, 0)
end
end
end
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/ircIsOp

2008-01-13T19:19:27Z

Mountnl:

__NOTOC__
{{ModuleFunction|IRCEcho}}
Can be used to check if the user has Op or higher

==Syntax==
<syntaxhighlight lang="lua">
function ircIsOp ( IRCConnection irc, string channel, string nick )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection
* '''channel:''' The channel that you want to check on
* '''nick:''' The person that you want to check on

==Example==
'''Example 1:''' This script can be used from irc, so that people with op or higher can use !kick
<syntaxhighlight lang="lua">
function irc_onPrivMsg( szChannel, szNick, szText )
if string.find( szText, "!kick" ) == 1 then
if ( ircIsOp( pIRC, szChannel, szNick ) ) then
local thePlayer = getPlayerFromNick(string.sub(szText, 6))
if (thePlayer) then
kickPlayer( thePlayer )
end
end
end
end
</syntaxhighlight>

Modules/IRCEcho/ircIsSuper

2008-01-13T19:19:08Z

Mountnl:

__NOTOC__
{{ModuleFunction|IRCEcho}}
Can be used to check if the user has superops (aka Protection) or higher

==Syntax==
<syntaxhighlight lang="lua">
function ircIsSuper ( IRCConnection irc, string channel, string nick )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection
* '''channel:''' The channel that you want to check on
* '''nick:''' The person that you want to check on

==Example==
'''Example 1:''' This script can be used from irc, so that people with superops or higher can use !ban
<syntaxhighlight lang="lua">
function irc_onPrivMsg( szChannel, szNick, szText )
if string.find( szText, "!ban" ) == 1 then
if ( ircIsSuper( pIRC, szChannel, szNick ) ) then
local thePlayer = getPlayerFromNick(string.sub(szText, 5))
if (thePlayer) then
banPlayer( thePlayer )
end
end
end
end
</syntaxhighlight>

Modules/IRCEcho/ircIsOwner

2008-01-13T19:18:50Z

Mountnl:

__NOTOC__
{{ModuleFunction|IRCEcho}}
Can be used to check if the user has founderrights in an channel

==Syntax==
<syntaxhighlight lang="lua">
function ircIsOwner ( IRCConnection irc, string channel, string nick )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection
* '''channel:''' The channel that you want to check on
* '''nick:''' The person that you want to check on

==Example==
'''Example 1:''' This script can be used from irc, so that people with founderrights or higher can use !unban
<syntaxhighlight lang="lua">
function irc_onPrivMsg( szChannel, szNick, szText )
if string.find( szText, "!unban" ) == 1 then
if ( ircIsOwner( pIRC, szChannel, szNick ) ) then
unbanIP(string.sub(szText, 7))
end
end
end
</syntaxhighlight>

Modules/IRCEcho/ircGetStatus

2008-01-13T19:18:20Z

Mountnl: New page: __NOTOC__ {{ModuleFunction|IRCEcho}} Can be used to check if the user has Op or higher ==Syntax== <syntaxhighlight lang="lua"> function ircGetStatus ( IRCConnection irc, string channel, string nick ) </...

__NOTOC__
{{ModuleFunction|IRCEcho}}
Can be used to check if the user has Op or higher

==Syntax==
<syntaxhighlight lang="lua">
function ircGetStatus ( IRCConnection irc, string channel, string nick )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection
* '''channel:''' The channel that you want to check on
* '''nick:''' The person that you want to check on

==Example==
'''Example 1:''' This script can be used from irc, so people can check their rights
<syntaxhighlight lang="lua">
function irc_onPrivMsg( szChannel, szNick, szText )
if string.find( szText, "!rights" ) == 1 then
ircMessage( pIRC, szChannel, szNick .. ", you have level " .. tostring( ircGetStatus( pIRC, szChannel, szNick ) )
end
end
</syntaxhighlight>

Modules/IRCEcho/ircIsOwner

2008-01-13T19:15:52Z

Mountnl: New page: __NOTOC__ {{ModuleFunction|IRCEcho}} Can be used to check if the user has founderrights in an channel ==Syntax== <syntaxhighlight lang="lua"> function ircIsOwner ( IRCConnection irc, string channel, str...

__NOTOC__
{{ModuleFunction|IRCEcho}}
Can be used to check if the user has founderrights in an channel

==Syntax==
<syntaxhighlight lang="lua">
function ircIsOwner ( IRCConnection irc, string channel, string nick )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection
* '''channel:''' The channel that you want to check on
* '''nick:''' The person that you want to check on

==Example==
'''Example 1:''' This script can be used from irc, so that people with founderrights or higher can use !unban
<syntaxhighlight lang="lua">
function irc_onPrivMsg( szChannel, szNick, szText )
if string.find( szText, "!unban" ) == 1 then
if ( ircIsOwner( pIRC, '#mta', szNick ) ) then
unbanIP(string.sub(szText, 7))
end
end
end
</syntaxhighlight>

Modules/IRCEcho/ircIsSuper

2008-01-13T19:13:52Z

Mountnl: New page: __NOTOC__ {{ModuleFunction|IRCEcho}} Can be used to check if the user has superops (aka Protection) or higher ==Syntax== <syntaxhighlight lang="lua"> function ircIsSuper ( IRCConnection irc, string chan...

__NOTOC__
{{ModuleFunction|IRCEcho}}
Can be used to check if the user has superops (aka Protection) or higher

==Syntax==
<syntaxhighlight lang="lua">
function ircIsSuper ( IRCConnection irc, string channel, string nick )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection
* '''channel:''' The channel that you want to check on
* '''nick:''' The person that you want to check on

==Example==
'''Example 1:''' This script can be used from irc, so that people with superops or higher can use !ban
<syntaxhighlight lang="lua">
function irc_onPrivMsg( szChannel, szNick, szText )
if string.find( szText, "!ban" ) == 1 then
if ( ircIsSuper( pIRC, '#mta', szNick ) ) then
local thePlayer = getPlayerFromNick(string.sub(szText, 5))
if (thePlayer) then
banPlayer( thePlayer )
end
end
end
end
</syntaxhighlight>

Modules/IRCEcho/ircIsVoice

2008-01-13T19:12:43Z

Mountnl:

__NOTOC__
{{ModuleFunction|IRCEcho}}
Can be used to check if the user has Voice or higher

==Syntax==
<syntaxhighlight lang="lua">
function ircIsVoice ( IRCConnection irc, string channel, string nick )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection
* '''channel:''' The channel that you want to check on
* '''nick:''' The person that you want to check on

==Example==
'''Example 1:''' This script can be used from irc, so that people with voice or higher can use !say
<syntaxhighlight lang="lua">
function irc_onPrivMsg( szChannel, szNick, szText )
if string.find( szText, "!say" ) == 1 then
if ( ircIsVoice( pIRC, '#mta', szNick ) ) then
local Message = string.sub(szText, 5)
outputChatBox("* " .. szNick .. " [IRC]: " .. Message)
end
end
end
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/ircIsVoice

2008-01-13T19:12:10Z

Mountnl:

__NOTOC__
{{ModuleFunction|IRCEcho}}
Can be used to check if the user has Voice or higher

==Syntax==
<syntaxhighlight lang="lua">
function ircIsVoice ( IRCConnection irc, string channel, string nick )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection
* '''channel:''' The channel that you want to check on
* '''nick:''' The person that you want to check on

==Example==
'''Example 1:''' This script can be used from irc, so that people with voice or higher can use !say
<syntaxhighlight lang="lua">
function irc_onPrivMsg( szChannel, szNick, szText )
if string.find( szText, "!say" ) == 1 then
if ( ircIsVoice( pIRC, '#mta', szNick ) )
local Message = string.sub(szText, 5)
outputChatBox("* " .. szNick .. " [IRC]: " .. Message)
end
end
end
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/ircIsOp

2008-01-13T19:11:43Z

Mountnl:

__NOTOC__
{{ModuleFunction|IRCEcho}}
Can be used to check if the user has Op or higher

==Syntax==
<syntaxhighlight lang="lua">
function ircIsOp ( IRCConnection irc, string channel, string nick )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection
* '''channel:''' The channel that you want to check on
* '''nick:''' The person that you want to check on

==Example==
'''Example 1:''' This script can be used from irc, so that people with op or higher can use !kick
<syntaxhighlight lang="lua">
function irc_onPrivMsg( szChannel, szNick, szText )
if string.find( szText, "!kick" ) == 1 then
if ( ircIsOp( pIRC, '#mta', szNick ) ) then
local thePlayer = getPlayerFromNick(string.sub(szText, 6))
if (thePlayer) then
kickPlayer( thePlayer )
end
end
end
end
</syntaxhighlight>

Modules/IRCEcho/ircIsHalfop

2008-01-13T19:11:31Z

Mountnl:

__NOTOC__
{{ModuleFunction|IRCEcho}}
Can be used to check if the user has Halfop or higher

==Syntax==
<syntaxhighlight lang="lua">
function ircIsHalfop ( IRCConnection irc, string channel, string nick )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection
* '''channel:''' The channel that you want to check on
* '''nick:''' The person that you want to check on

==Example==
'''Example 1:''' This script can be used from irc, so that people with Halfop or higher can use !asay
<syntaxhighlight lang="lua">
function irc_onPrivMsg( szChannel, szNick, szText )
if string.find( szText, "!asay" ) == 1 then
if ( ircIsHalfop( pIRC, '#mta', szNick ) ) then
local Message = string.sub(szText, 6)
outputChatBox("The admin says: " .. Message, getRootResource(), 255, 0, 0)
end
end
end
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/ircIsOp

2008-01-13T19:11:01Z

Mountnl: New page: __NOTOC__ {{ModuleFunction|IRCEcho}} Can be used to check if the user has Op or higher ==Syntax== <syntaxhighlight lang="lua"> function ircIsOp ( IRCConnection irc, string channel, string nick ) </syntaxhighlight>...

__NOTOC__
{{ModuleFunction|IRCEcho}}
Can be used to check if the user has Op or higher

==Syntax==
<syntaxhighlight lang="lua">
function ircIsOp ( IRCConnection irc, string channel, string nick )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection
* '''channel:''' The channel that you want to check on
* '''nick:''' The person that you want to check on

==Example==
'''Example 1:''' This script can be used from irc, so that people with op or higher can use !kick
<syntaxhighlight lang="lua">
function irc_onPrivMsg( szChannel, szNick, szText )
if string.find( szText, "!kick" ) == 1 then
if ( ircIsOp( pIRC, '#mta', szNick ) ) then
local thePlayer = getPlayerFromNick(string.sub(szText, 5))
if (thePlayer) then
kickPlayer( thePlayer )
end
end
end
end
</syntaxhighlight>

Modules/IRCEcho/ircIsHalfop

2008-01-13T19:07:58Z

Mountnl: New page: __NOTOC__ {{ModuleFunction|IRCEcho}} Can be used to check if the user has Halfop or higher ==Syntax== <syntaxhighlight lang="lua"> function ircIsHalfop ( IRCConnection irc, string channel, string nick )...

__NOTOC__
{{ModuleFunction|IRCEcho}}
Can be used to check if the user has Halfop or higher

==Syntax==
<syntaxhighlight lang="lua">
function ircIsHalfop ( IRCConnection irc, string channel, string nick )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection
* '''channel:''' The channel that you want to check on
* '''nick:''' The person that you want to check on

==Example==
'''Example 1:''' This script can be used from irc, so that people with Halfop or higher can use !asay
<syntaxhighlight lang="lua">
function irc_onPrivMsg( szChannel, szNick, szText )
if string.find( szText, "!asay" ) == 1 then
if ( ircIsHalfop( pIRC, '#mta', szNick ) )
local Message = string.sub(szText, 10)
outputChatBox("The admin says: " .. Message, getRootResource(), 255, 0, 0)
end
end
end
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/ircIsVoice

2008-01-13T19:06:22Z

Mountnl: New page: __NOTOC__ {{ModuleFunction|IRCEcho}} Can be used to check if the user has Voice or higher ==Syntax== <syntaxhighlight lang="lua"> function ircIsVoice ( IRCConnection irc, string channel, string nick ) <...

__NOTOC__
{{ModuleFunction|IRCEcho}}
Can be used to check if the user has Voice or higher

==Syntax==
<syntaxhighlight lang="lua">
function ircIsVoice ( IRCConnection irc, string channel, string nick )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection
* '''channel:''' The channel that you want to check on
* '''nick:''' The person that you want to check on

==Example==
'''Example 1:''' This script can be used from irc, so that people with voice or higher can use !say
<syntaxhighlight lang="lua">
function irc_onPrivMsg( szChannel, szNick, szText )
if string.find( szText, "!say" ) == 1 then
if ( ircIsVoice( pIRC, '#mta', szNick ) )
local Message = string.sub(szText, 10)
outputChatBox("* " .. szNick .. " [IRC]: " .. Message)
end
end
end
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/ircRaw

2008-01-13T19:02:03Z

Mountnl: New page: __NOTOC__ {{ModuleFunction|IRCEcho}} Sends an raw message to the IRCConnection ==Syntax== <syntaxhighlight lang="lua"> function ircRaw ( IRCConnection irc, string command ) </syntaxhighlight> ===Required arguments...

__NOTOC__
{{ModuleFunction|IRCEcho}}
Sends an raw message to the IRCConnection

==Syntax==
<syntaxhighlight lang="lua">
function ircRaw ( IRCConnection irc, string command )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection
* '''command:''' The command that you want to send to the IRC server

==Example==
'''Example 1:''' This makes the IRCConnection ban Fedor!*@*
<syntaxhighlight lang="lua">

function ircBanHost( thePlayer, command, channel )
ircRaw("MODE #mta +B Fedor!*@*")
end

addCommandHandler( "disgrace", ircBanHost )
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/ircMessage

2008-01-13T18:58:10Z

Mountnl:

__NOTOC__
{{ModuleFunction|IRCEcho}}
Displays an message to an IRC Channel

==Syntax==
<syntaxhighlight lang="lua">
function ircMessage ( IRCConnection irc, string channel, string message )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection
* '''channel:''' The channel or person you want to send the message to
* '''message:''' The message

==Example==
'''Example 1:''' This echo is displaying all the ingame chat to #mta with the IRCConnection stored in pIRC
<syntaxhighlight lang="lua">

function ChatToIRC( message, type )
if (type == 0) then -- Its an normal chatmessage
ircMessage( pIRC, "#mta", "CHAT:�� " .. getClientName( source ) .. ": " .. message )
elseif (type == 1) then -- Its an action
ircMessage( pIRC, "#mta", "ACTION: " .. getClientName( source ) .. ": " .. message )
elseif (type == 2) then -- Teamchat message
ircMessage( pIRC, "#mta", "TEAMCHAT: " .. getClientName( source ) .. ": " .. message )
end
end

addEventHandler( "onPlayerChat", getRootElement(), ChatToIRC )
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/ircNotice

2008-01-13T18:57:57Z

Mountnl:

__NOTOC__
{{ModuleFunction|IRCEcho}}
Notice somebody of an action

==Syntax==
<syntaxhighlight lang="lua">
function ircNotice ( IRCConnection irc, string channel, string message )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection
* '''channel:''' The channel or user you want to send to
* '''message:''' The message

==Example==
'''Example 1:''' This example is warning IJs of an banned user
<syntaxhighlight lang="lua">

function ReportBan( ip )
ircNotice( pIRC, "IJs", getClientName( source ) .. " banned " .. sz )
end

addEventHandler( "onBan", getRootElement(), ReportBan )
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/ircChangeNick

2008-01-13T18:57:41Z

Mountnl:

__NOTOC__
{{ModuleFunction|IRCEcho}}
Changes the name of the IRCConnection

==Syntax==
<syntaxhighlight lang="lua">
function ircChangeNick ( IRCConnection irc, string newnick )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection
* '''newnick:''' The new nickname

==Example==
'''Example 1:''' This example adds the command "ircname". That command can change the IRCConnection's name
<syntaxhighlight lang="lua">

function changeIrcName( thePlayer, command, newname )
ircChangeNick( pIRC, newname )
end

addCommandHandler( "ircname", changeIrcName )
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/ircJoin

2008-01-13T18:57:30Z

Mountnl:

__NOTOC__
{{ModuleFunction|IRCEcho}}
Lets the IRCConnection join an channel

==Syntax==
<syntaxhighlight lang="lua">
function ircJoin ( IRCConnection irc, string channel )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection
* '''channel:''' The channel you want to join

==Example==
'''Example 1:''' This command makes the bot join another channel
<syntaxhighlight lang="lua">

function ircJoinChannel( thePlayer, command, channel )
ircJoinChannel( pIRC, channel )
end

addCommandHandler( "ircjoin", ircJoinChannel )
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/ircPart

2008-01-13T18:57:19Z

Mountnl:

__NOTOC__
{{ModuleFunction|IRCEcho}}
Lets the IRCConnection leave a channel

==Syntax==
<syntaxhighlight lang="lua">
function ircPart ( IRCConnection irc, string channel )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection
* '''channel:''' The channel you want to leave

==Example==
'''Example 1:''' This command makes the bot leave a channel
<syntaxhighlight lang="lua">

function ircLeaveChannel( thePlayer, command, channel )
ircPart( pIRC, channel )
end

addCommandHandler( "ircpart", ircLeaveChannel )
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/ircPart

2008-01-13T18:57:07Z

Mountnl: New page: __NOTOC__ {{ModuleFunction|IRCEcho}} Lets the IRCConnection leave a channel ==Syntax== <syntaxhighlight lang="lua"> function ircPart ( IRCConnection irc, string channel ) </syntaxhighlight> ===Required arguments==...

__NOTOC__
{{ModuleFunction|IRCEcho}}
Lets the IRCConnection leave a channel

==Syntax==
<syntaxhighlight lang="lua">
function ircPart ( IRCConnection irc, string channel )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection you wish to disconnect
* '''channel:''' The channel you want to leave

==Example==
'''Example 1:''' This command makes the bot leave a channel
<syntaxhighlight lang="lua">

function ircLeaveChannel( thePlayer, command, channel )
ircPart( pIRC, channel )
end

addCommandHandler( "ircpart", ircLeaveChannel )
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/ircJoin

2008-01-13T18:56:02Z

Mountnl: New page: __NOTOC__ {{ModuleFunction|IRCEcho}} Lets the IRCConnection join an channel ==Syntax== <syntaxhighlight lang="lua"> function ircJoin ( IRCConnection irc, string channel ) </syntaxhighlight> ===Required arguments==...

__NOTOC__
{{ModuleFunction|IRCEcho}}
Lets the IRCConnection join an channel

==Syntax==
<syntaxhighlight lang="lua">
function ircJoin ( IRCConnection irc, string channel )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection you wish to disconnect
* '''channel:''' The channel you want to join

==Example==
'''Example 1:''' This command makes the bot join another channel
<syntaxhighlight lang="lua">

function ircJoinChannel( thePlayer, command, channel )
ircJoinChannel( pIRC, channel )
end

addCommandHandler( "ircjoin", ircJoinChannel )
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/ircChangeNick

2008-01-13T18:53:57Z

Mountnl: New page: __NOTOC__ {{ModuleFunction|IRCEcho}} Changes the name of the IRCConnection ==Syntax== <syntaxhighlight lang="lua"> function ircChangeNick ( IRCConnection irc, string newnick ) </syntaxhighlight> ===Required argume...

__NOTOC__
{{ModuleFunction|IRCEcho}}
Changes the name of the IRCConnection

==Syntax==
<syntaxhighlight lang="lua">
function ircChangeNick ( IRCConnection irc, string newnick )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection you wish to disconnect
* '''newnick:''' The new nickname

==Example==
'''Example 1:''' This example adds the command "ircname". That command can change the IRCConnection's name
<syntaxhighlight lang="lua">

function changeIrcName( thePlayer, command, newname )
ircChangeNick( pIRC, newname )
end

addCommandHandler( "ircname", changeIrcName )
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/ircMessage

2008-01-13T18:49:56Z

Mountnl:

__NOTOC__
{{ModuleFunction|IRCEcho}}
Displays an message to an IRC Channel

==Syntax==
<syntaxhighlight lang="lua">
function ircMessage ( IRCConnection irc, string channel, string message )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection you wish to disconnect
* '''channel:''' The channel or person you want to send the message to
* '''message:''' The message

==Example==
'''Example 1:''' This echo is displaying all the ingame chat to #mta with the IRCConnection stored in pIRC
<syntaxhighlight lang="lua">

function ChatToIRC( message, type )
if (type == 0) then -- Its an normal chatmessage
ircMessage( pIRC, "#mta", "CHAT:�� " .. getClientName( source ) .. ": " .. message )
elseif (type == 1) then -- Its an action
ircMessage( pIRC, "#mta", "ACTION: " .. getClientName( source ) .. ": " .. message )
elseif (type == 2) then -- Teamchat message
ircMessage( pIRC, "#mta", "TEAMCHAT: " .. getClientName( source ) .. ": " .. message )
end
end

addEventHandler( "onPlayerChat", getRootElement(), ChatToIRC )
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/ircNotice

2008-01-13T18:49:06Z

Mountnl: New page: __NOTOC__ {{ModuleFunction|IRCEcho}} Notice somebody of an action ==Syntax== <syntaxhighlight lang="lua"> function ircNotice ( IRCConnection irc, string channel, string message ) </syntaxhighlight> ===Required arg...

__NOTOC__
{{ModuleFunction|IRCEcho}}
Notice somebody of an action

==Syntax==
<syntaxhighlight lang="lua">
function ircNotice ( IRCConnection irc, string channel, string message )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection you wish to disconnect
* '''channel:''' The channel of user you want to send to
* '''message:''' The message

==Example==
'''Example 1:''' This example is warning IJs of an banned user
<syntaxhighlight lang="lua">

function ReportBan( ip )
ircNotice( pIRC, "IJs", getClientName( source ) .. " banned " .. sz )
end

addEventHandler( "onBan", getRootElement(), ReportBan )
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/ircMessage

2008-01-13T18:42:02Z

Mountnl: New page: __NOTOC__ {{ModuleFunction|IRCEcho}} Displays an message to an IRC Channel ==Syntax== <syntaxhighlight lang="lua"> function ircDisconnect ( IRCConnection irc, string channel, string message ) </syntaxhighlight> ==...

__NOTOC__
{{ModuleFunction|IRCEcho}}
Displays an message to an IRC Channel

==Syntax==
<syntaxhighlight lang="lua">
function ircDisconnect ( IRCConnection irc, string channel, string message )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection you wish to disconnect

==Example==
'''Example 1:''' This echo is displaying all the ingame chat to #mta with the IRCConnection stored in pIRC
<syntaxhighlight lang="lua">

function ChatToIRC( message, type )
if (type == 0) then -- Its an normal chatmessage
ircMessage( pIRC, "#mta", "CHAT:�� " .. getClientName( source ) .. ": " .. message )
elseif (type == 1) then -- Its an action
ircMessage( pIRC, "#mta", "ACTION: " .. getClientName( source ) .. ": " .. message )
elseif (type == 2) then -- Teamchat message
ircMessage( pIRC, "#mta", "TEAMCHAT: " .. getClientName( source ) .. ": " .. message )
end
end

addEventHandler( "onPlayerChat", getRootElement(), ChatToIRC )
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

HasObjectPermissionTo

2008-01-05T15:27:08Z

Mountnl:

__NOTOC__
{{Server function}}
This function returns whether or not the given object has access to perform the given action.

==Syntax==
<syntaxhighlight lang="lua">
bool hasObjectPermissionTo ( string / element theObject, string theAction [, bool defaultPermission = true ] )
</syntaxhighlight>

===Required Arguments===
*'''theObject:''' The object to test if has permission to. This can be a client element (ie. a player), a resource or a string in the form "user.<name>" or "resource.<name>".
*'''theAction:''' The action to test if the given object has access to. Ie. "function.kickPlayer".

===Optional Arguments===
{{OptionalArg}}
*'''defaultPermission:''' The default permission if none is specified in either of the groups the given object is a member of. If this is left to true, the given object will have permissions to perform the action unless the opposite is explicitly specified in the [[ACL]]. If false, the action will be denied by default unless explicitly approved by the [[ACL]].

===Returns===
Returns ''true'' if the given object has permission to perform the given action, ''false'' otherwise. Returns ''nil'' if the function failed because of bad arguments.

==Example==
This example does ban a player
<syntaxhighlight lang="lua">
-- Ban command
function onKickCommandHandler ( playerSource, commandName, playerToKick, stringReason )
-- Does the calling user have permission to kick the player? Default
-- to false for safety reasons. We do this so any user can't use us to
-- kick players.
if ( hasObjectPermissionTo ( playerSource, "function.kickPlayer", false ) ) then

-- Do we have permission to kick the player? We do this so we can fail
-- nicely if this resource doesn't have access to call that function.
if ( hasObjectPermissionTo ( getThisResource (), "function.kickPlayer", true ) ) then
-- Kick him
kickPlayer ( playerToKick, playerSource, stringReason )
else
-- Resource doesn't have any permissions, sorry
outputChatBox ( "kick: The admin resource is not able to kick players. Please give this resource access to 'function.kickPlayer' in the ACL to use this function.", playerSource )
end
else
-- User doesn't have any permissions
outputChatBox ( "kick: You don't have permissions to use this command.", playerSource )
end
end
addCommandHandler ( "ban", onKickCommandHandler )
</syntaxhighlight>

==See Also==

{{ACL_functions}}

GetServerPassword

2008-01-05T12:07:13Z

Mountnl:

__NOTOC__
{{Server function}}

This function returns the current password required to join the server.

==Syntax==

<syntaxhighlight lang="lua">
string getServerPassword ()
</syntaxhighlight>

===Returns===

Returns the current server password as a string if it has a password, if not it returns ''nil''.

==Example==
This example prints the serverpassword to the player
<syntaxhighlight lang="lua">
function viewPassword ( thePlayer, command )
-- Put the password in a var
local password = getServerPassword ()

-- Check if the server has a password
-- If the server has an password, echo it
if (password != nil) then
outputChatBox ( "The server password is " .. password, thePlayer )

-- Else print that there isnt any password
else
outputChatBox ( "The server doesn't have any password set", thePlayer )
end
end

-- Add console command 'viewpassword'
addCommandHandler ( "viewpassword", viewPassword )
</syntaxhighlight>

==See Also==
{{Server functions}}

GetServerPassword

2008-01-05T12:05:25Z

Mountnl:

__NOTOC__
{{Server function}}

This function returns the current password required to join the server.

==Syntax==

<syntaxhighlight lang="lua">
string getServerPassword ()
</syntaxhighlight>

===Returns===

Returns the current server password as a string if it has a password, if not it returns ''nil''.

==Example==
This example prints the serverpassword to the player
<syntaxhighlight lang="lua">
function viewPassword ( thePlayer, command )
-- Put the password in a var
local password = getServerPassword ()

-- Check if the server has a password
-- If the server has an password, echo it
if (password != nil) then
outputChatBox ( "The server password is " .. getServerPassword (), thePlayer )

-- Else print that there isnt any password
else
outputChatBox ( "The server doesn't have any password set", thePlayer )
end
end

-- Add console command 'viewpassword'
addCommandHandler ( "viewpassword", viewPassword )
</syntaxhighlight>

==See Also==
{{Server functions}}

GetServerPassword

2008-01-05T12:04:51Z

Mountnl:

__NOTOC__
{{Server function}}

This function returns the current password required to join the server.

==Syntax==

<syntaxhighlight lang="lua">
string getServerPassword ()
</syntaxhighlight>

===Returns===

Returns the current server password as a string if it has a password, if not it returns ''nil''.

==Example==
This example prints the serverpassword to the player
<syntaxhighlight lang="lua">
function viewPassword ( thePlayer, command )
-- Put the password in a var
local password = getServerPassword ()

-- Check if the server has a password
-- If the server has an password, echo it
if (password != nil) then
outputChatBox ( "The server password is " .. getServerPassword (), thePlayer )

-- Else print that there isnt any password
else
outputChatBox ( "The server password is " .. getServerPassword (), thePlayer )
end
end

-- Add console command 'viewpassword'
addCommandHandler ( "viewpassword", viewPassword )
</syntaxhighlight>

==See Also==
{{Server functions}}

OnVehicleRespawn

2008-01-05T11:58:37Z

Mountnl:

__NOTOC__
{{Server event}}
This event is triggered when a vehicle is respawned due. See [[toggleVehicleRespawn]].

==Parameters==
<syntaxhighlight lang="lua">
bool exploded
</syntaxhighlight>

*'''exploded''': ''true'' if this vehicle respawned because it exploded, ''false'' if it respawned due to being deserted.

==Source==
The [[event system#Event source|source]] of this event is the [[vehicle]] that respawned.

==Example==
This example shows a message in the chatbox, if it is respawned.
<syntaxhighlight lang="lua">
function onVehicleRespawn ( exploded )
-- Add this variable. It contains the vehicle name of the respawned vehicle
local vehicleName = getVehicleName ( source )

-- If it is exploded, echo a custom message
if ( exploded == true ) then
outputChatBox("A " .. vehiclename .. " has been respawned, after an explosion")

-- else echo a normal message
else
outputChatBox("A " .. vehiclename .. " has been respawned")
end
end

-- Add the Event Handler
addEventHandler ( "OnVehicleRespawn", getRootElement(), onVehicleRespawn )
</syntaxhighlight>

==See Also==
{{Event_functions}}

Interior

2008-01-05T11:46:01Z

Mountnl:

An ''interior'' in GTA is an area that isn't 'outside'. For example, inside houses, casinos, restaurants, shops etc. Players can not, by default, access these. You can use various scripting functions to move elements into these interiors. When you change the interior a player is in, they can only see the non-player elements in that interior. Players can see each other in whatever interior they are in.

You can have up to 255 interiors, interior 0 being the first one and referring to the normal GTA world.

==Uses==
To allow a player to enter an interior, you should use the [[setElementInterior]] function on the player you wish to move. You can also use this function on other elements, for example to make a vehicle or object appear in the interior.

==Relevant scripting functions==
*[[getElementInterior]]
*[[setElementInterior]]
*[[spawnPlayer]]

==See Also==
* [[Dimension]]

[[Category:Scripting Concepts]]

GetPlayerAccount

2008-01-05T11:35:47Z

Mountnl:

__NOTOC__
{{Server function}}
Returns the accountname of the player

==Syntax==
<syntaxhighlight lang="lua">int getPlayerAccount ( player thePlayer )</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you wish the retrieve the name of the account from.

===Returns===
Returns an string with name of the account.
-- TODO -- What does it return if it isnt known?

==Example==
When a player types '/account' this example retrieves the player's accountname, and prints it to his screen.
<syntaxhighlight lang="lua">
function viewAccount(thePlayer, command)
-- get the name of the account from thePlayer
local accountName = getPlayerMoney(thePlayer)

-- output the message to the player
outputChatBox("Your account name is " .. accountName, thePlayer)
end

-- add the console command
addCommandHandler("account", viewAccount)
</syntaxhighlight>

==See Also==
{{Player functions}}
[[Category:Incomplete]]

GetPlayerAccount

2008-01-05T11:34:40Z

Mountnl: New page: __NOTOC__ {{Server function}} Returns the accountname of the player ==Syntax== <syntaxhighlight lang="lua">int getPlayerAccount ( player thePlayer )</syntaxhighlight> ===Required Arguments=== *'''thePlayer:''...

__NOTOC__
{{Server function}}
Returns the accountname of the player

==Syntax==
<syntaxhighlight lang="lua">int getPlayerAccount ( player thePlayer )</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you wish the retrieve the name of the account from.

===Returns===
Returns an string with name of the account.
-- TODO -- What does it return if it isnt known?

==Example==
When a player types '/account' this example retrieves the player's accountname, and prints it to his screen.
<syntaxhighlight lang="lua">
function viewAccount(thePlayer, command)
-- get the name of the account from thePlayer
local accountName = getPlayerMoney(thePlayer)

-- output the message
outputChatBox("Your account name is " .. accountName, thePlayer)
end

-- add the console command
addCommandHandler("account", viewAccount)
</syntaxhighlight>

==See Also==
{{Player functions}}
[[Category:Incomplete]]

OnPlayerQuit

2008-01-05T11:07:05Z

Mountnl:

__NOTOC__
{{Server event}}
This event is triggered when a player disconnects from the server.

==Parameters==
<syntaxhighlight lang="lua">
string reason
</syntaxhighlight>

*'''reason''': A string containing the reason why the player left.
Quit reason string can be:
- "Unknown"
- "Quit"
- "Kicked"
- "Banned"
- "Bad Connection"
- "Timed out"

==Source==
The [[event system#Event source|source]] of this event is the [[player]] that left the server.

==Example==
This example gets the quitting client's name and outputs that he is gone

<syntaxhighlight lang="lua">
-- we register quitPlayer as a handler for the event
function quitPlayer ( )
-- we store the player's name
local quittingPlayerName = getClientName ( source )
-- and send the message to the server
outputChatBox ( quittingPlayerName .. " has left the server" )
end
addEventHandler ( "onPlayerQuit", getRootElement(), quitPlayer )
</syntaxhighlight>

==See Also==
{{Event_functions}}
[[Category:Incomplete]]

OnPlayerQuit

2008-01-05T11:06:40Z

Mountnl:

__NOTOC__
{{Server event}}
This event is triggered when a player disconnects from the server.

==Parameters==
<syntaxhighlight lang="lua">
string reason
</syntaxhighlight>

*'''reason''': A string containing the reason why the player left.
Quit reason string can be:
- "Unknown"
- "Quit"
- "Kicked"
- "Banned"
- "Bad Connection"
- "Timed out"

==Source==
The [[event system#Event source|source]] of this event is the [[player]] that left the server.

==Example==
This example gets the quitting client's name and outputs that he is gone

<syntaxhighlight lang="lua">
-- we register quitPlayer as a handler for the event
function quitPlayer ( )
-- we store the player's name
local quittingPlayerName = getClientName ( source )
-- and send him a greeting
outputChatBox ( quittingPlayerName .. " has left the server" )
end
addEventHandler ( "onPlayerQuit", getRootElement(), quitPlayer )
</syntaxhighlight>

==See Also==
{{Event_functions}}
[[Category:Incomplete]]