Multi Theft Auto: Wiki - User contributions [en]

Template:Useful Functions

2014-12-30T15:18:59Z

UnLimiTeD:

*[[attachEffect]] » This function allows you attach an effect to an element.
*[[bindControlKeys]] » This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.
*[[callClientFunction]] » This function allows you to call any client-side function from the server's side.
*[[callServerFunction]] » This function allows you to call any server-side function from the client's side.
*[[centerWindow]] » This function centers a CEGUI window element responsively in any resolution.
*[[Check]] » This function checks if its arguments are of the right type and calls the error-function if one is not.
*[[convertNumber]] » This function converts and formats large numbers.
*[[convertServerTickToTimeStamp]] » This function converts server ticks to a unix timestamp.
*[[convertTextToSpeech]] » This function converts the provided text to a speech in the provided language which players can hear.
*[[coroutine.resume]] » This function applies a fix for hidden coroutine error messages.
*[[dxDrawAnimWindow]] » This function draws an animated 2D window on the screen.
*[[dxDrawCircle]] » This function draws a number of 2D lines in order to achieve a circle shape on the screen.
*[[dxDrawColorText]] » This function draws 2D text with hexadecimal support on the screen.
*[[dxDrawEmptyRec]] » This function draws an empty 2D rectangle on the screen.
*[[dxDrawGifImage]] » This function simulates the effect of a GIF image by using image sprites in 2D.
*[[dxDrawImage3D]] » This function draws a 3D image in GTA world.
*[[dxDrawRectangle3D]] » This function draws a 3D rectangle in GTA world.
*[[dxGetFontSizeFromHeight]] » This function calculates the font size from given height.
*[[dxGetRealFontHeight]] » This function calculates the height of a font.
*[[findRotation]] » This function takes two points and returns the direction from point A to point B.
*[[FormatDate]] » This function formats a date on the basis of a format string and returns it.
*[[GenerateString]] » This function generates a random string with any characters.
*[[generateRandomASCIIString]] » This function returns a random string which uses ASCII characters. 
*[[getAge]] » This function calculates the age of a given birthday.
*[[getAlivePlayers (Client)|getAlivePlayers]] » This function returns a table of the alive players client-side.
*[[getAlivePlayersInTeam]] » This function returns a table of the alive players in a team.
*[[getBanFromName]] » This functions returns the ban of the given playername.
*[[getBoundControls]] » This function returns a table of control names that are bound to the specified key.
*[[getCurrentFPS]] » This function returns the frames per second at which GTA: SA is running.
*[[getCursorMoveOn]] » This function checks in which way the cursor is currently moving.
*[[getDistanceBetweenPointAndSegment2D]] » This function takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.
*[[getElementSpeed]] » This function returns the specified element's speed in m/s, km/h or mph.
*[[getElementsInDimension]] » This function returns a table of elements that are in the specified dimension.
*[[getElementsWithinMarker]] » This function returns a table of elements that are within a marker's collision shape.
*[[getJetpackWeaponsEnabled]] » This function returns a table of enabled weapons usable on a jetpack.
*[[getKeyFromValueInTable]] » This function returns the key of the specified value in a table.
*[[getOffsetFromXYZ]] » This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.
*[[getOnlineAdmins]] » This function returns a table of all logged-in administrators.
*[[getOnlineStaff]] » This function returns a string of all logged-in administrators separated by two whitespace characters.
*[[getPedMaxHealth]] » This function returns a pedestrians's maximum health by converting it from their maximum health stat.
*[[getPedMaxOxygenLevel]] » This function returns a ped's maximum oxygen level by converting it from their maximum underwater stamina stat.
*[[getPlayerFromNamePart]] » This function returns a player from partial name.
*[[getPlayerFromSerial]] » This function returns a player from their serial.
*[[getPlayerAcls]] » This function returns a table of all ACL groups on a player.
*[[getPlayersByData]] » This function returns a table of players that have the specified data name.
*[[getPlayersInPhotograph]] » This function returns a table of all players in photograph.
*[[getPlayerCity]] » This functions returns a string containing the player's city name
*[[getPointFromDistanceRotation]] » This function finds a point based on a starting point, direction and distance.
*[[getResourceSettings]] » This function returns a table of the resource settings.
*[[getResourceScripts]] » This function returns a table of the resource scripts.
*[[getRGColorFromPercentage]] »This function returns two integers representing red and green colors according to the specified percentage.
*[[getScreenRotationFromWorldPosition]] » This function returns a screen relative rotation to a world position.
*[[getTeamFromColor]] » This function returns a team element by the specified color.
*[[getTeamWithFewestPlayers]] » This function returns a team element with least players of all the specified teams.
*[[getTimestamp]] » This function returns the UNIX timestamp of a specified date and time.
*[[getValidVehicleModels]] » This function returns a table of all valid vehicle models.
*[[getVehicleRespawnPosition]] » This function allows you to get the respawn position of a vehicle.
*[[getXMLNodes]] » This function returns all children of a XML node.
*[[guiComboBoxAdjustHeight]] » This function adjusts a CEGUI combobox element to have the correct height.
*[[guiGridListGetSelectedText]] » This function returns a string containing the inner text of a selected gridlist item.
*[[IfElse]] » This function returns one of two values based on a boolean expression.
*[[isElementInPhotograph]] » This function checks if an element is in the player's camera picture area.
*[[isElementInRange]] » This function allows you to check if an element's range to a main point is within the maximum range.
*[[isElementMoving]]» This function checks if an element is moving.
*[[isElementWithinAColShape]]» This function checks if an element is within a collision shape element.
*[[isLeapYear]] » This function returns a boolean representing if a given year is a leap year.
*[[isPedAiming]]» This function checks if a pedestrian is aiming their weapon.
*[[isPedDrivingVehicle]] » This function checks if a specified pedestrian is driving a vehicle.
*[[isPlayerInACL]] » This function checks if a player element is in an ACL group.
*[[isPlayerInTeam]] » This function checks if a player is in a specified team.
*[[isSoundFinished]] » This function checks if a sound element has finished.
*[[isVehicleEmpty]] » This function checks whether a vehicle is empty.
*[[isVehicleOccupied]] » This function checks if a specified vehicle is occupied.
*[[isVehicleOnRoof]] » This function checks whether vehicle is on roof.
*[[iterElements]] » This function returns ''a time-saving'' iterator for your for-loops.
*[[mathNumber]] » This function is a workaround for the client-side floating-point precision of 24-bits.
*[[math.percent]] » This function returns a percentage from two number values.
*[[math.round]] » Rounds a number whereas the number of decimals to keep and the method may be set.
*[[multi_check]] » This function checks one element to many, handy and clean.
*[[onVehicleWeaponFire]] » This code implements an event that is triggered when a player in a vehicle fires a vehicle's weapon.
*[[renameAclGroup]] » This function gives an existing ACL group a new name.
*[[RGBToHex]] » This function returns a string representing the color in hexadecimal.
*[[secondsToTimeDesc]] » This function converts a plain seconds-integer into a user-friendly time description.
*[[setAccountName]] » This function is used to change an existing account's name.
*[[setElementSpeed]] » This function allows you to set the speed of an element in kph or mph units.
*[[setTableProtected]] » This function protects a table and makes it read-only.
*[[setVehicleGravityPoint]] » This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.
*[[smoothMoveCamera]] » This function allows you to create a cinematic camera flight.
*[[string.count]] » This function counts the amount of occurences of a string in a string.
*[[string.explode]] » This function splits a string at a given separator pattern and returns a table with the pieces.
*[[switch]] » This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.
*[[table.copy]] » This function copies a whole table and all the tables in that table.
*[[table.compare]] » This function checks whether two given tables are equal.
*[[table.empty]] » This function checks whether a table is empty.
*[[table.map]] » 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.
*[[table.merge]] » This function merges two or more tables together.
*[[table.random]] » This function retrieves a random value from a table.
*[[table.size]] » This function returns the absolute size of a table.
*[[toHex]] » This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.
*[[unbindControlKeys]] » This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].
*[[var dump]] » This function outputs information about one or more variables using outputConsole.
*[[wavelengthToRGBA]] » This function converts a physical wavelength of light to a RGBA color.
[[Category:Useful Functions]]

