Multi Theft Auto: Wiki - User contributions [en]

OnClientDoubleClick

2014-04-19T15:12:31Z

TAPL: /* Example */

{{Client event}}
__NOTOC__
This event triggers whenever the user double-clicks his mouse. This is linked to the GTA world, as appose to GUI for which [[onClientGUIDoubleClick]] is to be used. This event allows detection of click positions of the 3D world.

==Parameters==
<syntaxhighlight lang="lua">string button, int absoluteX, int absoluteY, float worldX, float worldY, float worldZ, element clickedWorld
</syntaxhighlight>
* '''button''': This refers the button used to click on the mouse, can be ''left'', ''right'', or ''middle'
* '''absoluteX''': This refers to the 2D ''x coordinate'' the user clicked on his screen, and is an ''absolute'' position in pixels.
* '''absoluteY''': This refers to the 2D ''y coordinate'' the user clicked on his screen, and is an ''absolute'' position in pixels.
* '''worldX''': This represents the 3D ''x coordinate'' the player clicked on the screen, and is relative to the GTA world.
* '''worldY''': This represents the 3D ''y coordinate'' the player clicked on the screen, and is relative to the GTA world.
* '''worldZ''': This represents the 3D ''z coordinate'' the player clicked on the screen, and is relative to the GTA world.
* '''clickedWorld''': This represents any physical [[entity]] elements that were clicked. If the player clicked on no MTA element, it's set to false.

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

==Example==
<syntaxhighlight lang="lua">
function onMyMouseDoubleClick (button, absoluteX, absoluteY, worldX, worldY, worldZ, clickedWorld)
if button == "left" then
playSoundFrontEnd(40)
end
end
addEventHandler("onClientDoubleClick", root, onMyMouseDoubleClick)</syntaxhighlight>

==See Also==
===GUI events===
{{GUI_events}}
===Client event functions===
{{Client_event_functions}}

SetElementParent

2014-04-12T08:55:20Z

TAPL: /* Example */

{{Server client function}}
__NOTOC__
This function is used for setting an element as the parent of another element.
{{Important Note|The client-side version of this function can only be used on client-created elements. It cannot be used to modify the parent of server side elements.}}
{{Note|This function does not change when an element will be destroyed - Elements are always destroyed when the resource that created them is stopped.}}
{{Note|When an element is destroyed, its parent becomes the new parent of its children.}}
{{Note|setElementParent only works if new parent is the root element, map root, or ancestor of map root}}
{{Tip|This function does not affect the child elements position. To attach elements use the function [[attachElements]].}}
==Syntax==
<syntaxhighlight lang="lua">
bool setElementParent ( element theElement, element parent )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The element that you wish to set the parent of.
*'''parent:''' The element you wish to be the parent of ''theElement''.

===Returns===
Returns ''true'' if both [[element]]s are valid, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
This example sets the parent of each spawnpoint to a dummy element:
<syntaxhighlight lang="lua">
dummyElem = createElement ( "spawngroup", "Group of spawn points" ) -- create a dummy element
local spawnpoints = getElementsByType ( "spawnpoint" ) -- get a table of spawn point elements
for k,v in ipairs (spawnpoints) do -- loop through the table of spawn points
setElementParent ( v, dummyElem ) -- set the dummy element as the parent of the spawn point
end
-- all of the spawn points are now children of 'dummyElem'
</syntaxhighlight>

This is the equivalent of:
<syntaxhighlight lang="xml">
<spawngroup id="Group of spawn points">
<spawnpoint id="spawnpoint_0" posX="2507.8715820313" posY="2772.6071777344" posZ="10.8203125" rot="270" skin="285"/>
<spawnpoint id="spawnpoint_1" posX="2508.060546875" posY="2780.3647460938" posZ="10.8203125" rot="270" skin="285"/>
<spawnpoint id="spawnpoint_2" posX="2508.0053710938" posY="2776.2897949219" posZ="10.8203125" rot="270" skin="285"/>
<spawnpoint id="spawnpoint_3" posX="2510.6899414063" posY="2778.3745117188" posZ="10.8203125" rot="270" skin="285"/>
</spawngroup></syntaxhighlight>
</section>

==See Also==
{{element functions}}

OnClientGUIClick

2014-01-16T08:47:26Z

TAPL:

{{Client event}}
__NOTOC__
This event happens when any gui-element clicked
{{Note|The '''player''' who clicked the gui-element is always the [[localPlayer]].}}

==Parameters==
<syntaxhighlight lang="lua">
string button, string state, int absoluteX, int absoluteY
</syntaxhighlight>
*'''button:''' the name of the button which will be clicked , it can be ''left'', ''right'', ''middle''
*'''state:''' the state of the mouse button, will be ''down'' if the mouse button was pushed, or ''up'' if it was released. '''Please note currently only the ''up'' state is supported.'''
*'''absoluteX:''' the X position of the mouse cursor, in pixels, measured from the left side of the screen.
*'''absoluteY:''' the Y position of the mouse cursor, in pixels, measured from the top of the screen.

==Source==
The [[event system#Event source|source]] of this event is the GUI element that was clicked.

==Example==
This example creates an edit box alongside an "Output!" button. When the button is clicked with the left mouse button, it will output the message in the edit box into the chat box.
<syntaxhighlight lang="lua">
-- When client's resource starts, create the GUI
function initGUI( )
-- Create our button
btnOutput = guiCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )

-- And attach our button to the outputEditBox function
addEventHandler ( "onClientGUIClick", btnOutput, outputEditBox, false )

-- Create an edit box and define it as "editBox".
editBox = guiCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
guiEditSetMaxLength ( editBox, 128 ) -- The max chatbox text length is 128, so force this
end
addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource( ) ), initGUI )

-- Setup our function to output the message to the chatbox
function outputEditBox ( button )
if button == "left" then
local text = guiGetText ( editBox )-- Get the text from the edit box
outputChatBox ( text ) -- Output that text
end
end
</syntaxhighlight>

==See Also==
===GUI events===
{{GUI_events}}
===Client event functions===
{{Client_event_functions}}

CreateObject

2014-01-03T20:28:45Z

TAPL: /* Example */

__NOTOC__
{{Server client function}}
Creates an object in the GTA world.

==Syntax==
<syntaxhighlight lang="lua">object createObject ( int modelid, float x, float y, float z, [ float rx, float ry, float rz, bool isLowLOD = false ] )</syntaxhighlight>

===Required Arguments===
*'''modelid:''' A whole integer specifying the GTASA object model ID.
*'''x:''' A floating point number representing the X coordinate on the map.
*'''y:''' A floating point number representing the Y coordinate on the map.
*'''z:''' A floating point number representing the Z coordinate on the map.

===Optional Arguments===
{{OptionalArg}}
*'''rx:''' A floating point number representing the rotation about the X axis in degrees.
*'''ry:''' A floating point number representing the rotation about the Y axis in degrees.
*'''rz:''' A floating point number representing the rotation about the Z axis in degrees.
{{New items|3.0120|1.2|
*'''isLowLOD:''' A bool value specifying if the object will be low LOD. A low LOD object has no collision and a longer draw distance.
}}
===Returns===
Returns the [[object]] element if creation was successful, ''false'' otherwise.

==Example==

<section name="Example1" class="server" show="true">
This example creates an object when the resource starts:
<syntaxhighlight lang="lua">
function mapLoad ( name )
-- create an object at a specified position with a specified rotation
createObject ( 1337, 5540.6654, 1020.55122, 1240.545, 90, 0, 0 )
end
addEventHandler ( "onResourceStart", getRootElement(), mapLoad )
</syntaxhighlight>
</section>

<section name="Example2" class="server" show="true">
This example creates an object near player who write createObject:
<syntaxhighlight lang="lua">
-- this function is called whenever someone types 'createObject' in the console:
function consoleCreateObject ( thePlayer, commandName )
if ( thePlayer ) then
local x, y, z = getElementPosition ( thePlayer ) -- get the player's position
-- create a Object next to the player:
local theObject = createObject ( 980, x + 2, y + 2, z, 0, 0, 0 )
if ( theObject ) then -- check if the Obeject was created successfully
outputConsole ( "Object created successfully", thePlayer )
else
outputConsole ( "Failed to create Object", thePlayer )
end
end
end
addCommandHandler ( "createObject", consoleCreateObject )
</syntaxhighlight>
</section>

==See Also==
{{Object functions}}

[[de:createObject]]

GetPlayerFromPartialName

2013-10-29T19:46:33Z

TAPL: /* Returns */

{{Useful Function}}
__NOTOC__
This function allows you to get player From his Name part.

==Syntax==
<syntaxhighlight lang="lua">
player getPlayerFromNamePart ( string Name )
</syntaxhighlight>

===Required Arguments===
* '''Name''': A string containing the name part of the player you want to reference

===Returns===
Returns a [[player]] if the Name part is exist, ''nil'' otherwise.

==Code==
<syntaxhighlight lang="lua">function getPlayerFromNamePart(name)
local name = name and name:gsub("#%x%x%x%x%x%x", ""):lower() or nil
if name then
for _, player in ipairs(getElementsByType("player")) do
local name_ = getPlayerName(player):gsub("#%x%x%x%x%x%x", ""):lower()
if name_:find(name, 1, true) then
return player
end
end
end
end</syntaxhighlight>

'''Author: TAPL'''

==See Also==
{{Useful_Functions}}

Resource:Exp system

2013-10-16T21:05:03Z

TAPL: Double 'with'

{{Resource page}}
A level/experience system made from scratch by [[User:Castillo|Castillo]].<br>
It uses SQLite to save level and experience.

=Exported Functions=

<section name="Server" class="server" show="true">
This function is used to get a player level.

==Syntax==
<syntaxhighlight lang="lua">
bool getPlayerLevel ( player thePlayer )
</syntaxhighlight>

==Required Arguments==
*'''thePlayer''': The player element you wish you get the level.

==Returns==
Returns a number with the level of the player.
<syntaxhighlight lang="lua">
addCommandHandler ( "mylevel",
function ( thePlayer )
local myLevel = exports.exp_system:getPlayerLevel ( thePlayer )
outputChatBox ( "Your level is: ".. myLevel, thePlayer )
end
)

