Multi Theft Auto: Wiki - User contributions [en]

IsMouseInPosition

2015-04-11T12:05:02Z

AlaaS:

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function allows you to check whether the mouse cursor/pointer is within a rectangular position
==Syntax==
<syntaxhighlight lang="lua">bool isMouseInPosition ( int x, int y, int width, int height )</syntaxhighlight>

===Required arguments===
* '''x''': Left-most X position for detection (absolute)
* '''y''': Top-most Y position for detection (absolute)
* '''width''': Width for detection (absolute)
* '''heigh''': Height for detection (absolute)

===Return===
Returns true/false depending on whether the mouse is within the specified position or not

==Code==
<syntaxhighlight lang="lua">
function isMouseInPosition ( x, y, width, height )
if ( not isCursorShowing ( ) ) then
return false
end

local sx, sy = guiGetScreenSize ( )
local cx, cy = getCursorPosition ( )
local cx, cy = ( cx * sx ), ( cy * sy )
if ( cx >= x and cx <= x + width ) and ( cy >= y and cy <= y + height ) then
return true
else
return false
end
end
</syntaxhighlight>

==Example==
<section name="Example" class="client" show="true">
Changes the image when you move your cursor over it.
<syntaxhighlight lang="lua">
addEventHandler ( "onClientRender", root,
function ( )
local imgX, imgY, imgWidth, imgHeight = 50, 50, 200, 200
dxDrawImage ( imgX, imgY, imgWidth, imgHeight, ( isMouseInPosition ( imgX, imgY, imgWidth, imgHeight ) and "myImage2.png" or "myImage.png" ), tocolor ( 255, 255, 255 ) )
end
)
</syntaxhighlight>
</section>

Author: Castillo

==See Also==
{{Useful_Functions}}

IsMouseInPosition

2015-04-11T12:04:36Z

AlaaS:

{{Useful Function}}
{{Needs Example}}
<lowercasetitle/>
__NOTOC__
This function allows you to check whether the mouse cursor/pointer is within a rectangular position
==Syntax==
<syntaxhighlight lang="lua">bool isMouseInPosition ( int x, int y, int width, int height )</syntaxhighlight>

===Required arguments===
* '''x''': Left-most X position for detection (absolute)
* '''y''': Top-most Y position for detection (absolute)
* '''width''': Width for detection (absolute)
* '''heigh''': Height for detection (absolute)

===Return===
Returns true/false depending on whether the mouse is within the specified position or not

==Code==
<syntaxhighlight lang="lua">
function isMouseInPosition ( x, y, width, height )
if ( not isCursorShowing ( ) ) then
return false
end

local sx, sy = guiGetScreenSize ( )
local cx, cy = getCursorPosition ( )
local cx, cy = ( cx * sx ), ( cy * sy )
if ( cx >= x and cx <= x + width ) and ( cy >= y and cy <= y + height ) then
return true
else
return false
end
end
</syntaxhighlight>

==Example==
<section name="Example" class="client" show="true">
Changes the image when you move your cursor over it.
<syntaxhighlight lang="lua">
addEventHandler ( "onClientRender", root,
function ( )
local imgX, imgY, imgWidth, imgHeight = 50, 50, 200, 200
dxDrawImage ( imgX, imgY, imgWidth, imgHeight, ( isMouseInPosition ( imgX, imgY, imgWidth, imgHeight ) and "myImage2.png" or "myImage.png" ), tocolor ( 255, 255, 255 ) )
end
)
</syntaxhighlight>
</section>

Author: Castillo

==See Also==
{{Useful_Functions}}

IsBan

2015-04-11T12:01:09Z

AlaaS: /* Example */