GenerateRandomASCIIString

2014-12-30T15:11:30Z

UnLimiTeD:

{{Useful Function}}
This function returns a random string which uses ASCII characters.

==Syntax==
<syntaxhighlight lang="lua">int generateRandomASCIIString( int chars )</syntaxhighlight>

===Required Arguments===
* '''chars''': How long the string should be.

==Code==

<syntaxhighlight lang="lua">
function generateRandomASCIIString(chars)
local str = ""
for i = 1, chars do
str = str..(string.format("%c", math.random(32, 126)))
end
return str
end
</syntaxhighlight>

Author: UnLimiTeD^
Idea by: Poof
==Example==
<syntaxhighlight lang="lua">
local str = generateRandomASCIIString(10)
outputChatBox(str)
</syntaxhighlight>

==See Also==
{{Useful_Functions}}

GenerateRandomASCIIString

2014-12-30T15:08:14Z

UnLimiTeD:

{{Useful Function}}
This function returns a random string which uses ASCII characters.

==Syntax==
<syntaxhighlight lang="lua">int generateRandomASCIIString( int chars )</syntaxhighlight>

===Required Arguments===
* '''chars''': How long the string should be.

==Code==

<syntaxhighlight lang="lua">
function generateRandomASCIIString(chars)
local str = ""
for i = 1, chars do
str = str..(string.format("%c", math.random(32, 126)))
end
return str
end
</syntaxhighlight>