</section>

<section name="Server" class="server" show="true">
This function is used to set a player level.

==Syntax==
<syntaxhighlight lang="lua">
bool setPlayerLevel ( player thePlayer, int theLevel )
</syntaxhighlight>

==Required Arguments==
*'''thePlayer''': The player element you wish you set the level.
*'''theLevel''': The level you want to set.

==Returns==
Returns a bool, whether the level was set successfully or not.
<syntaxhighlight lang="lua">
addCommandHandler ( "setmylevel",
function ( thePlayer, commandName, theLevel )
local theLevel = tonumber ( theLevel ) or 1
exports.exp_system:setPlayerLevel ( thePlayer, theLevel )
end
)
</section>

<section name="Server" class="server" show="true">
This function is used to get a player experience.

==Syntax==
<syntaxhighlight lang="lua">
bool getPlayerEXP ( player thePlayer )
</syntaxhighlight>

==Required Arguments==
*'''thePlayer''': The player element you wish you get the experience.

==Returns==
Returns a number with with the experience of the player.
==Example==
<syntaxhighlight lang="lua">
addCommandHandler ( "myexp",
function ( thePlayer )
local myExp = exports.exp_system:getPlayerEXP ( thePlayer )
outputChatBox ( "Your experience is: ".. myExp, thePlayer )
end
)
</section>
<section name="Server" class="server" show="true">
This function is used to set a player experience.

==Syntax==
<syntaxhighlight lang="lua">
bool setPlayerEXP ( player thePlayer, int theExperience )
</syntaxhighlight>

==Required Arguments==
*'''thePlayer''': The player element you wish you set the experience.
*'''theExperience''': The exprience you want to set.

==Returns==
Returns a bool, whether the experience was set successfully or not.
==Example==
<syntaxhighlight lang="lua">
addCommandHandler ( "setmyexp",
function ( thePlayer, commandName, theExp )
local theExp = tonumber ( theExp ) or 0
exports.exp_system:setPlayerEXP ( thePlayer, theExp )
end
)
</section>
<section name="Server" class="server" show="true">
This function is used to give a player experience.

==Syntax==
<syntaxhighlight lang="lua">
bool addPlayerEXP ( player thePlayer, int theExperience )
</syntaxhighlight>

==Required Arguments==
*'''thePlayer''': The player element you wish you to give the experience.
*'''theExperience''': The exprience you want to give.

==Returns==
Returns a bool, whether the experience was given successfully or not.
==Example==
<syntaxhighlight lang="lua">
addEvent ( "onZombieWasted", true )
addEventHandler ( "onZombieWasted", root,
function ( theKiller )
exports.exp_system:addPlayerEXP ( theKiller, 5 )
end
)
</section>
<section name="Server" class="server" show="true">
This function is used to get an account level.

==Syntax==
<syntaxhighlight lang="lua">
bool getAccountLevel ( account theAccount )
</syntaxhighlight>

==Required Arguments==
*'''theAccount''': The player element you wish you get the level.

==Returns==
Returns a number with with the level of the account.
<syntaxhighlight lang="lua">
addCommandHandler ( "mylevel",
function ( thePlayer )
local account = getPlayerAccount ( thePlayer )
local myExp = exports.exp_system:getAccountLevel ( account )
outputChatBox ( "Your account level is: ".. myLevel, thePlayer )
end
)

</section>

<section name="Server" class="server" show="true">
This function is used to set an account level.

==Syntax==
<syntaxhighlight lang="lua">
bool setAccountLevel ( account theAccount, int theLevel )
</syntaxhighlight>

==Required Arguments==
*'''theAccount''': The player element you wish you set the level.
*'''theLevel''': The level you want to set.

==Returns==
Returns a bool, whether the level was set successfully or not.
<syntaxhighlight lang="lua">
addCommandHandler ( "setmylevel",
function ( thePlayer, commandName, theLevel )
local account = getPlayerAccount ( thePlayer )
local theLevel = tonumber ( theLevel ) or 1
exports.exp_system:setAccountLevel ( account, theLevel )
end
)
</section>

<section name="Server" class="server" show="true">
This function is used to get an account experience.

==Syntax==
<syntaxhighlight lang="lua">
bool getAccountEXP ( account theAccount )
</syntaxhighlight>

==Required Arguments==
*'''theAccount''': The player element you wish you get the experience.

==Returns==
Returns a number with with the experience of the player.
==Example==
<syntaxhighlight lang="lua">
addCommandHandler ( "myexp",
function ( thePlayer )
local account = getPlayerAccount ( thePlayer )
local myExp = exports.exp_system:getAccountEXP ( account )
outputChatBox ( "Your account experience is: ".. myExp, thePlayer )
end
)
</section>
<section name="Server" class="server" show="true">
This function is used to set an account experience.

==Syntax==
<syntaxhighlight lang="lua">
bool setAccountEXP ( account theAccount, int theExperience )
</syntaxhighlight>

==Required Arguments==
*'''theAccount''': The player element you wish you set the experience.
*'''theExperience''': The exprience you want to set.

==Returns==
Returns a bool, whether the experience was set successfully or not.
==Example==
<syntaxhighlight lang="lua">
addCommandHandler ( "setmyexp",
function ( thePlayer, commandName, theExp )
local account = getPlayerAccount ( thePlayer )
local theExp = tonumber ( theExp ) or 0
exports.exp_system:setAccountEXP ( account, theExp )
end
)
</section>

<section name="Server" class="server" show="true">
This function is used to refresh the levels.

==Syntax==
<syntaxhighlight lang="lua">
bool loadLevelsFromXML( )
</syntaxhighlight>

==Required Arguments==
*'''None'''

==Example==
<syntaxhighlight lang="lua">
addCommandHandler ( "refreshlevels",
function ( )
exports.exp_system:loadLevelsFromXML ( )
end
)
</section>

<section name="Server" class="server" show="true">
This function is used to obtain the name and experience required of a level.

==Syntax==
<syntaxhighlight lang="lua">
getLevelData ( int theLevel )
</syntaxhighlight>

==Required Arguments==
*'''theLevel'''

==Returns==
Returns the name of the level and the experience required.
==Example==
<syntaxhighlight lang="lua">
addCommandHandler ( "getleveldata",
function ( thePlayer )
local level = exports.exp_system:getPlayerLevel ( thePlayer )
local name, expreq = exports.exp_system:getLevelData ( level )
outputChatBox ( name ..": ".. expreq, thePlayer )
end
)
</section>

=Custom Events=

<section name="Server" class="server" show="true">
This event is called when a player level changes.

==Syntax==
<syntaxhighlight lang="lua">
event onPlayerChangeLevel
</syntaxhighlight>

==Parameters==
*'''oldLevel''': The player old level.
*'''newLevel''': The player new level.