__NOTOC__
{{Server function}}
{{New items|4.0132|1.4|
This function checks if the passed value is valid [[ban]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool isBan ( ban theBan )
</syntaxhighlight>

===Required Arguments===
*'''theValue:''' The value to check

===Returns===
Returns ''true'' if the value is a ban, ''false'' otherwise.

==Example==
<section name="Example1" class="server" show="true">
This example chechks if the passed argument is a ban or not.
<syntaxhighlight lang="lua">
function banRecieve ( ban )
if ban and isBan(ban) == true then
outputChatBox("this is a ban!")--Valid ban is recieved!
else
outputChatBox("this is not a ban, this is a "..getElementType(ban))--if the argument is not a ban, then checks its type and output it into the chat box.
end
end

function onBan ( ban ) -- This function will be triggered every time a player is banned.
banRecieve(ban)
end
addEventHandler ( "onPlayerBan", getRootElement(), onBan )

function sendWrongBanArguement()
vehicle = createVehicle(411,0,5,3)
object = createObject(2600,0,0,0)
ped = createPed(61,0,0,3)
banRecieve(vehicle)--sends a vehicle as an argument.
banRecieve(object)--sends an object as an argument.
banRecieve(ped)--sends a ped as an argument.
end
addCommandHandler("sendWrongArgument",sendWrongBanArguement)
</syntaxhighlight>
</section>

==See Also==
{{Admin_functions}}
[[ru:isBan]]

IsBan

2015-04-11T12:00:33Z

AlaaS:

__NOTOC__
{{Server function}}
{{New items|4.0132|1.4|
This function checks if the passed value is valid [[ban]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool isBan ( ban theBan )
</syntaxhighlight>

===Required Arguments===
*'''theValue:''' The value to check

===Returns===
Returns ''true'' if the value is a ban, ''false'' otherwise.

==Example==
<section name="Example1" class="server" show="true">
This example chechks if the passed argument is a ban or not.
<syntaxhighlight lang="lua">
function banRecieve ( ban )
if ban and isBan(ban) == true then
outputChatBox("this is a ban!")--Valid ban is recieved!
else
outputChatBox("this is not a ban, this is a "..getElementType(ban))--if the argument is not a ban, then checks its type and output it into the chat box.
end
end
function onBan ( ban ) -- This function will be triggered every time a player is banned.
banRecieve(ban)
end
addEventHandler ( "onPlayerBan", getRootElement(), onBan )

function sendWrongBanArguement()
vehicle = createVehicle(411,0,5,3)
object = createObject(2600,0,0,0)
ped = createPed(61,0,0,3)
banRecieve(vehicle)--sends a vehicle as an argument.
banRecieve(object)--sends an object as an argument.
banRecieve(ped)--sends a ped as an argument.
end
addCommandHandler("sendWrongArgument",sendWrongBanArguement)
</syntaxhighlight>
</section>

==See Also==
{{Admin_functions}}
[[ru:isBan]]

IsBan

2015-04-11T11:59:38Z

AlaaS: /* Example */

__NOTOC__
{{Server function}}
{{Needs_Example}}
{{New items|4.0132|1.4|
This function checks if the passed value is valid [[ban]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool isBan ( ban theBan )
</syntaxhighlight>

===Required Arguments===
*'''theValue:''' The value to check

===Returns===
Returns ''true'' if the value is a ban, ''false'' otherwise.

==Example==
<section name="Example1" class="server" show="true">
This example chechks if the passed argument is a ban or not.
<syntaxhighlight lang="lua">
function banRecieve ( ban )
if ban and isBan(ban) == true then
outputChatBox("this is a ban!")--Valid ban is recieved!
else
outputChatBox("this is not a ban, this is a "..getElementType(ban))--if the argument is not a ban, then checks its type and output it into the chat box.
end
end
function onBan ( ban ) -- This function will be triggered every time a player is banned.
banRecieve(ban)
end
addEventHandler ( "onPlayerBan", getRootElement(), onBan )

function sendWrongBanArguement()
vehicle = createVehicle(411,0,5,3)
object = createObject(2600,0,0,0)
ped = createPed(61,0,0,3)
banRecieve(vehicle)--sends a vehicle as an argument.
banRecieve(object)--sends an object as an argument.
banRecieve(ped)--sends a ped as an argument.
end
addCommandHandler("sendWrongArgument",sendWrongBanArguement)
</syntaxhighlight>
</section>

==See Also==
{{Admin_functions}}
[[ru:isBan]]

GetXMLNodes

2014-12-12T12:38:31Z

AlaaS:

{{Useful Function}}
<lowercasetitle/>

==Syntax==
<syntaxhighlight lang="lua">void getXMLNodes( string xmlfilename, string nodename)</syntaxhighlight>

===Required Arguments===
* '''xmlfilename''': The xml file name and path
* '''nodename''': Node name in xml file

===Optional Arguments===
{{OptionalArg}}

==Code==
<section name="Serverside/clientside" class="server/client" show="true">
<syntaxhighlight lang="lua">
function getXMLNodes(xmlfile,nodename)
local xml = xmlLoadFile(xmlfile)
if xml then
local ntable={}
local a = 0
while xmlFindChild(xml,nodename,a) do
table.insert(ntable,a+1)
ntable[a+1]={}
local attrs = xmlNodeGetAttributes ( xmlFindChild(xml,nodename,a) )
for name,value in pairs ( attrs ) do
table.insert(ntable[a+1],name)
ntable[a+1][name]=value
end

ntable[a+1]["nodevalue"]=xmlNodeGetValue(xmlFindChild(xml,nodename,a))

a=a+1
end
return ntable
else
return {}
end
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
local aTeam = getXMLNodes("teams.xml","team")
for ka,vc in ipairs(aTeam) do
outputDebugString(vc.tag)
end
</syntaxhighlight>
</section>
XML<teams.xml>
<syntaxhighlight lang="xml">
<teams>
<team tag="|OS|" />
<teams>
</syntaxhighlight>

Author: NeoN

==See Also==
{{Useful_Functions}}

SetProjectileCounter

2014-08-13T14:36:39Z

AlaaS: /* Returns */

__NOTOC__
{{Client function}}
{{Needs_Example}}
Will change the projectile counter timer which depending on the projectile type will do different things:
* Rockets and Grenades will explode when it hits 0
* Teargas may be a duration timer
* Satchels restart (we currently assume it doesn't cause an effect)

==Syntax==
<syntaxhighlight lang="lua">bool setProjectileCounter ( projectile projectile, int timeToDetonate )</syntaxhighlight>

===Required Arguments===
* '''projectile:''' The projectile to edit the timer of.
* '''timeToDetonate:''' The time in milliseconds to detonation.

===Returns===
Returns ''true'' on success, ''false'' otherwise.
===Example===
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function bomberf(cmd, player, bombid, duration) -- This will get the arguments of /setbombtime <bombid> <duration in secondes>
if bombid and duration then -- Checks if the bombid and the duration are avaible.
result = setProjectileCounter( bombid, duration * 1000 )-- This will set the bomb requested in bombid counter to the requested duration.
if result then -- this checks if the code worked or no.
outputChatBox("Timer of projectile :"..bombid.." set to :"..duration.." secodes")
end
end
end
addCommandHandler("setbombtime", bomberf)-- when player do /setbombtime this will trigger the bombrf function.
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|n/a|1.3.0-9.04555|}}

==See Also==
{{Client projectile functions}}