==Example==
<syntaxhighlight lang="lua">
local str = generateRandomASCIIString(10)
outputChatBox(str)
</syntaxhighlight>

==See Also==
{{Useful_Functions}}

GenerateRandomASCIIString

2014-12-30T15:05:20Z

UnLimiTeD:

{{Useful Function}}
This function returns a random string which uses ASCII characters.

==Syntax==
<syntaxhighlight lang="lua">int genereateRandomASCIIString( int chars )</syntaxhighlight>

===Required Arguments===
* '''chars''': How long the string should be.

==Code==

<syntaxhighlight lang="lua">
function generateRandomASCIIString(chars)
local str = ""
for i = 1, chars do
str = str..(string.format("%c", math.random(32, 126)))
end
return str
end
</syntaxhighlight>

==Example==
<syntaxhighlight lang="lua">
local str = generateRandomASCIIString(10)
outputChatBox(str)
</syntaxhighlight>

==See Also==
{{Useful_Functions}}

Template:Useful Functions

2014-12-30T15:04:51Z

UnLimiTeD:

*[[attachEffect]] » This function allows you attach an effect to an element.
*[[bindControlKeys]] » This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.
*[[callClientFunction]] » This function allows you to call any client-side function from the server's side.
*[[callServerFunction]] » This function allows you to call any server-side function from the client's side.
*[[centerWindow]] » This function centers a CEGUI window element responsively in any resolution.
*[[Check]] » This function checks if its arguments are of the right type and calls the error-function if one is not.
*[[convertNumber]] » This function converts and formats large numbers.
*[[convertServerTickToTimeStamp]] » This function converts server ticks to a unix timestamp.
*[[convertTextToSpeech]] » This function converts the provided text to a speech in the provided language which players can hear.
*[[coroutine.resume]] » This function applies a fix for hidden coroutine error messages.
*[[dxDrawAnimWindow]] » This function draws an animated 2D window on the screen.
*[[dxDrawCircle]] » This function draws a number of 2D lines in order to achieve a circle shape on the screen.
*[[dxDrawColorText]] » This function draws 2D text with hexadecimal support on the screen.
*[[dxDrawEmptyRec]] » This function draws an empty 2D rectangle on the screen.
*[[dxDrawGifImage]] » This function simulates the effect of a GIF image by using image sprites in 2D.
*[[dxDrawImage3D]] » This function draws a 3D image in GTA world.
*[[dxDrawRectangle3D]] » This function draws a 3D rectangle in GTA world.
*[[dxGetFontSizeFromHeight]] » This function calculates the font size from given height.
*[[dxGetRealFontHeight]] » This function calculates the height of a font.
*[[findRotation]] » This function takes two points and returns the direction from point A to point B.
*[[FormatDate]] » This function formats a date on the basis of a format string and returns it.
*[[GenerateString]] » This function generates a random string with any characters.
*[[getAge]] » This function calculates the age of a given birthday.
*[[getAlivePlayers (Client)|getAlivePlayers]] » This function returns a table of the alive players client-side.
*[[getAlivePlayersInTeam]] » This function returns a table of the alive players in a team.
*[[getBanFromName]] » This functions returns the ban of the given playername.
*[[getBoundControls]] » This function returns a table of control names that are bound to the specified key.
*[[getCurrentFPS]] » This function returns the frames per second at which GTA: SA is running.
*[[getCursorMoveOn]] » This function checks in which way the cursor is currently moving.
*[[getDistanceBetweenPointAndSegment2D]] » This function takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.
*[[getElementSpeed]] » This function returns the specified element's speed in m/s, km/h or mph.
*[[getElementsInDimension]] » This function returns a table of elements that are in the specified dimension.
*[[getElementsWithinMarker]] » This function returns a table of elements that are within a marker's collision shape.
*[[getJetpackWeaponsEnabled]] » This function returns a table of enabled weapons usable on a jetpack.
*[[getKeyFromValueInTable]] » This function returns the key of the specified value in a table.
*[[getOffsetFromXYZ]] » This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.
*[[getOnlineAdmins]] » This function returns a table of all logged-in administrators.
*[[getOnlineStaff]] » This function returns a string of all logged-in administrators separated by two whitespace characters.
*[[getPedMaxHealth]] » This function returns a pedestrians's maximum health by converting it from their maximum health stat.
*[[getPedMaxOxygenLevel]] » This function returns a ped's maximum oxygen level by converting it from their maximum underwater stamina stat.
*[[getPlayerFromNamePart]] » This function returns a player from partial name.
*[[getPlayerFromSerial]] » This function returns a player from their serial.
*[[getPlayerAcls]] » This function returns a table of all ACL groups on a player.
*[[getPlayersByData]] » This function returns a table of players that have the specified data name.
*[[getPlayersInPhotograph]] » This function returns a table of all players in photograph.
*[[getPlayerCity]] » This functions returns a string containing the player's city name
*[[getPointFromDistanceRotation]] » This function finds a point based on a starting point, direction and distance.
*[[getResourceSettings]] » This function returns a table of the resource settings.
*[[getResourceScripts]] » This function returns a table of the resource scripts.
*[[getRGColorFromPercentage]] »This function returns two integers representing red and green colors according to the specified percentage.
*[[getScreenRotationFromWorldPosition]] » This function returns a screen relative rotation to a world position.
*[[getTeamFromColor]] » This function returns a team element by the specified color.
*[[getTeamWithFewestPlayers]] » This function returns a team element with least players of all the specified teams.
*[[getTimestamp]] » This function returns the UNIX timestamp of a specified date and time.
*[[getValidVehicleModels]] » This function returns a table of all valid vehicle models.
*[[getVehicleRespawnPosition]] » This function allows you to get the respawn position of a vehicle.
*[[getXMLNodes]] » This function returns all children of a XML node.
*[[guiComboBoxAdjustHeight]] » This function adjusts a CEGUI combobox element to have the correct height.
*[[guiGridListGetSelectedText]] » This function returns a string containing the inner text of a selected gridlist item.
*[[IfElse]] » This function returns one of two values based on a boolean expression.
*[[isElementInPhotograph]] » This function checks if an element is in the player's camera picture area.
*[[isElementInRange]] » This function allows you to check if an element's range to a main point is within the maximum range.
*[[isElementMoving]]» This function checks if an element is moving.
*[[isElementWithinAColShape]]» This function checks if an element is within a collision shape element.
*[[isLeapYear]] » This function returns a boolean representing if a given year is a leap year.
*[[isPedAiming]]» This function checks if a pedestrian is aiming their weapon.
*[[isPedDrivingVehicle]] » This function checks if a specified pedestrian is driving a vehicle.
*[[isPlayerInACL]] » This function checks if a player element is in an ACL group.
*[[isPlayerInTeam]] » This function checks if a player is in a specified team.
*[[isSoundFinished]] » This function checks if a sound element has finished.
*[[isVehicleEmpty]] » This function checks whether a vehicle is empty.
*[[isVehicleOccupied]] » This function checks if a specified vehicle is occupied.
*[[isVehicleOnRoof]] » This function checks whether vehicle is on roof.
*[[iterElements]] » This function returns ''a time-saving'' iterator for your for-loops.
*[[mathNumber]] » This function is a workaround for the client-side floating-point precision of 24-bits.
*[[math.percent]] » This function returns a percentage from two number values.
*[[math.round]] » Rounds a number whereas the number of decimals to keep and the method may be set.
*[[multi_check]] » This function checks one element to many, handy and clean.
*[[onVehicleWeaponFire]] » This code implements an event that is triggered when a player in a vehicle fires a vehicle's weapon.
*[[renameAclGroup]] » This function gives an existing ACL group a new name.
*[[RGBToHex]] » This function returns a string representing the color in hexadecimal.
*[[secondsToTimeDesc]] » This function converts a plain seconds-integer into a user-friendly time description.
*[[setAccountName]] » This function is used to change an existing account's name.
*[[setElementSpeed]] » This function allows you to set the speed of an element in kph or mph units.
*[[setTableProtected]] » This function protects a table and makes it read-only.
*[[setVehicleGravityPoint]] » This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.
*[[smoothMoveCamera]] » This function allows you to create a cinematic camera flight.
*[[string.count]] » This function counts the amount of occurences of a string in a string.
*[[string.explode]] » This function splits a string at a given separator pattern and returns a table with the pieces.
*[[switch]] » This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.
*[[table.copy]] » This function copies a whole table and all the tables in that table.
*[[table.compare]] » This function checks whether two given tables are equal.
*[[table.empty]] » This function checks whether a table is empty.
*[[table.map]] » 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.
*[[table.merge]] » This function merges two or more tables together.
*[[table.random]] » This function retrieves a random value from a table.
*[[table.size]] » This function returns the absolute size of a table.
*[[toHex]] » This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.
*[[unbindControlKeys]] » This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].
*[[var dump]] » This function outputs information about one or more variables using outputConsole.
*[[wavelengthToRGBA]] » This function converts a physical wavelength of light to a RGBA color.
*[[generateRandomASCIIString]] » This function returns a random string which uses ASCII characters.
[[Category:Useful Functions]]