==Source==
The [[event system#Event source|source]] of this event is the [[player]] whose level changed.
</section>

<section name="Server" class="server" show="true">
This event is called when a player level UP.

==Syntax==
<syntaxhighlight lang="lua">
event onPlayerLevelUP
</syntaxhighlight>

==Parameters==
*'''oldLevel''': The player old level.
*'''newLevel''': The player new level.


==Source==
The [[event system#Event source|source]] of this event is the [[player]] who leveled UP.
</section>

=See also=
[http://community.mtasa.com/index.php?p=resources&s=details&id=1253 Download page]<br>

[[Category:Resource]]

GetPlayerFromPartialName

2013-10-15T13:00:06Z

TAPL: Fixed colorcode.

{{Useful Function}}
__NOTOC__
This function allows you to get player From his Name part.

==Syntax==
<syntaxhighlight lang="lua">
player getPlayerFromNamePart ( string Name )
</syntaxhighlight>

===Required Arguments===
* '''Name''': A string containing the name part of the player you want to reference

===Returns===
Returns a [[player]] if the Name part is exist, ''false'' otherwise.

==Code==
<syntaxhighlight lang="lua">function getPlayerFromNamePart(name)
local name = name and name:gsub("#%x%x%x%x%x%x", ""):lower() or nil
if name then
for _, player in ipairs(getElementsByType("player")) do
local name_ = getPlayerName(player):gsub("#%x%x%x%x%x%x", ""):lower()
if name_:find(name, 1, true) then
return player
end
end
end
end</syntaxhighlight>

'''Author: TAPL'''

==See Also==
{{Useful_Functions}}

GuiGridListSetVerticalScrollPosition

2013-09-20T10:52:28Z

TAPL:

{{client function}}
This function is used to set the vertical scroll position from a grid list

==Syntax==
<syntaxhighlight lang="lua">
bool guiGridListSetVerticalScrollPosition( element guiGridlist, float fPosition )
</syntaxhighlight>

===Required Arguments===
*'''guiGridlist''': The grid list you want to set the vertical scroll position from
*'''fPosition''': A float representing the vertical scroll position (0-100)

===Returns===
Returns ''true'' if the vertical scroll position was set, or ''false'' otherwise.

==Requirements==
{{Requirements|n/a|1.3.2}}

==Example==
<syntaxhighlight lang="lua">
-- Todo
</syntaxhighlight>

==See Also==
{{GUI_functions}}

OnClientWeaponFire

2013-09-02T17:09:44Z

TAPL:

{{Client event}}
__NOTOC__
This event will be triggered once a client fires his weapon.
{{Note|This event is only for custom weapons that were created with [[createWeapon]], for player held weapons use [[onClientPlayerWeaponFire]].}}

==Parameters==
<syntaxhighlight lang="lua">
element hitElement, float posX, float posY, float posZ, float normalX, float normalY, float normalZ, int materialType, int lighting, int pieceHit
</syntaxhighlight>
*'''hitElement:''' the element that was hit
*'''posX:''' the position it will hit
*'''posY:''' the position it will hit
*'''posZ:''' the position it will hit
*'''normalX:''' the normal it hit ( see processLineOfSight )
*'''normalY:''' the normal it hit ( see processLineOfSight )
*'''normalZ:''' the normal it hit ( see processLineOfSight )
*'''materialType:''' the material type it hit ( see processLineOfSight )
*'''lighting:''' the lighting of the entity it hit ( see processLineOfSight )
*'''pieceHit:''' the piece of the entity it hit ( see processLineOfSight )

==Source==
The [[event system#Event source|source]] of this event is the weapon that was fired.

==Cancel Effect==
If this event was [[Event system#Canceling|canceled]], then the weapon will not fire.

==Example==
This example prevents the player from firing a Deagle.
<syntaxhighlight lang="lua">
function noDeagle()
local weaponID = getElementModel(source)
-- Gets the ID of the weapon.
if weaponID == 24 then
-- If the weapon ID is of the Deagle's then cancel the event.
cancelEvent()
end
end
addEventHandler("onClientWeaponFire", getRootElement(), noDeagle)
-- Attach the event 'onClientWeaponFire' to the function.
</syntaxhighlight>

==See Also==
===Client event functions===
{{Client_event_functions}}

SetWeaponOwner

2013-08-09T13:52:36Z

TAPL:

__NOTOC__
{{Client function}}
Sets the owner (a player) of the custom weapon.

==Syntax==
<syntaxhighlight lang="lua">bool setWeaponOwner ( theWeapon, player theOwner )</syntaxhighlight>

===Required Arguments===
* '''theWeapon:''' The weapon to set the owner of
* '''theOwner:''' The weapon owner

===Returns===
Returns ''true'' on success, ''false'' otherwise.

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

==See Also==
{{Client weapon creation functions}}

GetValidPedModels

2013-04-18T13:25:16Z

TAPL: Undo revision 33844 by Socialz (talk)

{{Server client function}}
__NOTOC__
This function returns all valid ped models.

==Syntax==
<syntaxhighlight lang="lua">
table getValidPedModels ( )
</syntaxhighlight>

===Returns===
Returns a [[table]] with all valid ped models.

==Example==
This example will get if the specified skin is a valid skin or not.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function isValidSkin( thePlayer, command, specifiedSkin ) -- Define the function
if ( specifiedSkin ) then -- If skin specified
local allSkins = getValidPedModels ( ) -- Get valid skin IDs
local result = false -- Define result, it is currently false
for key, skin in ipairs( allSkins ) do -- Check all skins
if skin == tonumber( specifiedSkin ) then -- If skin equals specified one, it is valid
result = skin -- So set it as result
break --stop looping through a table after we found the skin
end
end
if ( result ) then -- If we got results
outputChatBox( tostring( skin ) .. " is a valid skin ID.", thePlayer, 0, 255, 0 ) -- It is valid, output it
else -- If we didn't get results
outputChatBox( specifiedSkin .. " is not a valid skin ID.", thePlayer, 0, 255, 0 ) -- No result, it is not valid
end
else -- If no skin specified
outputChatBox( "Please specify a skin ID to check!", thePlayer, 255, 0, 0 ) -- Tell it to the player
end
end
addCommandHandler("checkskin",isValidSkin) -- bind 'checkskin' command to 'isValidSkin' function
</syntaxhighlight>
</section>

==See Also==
{{Ped functions}}

User talk:TAPL

2013-04-13T11:19:36Z

TAPL:

Why did you do this "http://wiki.multitheftauto.com/index.php?title=CreateTeam&diff=next&oldid=34673" ? --[[User:X86dev|X86dev]] 08:20, 29 January 2013 (UTC)

Because colors arguments are optional. --[[User:TAPL|TAPL]] 11:15, 13 April 2013 (UTC)

User talk:TAPL

2013-04-13T11:15:32Z

TAPL: /* Because colors arguments are optional. */ new section

User talk:TAPL

2013-04-13T11:14:49Z

TAPL:

Why did you do this "http://wiki.multitheftauto.com/index.php?title=CreateTeam&diff=next&oldid=34673" ? --[[User:X86dev|X86dev]] 08:20, 29 January 2013 (UTC)

Because colors arguments are optional.

GuiGridListRemoveColumn

2013-04-13T11:07:40Z

TAPL: 6 years have passed and no one has noticed this mistake?

{{Client function}}
__NOTOC__
This allows you to delete columns that exist in grid lists.

==Syntax==

<syntaxhighlight lang="lua">
bool guiGridListRemoveColumn ( element gridList, int columnIndex )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' The grid list you want to remove a column from
*'''columnIndex:''' Column ID

===Returns===
Returns ''true'' if the grid list column was successfully removed, ''false'' otherwise.

==Example==
This example creates a grid list and adds 4 columns to it when the script starts. After 3 seconds, it randomly deletes a column and outputs to the chat box which column was deleted.
<syntaxhighlight lang="lua">function deleteColumn ()
--Choose randomly which column to delete, output the chosen column into the chat box, and delete the column
randomDeletion = math.random ( 1, 4 )
if randomDeletion == 1 then
outputChatBox ( "Removing column A" )
guiGridListRemoveColumn ( myGridList, columnA )
elseif randomDeletion == 2 then
outputChatBox ( "Removing column B" )
guiGridListRemoveColumn ( myGridList, columnB )
elseif randomDeletion == 3 then
outputChatBox ( "Removing column C" )
guiGridListRemoveColumn ( myGridList, columnC )
else
outputChatBox ( "Removing column D" )
guiGridListRemoveColumn ( myGridList, columnD )
end
end

function clientsideResourceStart ()
--Create a gridlist
myGridList = guiCreateGridList ( 0.30, 0.10, 0.5, 0.60, true )
--Create 4 columns for myGridList
columnA = guiGridListAddColumn ( myGridList, "columnA Title", 0.25 )
columnB = guiGridListAddColumn ( myGridList, "columnB Title", 0.25 )
columnC = guiGridListAddColumn ( myGridList, "columnC Title", 0.25 )
columnD = guiGridListAddColumn ( myGridList, "columnD Title", 0.25 )
--Set a timer to trigger the deleteColumn function 3 seconds after the script starts
setTimer ( deleteColumn, 3000, 1 )
end
addEventHandler ( "onClientResourceStart", getRootElement(), clientsideResourceStart )
</syntaxhighlight>

==Issues==
{{Issues|
{{Issue|5620|guiGridListAddColumn returns wrong index after deleting columns }}
}}

==See Also==

{{GUI functions}}

CreateTeam

2013-01-28T22:46:57Z

TAPL:

__NOTOC__
{{Server function}}
This function is for creating a new [[team]], which can be used to group players. Players will not join the team until they are respawned.

==Syntax==
<syntaxhighlight lang="lua">
team createTeam ( string teamName, [int colorR = 255, int colorG = 255, int colorB = 255] )
</syntaxhighlight>

===Required Arguments===
*'''teamName:''' A string representing the teams name.
===Optional Arguments===
*'''colorR:''' An integer representing the red color value.
*'''colorG:''' An integer representing the green color value.
*'''colorB:''' An integer representing the blue color value.

===Returns===
Returns a team element if it was successfully created, ''false'' if invalid arguments are passed or a team with that name already exists.

==Example==
'''Example 1:''' This example creates a new team for a player, then adds him to it.
<syntaxhighlight lang="lua">
function gimmeATeam ( source, commandName, teamName )
local newTeam = createTeam ( teamName ) -- create a new team with the specified name
if newTeam then -- if it was successfully created
setPlayerTeam ( source, newTeam ) -- add the player to the new team
end
end
addCommandHandler("giveteam", gimmeATeam)
</syntaxhighlight>

'''Example 2:''' This example creates two teams, one for Admin and one for Freeroamers, when the resource this script is in is started.
<syntaxhighlight lang="lua">
function createTeamsOnStart ()
teamAdmmin = createTeam ( "Admin", 0, 255, 0 ) --change the 3 numbers(0,255,0), the first number is ColourR, the second is ColourG, and the last one is ColourB
teamFreeroamers = createTeam ( "Freeroamer", 200, 0, 100 )
end
addEventHandler("onResourceStart", resourceRoot, createTeamsOnStart) --we attach the function to this resource's root element
</syntaxhighlight>

'''Example 3:''' This example creates a team for Admin and when an admin logs in, he will be set in the Admin team.
<syntaxhighlight lang="lua">
function createAdminTeamOnStart ()
AdminTeam = createTeam ( "Admin", 0, 255, 0 )-- create a new team and name it 'Admin'
end
addEventHandler("onResourceStart", resourceRoot, createAdminTeamOnStart) -- add an event handler

function setAdminTeam()
if isObjectInACLGroup("user."..getAccountName(getPlayerAccount(source)), aclGetGroup("Admin")) then -- if he is admin
setPlayerTeam(source, AdminTeam) -- set him to admin team
end
end
addEventHandler("onPlayerLogin",getRootElement(),setAdminTeam) -- add an event handler
</syntaxhighlight>

==See Also==
{{Team_functions}}

CreateTeam

2013-01-28T22:43:41Z

TAPL: colors is optional.

__NOTOC__
{{Server function}}
This function is for creating a new [[team]], which can be used to group players. Players will not join the team until they are respawned.

==Syntax==
<syntaxhighlight lang="lua">
team createTeam ( string teamName, [int colorR = 255, int colorG = 255, int colorB = 255] )
</syntaxhighlight>

===Required Arguments===
*'''teamName:''' A string representing the teams name.
===Optional Arguments===
{{OptionalArg}}
*'''colorR:''' An integer representing the red color value.
*'''colorG:''' An integer representing the green color value.
*'''colorB:''' An integer representing the blue color value.

===Returns===
Returns a team element if it was successfully created, ''false'' if invalid arguments are passed or a team with that name already exists.

==Example==
'''Example 1:''' This example creates a new team for a player, then adds him to it.
<syntaxhighlight lang="lua">
function gimmeATeam ( source, commandName, teamName )
local newTeam = createTeam ( teamName ) -- create a new team with the specified name
if newTeam then -- if it was successfully created
setPlayerTeam ( source, newTeam ) -- add the player to the new team
end
end
addCommandHandler("giveteam", gimmeATeam)
</syntaxhighlight>

'''Example 2:''' This example creates two teams, one for Admin and one for Freeroamers, when the resource this script is in is started.
<syntaxhighlight lang="lua">
function createTeamsOnStart ()
teamAdmmin = createTeam ( "Admin", 0, 255, 0 ) --change the 3 numbers(0,255,0), the first number is ColourR, the second is ColourG, and the last one is ColourB
teamFreeroamers = createTeam ( "Freeroamer", 200, 0, 100 )
end
addEventHandler("onResourceStart", resourceRoot, createTeamsOnStart) --we attach the function to this resource's root element
</syntaxhighlight>

'''Example 3:''' This example creates a team for Admin and when an admin logs in, he will be set in the Admin team.
<syntaxhighlight lang="lua">
function createAdminTeamOnStart ()
AdminTeam = createTeam ( "Admin", 0, 255, 0 )-- create a new team and name it 'Admin'
end
addEventHandler("onResourceStart", resourceRoot, createAdminTeamOnStart) -- add an event handler

function setAdminTeam()
if isObjectInACLGroup("user."..getAccountName(getPlayerAccount(source)), aclGetGroup("Admin")) then -- if he is admin
setPlayerTeam(source, AdminTeam) -- set him to admin team
end
end
addEventHandler("onPlayerLogin",getRootElement(),setAdminTeam) -- add an event handler
</syntaxhighlight>

==See Also==
{{Team_functions}}

Server Manual

2012-10-07T11:14:51Z

TAPL: default port is 22003 not 22004

__TOC__

==Getting started==
It is much easier than it looks to get a server up and running for your internet or LAN buddies; follow this wiki article and you will hopefully be on your way to hosting your own MTA:SA server in no time!

==Installing the server==
The dedicated server application is available in different flavours depending on the platform of the server.

===Linux installation===
There are different ways of getting a Linux server up and running:
* [http://linux.mtasa.com Getting a precompiled package]
* [[Building MTASA Server on GNU Linux]]

===FreeBSD installation===

You can run MTA:SA under FreeBSD using Linux emulation.
* Enable [http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/linuxemu-lbc-install.html Linux binary compatibility]
* Install following packages or compile them from ports: hs-terminfo, linux_base-f10, linux-f10-sqlite3
* Install [http://linux.mtasa.com/ Linux precompiled package]

===Windows installation===
Installation of the MTA:SA server on Windows is easy as pie.
*Go to the [http://mtasa.com/ download page] and download the installer.
*Once the installer is downloaded, open it.
*Select a folder where you want to install the server.
*Click Install.
*Done!

''For a full explanation of acl.xml (access control list) read: [[Access_Control_List|Access Control List]]''<br/><br/>

==Configuring your server==
The Multi Theft Auto dedicated server is initially configurable through it's console window, from within the game, and from a webbrowser. In order to make use of the two last options, it is necessary to add at least one administrator user to your configuration file.

===General configuration===
All general configuration options can be found in the 'mods/deathmatch/[[Server_mtaserver.conf|'''mtaserver.conf''']]' file and can be opened by any regular text editor.

This file is fairly straightforward; every variable has a [[Server_mtaserver.conf|description of what to do with it and how to change it]].

===Port forwarding===
If you run your server on your own private computer, and you have an router between the internet and your computer. You need to forward 3 ports.

First of all open the file 'mods/deathmatch/[[Server_mtaserver.conf|'''mtaserver.conf''']]' and search for the next lines:
<syntaxhighlight lang="xml">
<serverport>22003</serverport>
<httpport>22005</httpport>
</syntaxhighlight>

The ports are needed to setup the server correctly. We explain later how to set them, but first if you want your server to appear in the server browser there is another port we need, and that is the ASE port.
(quick example for how to turn ASE on or off):
<syntaxhighlight lang="xml">
<ase>1</ase> 
</syntaxhighlight>

Now we going to forward the ports in your router, which is not needed if you already have all ports open, or if you don't have a router with a firewall. If so, skip this part.

If you don't know how port forwarding works in your router, go to the [http://portforward.com/ Port Forward website], find your router model there, and follow the instructions there.

In almost every router you can set the port type: UDP or TCP. The following list will explain which port type is needed for what:

Main server port: UDP

HTTP Port: TCP

ASE Port: UDP (this is needed if you want your server to appear in the server list)

The ASE port is also simple to get:

ASE port = Main server port + 123

So, if you have the main server port set to 22003, then the ASE port will be 22126.

Good luck!

''In the latest version of the server, you can check the port status by using the server command [[Server_Commands#openports|openports]].''

===Client Checks===

The MTA server can be configured to disable the anti-cheat. It can also allow specific or all files to be modified (e.g. carmods.dat), and make sure clients are of a minimum version.

All of these settings are within the file 'mods/deathmatch/[[Server_mtaserver.conf|'''mtaserver.conf''']]'. See the [[Anti-cheat_guide|Anti-cheat guide]] for more details.<br/>

If you want to force a minimum client version, search for the following line:
<syntaxhighlight lang="xml">
<minclientversion></minclientversion>
</syntaxhighlight>
Accepted values look like: 1.1.1-9.02320

===Adding administrators===
It is strongly recommended to add at least one administrator to your server in order to make use of the built-in webserver to easily maintain and configure your server. This administrator will then also be able to log-in from within the game and control the server.

To add an administrator to your server, follow these steps:<br>
<ol>
<li>While the server is running, add a new account by typing '''[[Server_Commands#addaccount|addaccount name password]]''' into the server window. For example, to add user BennyLava you could type:
<div style="margin: 10px 10px 10px 10px;">
<syntaxhighlight lang="xml">
addaccount BennyLava 123password
</syntaxhighlight>
</div>
<div style="margin: 10px 10px 10px 20px;">
''Note: If you do not have access to the server window, and the 'admin' resource is running, you can add the example account by issuing the chatbox command '''/register BennyLava 123password'''''
</div>
<li>The server should display a message confirming the account has been added.
<li>Next, shutdown the server by typing '''shutdown''' into the server window.
<li>Make sure your server is stopped; if your server is still running, the following changes you make will be overwritten</li>
<li>Open the file 'mods/deathmatch/'acl.xml'''' with any text editor</li>
<li>Add the account to the ''Admin'' group by using the XML-syntax below
<div style="padding: 10px">
<syntaxhighlight lang="xml">
<acl>
...
<group name="Admin">
<acl name="Admin"/>
...
<object name="user.BennyLava" />
</group>
...
</acl>
</syntaxhighlight>
</div>

You're done! You can add as many administrators or users as you want this way, take a look at some of the other groups and ACLs for example. The ACL is also accessible through the [[Access_Control_List|Lua scripting engine]].<br>

It is recommended to take a look at the web interface, we will explain how to do this below.
</li>
</ol>
'''Note''': There are also ways to add accounts and edit rights for the server while it's running. "[[Server_Commands#addaccount|addaccount <user> <password>]]" is an internal command to add accounts, but you will have to use the web interface to add these accounts to specific groups/ACLs!<br />

===Using the web interface===
The dedicated server comes with a few Lua [[resources]] that provide a nice little web interface to your server. This can be used to easily maintain your server, as it allows you to add users, start/stop resources, and more.

The web interface resources are enabled by default and are served through the built-in HTTP web server. To make sure the built-in HTTP web server runs on a port you like (22005 by default), follow these steps:
<ol>
<li>Make sure your server is stopped
<li>Open the file 'mods/deathmatch/[[Server_mtaserver.conf|'''mtaserver.conf''']]' with any text editor</li>
<li>Verify that the HTTP server is enabled:
<div style="padding: 10px">
<syntaxhighlight lang="xml">
<httpserver>1</httpserver>
</syntaxhighlight>
</div>
</li>
<li>Change the HTTP server port to your liking:
<div style="padding: 10px">
<syntaxhighlight lang="xml">
<httpport>22005</httpport>
</syntaxhighlight>
</div>
</li>
<li>Save and close the configuration file</li>
<li>Start your server</li>
<li>If you happened to have changed the start-up resources in your configuration file, make sure the following resources are started:

# resourcebrowser
# resourcemanager
# webadmin
# webmap

These are automatically started in the default configuration file, in case you just installed your server.
</li>
<li>Open a web browser (Internet Explorer 6 or 7 are NOT supported; use [http://www.mozilla.com/firefox Mozilla Firefox], [http://www.google.com/chrome Google Chrome], [http://www.apple.com/safari/download Apple Safari], [http://www.opera.com Opera] or others) and navigate to the HTTP server URL: '''http://server:port/'''. For example, If you are running a local server on HTTP port 22005, use '''http://127.0.0.1:22005/'''.</li>
<li>Enter the username and password of the administrator you added in the previous section.</li>
</ol>

<br />
You should now be able to maintain your server from the web interface.

=== Configuring an external web server ===
The built-in web server is also used to serve files that are required by resources running on your server to any player that is connected to your server. For example, if you are running a game script with a scripted graphical user interface, or custom models, these need to be transferred to every connected player in order to function properly. This is done by either the built-in web server, or an external web server (that is usually a bit faster) but needs to be set up separately.

For performance or consistency reasons during the game, you could choose to make use of such an external web server if you have one set up. The external web server needs to be accessible for the public, so any client will be able to download the necessary client-side files in order to join and play on your server.

To enable downloading off an external web server, you should configure the [[Server_mtaserver.conf#httpdownloadurl|httpdownloadurl]] tag in your server configuration:

<div style="padding: 10px">
<syntaxhighlight lang="xml">
<httpdownloadurl>http://www.myserver.tld/directory/here</httpdownloadurl>
</syntaxhighlight></div>

Since all the default resources provided with the dedicated server are zipped, and are normally automatically extracted by the built-in web server, you now have to provide a way for the clients to download the compressed files to their computers. To configure MTA to maintain a copy of only your unzipped client resources, set [[Server_mtaserver.conf#httpautoclientfiles|httpautoclientfiles]] in your server configuration:

<div style="padding: 10px">
<syntaxhighlight lang="xml"><httpautoclientfiles>1</httpautoclientfiles>
</syntaxhighlight></div>

Now when you launch the server, the directory '''<SERVER>/mods/deathmatch/resource-cache/http-client-files''' will contain the correct client files for hosting on an external web server. If the web server is on the same machine, you can simply link the appropriate web server directory to '''http-client-files'''. If the web server is on a separate machine, ensure it has access to '''http-client-files''' via a network path, or maintain a remote copy using synchronization software.

'''Note 1''': Please try to avoid any special characters (e.g. ~, !) in your download URLs.<br />
'''Note 2''': Please do not use a trailing slash in your download URL (e.g. ''hxxp://www.myserver.tld/directory'' rather than ''hxxp://www.myserver.tld/directory/'')

==Starting your server==
Begin by making sure that you have finished all configuration of your server, starting your server is the last stage so everything must be ready!

To start your server double click on MTA Server.exe, make sure you allow it through any firewalls and forward ports where necessary.

==Installing/Updating resources on your server==
Resources can come in two formats, either a ZIP format or just a normal folder with the script files inside it. The MTA:SA server supports both these methods.

# Move or copy the new resource to your <SERVER>\mods\deathmatch\resources folder.
# In the server window type in the command [[Server_Commands#refresh|refresh]], this will re-scan the resources folder and update the live resources where necessary.

==Uninstalling resources==
Resources can easily be removed from your server if you no longer want them.

# Delete the ZIP file or the folder of the resource you wish to uninstall
# In the server window type in the command "refresh" (without the quotes), this will re-scan the resources folder and update the live resources where necessary.

==Administrating your server==
You can start resources by typing the command "start resourcename" in the server console, or stop ones with "stop resourcename".

It's also possible to execute these and other admin commands from the in-game console (which you can bring up with the ` key or F8); for this to work, you first need to log in with the command "[[Server_Commands#login|login username password]]". Additionally, you can press the p key to bring up the admin panel: this is a graphical interface which allows you to easily kick or ban misbehaving players, among others.

For further commands, type [[Server_Commands#help|help]] in a console.

==Starting a map/gamemode==
See the commands section of the documentation for [[Resource:Map manager|mapmanager]] for more information.

==Useful Notes==

# You may also update the resources while in-game as long as you have the correct access levels by typing "refresh" in the clients console or "/refresh" in the chat window. This may cause a second of lag if you have many resources.
# In the above instructions, <SERVER> is the path to your server's main directory. In most cases this is C:\Program Files\MTA San Andreas\server
# You can choose a different config file for the server to use by passing it in the command line after a --config argument, e.g. mtaserver.exe --config anotherconfig.cfg.
# Do not be alarmed by the warning regarding the parsing of the settings.xml file. This happens because your server installation is still clean and unused.

====Need further help?====
Why not pop over to our [http://forum.mtasa.com/ Forums] or join us on [irc://irc.multitheftauto.com/mta IRC] (irc.multitheftauto.com #mta - [http://www.mirc.com mIRC])

[[es:Manual del Servidor]]
[[de:Server Anleitung]]
[[it:Manuale del Server]]
[[nl:Server Manual]]
[[ru:Server Manual]]
[[pl:Server Manual]]

[[Category:Support]]

GetWeaponState

2012-10-06T09:12:53Z

TAPL:

__NOTOC__
{{Client function}}
{{Needs Example}}
Get the state of the custom weapon.

==Syntax==
<syntaxhighlight lang="lua">string getWeaponState ( weapon theWeapon )</syntaxhighlight>

===Required Arguments===
* '''theWeapon:''' The [[weapon]] to get the target of.

===Returns===
Returns a [[string]] indicating the weapon state, ''false'' otherwise.
<div style="border:3px solid red;margin-bottom:3px;padding-left:5px;"><div style="float:right;padding-right:5px;font-weight:bold;"></div>
* '''reloading''': The weapon is reloading
* '''firing''': The weapon will constantly fire ( unless any shooting blocking flags are set ) according to its assigned firing rate
* '''ready''': The weapon is idle
</div>

==Example==
TODO
<syntaxhighlight lang="lua">
--TODO
</syntaxhighlight>

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

==See Also==
{{Client weapon creation functions}}

GetWeaponTarget

2012-10-06T09:12:49Z

TAPL:

__NOTOC__
{{Client function}}
{{Needs Example}}
Get the target of the custom weapon.

==Syntax==
<syntaxhighlight lang="lua">element getWeaponTarget ( weapon theWeapon )</syntaxhighlight>

===Required Arguments===
* '''theWeapon:''' The weapon to get the target of.

===Returns===
Returns the ''target element'' of the custom weapon, ''false'' otherwise.

==Example==
TODO
<syntaxhighlight lang="lua">
--TODO
</syntaxhighlight>

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

==See Also==
{{Client weapon creation functions}}

IsElementCollidableWith

2012-10-06T09:11:33Z

TAPL:

{{Client function}}
{{Needs Example}}
__NOTOC__
This function can be used to check whether specified element is collidable with another element.<br>
'''Note:''' You can only use this function with the element types listed below.
*[[Player]]
*[[Ped]]
*[[Vehicle]]
*[[Object]]

==Syntax==
<syntaxhighlight lang="lua">
bool isElementCollidableWith ( element theElement, element withElement )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The [[element]] which colliding you want to get
*'''withElement:''' The other [[element]] which colliding with the first entity you want to get

===Returns===
Returns ''true'' if the elements collide with eachother, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>
</section>

==See Also==
{{Client element functions}}

DxDrawMaterialLine3D

2012-10-06T09:06:59Z

TAPL:

__NOTOC__
{{Client function}}
{{Needs Example}}
{{New feature/item|4.0140|1.3.0|3931|
This function draws a textured 3D line between two points in the 3D world - rendered for one frame. This should be used in conjunction with [[onClientPreRender]] in order to display continuously.

The 3D line with a large width value effectively becomes a rectangle, so it it possible to construct basic shapes such as boxes with several large width lines and the appropriate values for 'faceToward'.

3D lines are drawn at a particular place in the [[Game_Processing_Order|game processing order]], so use [[onClientPreRender]] for drawing if you are attaching them to world elements.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool dxDrawMaterialLine3D ( float startX, float startY, float startZ, float endX, float endY, float endZ,
element material, int width, [, int color = white, float faceTowardX, float faceTowardY, float faceTowardZ ] )
</syntaxhighlight>

===Required Arguments===
* '''startX/Y/Z:''' The start position of the 3D line, representing a coordinate in the GTA world.
* '''endX/Y/Z:''' The end position of the 3D line, representing a coordinate in the GTA world.
* '''material:''' A [[material]] to draw the line with.
* '''width:''' The width/thickness of the line in GTA world units. (This is 1/75th of the width used in dxDrawLine3D)

==Optional Arguments==
{{OptionalArg}}
* '''color:''' An [[int|integer]] of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
* '''faceTowardX/Y/Z:''' The direction the front of the line should face towards. If this is not set, the front of the line always faces toward the camera.

===Returns===
Returns a ''true'' if the operation was successful, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
TODO
</syntaxhighlight>
</section>

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

==See Also==
{{Drawing_functions}}
[[Category:Needs Example]]

DxGetBlendMode

2012-10-06T09:06:50Z

TAPL:

{{Client function}}
__NOTOC__
This function returns the current blend mode for the dxDraw functions. The blend mode is set using [[dxSetBlendMode]]

==Syntax==
<syntaxhighlight lang="lua">
string dxGetBlendMode ( )
</syntaxhighlight>

==Returns==
Returns the current blend mode, which can be one of:
*'''blend'''
*'''add'''
*'''modulate_add'''

==Example==
<syntaxhighlight lang="lua">
TODO
</syntaxhighlight>

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

==See Also==
{{Drawing_functions}}
[[Category:Needs Example]]

DxSetPixelColor

2012-10-06T09:06:40Z

TAPL:

{{Client function}}
__NOTOC__
This function sets the color of a single pixel for [[Texture_pixels|pixels]] contained in a string. It only works with ''''plain'''' format pixels.

==Syntax==
<syntaxhighlight lang="lua">
bool dxSetPixelColor ( string pixels, int x, int y, int r, int g, int b [, int a = 255 ] )
</syntaxhighlight>

===Required Arguments===
*'''pixels :''' The pixels to use
*'''x:''' The X coordinate for the pixel
*'''y:''' The Y coordinate for the pixel
*'''r:''' The red channel for the color (0-255)
*'''g:''' The green channel for the color (0-255)
*'''b:''' The blue channel for the color (0-255)

===Optional Arguments===
*'''a:''' The alpha channel for the color (0-255)

==Returns==
Returns true if successful, or ''false'' if invalid arguments were passed to the function.

==Example==
<syntaxhighlight lang="lua">
TODO
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3|}}

==See Also==
{{Drawing_functions}}
[[Category:Needs Example]]

DxGetPixelColor

2012-10-06T09:06:19Z

TAPL:

{{Client function}}
__NOTOC__
This function gets the color of a single pixel from [[Texture_pixels|pixels]] contained in a string. It only works with ''''plain'''' format pixels.

==Syntax==
<syntaxhighlight lang="lua">
int dxGetPixelColor ( string pixels, int x, int y )
</syntaxhighlight>

===Required Arguments===
*'''pixels :''' The pixels to use
*'''x:''' The X coordinate for the pixel
*'''y:''' The Y coordinate for the pixel

==Returns==
Returns the color of pixel if successful, or ''false'' if invalid arguments were passed to the function.

==Example==
<syntaxhighlight lang="lua">
TODO
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3|}}

==See Also==
{{Drawing_functions}}
[[Category:Needs Example]]

DxConvertPixels

2012-10-06T09:06:15Z

TAPL:

{{Client function}}
__NOTOC__
This function converts [[Texture_pixels|pixels]] from one format to another.

==Syntax==
<syntaxhighlight lang="lua">
string dxConvertPixels ( string pixels, string newFormat [, int quality = 80 ] )
</syntaxhighlight>

===Required Arguments===
*'''pixels :''' The pixels to convert the format of
*'''newFormat :''' The new format required (''''plain'''' or ''''png'''' or ''''jpeg'''')

===Optional Arguments===
*'''quality :''' The quality of the returned pixels if the new format is ''''jpeg''''

==Returns==
Returns a copy of the pixels in the new format, or ''false'' if invalid arguments were passed to the function.

==Example==
<syntaxhighlight lang="lua">
TODO
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3|}}

==See Also==
{{Drawing_functions}}
[[Category:Needs Example]]

DxGetPixelsFormat

2012-10-06T09:06:12Z

TAPL:

{{Client function}}
__NOTOC__
This function returns the format of [[Texture_pixels|pixels]] contained in a string.

==Syntax==
<syntaxhighlight lang="lua">
string dxGetPixelsFormat ( string pixels )
</syntaxhighlight>

===Required Arguments===
*'''pixels :''' The pixels to get the format of

==Returns==
Returns the format of the pixels if successful, ''false'' if invalid arguments were passed to the function.

==Example==
<syntaxhighlight lang="lua">
TODO
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3|}}

==See Also==
{{Drawing_functions}}
[[Category:Needs Example]]

DxGetPixelsSize

2012-10-06T09:06:08Z

TAPL:

{{Client function}}
__NOTOC__
This function gets the dimensions of [[Texture_pixels|pixels]] contained in a string. It works with all pixel formats.

==Syntax==
<syntaxhighlight lang="lua">
int int dxGetPixelsSize ( string pixels )
</syntaxhighlight>

===Required Arguments===
*'''pixels :''' The pixels to get the dimensions of

==Returns==
Returns width and height of the pixels if successful, ''false'' if invalid arguments were passed to the function.

==Example==
<syntaxhighlight lang="lua">
TODO
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3|}}

==See Also==
{{Drawing_functions}}
[[Category:Needs Example]]

DxSetTexturePixels

2012-10-06T09:05:50Z

TAPL:

{{Client function}}
__NOTOC__
This function sets the [[Texture_pixels|pixels]] of a [[texture]] element. It can be used with a standard texture, render target or screen source. Only ''''plain'''' format pixels please.

----
''Performance note:
*''This function is slow and not something you want to be doing once a frame.''
*''It is very slow when setting pixels to a render target or screen source.''
*''And is very slow indeed if the texture format is not ''' 'argb' ''' ''
----

==Syntax==
<syntaxhighlight lang="lua">
bool dxSetTexturePixels ( [ int surfaceIndex = 0, ] element texture, string pixels [, int x = 0, int y = 0, int width = 0, int height = 0 ] )
</syntaxhighlight>

===Required Arguments===
*'''texture :''' The texture element to set the pixels of
*'''pixels :''' The ''''plain'''' format pixels to use

===Optional Arguments===
{{New feature/item|4.0130|1.3|4021|
*'''surfaceIndex:''' Desired slice to set if the texture is a volume texture, or desired face to set if the texture is a cube map. <nowiki>(Cube map faces: 0=+X 1=-X 2=+Y 3=-Y 4=+Z 5=-Z)</nowiki>
}}
By default the pixels are set starting at the top left corner of the texture. To set a different region, define a rectangular area using all four of these optional arguments:
*'''x:''' Rectangle left position
*'''y:''' Rectangle top position
*'''width:''' Rectangle width
*'''height :''' Rectangle height

==Returns==
Returns a string if successful, ''false'' if invalid arguments were passed to the function.

==Example==
<syntaxhighlight lang="lua">
TODO
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3|}}

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04021|Added surfaceIndex argument}}

==See Also==
{{Drawing_functions}}
[[Category:Needs Example]]

DxGetTexturePixels

2012-10-06T09:05:35Z

TAPL:

{{Client function}}
__NOTOC__
This function fetches the [[Texture_pixels|pixels]] from a [[texture]] element. It can be used with a standard texture, render target or screen source.

----
''Performance note:
*''This function is slow and not something you want to be doing once a frame.''
*''It is slower when reading pixels from a render target or screen source.''
*''And is very slow indeed if the texture format is not ''' 'argb' ''' ''
----

==Syntax==
<syntaxhighlight lang="lua">
string dxGetTexturePixels ( [ int surfaceIndex = 0, ] element texture [, int x = 0, int y = 0, int width = 0, int height = 0 ] )
</syntaxhighlight>

===Required Arguments===
*'''texture :''' The texture element to get the pixels from

===Optional Arguments===
{{New feature/item|4.0130|1.3|4021|
*'''surfaceIndex:''' Desired slice to get if the texture is a volume texture, or desired face to get if the texture is a cube map. <nowiki>(Cube map faces: 0=+X 1=-X 2=+Y 3=-Y 4=+Z 5=-Z)</nowiki>
}}
By default the pixels from the whole texture is returned. To get only a portion of the texture, define a rectangular area using all four of these optional arguments:
*'''x:''' Rectangle left position
*'''y:''' Rectangle top position
*'''width:''' Rectangle width
*'''height :''' Rectangle height

==Returns==
Returns a ''''plain'''' format pixels string if successful, ''false'' if invalid arguments were passed to the function.

==Example==
<syntaxhighlight lang="lua">
TODO
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3|}}

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04021|Added surfaceIndex argument}}

==See Also==
{{Drawing_functions}}
[[Category:Needs Example]]

DxSetTestMode

2012-10-06T09:05:21Z

TAPL:

{{Client function}}
__NOTOC__
This function is used for testing scripts written using [[guiCreateFont]], [[dxCreateFont]], [[dxCreateShader]] and [[dxCreateRenderTarget]]

Each one of the 3 test modes should be used in turn to help highlight any potential problems.

==Syntax==
<syntaxhighlight lang="lua">
bool dxSetTestMode ( string testMode )
</syntaxhighlight>

===Required Arguments===
*'''testMode :''' The test mode to be set. It can be one of the following values:
**'''none :''' Test mode disabled
**'''no_mem:''' Simulate no free video memory available for MTA.
**'''low_mem:''' Simulate little free video memory available for MTA.
**'''no_shader:''' Simulate shaders failing validation.

===Returns===
Returns ''true'' if the test mode was successfully set, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
</syntaxhighlight>

==See Also==
{{Drawing_functions}}
[[Category:Needs Example]]

DxSetShaderTransform

2012-10-06T09:05:04Z

TAPL:

{{Client function}}
__NOTOC__
This function applies a 3D transformation to a [[shader]] element when it is draw with [[dxDrawImage]].

==Syntax==
<syntaxhighlight lang="lua">
bool dxSetShaderTransform ( element shader,
float rotationX, float rotationY, float rotationZ,
[ float rotationCenterOffsetX = 0, float rotationCenterOffsetY = 0, float rotationCenterOffsetZ = 0,
bool bRotationCenterOffsetOriginIsScreen = false,
float perspectiveCenterOffsetX = 0, float perspectiveCenterOffsetY = 0,
bool bPerspectiveCenterOffsetOriginIsScreen = false ] )
</syntaxhighlight>

===Required Arguments===
*'''shader:''' The shader element whose transformation is to be changed
*'''rotationX:''' Rotation angle in degrees around the X axis (Left,right). This will make the shader rotate along its width.
*'''rotationY:''' Rotation angle in degrees around the Y axis (Up,down). This will make the shader rotate along its height.
*'''rotationZ:''' Rotation angle in degrees around the Z axis (In,out). This will make the shader rotate in a similar way to the rotation argument in [[dxDrawImage]].

===Optional Arguments===
*'''rotationCenterOffsetX :''' The center of rotation offset X position in screen relative units.
*'''rotationCenterOffsetY :''' The center of rotation offset Y position in screen relative units.
*'''rotationCenterOffsetZ :''' The center of rotation offset Z position in screen relative units.
*'''bRotationCenterOffsetOriginIsScreen :''' Set to [[boolean|true]] if the center of rotation origin should be the center of the screen rather than the center of the image.
*'''perspectiveCenterOffsetX :''' The center of perspective offset X position in screen relative units.
*'''perspectiveCenterOffsetY :''' The center of perspective offset Y position in screen relative units.
*'''bPerspectiveCenterOffsetOriginIsScreen :''' Set to [[boolean|true]] if the center of perspective origin should be the center of the screen rather than the center of the image.

To convert screen relative units into screen pixel coordinates, ''multiply'' by the screen size. Conversely, to convert screen pixel coordinates to screen relative units, '''''divide''''' by the screen size.

===Returns===
Returns ''true'' if the shader element's transform was successfully changed, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.2.0-9.03618|}}

==See Also==
{{Drawing_functions}}
[[Category:Needs Example]]

DxDrawImageSection

2012-10-06T09:03:52Z

TAPL:

__NOTOC__
{{Client function}}
Differing from [[dxDrawImage]], this function only draws a part of an image on the screen for a single frame. In order for the image to stay visible continuously, you need to call this function with the same parameters on each frame update (see [[onClientRender]]).

==Syntax==
<syntaxhighlight lang="lua">
bool dxDrawImageSection ( float posX, float posY, float width, float height, float u, float v, float usize, float vsize, mixed image,
[ float rotation = 0, float rotationCenterOffsetX = 0, float rotationCenterOffsetY = 0, int color = white, bool postGUI = false ] )
</syntaxhighlight>

===Required Arguments===
*'''posX:''' the absolute X coordinate of the top left corner of the image
*'''posY:''' the absolute Y coordinate of the top left corner of the image
*'''width:''' the absolute width of the image
*'''height:''' the absolute height of the image
*'''u:''' the absolute X coordinate of the top left corner of the section which should be drawn from image
*'''v:''' the absolute Y coordinate of the top left corner of the section which should be drawn from image
*'''usize:''' the absolute width of the image section
*'''vsize:''' the absolute height of the image section
*'''image:''' Either a [[material]] element or a [[filepath]] of the image which is going to be drawn. (.dds images are also supported). Image files should ideally have dimensions that are a power of two, to prevent possible blurring.

===Optional Arguments===
*'''rotation:''' the rotation, in degrees for the image.
*'''rotationCenterOffsetX:''' the absolute X offset from the image center for which to rotate the image from.
*'''rotationCenterOffsetY:''' the absolute Y offset from the image center for which to rotate the image from.
*'''color:''' the color of the image, a value produced by [[tocolor]] or hexadecimal number in format: 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
*'''postgui :''' A bool representing whether the image should be drawn on top of or behind any ingame GUI (rendered by CEGUI).

===Returns===
Returns ''true'' if successful, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
--TODO
</syntaxhighlight>
</section>

==See Also==
{{Drawing_functions}}
[[Category:Needs Example]]

GetSoundFFTData

2012-10-06T09:00:12Z

TAPL:

__NOTOC__
{{Client function}}
{{Needs Example}}
{{New feature/item|4.0140|1.3.0|4125|
This function gets the FFT data for an audio stream which is a table of floats representing the current audio frame.
This allows things like visualisations.
}}

==Syntax==
<syntaxhighlight lang="lua">table getSoundFFTData ( element sound, int iSamples [, int iBands = 0 ] )</syntaxhighlight>

===Required Arguments===
*'''sound:''' A sound element that is created using [[playSound]] or [[playSound3D]]. Streams are also supported
*'''iSamples:''' Allowed samples are 128, 256, 512, 1024, 2048, 4096, 8092 and 16184

===Optional Arguments===
*'''iBands:''' Post processing option

===Returns===
Returns a table of floats representing the current audio frame.
Returns false if the sound is not playing yet or hasn't buffered in the
case of streams.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
-- not done yet
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}
[[Category:Needs Example]]

SetSoundProperties

2012-10-06T08:59:29Z

TAPL:

__NOTOC__
{{Client function}}
{{New feature/item|4.0140|1.3.0|4097|
This function edit's the properties of a specific [[sound]].
}}

==Syntax==
<syntaxhighlight lang="lua">bool setSoundProperties(element sound, float fSampleRate, float fTempo, float fPitch, bool bReverse )</syntaxhighlight>

===Required Arguments===
*'''sound:''' A sound element that is created using [[playSound]] or [[playSound3D]]

*'''fSampleRate:''' A float that defines the new sound's [http://en.wikipedia.org/wiki/Sampling_rate sample rate]

*'''fTempo:''' A float that defines the new sound [http://en.wikipedia.org/wiki/Tempo tempo]

*'''fPitch:''' A float that defines the new sound [http://en.wikipedia.org/wiki/Pitch_%28music%29 pitch]

*'''bReverse:''' A boolean representing whether the sound will be reversed or not.

===Returns===
Returns true if the properties sucessfully set, false otherwise.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
-- not done yet
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}
[[Category:Needs Example]]

GetSoundProperties

2012-10-06T08:59:18Z

TAPL:

__NOTOC__
{{Client function}}
{{New feature/item|4.0140|1.3.0|4097|
This function gets the properties of a specific [[sound]].
}}

==Syntax==
<syntaxhighlight lang="lua">float, float, float, bool getSoundProperties( element sound )</syntaxhighlight>

===Required Arguments===
*'''sound:''' A sound element that is created using [[playSound]] or [[playSound3D]]

===Returns===
This function returns 3 floats and a boolean value:

The first float is the sound's [http://en.wikipedia.org/wiki/Sampling_rate sample rate], the second one the sound's [http://en.wikipedia.org/wiki/Tempo tempo], and the third one the [http://en.wikipedia.org/wiki/Pitch_%28music%29 pitch] of the sound. The boolean representing whether the sound is reversed or not.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
-- not done yet
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}
[[Category:Needs Example]]

GetSoundBPM

2012-10-06T08:58:56Z

TAPL:

__NOTOC__
{{Client function}}
{{New feature/item|4.0140|1.3.0|4145|
This function gets the beats per minute of a specific [[sound]] element.
}}

==Syntax==
<syntaxhighlight lang="lua">int getSoundBPM( element sound )</syntaxhighlight>

===Required Arguments===
*'''sound:''' A sound element that is created using [[playSound]] or [[playSound3D]]

===Returns===
Returns the beats per minute of the given sound.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
-- not done yet
</syntaxhighlight>
</section>

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

==See Also==
{{Client_audio_functions}}
[[Category:Needs Example]]

StopSound

2012-10-06T08:58:05Z

TAPL:

__NOTOC__
{{Client function}}
Stops the sound playback for specified [[sound]] element. The sound element is also destroyed.

==Syntax==
<syntaxhighlight lang="lua">bool stopSound ( element theSound )</syntaxhighlight>

===Required Arguments===
*'''theSound:''' The [[sound]] element you want to stop playing.

===Returns===
Returns ''true'' if the sound was successfully stopped, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function startMySound()
sound = playSound( "sound.mp3", true )
end
addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource() ), startMySound )

function stopMySound()
stopSound( sound )
end
addCommandHandler ( "stopsound", stopMySound ) --using the command 'stopsound' will stop the sound
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

GetSoundVolume

2012-10-06T08:56:57Z

TAPL:

__NOTOC__
{{Client function}}
This function is used to return the volume level of the specified [[sound]] element.

==Syntax==
<syntaxhighlight lang="lua">float getSoundVolume ( element theSound )</syntaxhighlight>

===Required Arguments===
*'''theSound:''' The [[sound]] element which volume you want to return.

===Returns===
Returns a [[float]] representing the volume level of the [[sound]] element, ''false'' if invalid arguments were passed.

==Example==
TODO
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
--TODO
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}
[[Category:Needs Example]]

GetSoundPosition

2012-10-06T08:56:13Z

TAPL:

__NOTOC__
{{Client function}}
This function is used to return the current seek position of the specified [[sound]] element.

==Syntax==
<syntaxhighlight lang="lua">int getSoundPosition ( element theSound )</syntaxhighlight>

===Required Arguments===
*'''theSound:''' The [[sound]] element which seek position you want to return.

===Returns===
Returns an [[int]]eger value indicating the seek position of the [[sound]] element in milliseconds.

==Example==
TODO
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
--TODO
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}
[[Category:Needs Example]]

GetSoundLength

2012-10-06T08:55:07Z

TAPL:

__NOTOC__
{{Client function}}
This function is used to return the playback length of the specified [[sound]] element.

==Syntax==
<syntaxhighlight lang="lua">float getSoundLength ( element theSound )</syntaxhighlight>

===Required Arguments===
*'''theSound:''' The [[sound]] element which length you want to return.

===Returns===
Returns an [[float]] value indicating the playback length of the [[sound]] element in seconds.

==Example==
TODO
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
--TODO
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

[[Category:Needs Example]]

Template:AR/Player functions

2012-09-29T19:35:36Z

TAPL:

* [[AR/forcePlayerMap|forcePlayerMap]]
* [[AR/getAlivePlayers|getAlivePlayers]]
* [[AR/getDeadPlayers|getDeadPlayers]]
* [[AR/getPlayerAnnounceValue|getPlayerAnnounceValue]]
* [[AR/getPlayerBlurLevel|getPlayerBlurLevel]]
* [[AR/getPlayerCount|getPlayerCount]]
* [[AR/getPlayerMoney|getPlayerMoney]]
* [[AR/getPlayerNametagColor|getPlayerNametagColor]]
* [[AR/getPlayerNametagText|getPlayerNametagText]]
* [[AR/getPlayerPing|getPlayerPing]]
* [[AR/getPlayerTeam|getPlayerTeam]]
* [[AR/getPlayerVersion|getPlayerVersion]]
* [[AR/getPlayerWantedLevel|getPlayerWantedLevel]]
* [[AR/getRandomPlayer|getRandomPlayer]]
* [[AR/givePlayerMoney|givePlayerMoney]]
* [[AR/isPlayerMapForced|isPlayerMapForced]]
* [[AR/isPlayerMuted|isPlayerMuted]]
* [[AR/isPlayerNametagShowing|isPlayerNametagShowing]]
* [[AR/setPlayerAnnounceValue|setPlayerAnnounceValue]]
* [[AR/setPlayerBlurLevel|setPlayerBlurLevel]]
* [[AR/setPlayerMoney|setPlayerMoney]]
* [[AR/setPlayerMuted|setPlayerMuted]]
* [[AR/setPlayerNametagColor|setPlayerNametagColor]]
* [[AR/setPlayerNametagShowing|setPlayerNametagShowing]]
* [[AR/setPlayerNametagText|setPlayerNametagText]]
* [[AR/setPlayerTeam|setPlayerTeam]]
* [[AR/setPlayerWantedLevel|setPlayerWantedLevel]]
* [[AR/showPlayerHudComponent|showPlayerHudComponent]]
* [[AR/spawnPlayer|spawnPlayer]]
* [[AR/takePlayerMoney|takePlayerMoney]]
* [[AR/getPlayerFromName|getPlayerFromName]]
* [[AR/getPlayerIP|getPlayerIP]]
* [[AR/getPlayerName|getPlayerName]]
* [[AR/redirectPlayer|redirectPlayer]]
* [[AR/setPlayerName|setPlayerName]]
{{New items|3.0120|1.2|
* [[AR/getPlayerIdleTime|getPlayerIdleTime]]
* [[AR/resendPlayerModInfo|resendPlayerModInfo]]
}}
* [[AR/isVoiceEnabled|isVoiceEnabled]]
* [[AR/setPlayerVoiceBroadcastTo|setPlayerVoiceBroadcastTo]]
* [[AR/setPlayerVoiceIgnoreFrom|setPlayerVoiceIgnoreFrom]]
{{New items|3.0130|1.3|
* [[AR/takePlayerScreenShot|takePlayerScreenShot]]
}}
<noinclude>[[Category:Functions templates]]</noinclude>

CreateBlip

2012-09-29T15:38:43Z

TAPL:

__NOTOC__
{{Server client function}}
This function creates a [[blip]] [[element]], which is displayed as an icon on the client's radar.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
blip createBlip ( float x, float y, float z, [int icon=0, int size=2, int r=255, int g=0, int b=0, int a=255,
int ordering=0, float visibleDistance=99999.0, visibleTo = getRootElement()] )
</syntaxhighlight>

===Required Arguments===
*'''x:''' The x position of the blip, in world coordinates.
*'''y:''' The y position of the blip, in world coordinates.
*'''z:''' The z position of the blip, in world coordinates.

===Optional Arguments===
{{OptionalArg}}
*'''icon:''' The icon that the radar blips should be. Valid values are:
{{Blip_Icons}}
*'''size:''' The size of the radar blip. Only applicable to the ''Marker'' icon. Default is 2.
*'''r:''' The amount of red in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 255.
*'''g:''' The amount of green in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 0.
*'''b:''' The amount of blue in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 0.
*'''a:''' The amount of alpha in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 255.
{{New feature/item|3|1.0||
*'''ordering:''' This defines the blip's Z-level ordering (-32768 - 32767). Default is 0.
*'''visibleDistance:''' The maximum distance from the camera at which the blip is still visible
}}
*'''visibleTo:''' What elements can see the blip. Defaults to visible to everyone. See [[visibility]].
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
blip createBlip ( float x, float y, float z, [int icon=0, int size=2, int r=255, int g=0, int b=0, int a=255,
int ordering=0, float visibleDistance ] )
</syntaxhighlight>

===Required Arguments===
*'''x:''' The x position of the blip, in world coordinates.
*'''y:''' The y position of the blip, in world coordinates.
*'''z:''' The z position of the blip, in world coordinates.

===Optional Arguments===
{{OptionalArg}}
*'''icon:''' The icon that the radar blips should be. Valid values are:
{{Blip_Icons}}
*'''size:''' The size of the radar blip. Only applicable to the ''Marker'' icon. Default is 2.
*'''r:''' The amount of red in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 255.
*'''g:''' The amount of green in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 0.
*'''b:''' The amount of blue in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 0.
*'''a:''' The amount of alpha in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 255.
{{New feature/item|3|1.0||
*'''ordering:''' This defines the blip's Z-level ordering (-32768 - 32767). Default is 0.
*'''visibleDistance:''' The maximum distance from the camera at which the blip is still visible
}}
</section>

==Returns==
Returns an [[element]] of the [[blip]] if it was created successfully, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
'''Example 1:''' This example creates a radar blip at a random player's position and makes it so that it is only visible to that player.
<syntaxhighlight lang="lua">
-- Pick a random player
myPlayer = getRandomPlayer ()
-- Retrieve the player's position and store it in the variables x, y and z
x,y,z = getElementPosition ( myPlayer )
-- Create a radar blip at the player's position, with a 'cash' icon and only visible to the player
myBlip = createBlip ( x, y, z, 51, 0, 0, 0, 255, myPlayer )
</syntaxhighlight>

'''Example 2:''' This example attaches a blip to a player. You can attach a blip to an element by just setting the blip's parent to that element.
<syntaxhighlight lang="lua">
-- Pick a random player
myPlayer = getRandomPlayer ()
-- Create a radar blip in the middle of the map
myBlip = createBlip ( 0, 0, 0 )
-- Make the player the parent of the blip, so that the blip follows the player around
setElementParent ( myBlip, myPlayer )
</syntaxhighlight>

'''Example 3:''' This example creates a blip at 0 , 0 , 0
<syntaxhighlight lang="lua">
--creates a blip at 0 , 0 , 0
createBlip ( 0 , 0 , 0 , 37 )
</syntaxhighlight>
</section>

==See Also==
{{Blip_functions}}

[[AR:createBlip]]
[[es:createBlip]]

CreateBlip

2012-09-29T15:38:14Z

TAPL:

Template:AR/Blip functions

2012-09-29T15:35:09Z

TAPL:

*[[AR/createBlip|createBlip]]
*[[AR/createBlipAttachedTo|createBlipAttachedTo]]
*[[AR/getBlipColor|getBlipColor]]
*[[AR/getBlipIcon|getBlipIcon]]
*[[AR/getBlipSize|getBlipSize]]
*[[AR/setBlipColor|setBlipColor]]
*[[AR/setBlipIcon|setBlipIcon]]
*[[AR/setBlipSize|setBlipSize]]
*[[AR/getBlipOrdering|getBlipOrdering]]
*[[AR/setBlipOrdering|setBlipOrdering]]
{{New items|3.0110|1.1|
*[[AR/getBlipVisibleDistance|getBlipVisibleDistance]]
*[[AR/setBlipVisibleDistance|setBlipVisibleDistance]]
}}
<noinclude>[[Category:Functions templates]]</noinclude>

AR/Server Scripting Functions

2012-09-29T15:35:03Z

TAPL: /* Announcement functions */

<pageclass class="server"></pageclass>
{{Adding_Pages_to_Categories_and_Templates}}
This page lists all the '''server-side''' scripting functions that have been implemented and are available as native functions. To request a function or event, use [[Requested Functions and Events]] or http://bugs.mtasa.com.

Please note that the scripting functions can also be extended by loading in dynamic modules that provide new functionality, such as utility functions. These scripting functions are non-native and require the module to be loaded in order to work.

Head over to [[Modules]] for a list of non-native serverside functions and modules that are available.

For more functions, check the [[Useful_Functions|useful functions page]].

'''Client-side scripting functions can be found here: [[Client Scripting Functions]].'''
__TOC__

==Account functions==
{{AR/Account_functions}}

==ACL functions==
{{AR/ACL_functions}}

==Admin functions==
{{AR/Admin_functions}}

==Audio functions==
{{AR/Audio_functions}}

==Blip functions==
{{AR/Blip_functions}}

==Camera functions==
{{AR/Camera functions}}

==Collision shape functions==
{{AR/Collision shape functions}}

==Clothes and body functions==
{{AR/Clothes and body functions}}

==Cursor functions==
{{AR/Cursor_functions}}

==Element functions==
{{AR/Element functions}}

==Event functions==
{{AR/Event_functions}}

==Explosion functions==
{{AR/Explosion_functions}}

==File functions==
{{AR/File_functions}}

==HTTP functions==
{{AR/HTTP_functions}}

==Input functions==
{{AR/Input_functions}}

==Map functions==
{{AR/Map_functions}}

==Marker functions==
{{AR/Marker functions}}

==Module functions==
{{AR/Module functions}}

==Object functions==
{{AR/Object functions}}

==Ped functions==
{{AR/Ped_functions}}

==Pickup functions==
{{AR/Pickup functions}}

==Player functions==
{{AR/Player functions}}

==Radar area functions==
{{AR/Radar area functions}}

==Resource functions==
{{AR/Resource functions}}

==Serial functions==
{{AR/Serial functions}}

==Server functions==
{{AR/Server functions}}

==Settings registry functions==
{{AR/Settings registry functions}}

==SQL functions==
{{AR/SQL_functions}}

==Team functions==
{{AR/Team functions}}

==Text functions==
{{AR/Text functions}}

==Utility functions==
{{AR/Utility functions}}

==Vehicle functions==
{{AR/Vehicle functions}}

==Water functions==
{{AR/Water functions}}

==Weapon functions==
{{AR/Weapon functions}}

==World functions==
{{AR/World functions}}

==XML functions==
{{AR/XML functions}}

[[en:Server Scripting Functions]]
[[es:Funciones_del_Server]]
[[de:Server-Seitige Scripting Funktionen]]

AR/Server Scripting Functions

2012-09-29T15:33:28Z

TAPL: /* Blip functions */

<pageclass class="server"></pageclass>
{{Adding_Pages_to_Categories_and_Templates}}
This page lists all the '''server-side''' scripting functions that have been implemented and are available as native functions. To request a function or event, use [[Requested Functions and Events]] or http://bugs.mtasa.com.

Please note that the scripting functions can also be extended by loading in dynamic modules that provide new functionality, such as utility functions. These scripting functions are non-native and require the module to be loaded in order to work.

Head over to [[Modules]] for a list of non-native serverside functions and modules that are available.

For more functions, check the [[Useful_Functions|useful functions page]].

'''Client-side scripting functions can be found here: [[Client Scripting Functions]].'''
__TOC__

==Account functions==
{{AR/Account_functions}}

==ACL functions==
{{AR/ACL_functions}}

==Admin functions==
{{AR/Admin_functions}}

==Audio functions==
{{AR/Audio_functions}}

==Announcement functions==
{{AR/Announce_functions}}

*[[AR/createBlip|createBlip]]
*[[AR/createBlipAttachedTo|createBlipAttachedTo]]
*[[AR/getBlipColor|getBlipColor]]
*[[AR/getBlipIcon|getBlipIcon]]
*[[AR/getBlipSize|getBlipSize]]
*[[AR/setBlipColor|setBlipColor]]
*[[AR/setBlipIcon|setBlipIcon]]
*[[AR/setBlipSize|setBlipSize]]
*[[AR/getBlipOrdering|getBlipOrdering]]
*[[AR/setBlipOrdering|setBlipOrdering]]
{{New items|3.0110|1.1|
*[[AR/getBlipVisibleDistance|getBlipVisibleDistance]]
*[[AR/setBlipVisibleDistance|setBlipVisibleDistance]]
}}
<noinclude>[[Category:Functions templates]]</noinclude>

==Camera functions==
{{AR/Camera functions}}

==Collision shape functions==
{{AR/Collision shape functions}}

==Clothes and body functions==
{{AR/Clothes and body functions}}

==Cursor functions==
{{AR/Cursor_functions}}

==Element functions==
{{AR/Element functions}}

==Event functions==
{{AR/Event_functions}}

==Explosion functions==
{{AR/Explosion_functions}}

==File functions==
{{AR/File_functions}}

==HTTP functions==
{{AR/HTTP_functions}}

==Input functions==
{{AR/Input_functions}}

==Map functions==
{{AR/Map_functions}}

==Marker functions==
{{AR/Marker functions}}

==Module functions==
{{AR/Module functions}}

==Object functions==
{{AR/Object functions}}

==Ped functions==
{{AR/Ped_functions}}

==Pickup functions==
{{AR/Pickup functions}}

==Player functions==
{{AR/Player functions}}

==Radar area functions==
{{AR/Radar area functions}}

==Resource functions==
{{AR/Resource functions}}

==Serial functions==
{{AR/Serial functions}}

==Server functions==
{{AR/Server functions}}

==Settings registry functions==
{{AR/Settings registry functions}}

==SQL functions==
{{AR/SQL_functions}}

==Team functions==
{{AR/Team functions}}

==Text functions==
{{AR/Text functions}}

==Utility functions==
{{AR/Utility functions}}

==Vehicle functions==
{{AR/Vehicle functions}}

==Water functions==
{{AR/Water functions}}

==Weapon functions==
{{AR/Weapon functions}}

==World functions==
{{AR/World functions}}

==XML functions==
{{AR/XML functions}}

[[en:Server Scripting Functions]]
[[es:Funciones_del_Server]]
[[de:Server-Seitige Scripting Funktionen]]

Template:AR/Blip functions

2012-09-29T15:33:23Z

TAPL:

==Blip functions==
{{AR/Blip_functions}}

AR/createBlip

2012-09-29T15:31:35Z

TAPL: /* See Also */

AR/createBlip

2012-09-29T15:31:05Z

TAPL: