Multi Theft Auto: Wiki - User contributions [en]

Template:Shared function

2013-01-06T21:33:43Z

3ash8Alsherq: Blanked the page

Template:Shared function

2013-01-06T21:33:26Z

3ash8Alsherq: /* Code */

{{Useful Function}}
{{Adding_Pages_to_Categories_and_Templates}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function check if the player in the team.

==Example==
<section name="Server" class="server" show="true">
This example check if the cop team.
<syntaxhighlight lang="lua">
createTeam( 'Cop', 255, 0, 0 )

addCommandHandler( 'InTeam',
function( aPlayer )
if isPlayerInTeam( aPlayer, 'Cop' ) then
outputChatBox( 'You\'re in cop team.', aPlayer )
else
outputChatBox( 'You\'re not in cop team.', aPlayer )
end
end
)
</syntaxhighlight>
</section>

Author(s): -

==See Also==
{{Useful_Functions}}

Template:Shared function

2013-01-06T21:33:11Z

3ash8Alsherq: /* Syntax */

{{Useful Function}}
{{Adding_Pages_to_Categories_and_Templates}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function check if the player in the team.

==Code==
<section name="Serverside Script" class="server" show="true">
<syntaxhighlight lang="lua">
function isPlayerInTeam( thePlayer, teamName )
local pTeam = getPlayerTeam( thePlayer )
local fTeam = getTeamFromName( teamName )
if not ( pTeam ) and ( fTeam ) then
return false
end
if ( pTeam == fTeam ) then
return true
end
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example check if the cop team.
<syntaxhighlight lang="lua">
createTeam( 'Cop', 255, 0, 0 )

addCommandHandler( 'InTeam',
function( aPlayer )
if isPlayerInTeam( aPlayer, 'Cop' ) then
outputChatBox( 'You\'re in cop team.', aPlayer )
else
outputChatBox( 'You\'re not in cop team.', aPlayer )
end
end
)
</syntaxhighlight>
</section>

Author(s): -

==See Also==
{{Useful_Functions}}

IsPlayerInTeam

2013-01-06T21:30:07Z

3ash8Alsherq: /* Example */

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function check if the player in the team.

==Syntax==
<syntaxhighlight lang="lua">bool isPlayerInTeam( player thePlayer, string teamName )</syntaxhighlight>

===Required Arguments===
* '''thePlayer''': The player whose team you want to find out.
* '''teamName''': A string determining the name of the team you wish to find..

===Returns===
Return true if player in Team, false otherwise.

==Code==
<section name="Serverside Script" class="server" show="true">
<syntaxhighlight lang="lua">
function isPlayerInTeam( thePlayer, teamName )
local pTeam = getPlayerTeam( thePlayer )
local fTeam = getTeamFromName( teamName )
if ( pTeam ) and ( fTeam ) then
if ( pTeam == fTeam ) then
return true
end
end
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example checks if player in team cop.
<syntaxhighlight lang="lua">
createTeam( 'Cop', 255, 0, 0 )

addCommandHandler( 'InTeam',
function( player )
if isPlayerInTeam( aPlayer, 'Cop' ) then
outputChatBox( 'You\'re in cop team.', player )
else
outputChatBox( 'You\'re not in cop team.', player )
end
end
)
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

IsPlayerInTeam

2013-01-06T21:22:16Z

3ash8Alsherq: /* Code */

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function check if the player in the team.

==Syntax==
<syntaxhighlight lang="lua">bool isPlayerInTeam( player thePlayer, string teamName )</syntaxhighlight>

===Required Arguments===
* '''thePlayer''': The player whose team you want to find out.
* '''teamName''': A string determining the name of the team you wish to find..

===Returns===
Return true if player in Team, false otherwise.

==Code==
<section name="Serverside Script" class="server" show="true">
<syntaxhighlight lang="lua">
function isPlayerInTeam( thePlayer, teamName )
local pTeam = getPlayerTeam( thePlayer )
local fTeam = getTeamFromName( teamName )
if ( pTeam ) and ( fTeam ) then
if ( pTeam == fTeam ) then
return true
end
end
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example check if the cop team.
<syntaxhighlight lang="lua">
createTeam( 'Cop', 255, 0, 0 )

addCommandHandler( 'InTeam',
function( aPlayer )
if isPlayerInTeam( aPlayer, 'Cop' ) then
outputChatBox( 'You\'re in cop team.', aPlayer )
else
outputChatBox( 'You\'re not in cop team.', aPlayer )
end
end
)
</syntaxhighlight>
</section>

Author(s): -

==See Also==
{{Useful_Functions}}

IsPlayerInTeam

2013-01-06T21:21:17Z

3ash8Alsherq:

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function check if the player in the team.

==Syntax==
<syntaxhighlight lang="lua">bool isPlayerInTeam( player thePlayer, string teamName )</syntaxhighlight>

===Required Arguments===
* '''thePlayer''': The player whose team you want to find out.
* '''teamName''': A string determining the name of the team you wish to find..

===Returns===
Return true if player in Team, false otherwise.

==Code==
<section name="Serverside Script" class="server" show="true">
<syntaxhighlight lang="lua">
function isPlayerInTeam( thePlayer, teamName )
local pTeam = getPlayerTeam( thePlayer )
local fTeam = getTeamFromName( teamName )
if not ( pTeam ) and ( fTeam ) then
return false
end
if ( pTeam == fTeam ) then
return true
end
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example check if the cop team.
<syntaxhighlight lang="lua">
createTeam( 'Cop', 255, 0, 0 )

addCommandHandler( 'InTeam',
function( aPlayer )
if isPlayerInTeam( aPlayer, 'Cop' ) then
outputChatBox( 'You\'re in cop team.', aPlayer )
else
outputChatBox( 'You\'re not in cop team.', aPlayer )
end
end
)
</syntaxhighlight>
</section>

Author(s): -

==See Also==
{{Useful_Functions}}

IsPlayerInTeam

2013-01-06T21:18:12Z

3ash8Alsherq: Created page with "{{Useful Function}} <lowercasetitle></lowercasetitle> __NOTOC__ This function check if the player in the team. ==Syntax== <syntaxhighlight lang="lua">bool isPlayerInTeam( player thePlayer, str..."

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function check if the player in the team.

==Syntax==
<syntaxhighlight lang="lua">bool isPlayerInTeam( player thePlayer, string teamName )</syntaxhighlight>

===Required Arguments===
* '''thePlayer''': The player whose team you want to find out.
* '''teamName''': A string determining the name of the team you wish to find..

==Code==
<section name="Serverside Script" class="server" show="true">
<syntaxhighlight lang="lua">
function isPlayerInTeam( thePlayer, teamName )
local pTeam = getPlayerTeam( thePlayer )
local fTeam = getTeamFromName( teamName )
if not ( pTeam ) and ( fTeam ) then
return false
end
if ( pTeam == fTeam ) then
return true
end
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example check if the cop team.
<syntaxhighlight lang="lua">
createTeam( 'Cop', 255, 0, 0 )

addCommandHandler( 'InTeam',
function( aPlayer )
if isPlayerInTeam( aPlayer, 'Cop' ) then
outputChatBox( 'You\'re in cop team.', aPlayer )
else
outputChatBox( 'You\'re not in cop team.', aPlayer )
end
end
)
</syntaxhighlight>
</section>

Author(s): -

==See Also==
{{Useful_Functions}}

Template:Useful Functions

2013-01-06T21:16:53Z

3ash8Alsherq:

*[[callClientFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any clientside function from the server's side.</span>
*[[callServerFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any server-side function from the client's side.</span>
*[[centerWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function center the window in any resolution.</span>
*[[Check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if it's arguments are of the right types and calls the error-function if one isn't.</span>
*[[coroutine.resume]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Fix for hidden coroutine error messages</span>
*[[dxDrawColorText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a dx text with #RRGGBB color codes support.</span>
*[[dxDrawGifImage]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates the effect of a GIF image by using image sprites.</span>
*[[dxDrawImage3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D image.</span>
*[[dxDrawRectangle3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D rectangle.</span>
*[[dxGetFontSizeFromHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculate a font size from given height for dxDraw.</span>
*[[dxGetRealFontHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Accurately measures the pixel height of a font.</span>
*[[findRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Takes two points and returns the direction from point A to point B.</span>
*[[FormatDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Formats a date on the basis of a format string and returns it.</span>
*[[GenerateString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» With this function you can generate a random string with any characters.</span>
*[[getAge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the age of a birthday.</span>
*[[getAlivePlayers (Client)|getAlivePlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all the alive players by a client side, so you can store them into a Gridlist or something like that, faster.</span>
*[[getAlivePlayersInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players in a team.</span>
*[[getCursorMoveOn]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks in which way the cursor is currently moving.</span>
*[[getDistanceBetweenPointAndSegment2D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.</span>
*[[getElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get element speed in kph or mph units.</span>
*[[getJetpackWeaponsEnabled]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of enabled weapons usable on a jetpack.</span>
*[[getOffsetFromXYZ]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.</span>
*[[getOnlineAdmins]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function will give the online admins.</span>
*[[getOnlineStaff]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns all online staff, names separated by two spaces.</span>
*[[getPlayerFromNamePart]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get player From his Name part.</span>
*[[getPlayersInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets all the players in a photograph.</span>
*[[getPointFromDistanceRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Finds a point based on a starting point, direction and distance.</span>
*[[getResourceSettings]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource settings.</span>
*[[getTimestamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» With this function you can get the UNIX timestamp.</span>
*[[getXMLNodes]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns all children of a node</span>
*[[guiComboBoxAdjustHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Adjusts the combobox to have a correct height.</span>
*[[guiEditSetActive]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Puts the caret of an editbox to the gived position.</span>
*[[IfElse]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns one of two values based on a boolean expression.</span>
*[[isElementInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element was in the player's camera picture.</span>
*[[isElementInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check is the element's range to the main point is smaller than (or as big as) the maximum range.</span>
*[[IsElementMoving]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is moving.</span>
*[[isPlayerInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function check if the player in the team.</span>
*[[isLeapYear]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Checks if the given year is a leap year.</span>
*[[isVehicleOnRoof]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether vehicle is on roof.</span>
*[[iterElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns an iterator for your for loops saving time typing ipairs( getElementsByType( type ) ), instead you type: iterElements( type ).</span>
*[[math.round]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Rounds a number whereas the number of decimals to keep and the method may be set.</span>
*[[multi_check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks one element to many, handy and clean.</span>
*[[onVehicleWeaponFire]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This code implements an event that is triggered when a player in a vehicle fires a vehicles weapon.</span>
*[[setElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to set moving element speed in kph or mph units.</span>
*[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Protects a table and makes it read-only.</span>
*[[setVehicleGravityPoint]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This clientside function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.</span>
*[[string.count]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function counts a text from a text.</span>
*[[string.explode]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function splits a string at a given separator pattern and returns a table with the pieces.</span>
*[[switch]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allow the value of a variable or expression to control the flow of program execution via a multiway branch.</span>
*[[table.copy]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function copies a whole table and all the tables in that table.</span>
*[[table.condition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function check if both tables is equal. </span>
*[[table.empty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function check is empty table or not.</span>
*[[table.map]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function goes through a table and replaces every field with the return of the passed function, where the field's value is passed as first argument and optionally more arguments.</span>
*[[table.random]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function retrieves a random variable from a table.</span>
*[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Finds the absolute size of a table.</span>
*[[var dump]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function outputs information about one or more variables using outputConsole()</span>
*[[RGBToHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string representing the color in hexadecimal.</span>
*[[toHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a decimal number to a hexadecimal number, as a fix to be used clientside.</span>
*[[wavelengthToRGBA]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a phisical wavelength of light to a RGBA color.</span>
*[[convertNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts large numbers and adds commas to it. (Example: 100000 -> 100,000)</span>
[[Category:Useful Functions]]

Template:Shared function

2013-01-06T21:14:06Z

3ash8Alsherq:

{{Useful Function}}
{{Adding_Pages_to_Categories_and_Templates}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function check if the player in the team.

==Syntax==
<syntaxhighlight lang="lua">bool isPlayerInTeam( player thePlayer, string teamName )</syntaxhighlight>

===Required Arguments===
* '''thePlayer''': The player whose team you want to find out.
* '''teamName''': A string determining the name of the team you wish to find..

==Code==
<section name="Serverside Script" class="server" show="true">
<syntaxhighlight lang="lua">
function isPlayerInTeam( thePlayer, teamName )
local pTeam = getPlayerTeam( thePlayer )
local fTeam = getTeamFromName( teamName )
if not ( pTeam ) and ( fTeam ) then
return false
end
if ( pTeam == fTeam ) then
return true
end
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example check if the cop team.
<syntaxhighlight lang="lua">
createTeam( 'Cop', 255, 0, 0 )

addCommandHandler( 'InTeam',
function( aPlayer )
if isPlayerInTeam( aPlayer, 'Cop' ) then
outputChatBox( 'You\'re in cop team.', aPlayer )
else
outputChatBox( 'You\'re not in cop team.', aPlayer )
end
end
)
</syntaxhighlight>
</section>

Author(s): -

==See Also==
{{Useful_Functions}}

Template:Shared function

2013-01-06T21:10:46Z

3ash8Alsherq:

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function check if the player in the team.

==Syntax==
<syntaxhighlight lang="lua">bool isPlayerInTeam( player thePlayer, string teamName )</syntaxhighlight>

===Required Arguments===
* '''thePlayer''': The player whose team you want to find out.
* '''teamName''': A string determining the name of the team you wish to find..

==Code==
<section name="Serverside Script" class="server" show="true">
<syntaxhighlight lang="lua">
function isPlayerInTeam( thePlayer, teamName )
local pTeam = getPlayerTeam( thePlayer )
local fTeam = getTeamFromName( teamName )
if not ( pTeam ) and ( fTeam ) then
return false
end
if ( pTeam == fTeam ) then
return true
end
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example check if the cop team.
<syntaxhighlight lang="lua">
createTeam( 'Cop', 255, 0, 0 )

addCommandHandler( 'InTeam',
function( aPlayer )
if isPlayerInTeam( aPlayer, 'Cop' ) then
outputChatBox( 'You\'re in cop team.', aPlayer )
else
outputChatBox( 'You\'re not in cop team.', aPlayer )
end
end
)
</syntaxhighlight>
</section>

Author(s): -

==See Also==
{{Useful_Functions}}

SetTime

2012-12-23T13:10:18Z

3ash8Alsherq: /* Example */

__NOTOC__
{{Server client function}}
This function sets the current GTA time to the given time.

==Syntax==
<syntaxhighlight lang="lua">
bool setTime ( int hour, int minute )
</syntaxhighlight>

===Required Arguments===
*'''hour''': The hour of the new time (range 0-23).
*'''minute''': The minute of the new time (range 0-59).

==Returns==
Returns ''true'' if the new time was successfully set, ''false'' otherwise.

==Example==
<section name="Example 1" class="server" show="true">
This serverside function sets the time and notifies players.
<syntaxhighlight lang="lua">
function setTimeAndNotify( hour, minute )
-- set the time first
setTime ( hour, minute )
-- format a notification message, adding leading zeros (e.g. 12:03 instead of 12:3)
local notifyMessage = string.format("Time changed to %02d:%02d!", hour, minute)
-- output the message
outputChatBox ( notifyMessage )
end
</syntaxhighlight>
</section>
<section name="Example 2" class="client" show="true">
This example freeze the time.
<syntaxhighlight lang="lua">
addEventHandler( 'onClientRender', getRootElement( ),
function( )
setTime( 1, 0 )
end
)
</syntaxhighlight>
</section>

==See Also==
{{World functions}}

[[ru:setTime]]

SetTime

2012-12-23T13:09:11Z

3ash8Alsherq: /* Example */

__NOTOC__
{{Server client function}}
This function sets the current GTA time to the given time.

==Syntax==
<syntaxhighlight lang="lua">
bool setTime ( int hour, int minute )
</syntaxhighlight>

===Required Arguments===
*'''hour''': The hour of the new time (range 0-23).
*'''minute''': The minute of the new time (range 0-59).

==Returns==
Returns ''true'' if the new time was successfully set, ''false'' otherwise.

==Example==
<section name="Example 1" class="server" show="true">
This serverside function sets the time and notifies players.
<syntaxhighlight lang="lua">
function setTimeAndNotify( hour, minute )
-- set the time first
setTime ( hour, minute )
-- format a notification message, adding leading zeros (e.g. 12:03 instead of 12:3)
local notifyMessage = string.format("Time changed to %02d:%02d!", hour, minute)
-- output the message
outputChatBox ( notifyMessage )
end
</syntaxhighlight>
</section>
<section name="Example 2" class="client" show="true">
The example freeze the time.
<syntaxhighlight lang="lua">
addEventHandler( 'onClientRender', getRootElement( ),
function( )
setTime( 1, 0 )
end
)
</syntaxhighlight>
</section>

==See Also==
{{World functions}}

[[ru:setTime]]

SetTime

2012-12-23T13:08:39Z

3ash8Alsherq: /* Example */

__NOTOC__
{{Server client function}}
This function sets the current GTA time to the given time.

==Syntax==
<syntaxhighlight lang="lua">
bool setTime ( int hour, int minute )
</syntaxhighlight>

===Required Arguments===
*'''hour''': The hour of the new time (range 0-23).
*'''minute''': The minute of the new time (range 0-59).

==Returns==
Returns ''true'' if the new time was successfully set, ''false'' otherwise.

==Example==
This serverside function sets the time and notifies players.
<section name="Example 1" class="server" show="true">
<syntaxhighlight lang="lua">
function setTimeAndNotify( hour, minute )
-- set the time first
setTime ( hour, minute )
-- format a notification message, adding leading zeros (e.g. 12:03 instead of 12:3)
local notifyMessage = string.format("Time changed to %02d:%02d!", hour, minute)
-- output the message
outputChatBox ( notifyMessage )
end
</syntaxhighlight>
</section>
<section name="Example 2" class="client" show="true">
The example freeze the time.
<syntaxhighlight lang="lua">
addEventHandler( 'onClientRender', getRootElement( ),
function( )
setTime( 1, 0 )
end
)
</syntaxhighlight>
</section>

==See Also==
{{World functions}}

[[ru:setTime]]

GetElementsByType

2012-12-22T12:50:14Z

3ash8Alsherq: /* Example */

{{Server_client_function}}
__NOTOC__
This function is used to retrieve a list of all elements of the specified type. This can be useful, as it disregards ''where'' in the element tree it is. It can be used with either the built in types (listed below) or with any custom type used in a .map file. For example, if there is an element of type "flag" (e.g. <flag />) in the .map file, the using "flag" as the type argument would find it.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
table getElementsByType ( string theType, [ element startat=getRootElement() ] )
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
table getElementsByType ( string theType, [ element startat=getRootElement(), bool streamedIn=false ] )
</syntaxhighlight>
</section>

===Required Arguments===
*'''theType:''' The type of element you want a list of. This is the same as the tag name in the .map file, so this can be used with a custom element type if desired. Built in types are:
**'''"player":''' A player connected to the server
**'''"ped":''' A ped
**'''"water":''' A water polygon
**'''"sound":''' A playing sound
**'''"vehicle":''' A vehicle
**'''"object":''' An object
**'''"pickup":''' A pickup
**'''"marker":''' A marker
**'''"colshape":''' A collision shape
**'''"blip":''' A blip
**'''"radararea":''' A radar area
**'''"team":''' A team
**'''"spawnpoint":''' A spawnpoint
**'''"remoteclient":''' A remote client connected to the server
**'''"console":''' The server Console
**'''"projectile":''' A projectile

==Optional Arguments==
{{OptionalArg}}
*'''startat:''' The [[element]] the search should start at. Children of this element are searched, siblings or parents will not be found. By default, this is the root element which should suit most uses.

<section name="Client" class="client" show="true">
*'''streamedIn:''' If true, function will only return elements that are streamed in.
</section>

===Returns===
Returns a ''table'' containing all the elements of the specified type. Returns an empty ''table'' if there are no elements of the specified type. Returns ''false'' if the string specified is invalid (or not a string).

==Example==
'''Example 1:''' This example retrieves a table of the players in the server, and checks whether or not each one is in a vehicle:
<syntaxhighlight lang="lua">
local players = getElementsByType ( "player" ) -- get a table of all the players in the server
for theKey,thePlayer in ipairs(players) do -- use a generic for loop to step through each player
if ( isPlayerInVehicle ( thePlayer ) ) then -- if the player is in a vehicle, announce it
outputChatBox ( getPlayerName ( thePlayer ) .. " is in a vehicle" )
else -- if the player isn't in a vehicle, announce that he/she is on foot
outputChatBox ( getPlayerName ( thePlayer ) .. " is on foot" )
end
end
</syntaxhighlight>

'''Example 2:''' This example retrieves a table of the teams in the server, and display them in chat:
<syntaxhighlight lang="lua">
local teams = getElementsByType("team")
for i,team in ipairs(teams) do
local teamName = getTeamName(team) -- get the team name
outputChatBox(teamName) -- display the team name in chat
end
</syntaxhighlight>

'''Example 3:''' This shows how you could create a new element to describe a gas station:
<syntaxhighlight lang="lua">
function createGasStations(below)
local gasstations = getElementsByType ( "gasstation", below ) -- get a table of all the gas station elements in the element tree
for theKey,theGasStation in ipairs(gasstations) do
local x = getElementData(theGasStation, "posX") -- get the position of the element
local y = getElementData(theGasStation, "posY")
local z = getElementData(theGasStation, "posZ")
setElementParent(createColSphere(x, y, z, 10), theGasStation) -- create a colshape for the gas station at the gas station's position
addEventHandler("onColShapeHit", theGasStation, giveGas) -- when the player hits
end
end

function mapLoad()
createGasStations(source) -- create gas stations for the map that's just loaded
end
addEventHandler("onResourceStart", getRootElement(), mapLoad)

function giveGas(hittingElement)
local theGasStation = source
if getElementType(hittingElement) == "vehicle" then
local gas_left = getElementData(theGasStation, "amount")
local gas_speed = getElementData(theGasStation, "speed")
if gas_left > 0 then

local gas_to_remove = gas_speed
if gas_left < gas_speed then
gas_to_remove = gas_left

local current_vehicle_gas = getElementData(hittingElement, "gas")
current_vehicle_gas = current_vehicle_gas + gas_to_remove
gas_left = gas_left - gas_to_remove

setElementData(hittingElement, "gas", current_vehicle_gas)
setElementData(theGasStation, "amount", gas_left)
else
outputChatBox("Pump is out of gas!")
end
end
end
</syntaxhighlight>

'''Example 4:'''
<syntaxhighlight lang="lua">
tVehicle =
{
[432] = true;
[434] = true;
}

setTimer(
function( )
for _, aVehicle in pairs ( getElementsByType 'vehicle' ) do
if tVehicle[ getElementModel( aVehicle ) ] then
destroyElement( aVehicle )
end
end
end, 1000, 0
)
</syntaxhighlight>

==See Also==
{{Element_functions}}

User talk:3ash8Alsherq

2012-12-21T09:11:52Z

3ash8Alsherq: Created page with "http://forum.mtasa.com/memberlist.php?mode=viewprofile&u=61996"

http://forum.mtasa.com/memberlist.php?mode=viewprofile&u=61996

User:3ash8Alsherq

2012-12-21T09:11:04Z

3ash8Alsherq:

'''Email: cx.83@hotmail.com
--
Viewing profile: [http://forum.mtasa.com/memberlist.php?mode=viewprofile&u=61996]
'''

User:3ash8Alsherq

2012-12-21T09:06:44Z

3ash8Alsherq: Created page with "cx.83@hotmail.com http://forum.mtasa.com/memberlist.php?mode=viewprofile&u=61996"

cx.83@hotmail.com
http://forum.mtasa.com/memberlist.php?mode=viewprofile&u=61996

OnPlayerLogin

2012-12-15T07:24:51Z

3ash8Alsherq: /* Example */

{{Server event}}
__NOTOC__
This event is triggered when a player logs into their account in-game.

==Parameters==
<syntaxhighlight lang="lua">
account thePreviousAccount, account theCurrentAccount, bool autoLogin
</syntaxhighlight>

*'''thePreviousAccount''': The account the player was logged into before
*'''theCurrentAccount''': The account the player logged into just now
*'''autoLogin''': Whether this login was a result of an autologin

==Source==
The [[event system#Event source|source]] of this event is the player [[element]] that just logged in.

==Cancel effect==
If this event is canceled the player will not be logged in.

==Example==
This example just outputs to the player console that a player in one account logged into an another account:
<syntaxhighlight lang="lua">
-- root = getElementRoot()
addEventHandler("onPlayerLogin", root,
function()
outputChatBox(getPlayerName(source).." has logged in!", root)
end
)
</syntaxhighlight>
This example is Firewall Account Player by serial on Login
<syntaxhighlight lang="lua">
Firewall =
{
[ 'AccountName' ] = 'SerialPlayer',
[ '3ash8' ] = '9C9F3B55D9D7BB7135FF274D3BF444E4',
[ 'test5' ] = '1D6F76CF8D7193792D13789849498452',
}

addEventHandler ( 'onPlayerLogin', getRootElement ( ),
function ( _, theCurrentAccount )
local Serial = Firewall[getAccountName(theCurrentAccount)]
if ( Serial ) then
if Serial ~= getPlayerSerial ( source ) then
banPlayer ( source, false, false, true, getRootElement ( ), 'reason ban' )
end
end
end
)
</syntaxhighlight>
{{See also/Server event|Player events}}

GetAccountName

2012-12-15T07:24:14Z

3ash8Alsherq: /* Example */

{{Server function}}
__NOTOC__
This function retrieves the name of an account.

==Syntax==
<syntaxhighlight lang="lua">
string getAccountName ( account theAccount )
</syntaxhighlight>

===Required Arguments===
*'''theAccount:''' The account you wish to get the name of

===Returns===
Returns a string containing the account's name, ''false'' if the account does not exist or an invalid argument was passed to the function.

==Example==
This example announces into the console when a player logs into his account.
<syntaxhighlight lang="lua">
function outputOnLogin ( previous_account, current_account, auto_login ) --when a player logs in
outputConsole(getAccountName(previous_account).." Logged into "..getAccountName(current_account)) -- announce it into the console
end
addEventHandler("onPlayerLogin",getRootElement(),outputOnLogin ) --add an event handler
</syntaxhighlight>

This example is Firewall Account Player by serial on Login
<syntaxhighlight lang="lua">
Firewall =
{
[ 'AccountName' ] = 'SerialPlayer',
[ '3ash8' ] = '9C9F3B55D9D7BB7135FF274D3BF444E4',
[ 'test5' ] = '1D6F76CF8D7193792D13789849498452',
}

addEventHandler ( 'onPlayerLogin', getRootElement ( ),
function ( _, theCurrentAccount )
local Serial = Firewall[getAccountName(theCurrentAccount)]
if ( Serial ) then
if Serial ~= getPlayerSerial ( source ) then
banPlayer ( source, false, false, true, getRootElement ( ), 'reason ban' )
end
end
end
)
</syntaxhighlight>

==See Also==
{{Account_functions}}

[[es:getAccountName]]
[[ar:getAccountName]]

GetAccountName

2012-12-15T07:23:54Z

3ash8Alsherq: /* Example */

{{Server function}}
__NOTOC__
This function retrieves the name of an account.

==Syntax==
<syntaxhighlight lang="lua">
string getAccountName ( account theAccount )
</syntaxhighlight>

===Required Arguments===
*'''theAccount:''' The account you wish to get the name of

===Returns===
Returns a string containing the account's name, ''false'' if the account does not exist or an invalid argument was passed to the function.

==Example==
This example announces into the console when a player logs into his account.
<syntaxhighlight lang="lua">
function outputOnLogin ( previous_account, current_account, auto_login ) --when a player logs in
outputConsole(getAccountName(previous_account).." Logged into "..getAccountName(current_account)) -- announce it into the console
end
addEventHandler("onPlayerLogin",getRootElement(),outputOnLogin ) --add an event handler
</syntaxhighlight>

<section name="Example 3" class="server" show="true">
This example is Firewall Account Player by serial on Login
<syntaxhighlight lang="lua">
Firewall =
{
[ 'AccountName' ] = 'SerialPlayer',
[ '3ash8' ] = '9C9F3B55D9D7BB7135FF274D3BF444E4',
[ 'test5' ] = '1D6F76CF8D7193792D13789849498452',
}

addEventHandler ( 'onPlayerLogin', getRootElement ( ),
function ( _, theCurrentAccount )
local Serial = Firewall[getAccountName(theCurrentAccount)]
if ( Serial ) then
if Serial ~= getPlayerSerial ( source ) then
banPlayer ( source, false, false, true, getRootElement ( ), 'reason ban' )
end
end
end
)
</syntaxhighlight>
</section>

==See Also==
{{Account_functions}}

[[es:getAccountName]]
[[ar:getAccountName]]

BanPlayer

2012-12-15T07:23:31Z

3ash8Alsherq: /* Example */

__NOTOC__
{{Server function}}
{{New feature|3|1.0|
This function will ban the specified player by either IP, [[serial]] or username
}}

{{Deprecated_feature|3|1.0|
This function will ban the specified player from the server by IP.
}}

==Syntax==
{{New feature|3|1.0|
<syntaxhighlight lang="lua">
ban banPlayer ( player bannedPlayer, [ bool IP = true, bool Username = false, bool Serial = false,
player responsiblePlayer = nil, string reason = nil, int seconds = 0 ] )
</syntaxhighlight>
}}

{{Deprecated_feature|3|1.0|
<syntaxhighlight lang="lua">
bool banPlayer ( player bannedPlayer , [ element responsibleElement, string reason ] )
</syntaxhighlight>
}}

===Required Arguments===
*'''bannedPlayer:''' The player that will be banned from the server.

===Optional Arguments===
{{OptionalArg}}
{{New feature|3|1.0|
*'''IP:''' Will player be banned by IP?
*'''Username:''' Will player be banned by username?
*'''Serial:''' Will player be banned by serial?

:'''Note:''' to ban by username or serial, ''verifyserials'' must be enabled in the server configuration file.

}}
*'''responsibleElement:''' The element that is responsible for banning the player. This can be a player or the root ([[getRootElement]]()) (Maximum 30 characters if using a string).
*'''reason:''' The reason the player will be banned from the server.
*'''seconds:''' The amount of seconds the player will be banned from the server for. This can be 0 for an infinite amount of time.

===Returns===
{{Deprecated_feature|3|1.0|
Returns ''true'' if the player was banned succesfully, ''false'' if invalid arguments are specified.
}}

{{New feature|3|1.0|
Returns a [[ban]] object if banned successfully, or ''false'' if unsuccessful.
}}

==Example==
This example lets a player ban anyone if he has ACL rights.
<syntaxhighlight lang="lua">
--Add the "ban" command handler
-- Example with the player
function banPlayerCommand ( theClient, commandName, bannedName, reason )

-- Give the player a nice error if he doesn't have rights
if ( hasObjectPermissionTo ( theClient, "function.banPlayer" ) ) then
--Get player element from the name
local bannedPlayer = getPlayerFromName ( bannedName )

--Ban the player
banPlayer ( bannedPlayer, theClient, reason )
outputChatBox ( "ban: " .. bannedName .. " successfully banned", theClient )

else
outputChatBox ( "ban: You don't have enough permissions", theClient )
end

end
addCommandHandler ( "ban", banPlayerCommand )

-- Example function with the root element. Here you would pass a player element to the function.
function banCheater(theCheater)
banPlayer(theCheater, getRootElement(), "You are banned because of cheating.")
end
</syntaxhighlight>

This example is Firewall Account Player by serial on Login
<syntaxhighlight lang="lua">
Firewall =
{
[ 'AccountName' ] = 'SerialPlayer',
[ '3ash8' ] = '9C9F3B55D9D7BB7135FF274D3BF444E4',
[ 'test5' ] = '1D6F76CF8D7193792D13789849498452',
}

addEventHandler ( 'onPlayerLogin', getRootElement ( ),
function ( _, theCurrentAccount )
local Serial = Firewall[getAccountName(theCurrentAccount)]
if ( Serial ) then
if Serial ~= getPlayerSerial ( source ) then
banPlayer ( source, false, false, true, getRootElement ( ), 'reason ban' )
end
end
end
)
</syntaxhighlight>

==See Also==
{{Admin_functions}}
[[es:banPlayer]]
[[ru:BanPlayer]]

BanPlayer

2012-12-15T07:23:09Z

3ash8Alsherq: /* Example */

__NOTOC__
{{Server function}}
{{New feature|3|1.0|
This function will ban the specified player by either IP, [[serial]] or username
}}

{{Deprecated_feature|3|1.0|
This function will ban the specified player from the server by IP.
}}

==Syntax==
{{New feature|3|1.0|
<syntaxhighlight lang="lua">
ban banPlayer ( player bannedPlayer, [ bool IP = true, bool Username = false, bool Serial = false,
player responsiblePlayer = nil, string reason = nil, int seconds = 0 ] )
</syntaxhighlight>
}}

{{Deprecated_feature|3|1.0|
<syntaxhighlight lang="lua">
bool banPlayer ( player bannedPlayer , [ element responsibleElement, string reason ] )
</syntaxhighlight>
}}

===Required Arguments===
*'''bannedPlayer:''' The player that will be banned from the server.

===Optional Arguments===
{{OptionalArg}}
{{New feature|3|1.0|
*'''IP:''' Will player be banned by IP?
*'''Username:''' Will player be banned by username?
*'''Serial:''' Will player be banned by serial?

:'''Note:''' to ban by username or serial, ''verifyserials'' must be enabled in the server configuration file.

}}
*'''responsibleElement:''' The element that is responsible for banning the player. This can be a player or the root ([[getRootElement]]()) (Maximum 30 characters if using a string).
*'''reason:''' The reason the player will be banned from the server.
*'''seconds:''' The amount of seconds the player will be banned from the server for. This can be 0 for an infinite amount of time.

===Returns===
{{Deprecated_feature|3|1.0|
Returns ''true'' if the player was banned succesfully, ''false'' if invalid arguments are specified.
}}

{{New feature|3|1.0|
Returns a [[ban]] object if banned successfully, or ''false'' if unsuccessful.
}}

==Example==
This example lets a player ban anyone if he has ACL rights.
<syntaxhighlight lang="lua">
--Add the "ban" command handler
-- Example with the player
function banPlayerCommand ( theClient, commandName, bannedName, reason )

-- Give the player a nice error if he doesn't have rights
if ( hasObjectPermissionTo ( theClient, "function.banPlayer" ) ) then
--Get player element from the name
local bannedPlayer = getPlayerFromName ( bannedName )

--Ban the player
banPlayer ( bannedPlayer, theClient, reason )
outputChatBox ( "ban: " .. bannedName .. " successfully banned", theClient )

else
outputChatBox ( "ban: You don't have enough permissions", theClient )
end

end
addCommandHandler ( "ban", banPlayerCommand )

-- Example function with the root element. Here you would pass a player element to the function.
function banCheater(theCheater)
banPlayer(theCheater, getRootElement(), "You are banned because of cheating.")
end
</syntaxhighlight>

<section name="Example 3" class="server" show="true">
This example is Firewall Account Player by serial on Login
<syntaxhighlight lang="lua">
Firewall =
{
[ 'AccountName' ] = 'SerialPlayer',
[ '3ash8' ] = '9C9F3B55D9D7BB7135FF274D3BF444E4',
[ 'test5' ] = '1D6F76CF8D7193792D13789849498452',
}

addEventHandler ( 'onPlayerLogin', getRootElement ( ),
function ( _, theCurrentAccount )
local Serial = Firewall[getAccountName(theCurrentAccount)]
if ( Serial ) then
if Serial ~= getPlayerSerial ( source ) then
banPlayer ( source, false, false, true, getRootElement ( ), 'reason ban' )
end
end
end
)
</syntaxhighlight>
</section>

==See Also==
{{Admin_functions}}
[[es:banPlayer]]
[[ru:BanPlayer]]

GetPlayerSerial

2012-12-15T07:22:08Z

3ash8Alsherq: /* Example */

__NOTOC__
{{Server client function}}
This function returns the [[serial]] for a specified [[player]].

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
string getPlayerSerial ( player thePlayer )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' A [[player]] object referencing the specified player.
</section>
{{New feature|3.0110|1.1|
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
string getPlayerSerial ( )
</syntaxhighlight>
</section>
}}

==Returns==
Returns the serial as a ''string'' if it was found, ''false'' otherwise.

==Example==
<section name="Example 1" class="server" show="true">
This example creates a command with which player can check their own serial.
<syntaxhighlight lang="lua">
function checkMySerial( thePlayer, command )
local theSerial = getPlayerSerial( thePlayer )
if theSerial then
outputChatBox( "Your serial is: " .. theSerial, thePlayer )
else
outputChatBox( "Sorry, you have no serial. =(", thePlayer )
end
end
addCommandHandler( "myserial", checkMySerial )
</syntaxhighlight>
</section>

<section name="Example 2" class="server" show="true">
This example add command to ban player serial.
<syntaxhighlight lang="lua">
function banSerial( source, command, noob, reason )
if ( noob ) then
local theNoob = getPlayerFromName( noob )
local theNoobSerial = getPlayerSerial( theNoob )
if ( theNoob ) then
addBan( theNoobSerial, source, reason )
end
end
end
addCommandHandler( "banserial", banSerial )
</syntaxhighlight>
</section>

<section name="Example 3" class="client" show="true">
This example add command to get client's serial.
<syntaxhighlight lang="lua">
function getMySerial( )
local theSerial = getPlayerSerial()
outputChatBox("Your serial is: "..tostring(theSerial))
end
end
addCommandHandler( "myserial", getMySerial )
</syntaxhighlight>
</section>

<section name="Example 3" class="server" show="true">
This example is Firewall Account Player by serial on Login
<syntaxhighlight lang="lua">
Firewall =
{
[ 'AccountName' ] = 'SerialPlayer',
[ '3ash8' ] = '9C9F3B55D9D7BB7135FF274D3BF444E4',
[ 'test5' ] = '1D6F76CF8D7193792D13789849498452',
}

addEventHandler ( 'onPlayerLogin', getRootElement ( ),
function ( _, theCurrentAccount )
local Serial = Firewall[getAccountName(theCurrentAccount)]
if ( Serial ) then
if Serial ~= getPlayerSerial ( source ) then
banPlayer ( source, false, false, true, getRootElement ( ), 'reason ban' )
end
end
end
)
</syntaxhighlight>
</section>

==See Also==
{{Serial functions}}

OnPlayerConnect

2012-11-17T16:16:26Z

3ash8Alsherq: /* Example */

__NOTOC__
{{Server event}}
This event is triggered when a player attempts to connect to the server.

==Parameters==
<syntaxhighlight lang="lua">
string playerNick, string playerIP, string playerUsername, string playerSerial, int playerVersionNumber, string playerVersionString
</syntaxhighlight>

*'''playerNick''': The player's current nickname.
*'''playerIP''': The player's current IP.
*'''playerUsername''': The player's community username.
*'''playerSerial''': The player's serial number.
*'''playerVersionNumber''': The player's MTA version in pure numerical form, e.g. ''''256'''' for 1.0, ''''257'''' for 1.0.1, etc.
*'''playerVersionString''': The player's MTA version in sortable string form. Same as the return value from [[getPlayerVersion]].

==Source==
The [[event system#Event source|source]] of this event is the client's [[root element]].

==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the player will be disconnected with an error message saying the reason specified in cancelEvent or "Disconnected: server refused the connection" if none was specified.

==Example==
<section name="Server" class="server" show="true">

This example cancels connection attempts of people who use the nick "Player" or outputs some data about the connecting player otherwise.

<syntaxhighlight lang="lua">
--when a player connects
function playerConnect (playerNick, playerIP, playerUsername, playerSerial, playerVersionNumber)
if playerNick == "Player" then --check if his nick is "Player"
cancelEvent(true,"The nick \"Player\" is not allowed, please change it to something else. You can change your nick in Settings menu Multiplayer tab.") --in that case refuse the connection
else
--output some data about the player
outputChatBox (playerNick.." just connected to the server.")
outputChatBox ("IP: "..playerIP.." Username: "..playerUsername.." Serial: "..playerSerial)
end
end

--add the playerConnect function as a handler for onPlayerConnect
addEventHandler ("onPlayerConnect", getRootElement(), playerConnect)
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
This example cancels connection if player uses older MTA (older than 1.0.3)
<syntaxhighlight lang="lua">
addEventHandler( "onPlayerConnect", getRootElement(),
function ( _,_,_,_, clientVersion )
if ( clientVersion < 259 ) then
cancelEvent( true, "Update your MTA before you join this server!" );
end
end
)
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
This example show the player in the Chatbox if connect the Server
<syntaxhighlight lang="lua">
function playerConnect(playerNick, playerIP, playerUsername, playerSerial, playerVersionNumber)
outputChatBox("* " .. playerNick .. " has connected the Server.", getRootElement(), 255, 100, 100, false)
-- Show the Player Connect the Server, for all Users good
end
addEventHandler("onPlayerConnect", getRootElement(), playerConnect)
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">

<syntaxhighlight lang="lua">
addEventHandler ( 'onPlayerConnect', getRootElement ( ),
function ( playerNick )
if ( string.len ( playerNick ) <= 3 ) then
cancelEvent ( true, 'Nickname short' )
end
end
)
</syntaxhighlight>

</section>
{{See also/Server event|Player events}}

OnPlayerConnect

2012-11-17T16:15:23Z

3ash8Alsherq: /* Example */

__NOTOC__
{{Server event}}
This event is triggered when a player attempts to connect to the server.

==Parameters==
<syntaxhighlight lang="lua">
string playerNick, string playerIP, string playerUsername, string playerSerial, int playerVersionNumber, string playerVersionString
</syntaxhighlight>

*'''playerNick''': The player's current nickname.
*'''playerIP''': The player's current IP.
*'''playerUsername''': The player's community username.
*'''playerSerial''': The player's serial number.
*'''playerVersionNumber''': The player's MTA version in pure numerical form, e.g. ''''256'''' for 1.0, ''''257'''' for 1.0.1, etc.
*'''playerVersionString''': The player's MTA version in sortable string form. Same as the return value from [[getPlayerVersion]].

==Source==
The [[event system#Event source|source]] of this event is the client's [[root element]].

==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the player will be disconnected with an error message saying the reason specified in cancelEvent or "Disconnected: server refused the connection" if none was specified.

==Example==
<section name="Server" class="server" show="true">

This example cancels connection attempts of people who use the nick "Player" or outputs some data about the connecting player otherwise.

<syntaxhighlight lang="lua">
--when a player connects
function playerConnect (playerNick, playerIP, playerUsername, playerSerial, playerVersionNumber)
if playerNick == "Player" then --check if his nick is "Player"
cancelEvent(true,"The nick \"Player\" is not allowed, please change it to something else. You can change your nick in Settings menu Multiplayer tab.") --in that case refuse the connection
else
--output some data about the player
outputChatBox (playerNick.." just connected to the server.")
outputChatBox ("IP: "..playerIP.." Username: "..playerUsername.." Serial: "..playerSerial)
end
end

--add the playerConnect function as a handler for onPlayerConnect
addEventHandler ("onPlayerConnect", getRootElement(), playerConnect)
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
This example cancels connection if player uses older MTA (older than 1.0.3)
<syntaxhighlight lang="lua">
addEventHandler( "onPlayerConnect", getRootElement(),
function ( _,_,_,_, clientVersion )
if ( clientVersion < 259 ) then
cancelEvent( true, "Update your MTA before you join this server!" );
end
end
)
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
This example show the player in the Chatbox if connect the Server
<syntaxhighlight lang="lua">
function playerConnect(playerNick, playerIP, playerUsername, playerSerial, playerVersionNumber)
outputChatBox("* " .. playerNick .. " has connected the Server.", getRootElement(), 255, 100, 100, false)
-- Show the Player Connect the Server, for all Users good
end
addEventHandler("onPlayerConnect", getRootElement(), playerConnect)
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
This example cancels connection if player uses older MTA (older than 1.0.3)
<syntaxhighlight lang="lua">
addEventHandler ( 'onPlayerConnect', getRootElement ( ),
function ( playerNick )
if ( string.len ( playerNick ) <= 3 ) then
cancelEvent ( true, 'Nickname short' )
end
end
)
</syntaxhighlight>

</section>
{{See also/Server event|Player events}}

OnPlayerWeaponSwitch

2012-11-14T12:05:30Z

3ash8Alsherq: /* Example */

__NOTOC__
{{Server event}}
This event is triggered whenever a player's equipped weapon '''slot''' changes. This means giveWeapon and takeWeapon will trigger this function if the equipped slot is forced to change.

==Parameters==
<syntaxhighlight lang="lua">
int previousWeaponID, int currentWeaponID
</syntaxhighlight>

*'''previousWeaponID''': An [[int|integer]] representing the [[weapons|weapon]] that was switched from
*'''currentWeaponID''': An [[int|integer]] representing the [[weapons|weapon]] that was switched to

==Source==
The [[event system#Event source|source]] of this event is the [[player]] that switched his weapon.

==Example==
This example disables use of the minigun upon switch. It should be noted that this can be done more efficiently clientside.
<syntaxhighlight lang="lua">
WeaponID = {
[31] = true,
[36] = true,
[38] = true,
}

--add an event handler for onPlayerWeaponSwitch
addEventHandler ( 'onPlayerWeaponSwitch', getRootElement ( ),
function ( previousWeaponID, currentWeaponID )
if ( WeaponID[currentWeaponID] ) then
toggleControl ( source, 'fire', false ) --disable the fire button
else
toggleControl ( source, 'fire', true ) --enable it
end
end
)
</syntaxhighlight>

{{See also/Server event|Player events}}