GenerateRandomASCIIString

2014-12-30T15:01:49Z

UnLimiTeD: /* Code */

{{Useful Function}}
__NOTOC__
This function returns a random string which uses ASCII characters.

==Syntax==
<syntaxhighlight lang="lua">int genereateRandomASCIIString( int chars )</syntaxhighlight>

===Required Arguments===
* '''chars''': How long the string should be.

==Code==

<syntaxhighlight lang="lua">
function generateRandomASCIIString(chars)
local str = ""
for i = 1, chars do
str = str..(string.format("%c", math.random(32, 126)))
end
return str
end
</syntaxhighlight>

==Example==
<syntaxhighlight lang="lua">
local str = generateRandomASCIIString(10)
outputChatBox(str)
</syntaxhighlight>

==See Also==
{{Useful_Functions}}

GenerateRandomASCIIString

2014-12-30T15:01:06Z

UnLimiTeD: Created page with "{{Useful Function}} __NOTOC__ This function returns a random string which uses ASCII characters. ==Syntax== <syntaxhighlight lang="lua">int genereateRandomASCIIString( int chars )</syntaxhighlight> =..."

{{Useful Function}}
__NOTOC__
This function returns a random string which uses ASCII characters.

==Syntax==
<syntaxhighlight lang="lua">int genereateRandomASCIIString( int chars )</syntaxhighlight>

===Required Arguments===
* '''chars''': How long the string should be.

==Code==

<syntaxhighlight lang="lua">
function generateRandomASCIIString(chars)
local str = ""
for i = 1, chars do
str = str..(string.format("%c", math.random(1,99)))
end
return str
end
</syntaxhighlight>

==Example==
<syntaxhighlight lang="lua">
local str = generateRandomASCIIString(10)
outputChatBox(str)
</syntaxhighlight>

==See Also==
{{Useful_Functions}}

GetBanFromName

2014-07-23T18:21:50Z

UnLimiTeD: /* Example */

{{Useful_Function}}
<lowercasetitle/>
__NOTOC__
This function returns the ban of the given playername (if the player got banned) otherwise false.
 '''Important Note:''' Case sensitivity of the playername is important!
 Example: If 'SomeGuy' got banned, and you will try 'someguy' you will get false.

==Syntax==
<syntaxhighlight lang="lua">ban getBanFromName( string playername )</syntaxhighlight>

===Required Arguments===
* '''playername''': The name of the player which got banned.

==Code==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function getBanFromName (name)
for key, ban in ipairs(getBans()) do -- for every ban do following
if (getBanNick(ban) == name) then -- if the name of the banned player is equal to our name then
return ban -- return the ban
end
end
return false -- else return false
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example gets the IP of the ban which has been returned from getBanFromName(). ( Only works if server version is 1.4 and oop sets to true. )
<syntaxhighlight lang="lua">
addEventHandler("onPlayerBan", root, function(_, banner)
outputChatBox(("%s has banned %s"):format(banner:getName(), source:getName()), root, 255, 0, 0)
local ban = getBanFromName(source:getName())
local ip = getBanIP(ban) -- Getting the IP of the ban which has been returned from getBanFromName()
end)
</syntaxhighlight>
</section>

Author: StiviK

==See Also==
{{Useful_Functions}}

GetBanFromName

2014-07-23T18:20:34Z

UnLimiTeD: /* Example */

{{Useful_Function}}
<lowercasetitle/>
__NOTOC__
This function returns the ban of the given playername (if the player got banned) otherwise false.
 '''Important Note:''' Case sensitivity of the playername is important!
 Example: If 'SomeGuy' got banned, and you will try 'someguy' you will get false.

==Syntax==
<syntaxhighlight lang="lua">ban getBanFromName( string playername )</syntaxhighlight>

===Required Arguments===
* '''playername''': The name of the player which got banned.

==Code==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function getBanFromName (name)
for key, ban in ipairs(getBans()) do -- for every ban do following
if (getBanNick(ban) == name) then -- if the name of the banned player is equal to our name then
return ban -- return the ban
end
end
return false -- else return false
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example gets the IP of the ban which has been returned from getBanFromName().
<syntaxhighlight lang="lua">
addEventHandler("onPlayerBan", root, function(_, banner)
outputChatBox(("%s has banned %s"):format(banner:getName(), source:getName()), root, 255, 0, 0)
local ban = getBanFromName(source:getName())
local ip = getBanIP(ban) -- Getting the IP of the ban which has been returned from getBanFromName()
end)
</syntaxhighlight>
</section>

Author: StiviK

==See Also==
{{Useful_Functions}}

GetBanFromName

2014-07-23T18:18:50Z

UnLimiTeD: /* Example */

{{Useful_Function}}
<lowercasetitle/>
__NOTOC__
This function returns the ban of the given playername (if the player got banned) otherwise false.
 '''Important Note:''' Case sensitivity of the playername is important!
 Example: If 'SomeGuy' got banned, and you will try 'someguy' you will get false.

==Syntax==
<syntaxhighlight lang="lua">ban getBanFromName( string playername )</syntaxhighlight>

===Required Arguments===
* '''playername''': The name of the player which got banned.

==Code==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function getBanFromName (name)
for key, ban in ipairs(getBans()) do -- for every ban do following
if (getBanNick(ban) == name) then -- if the name of the banned player is equal to our name then
return ban -- return the ban
end
end
return false -- else return false
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example changes the Ban Admin from the player called 'someguy'. Important: Because of 'setBanAdmin' it only works with MTA 1.4.0+!
<syntaxhighlight lang="lua">
addEventHandler("onPlayerBan", root, function(_, banner)
outputChatBox(("%s has banned %s"):format(banner:getName(), source:getName()), root, 255, 0, 0)
local ban = getBanFromName(source:getName())
local ip = getBanIP(ban) -- Getting the IP of the ban which has been returned from getBanFromName()
end)
</syntaxhighlight>
</section>

Author: StiviK

==See Also==
{{Useful_Functions}}