Multi Theft Auto: Wiki - User contributions [en]

Resource:Dxscoreboard

2010-08-05T13:57:24Z

DakiLLa: Undo revision 24174 by ALeKS 007 (Talk)

{{Resource page}}
__NOTOC__
The DirectX scoreboard displays connected players, teams, pings and other data for players ingame. It also has a javascript-enabled web interface, so it can be viewed from a browser. It's created as a replacement for the old [[scoreboard]] resource created by [[User:jbeta|jbeta]].

The biggest difference to the old resource is that it is created fully using MTA's DirectX drawing functions.
When you add a column to the scoreboard, it's linked to the element data field of the same name, so if you add the "score" column, element data in the field "score" will be shown for all players and teams.

Download can be found at the [http://community.mtasa.com/index.php?p=resources&s=details&id=419 MTA community page].

==Exported functions/events==
<section name="Server" class="server" show="true">
===Functions===
<syntaxhighlight lang="lua">
bool scoreboardAddColumn ( string name, [ element forElement = getRootElement(), int width = 70, string friendlyName = name, int priority = slot after "name" column ] )
</syntaxhighlight>
*'''name:''' The column name (also the element data name used to get information from).
*'''forElement:''' The player to who the column should be added for.
*'''width:''' Width of the column in pixels.
*'''friendlyName:''' Friendly name (displayed in the scoreboard) of the column.
*'''priority:''' The priority slot of the column (1-500). If slot isn't free, the column in that slot will be pushed forward.
<br>

<syntaxhighlight lang="lua">
bool scoreboardRemoveColumn ( string name, [ element forElement = getRootElement() ] )
</syntaxhighlight>
*'''name:''' The column name.
*'''forElement:''' The player from who the column should be removed.
<br>

<syntaxhighlight lang="lua">
bool scoreboardClearColumns ( [ element forElement = getRootElement() ] )
</syntaxhighlight>
*'''forElement:''' The player whose scoreboard's columns should be cleared.
<br>

<syntaxhighlight lang="lua">
bool scoreboardResetColumns ( [ element forElement = getRootElement() ] )
</syntaxhighlight>
*'''forElement:''' The player whose scoreboard's columns should be reset (only leaves name and ping).
<br>

<syntaxhighlight lang="lua">
bool scoreboardSetForced ( bool forced, [ element forElement = getRootElement() ] )
</syntaxhighlight>
*'''forced:''' Should scoreboard be forced.
*'''forElement:''' The player whose scoreboard should be forced.
<br>

<syntaxhighlight lang="lua">
bool scoreboardSetSortBy ( string name, [ bool descending = true, element forElement = getRootElement() ] )
</syntaxhighlight>
*'''name:''' The column name. Can also be ''nil'' making the sorting be disabled.
*'''descending:''' Use descending sort.
*'''forElement:''' The player whose scoreboard should be sorted.
<br>

<syntaxhighlight lang="lua">
int scoreboardGetColumnPriority ( string name )
</syntaxhighlight>
*'''name:''' The column name.
'''Returns the column priority (1-500).'''
<br>

<syntaxhighlight lang="lua">
bool scoreboardSetColumnPriority ( string name, int priority, [ element forElement = getRootElement() ] )
</syntaxhighlight>
*'''name:''' The column name.
*'''priority:''' The priority slot of the column (1-500). If slot isn't free, the column in that slot will be pushed forward.
*'''forElement:''' The player to who the column should be added for.
<br>

<syntaxhighlight lang="lua">
int scoreboardGetColumnCount ()
</syntaxhighlight>
*''No arguments.''
'''Returns scoreboard column count.'''
<br>

<syntaxhighlight lang="lua">
bool scoreboardForceTeamsVisible( bool enabled )
</syntaxhighlight>
*'''enabled:''' Should the team header be always visible in the scoreboard (client's setting will be ignored)?
<br>

<syntaxhighlight lang="lua">
bool scoreboardForceTeamsHidden( bool enabled )
</syntaxhighlight>
*'''enabled:''' Should the team header be always hidden in the scoreboard (client's setting will be ignored)?
<br>

<syntaxhighlight lang="lua">
bool isPrioritySlotFree( int slot )
</syntaxhighlight>
*'''slot:''' The priority slot that should be checked.
'''Checks if the specified priority slot is free.'''
<br>

<syntaxhighlight lang="lua">
int getNextFreePrioritySlot( [ int startAt = 1 ] )
</syntaxhighlight>
*'''startAt:''' At which point should we start looking for free slots.
'''Finds the next free priority slot.'''
<br>

'''Note:''' These functions used in [[scoreboard]] resource do also work in dxscoreboard.
<syntaxhighlight lang="lua">
bool addScoreboardColumn ( string columnName, element visibleToElement, int columnPosition, float columnSize )
bool removeScoreboardColumn ( string columnName )
bool setPlayerScoreboardForced ( player thePlayer, bool forced )
bool resetScoreboardColumns ()
</syntaxhighlight>
</section>
<section name="Client" class="client" show="true">
===Functions===
<syntaxhighlight lang="lua">
bool scoreboardAddColumn ( string name, [ int width = 70, string friendlyName = name, int priority = slot after "name" column, function textFunction = nil ] )
</syntaxhighlight>
*'''name:''' The column name (also the element data name used to get information from).
*'''width:''' Width of the column in pixels.
*'''friendlyName:''' Friendly name (displayed in the scoreboard) of the column.
*'''priority:''' The priority slot of the column (1-500). If slot isn't free, the column in that slot will be pushed forward.
*'''textFunction:''' The text function used to process before displaying the content in the column. For example, this function would replace the "_"'s in player names with a space, if added to the "name" column.
<syntaxhighlight lang="lua">
function fixName( playerName )
return playerName:gsub( "_", " " )
end
</syntaxhighlight>
<br>

<syntaxhighlight lang="lua">
bool scoreboardRemoveColumn ( string name )
</syntaxhighlight>
*'''name:''' The column name.
<br>

<syntaxhighlight lang="lua">
bool scoreboardClearColumns ()
</syntaxhighlight>
*''No arguments.''
<br>

<syntaxhighlight lang="lua">
bool scoreboardResetColumns ()
</syntaxhighlight>
*''No arguments.''
<br>

<syntaxhighlight lang="lua">
bool scoreboardSetForced ( bool forced )
</syntaxhighlight>
*'''forced:''' Should scoreboard be forced.
<br>

<syntaxhighlight lang="lua">
bool scoreboardSetColumnTextFunction ( string name, function textFunction )
</syntaxhighlight>
*'''name:''' The column name.
*'''textFunction:''' The text function used to process before displaying the content in the column. For example, this function would replace the "_"'s in player names with a space, if added to the "name" column.
<syntaxhighlight lang="lua">
function fixName( playerName )
return playerName:gsub( "_", " " )
end
</syntaxhighlight>
<br>

<syntaxhighlight lang="lua">
bool scoreboardSetSortBy ( string name, [ bool descending = true ] )
</syntaxhighlight>
*'''name:''' The column name. Can also be ''nil'' making the sorting be disabled.
*'''descending:''' Use descending sort.
<br>

<syntaxhighlight lang="lua">
int scoreboardGetColumnPriority ( string name )
</syntaxhighlight>
*'''name:''' The column name.
'''Returns the column priority (1-500).'''
<br>

<syntaxhighlight lang="lua">
bool scoreboardSetColumnPriority ( string name, int priority )
</syntaxhighlight>
*'''name:''' The column name.
*'''priority:''' The priority slot of the column (1-500). If slot isn't free, the column in that slot will be pushed forward.
*'''forElement:''' The player to who the column should be added for.
<br>

<syntaxhighlight lang="lua">
int scoreboardGetColumnCount ()
</syntaxhighlight>
*''No arguments.''
'''Returns scoreboard column count.'''
<br>

<syntaxhighlight lang="lua">
bool isPrioritySlotFree( int slot )
</syntaxhighlight>
*'''slot:''' The priority slot that should be checked.
'''Checks if the specified priority slot is free.'''
<br>

<syntaxhighlight lang="lua">
int getNextFreePrioritySlot( [ int startAt = 1 ] )
</syntaxhighlight>
*'''startAt:''' At which point should we start looking for free slots.
'''Finds the next free priority slot.'''
<br>

<syntaxhighlight lang="lua">
int, int scoreboardGetTopCornerPosition ()
</syntaxhighlight>
'''Returns the absolute position of the scoreboards top corner if it's drawn, ''false'' otherwise.'''
<br>

<syntaxhighlight lang="lua">
int, int scoreboardGetSize ()
</syntaxhighlight>
'''Returns the absolute size (width, height) of the scoreboard if it's drawn, ''false'' otherwise.'''
<br>

<syntaxhighlight lang="lua">
table scoreboardGetSelectedRows ()
</syntaxhighlight>
'''Returns a table with all the selected rows (element, which can be either team or player). Can also return an empty table if rows are selected.''
<br>

'''Note:''' These functions used in [[scoreboard]] resource do also work in dxscoreboard.
<syntaxhighlight lang="lua">
bool setScoreboardForced ( bool forced )
</syntaxhighlight>

===Events===
====onClientPlayerScoreboardClick====
<syntaxhighlight lang="lua">
bool selected, int cursorX, int cursorY
</syntaxhighlight>
*'''selected:''' Was the current row selected (''true'') or unselected (''false'').
*'''cursorX:''' Absolute X position of the cursor.
*'''cursorY:''' Absolute Y position of the cursor.
'''Triggered when a player clicks team/player row with the left mouse button.'''<br>
'''Event ''source'' is the element was clicked, can be either [[player]] or [[team]].'''
</section>

You can call them from another resource using call()
<syntaxhighlight lang="lua">
call ( getResourceFromName ( "dxscoreboard" ), "scoreboardAddColumn", "Wanted level" )

-- Note that this syntax is also valid
exports.dxscoreboard:scoreboardAddColumn( "Wanted level" )
</syntaxhighlight>

You can set the scoreboard data with setElementData:
<syntaxhighlight lang="lua">
-- 3 is inserted in the player's wanted level column, if column
-- called "Wanted level" has been added in the scoreboard
setElementData ( player, "Wanted level", 3 )
</syntaxhighlight>

GetChatboxLayout

2010-07-23T14:00:27Z

DakiLLa:

__NOTOC__
{{Client function}}
{{Needs Checking|Returns a table now --[[User:Sebassje|Sebas]] 17:27, 8 May 2010 (UTC)}}
Returns information about how the chatbox looks.

==Syntax==
<syntaxhighlight lang="lua">int getChatboxLayout ( string CVar )</syntaxhighlight>

===Required Arguments===
*'''CVar:''' the name of the property you want returned. Can be the following values:
**'''chat_font''' - Returns the chatbox font
**'''chat_lines''' - Returns how many lines the chatbox has
**'''chat_color''' - Returns the background color of the chatbox
**'''chat_text_color''' - Returns the chatbox text color
**'''chat_input_color''' - Returns the background color of the chatbox input
**'''chat_input_prefix_color''' - Returns the color of the input prefix text
**'''chat_input_text_color''' - Returns the color of the text in the chatbox input
**'''chat_scale''' - Returns the scale of the text in the chatbox
**'''chat_width''' - Returns the scale of the background width
**'''chat_css_style_text''' - Returns whether text fades out over time
**'''chat_css_style_background''' - Returns whether the background fades out over time
**'''chat_line_life''' - Returns how long it takes for text to start fading out
**'''chat_line_fade_out''' - Returns how long takes for text to fade out
**'''chat_use_cegui''' - Returns whether CEGUI is used to render the chatbox
**'''text_scale''' - Returns text scale

===Returns===
*4 numbers if the CVar contains "color"
*2 numbers if '''chat_scale''' was entered
*1 number if any other CVar was specified
*''false'' if an invalid CVar was specified

==Example==
This code makes the chatbox empty when you type /clear
<syntaxhighlight lang="lua">
addCommandHandler("clear",
function ()
local lines = getChatboxLayout()["chat_lines"]
for i=1,lines do
outputChatBox("")
end
end
)
</syntaxhighlight>

==See Also==
{{GUI_functions}}

SetPedAnimation

2009-08-08T19:57:06Z

DakiLLa: /* Example */

__NOTOC__
{{Server client function}}

Sets the current animation of a player or ped. Not specifying the type of animation will automatically cancel the current one.

==Syntax==
<syntaxhighlight lang="lua">
bool setPedAnimation ( ped thePed [, string block=nil, string anim=nil, int time=-1, bool loop=true, bool updatePosition=true, bool interruptable=true] )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the player or ped you want to apply an animation to.

===Optional Arguments===
{{OptionalArg}}
*'''block:''' the [[Animations|animation]] block's name.
*'''anim:''' the name of the [[Animations|animation]] within the block.
*'''time:''' how long the animation will run for.
*'''loop:''' indicates whether or not the animation will loop.
*'''updatePosition:''' will change the actual coordinates of the ped according to the animation. Use this for e.g. walking animations.
*'''interruptable:''' if set to 'false' other tasks wont be able to interupt the animation.

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

==Example==

<section name="Server" class="server" show="true">
This example creates a ped, rotates him, and makes him walk:
<syntaxhighlight lang="lua">
function makePed()
ped1 = createPed(56, 1, 1, 4)
setPedRotation(ped1, 315)
setPedAnimation( ped1, "ped", "WOMAN_walknorm")
end
addCommandHandler("makemyped", makePed)
</syntaxhighlight>
</section>

==See Also==
{{Ped_functions}}

RU/Weather

2009-08-06T19:56:31Z

DakiLLa:

Погоду можно изменить используя [[setWeather]] и [[setWeatherBlended]].
{{New feature|3|1.0|
Смешанная погода под ID 20 и 255 так же поддерживается.
}}

==ID погоды==
* '''0 до 7:''' Различные версии голубого неба / облаков
* '''8:''' Гроза
* '''9:''' Туман и облачно
* '''10:''' Чистое голубое небо
* '''11:''' Палящее солнце (смог в Лос Сантосе)
* '''12 до 15:''' Пасмурная, бесцветная погода
* '''16:''' Пасмурно, дождливо
* '''17, 18:''' Палящее солнце
* '''19:''' Песчаная буря

SetElementAttachedOffsets

2009-08-05T07:55:02Z

DakiLLa:

__NOTOC__
{{Server client function}}
This function updates the offsets of an element that has been attached to another element using [[attachElements]].

==Syntax==
<syntaxhighlight lang="lua">
bool setElementAttachedOffsets ( element theElement, [ float xPosOffset, float yPosOffset, float zPosOffset, float xRotOffset, float yRotOffset, float zRotOffset ])
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The attached element.

===Optional Arguments===
{{OptionalArg}}
*'''xPosOffset:''' The x offset, if you want the elements to be a certain distance from one another (default 0).
*'''yPosOffset:''' The y offset (default 0).
*'''zPosOffset:''' The z offset (default 0).
*'''xRotOffset:''' The x rotation offset (default 0).
*'''yRotOffset:''' The y rotation offset (default 0).
*'''zRotOffset:''' The z rotation offset (default 0).

===Returns===
Returns ''true'' if the attaching process was successful, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
'''Example:''' This example creates a car with a minigun
<syntaxhighlight lang="lua">
-- Offsets
local x,y,z,rx,ry,rz= 0,-1.5,-0.1,0,0,-90

function createArmedBobcat(cmd)
local lx,ly,lz = getElementPosition(getLocalPlayer()) -- get the position of the player
lx = lx + 5 -- add 5 units to the x position

veh = createVehicle( 422, lx, ly, lz) -- create a bobcat
base = createObject( 2985, 2,2,2) -- create a minigun_base object
setElementCollisionsEnabled ( base, false ) -- the minigun_base damages the car
-- you could alternatively load an empty col file for the minigun object
attachElements ( base, veh, x,y,z,rx,ry,rz) -- attach the base to the bobcat
end

function rotateIt(cmd, addZ)
if(addZ) then
rz=rz+addZ
setElementAttachedOffsets (base,x,y,z,rx,ry,rz) --update offsets
end
end

addCommandHandler("bobcat", createArmedBobcat)
addCommandHandler("rotate", rotateIt)
</syntaxhighlight>
</section>
==See Also==
{{Element functions}}

SetElementAttachedOffsets

2009-07-20T22:17:33Z

DakiLLa:

__NOTOC__
{{Client function}}
This function updates the offsets of an element that has been attached to another element using [[attachElements]].

==Syntax==
<syntaxhighlight lang="lua">
bool setElementAttachedOffsets ( element theElement, [ float xPosOffset, float yPosOffset, float zPosOffset, float xRotOffset, float yRotOffset, float zRotOffset ])
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The attached element.

===Optional Arguments===
{{OptionalArg}}
*'''xPosOffset:''' The x offset, if you want the elements to be a certain distance from one another (default 0).
*'''yPosOffset:''' The y offset (default 0).
*'''zPosOffset:''' The z offset (default 0).
*'''xRotOffset:''' The x rotation offset (default 0).
*'''yRotOffset:''' The y rotation offset (default 0).
*'''zRotOffset:''' The z rotation offset (default 0).

===Returns===
Returns ''true'' if the attaching process was successful, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
'''Example:''' This example creates a car with a minigun
<syntaxhighlight lang="lua">
-- Offsets
local x,y,z,rx,ry,rz= 0,-1.5,-0.1,0,0,-90

function createArmedBobcat(cmd)
local lx,ly,lz = getElementPosition(getLocalPlayer()) -- get the position of the player
lx = lx + 5 -- add 5 units to the x position

veh = createVehicle( 422, lx, ly, lz) -- create a bobcat
base = createObject( 2985, 2,2,2) -- create a minigun_base object
setElementCollisionsEnabled ( base, false ) -- the minigun_base damages the car
-- you could alternatively load an empty col file for the minigun object
attachElements ( base, veh, x,y,z,rx,ry,rz) -- attach the base to the bobcat
end

function rotateIt(cmd, addZ)
if(addZ) then
rz=rz+addZ
setElementAttachedOffsets (base,x,y,z,rx,ry,rz) --update offsets
end
end

addCommandHandler("bobcat", createArmedBobcat)
addCommandHandler("rotate", rotateIt)
</syntaxhighlight>
</section>
==See Also==
{{Element functions}}

RU/Garage

2009-07-10T08:36:45Z

DakiLLa:

Любой гараж в Сан Андреасе может быть открыт или закрыт с помощью функции [[setGarageOpen]].

Идентификаторы гаражей и их описания изложены в списке ниже:

* '''0:''' Commerce Region, Loading Bay Garage (Life's a Beach)
* '''1:''' LSPD Police Impound Garage
* '''2:''' Mission Garage near El Corona (Los Desperados)
* '''3:''' Eight Ball Autos near El Corona
* '''4:''' Mission Garage near El Corona (Cesar Vialpando)
* '''5:''' Player Garage: El Corona
* '''6:''' LS Burglary Garage near Playe del Seville
* '''7:''' LowRider Tuning Garage in Willowfield
* '''8:''' Pay 'n' Spray in Idlewood
* '''9:''' Player Garage: Johnson House
* '''10:''' Transfender in Temple
* '''11:''' Pay 'n' Spray in Temple
* '''12:''' Pay 'n' Spray in Santa Maria Beach
* '''13:''' Player Garage: Santa Maria Beach
* '''14:''' Player Garage: Mulholland
* '''15:''' Wheel Archangels in Ocean Flats
* '''16:''' Mission Garage in Ocean Flats (T-Bone Mendez)
* '''17:''' Player Garage: Hashbury
* '''18:''' Transfender near Wang Cars in Doherty
* '''19:''' Pay 'n' Spray near Wang Cars in Doherty
* '''20:''' SF Burglary Garage, Loading Bay near Doherty
* '''21:''' Player Garage: Doherty
* '''22:''' Mission Garage in Doherty Garage
* '''23:''' Woozie's Mission Garage in Chinatown (Ran Fa Li)
* '''24:''' Michelle's Pay 'n' Spray in Downtown
* '''25:''' Player Garage: Calton Heights
* '''26:''' SFPD Police Impound Garage
* '''27:''' Pay 'n' Spray in Juniper Hollow
* '''28:''' Player Garage: Paradiso
* '''29:''' LVPD Police Impound Garage
* '''30:''' Airport Plane Garage in Las Venturas
* '''31:''' LV Burglary Garage near Camel's Toe
* '''32:''' Pay 'n' Spray near Royal Casino
* '''33:''' Transfender in come-a-lot
* '''34:''' Player Garage: Rockshore West
* '''35:''' Welding Wedding Bomb-workshop in Emerald Isle
* '''36:''' Pay 'n' Spray in Redsands East
* '''37:''' Player Garage: Redsands West
* '''38:''' Player Garage: Prickle Pine
* '''39:''' Player Garage: Whitewood Estates
* '''40:''' Pay 'n' Spray in El Quebrados
* '''41:''' Pay 'n' Spray in Fort Carson
* '''42:''' Player Garage: Fort Carson
* '''43:''' Player Garage: Verdant Meadows
* '''44:''' Mission Garage in El Castillo del Diablo (Interdiction)
* '''45:''' Airport Garage in Verdant Meadows
* '''46:''' Mission Garage in Angel Pine (Puncture Wounds)
* '''47:''' Pay 'n' Spray in Dillimore
* '''48:''' Player Garage: Palomino Creek
* '''49:''' Player Garage: Dillimore

==See Also==
[[id]]

GuiSetProperty

2009-06-29T08:13:19Z

DakiLLa: /* Example */

{{Client function}}
__NOTOC__
This function sets the value of a specific CEGUI property of a GUI element. For a list of properties and their meaning, see the [http://www.cegui.org.uk/wiki/index.php/SetProperty_(WindowsLook) CEGUI properties wiki page].

==Syntax==
<syntaxhighlight lang="lua">
bool guiSetProperty ( element guiElement, string property, string value )
</syntaxhighlight>

===Required Arguments===
*'''guiElement:''' the GUI element you wish to get a property of.
*'''property:''' the name of of property you want the value of.
*'''value:''' the new value for the property.

===Returns===
If the function succeeds it returns ''true'', if it fails it returns ''false''.

==Example==
This example creates a button when the resource starts and defines a console command that toggles it between enabled (clickable) and disabled (not clickable).
<syntaxhighlight lang="lua">

function onStart()
button = guiCreateButton( 20, 200, 150, 30, "Test", false )
end
addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource() ), onStart )

function toogleButton()
local currentState = guiGetProperty( button, "Disabled" )
if currentState == "False" then
guiSetProperty( button, "Disabled", "True" )
else
guiSetProperty( button, "Disabled", "False" )
end
end
addCommandHandler( "togglebtn", toogleButton )
</syntaxhighlight>

==See Also==
{{GUI functions}}

GuiSetProperty

2009-06-29T08:11:46Z

DakiLLa: /* Example */

{{Client function}}
__NOTOC__
This function sets the value of a specific CEGUI property of a GUI element. For a list of properties and their meaning, see the [http://www.cegui.org.uk/wiki/index.php/SetProperty_(WindowsLook) CEGUI properties wiki page].

==Syntax==
<syntaxhighlight lang="lua">
bool guiSetProperty ( element guiElement, string property, string value )
</syntaxhighlight>

===Required Arguments===
*'''guiElement:''' the GUI element you wish to get a property of.
*'''property:''' the name of of property you want the value of.
*'''value:''' the new value for the property.

===Returns===
If the function succeeds it returns ''true'', if it fails it returns ''false''.

==Example==
This example creates a button when the resource starts and defines a console command that toggles it between enabled (clickable) and disabled (not clickable).
<syntaxhighlight lang="lua">

function onStart()
button = guiCreateButton( 20, 200, 150, 30, "Test", false )
end
addEventHandler( "onClientResourceStart", getResourceRootElement(getThisResource()), onStart )

function toogleButton()
local currentState = guiGetProperty(button, "Disabled")
if currentState == "False" then
guiSetProperty(button, "Disabled", "True")
else
guiSetProperty(button, "Disabled", "False")
end
end
addCommandHandler("togglebtn", toogleButton )
</syntaxhighlight>

==See Also==
{{GUI functions}}

GiveWeapon

2009-06-17T09:26:14Z

DakiLLa:

__NOTOC__
{{Server function}}
giveWeapon gives a specified weapon to a certain player or ped. There is an optional argument to specify ammunition. For example, a melee weapon doesn't need an ammo argument.

==Syntax==
<syntaxhighlight lang="lua">giveWeapon ( player thePlayer, int weapon, [ int ammo=30, bool setAsCurrent=false ] )</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' A [[player]] object referencing the specified player
*'''weapon:''' A whole number integer that refers to a [[Weapon]] ID. Click [[Weapon|here]] for a list of possible weapon IDs.

===Optional Arguments===
{{OptionalArg}}
*'''ammo:''' A whole number integer serving as the ammo amount for the given weapon. For weapons that do not require ammo, such as melee, this should be at least 1.
*'''setAsCurrent:''' A boolean value determining whether or not the weapon will be set as the players current.

==Example==
'''Example 1:''' This example gives a player an M4 with 200 ammo whenever they spawn.
<syntaxhighlight lang="lua">
function giveWeaponsOnSpawn ( theSpawnpont, theTeam )
giveWeapon ( source, 31, 200 ) -- Gives the M4 weapon with 200 ammo
end
addEventHandler ( "onPlayerSpawn", getRootElement(), giveWeaponsOnSpawn ) -- attach the event handler
</syntaxhighlight>

'''Example 2:''' This example adds a "give" command in console which allows giving of any weapon by entering "give <id> <amount>".
<syntaxhighlight lang="lua">
function consoleGive ( thePlayer, commandName, weaponID, ammo )
local status = giveWeapon ( thePlayer, weaponID, ammo, true ) -- attempt to give the weapon, forcing it as selected weapon
if ( not status ) then -- if it was unsuccessful
outputConsole ( "Failed to give weapon.", thePlayer ) -- tell the player
end
end
addCommandHandler ( "give", consoleGive )
</syntaxhighlight>

'''Example 3:''' This example creates a ped in certain coordinates. You can give him a weapon with "give <weaponID> <amount>" command in console.
<syntaxhighlight lang="lua">
ped = createPed( 19, -1634.5775, 1203.85, 7.1796 );

addCommandHandler( "give",
function ( player, command, id, amount )
if not id then return end
giveWeapon( ped, id, amount, true )
end
)
</syntaxhighlight>

==See Also==
{{Weapon functions}}

GiveWeapon

2009-06-17T09:22:13Z

DakiLLa:

RU/Resource:Admin

2009-06-17T09:02:55Z

DakiLLa:

{{RU/Resource page}}
Небольшой учебник по установке привилегий админов в ресурсе 'admin'.

'''Важно:''' Сервер должен быть остановлен перед тем, как вы будете редактировать файлы, указанные ниже.

В начале, откроем файл '''accounts.xml''', расположенный по адресу '''server\mods\deathmatch\''' и добавим строчку с данными вашего аккаунта, как показано на рисунке ниже:

[[Image:admin_accounts.png]]

Затем, откроем файл '''acl.xml''' расположенный в той же самой директории и добавим себя как объект в группу Admin, используя синтаксис 'user.*', где * (звездочка) - имя вашего аккаунта.

[[Image:admin_acl.png]]

Теперь откроем файл '''mtaserver.conf''' и прокрутим колесиком мышки в самый низ файла. Убедитесь, что в нем находится строчка, указанная на рисунке ниже. Так же проверьте, добавлен ли ресурс Admin в директорию ресурсов.

[[Image:admin_mtaserver.png]]

Все готово для того проверить ваш админ-статус на сервере. Подключитесь к вашему серверу, войдите в свой аккаунт, используя команду /login [имя_пользователя] <пароль> (вводить без [] и <>). Если вы увидели надпись в чат-боксе о том, что нажатием кнопки 'P' можно открыть вашу админ панель, ("Press 'p' to open your admin panel"), значит вы все сделали верно! Если нет, попробуйте пройти по всем шагам этого учебника еще раз.
[[Category:Scripting Concepts]]

ProcessLineOfSight

2009-06-12T19:21:21Z

DakiLLa: /* Example */

{{Client function}}
__NOTOC__
This function checks if there is anything between 2 points in the world, and if there is, tells you where and what. The two positions '''must''' be within the local player's draw distance as the collision data is not loaded outside this area.

This function is useful for checking for collisions and for editor-style scripts. If you wish to get an element that's positioned at a particular point on the screen, use this function combined with [[getWorldFromScreenPosition]].

==Syntax==
<syntaxhighlight lang="lua">
bool float float float element processLineOfSight ( float startX, float startY, float startZ, float endX, float endY, float endZ, [ bool checkBuildings = true, bool checkVehicles = true, bool checkPlayers = true, bool checkObjects = true, bool checkDummies = true, bool seeThroughStuff = false, bool ignoreSomeObjectsForCamera = false, bool shootThroughStuff = false, element ignoredElement = nil ] )
</syntaxhighlight>

===Required Arguments===
*'''startX:''' The start ''x'' position
*'''startY:''' The start ''y'' position
*'''startZ:''' The start ''z'' position
*'''endX:''' The end ''x'' position
*'''endY:''' The end ''y'' position
*'''endZ:''' The end ''z'' position

===Optional Arguments===
{{OptionalArg}}
*'''checkBuildings:''' Allow the line of sight to be blocked by GTA's internally placed buildings, i.e. the world map.
*'''checkVehicles:''' Allow the line of sight to be blocked by [[Vehicle|vehicles]].
*'''checkPlayers:''' Allow the line of sight to be blocked by [[Player|players]].
*'''checkObjects:''' Allow the line of sight to be blocked by [[Object|objects]].
*'''checkDummies:''' Allow the line of sight to be blocked by GTA's internal dummies. These are not used in the current MTA version so this argument can be set to ''false''.
*'''seeThroughStuff:''' Allow the line of sight to be blocked by translucent game objects, e.g. glass.
*'''ignoreSomeObjectsForCamera:''' Allow the line of sight to be blocked by certain objects.
*'''shootThroughStuff:''' Allow the line of sight to be blocked by things that can be shot through
*'''ignoredElement:''' Allow the line of sight to pass through a certain specified element.

===Returns===
If there is a collision, the function will return ''true'', the collision position and MTA element hit. If no element is hit, the element return value will be ''nil''. If there is no collision the function will return ''false''.

==Example==
This example shows how you can tell what position and element the camera is looking at, up to 50 units away.
<syntaxhighlight lang="lua">
local w, h = guiGetScreenSize ()
local tx, ty, tz = getWorldFromScreenPosition ( w/2, h/2, 50 )
local px, py, pz = getCameraMatrix()
hit, x, y, z, elementHit = processLineOfSight ( px, py, pz, tx, ty, tz )
if hit then
outputChatBox ( "Looking at " .. x .. ", " .. y .. ", " .. z )
if elementHit then
outputChatBox ( "Hit element " .. getElementType(elementHit) )
end
end
</syntaxhighlight>

==See Also==
{{Client world functions}}

ProcessLineOfSight

2009-06-12T19:21:09Z

DakiLLa: /* Example */

{{Client function}}
__NOTOC__
This function checks if there is anything between 2 points in the world, and if there is, tells you where and what. The two positions '''must''' be within the local player's draw distance as the collision data is not loaded outside this area.

This function is useful for checking for collisions and for editor-style scripts. If you wish to get an element that's positioned at a particular point on the screen, use this function combined with [[getWorldFromScreenPosition]].

==Syntax==
<syntaxhighlight lang="lua">
bool float float float element processLineOfSight ( float startX, float startY, float startZ, float endX, float endY, float endZ, [ bool checkBuildings = true, bool checkVehicles = true, bool checkPlayers = true, bool checkObjects = true, bool checkDummies = true, bool seeThroughStuff = false, bool ignoreSomeObjectsForCamera = false, bool shootThroughStuff = false, element ignoredElement = nil ] )
</syntaxhighlight>

===Required Arguments===
*'''startX:''' The start ''x'' position
*'''startY:''' The start ''y'' position
*'''startZ:''' The start ''z'' position
*'''endX:''' The end ''x'' position
*'''endY:''' The end ''y'' position
*'''endZ:''' The end ''z'' position

===Optional Arguments===
{{OptionalArg}}
*'''checkBuildings:''' Allow the line of sight to be blocked by GTA's internally placed buildings, i.e. the world map.
*'''checkVehicles:''' Allow the line of sight to be blocked by [[Vehicle|vehicles]].
*'''checkPlayers:''' Allow the line of sight to be blocked by [[Player|players]].
*'''checkObjects:''' Allow the line of sight to be blocked by [[Object|objects]].
*'''checkDummies:''' Allow the line of sight to be blocked by GTA's internal dummies. These are not used in the current MTA version so this argument can be set to ''false''.
*'''seeThroughStuff:''' Allow the line of sight to be blocked by translucent game objects, e.g. glass.
*'''ignoreSomeObjectsForCamera:''' Allow the line of sight to be blocked by certain objects.
*'''shootThroughStuff:''' Allow the line of sight to be blocked by things that can be shot through
*'''ignoredElement:''' Allow the line of sight to pass through a certain specified element.

===Returns===
If there is a collision, the function will return ''true'', the collision position and MTA element hit. If no element is hit, the element return value will be ''nil''. If there is no collision the function will return ''false''.

==Example==
This example shows how you can tell what position and element the camera is looking at, up to 50 units away.
<syntaxhighlight lang="lua">
local w, h = guiGetScreenSize ()
local tx, ty, tz = getWorldFromScreenPosition ( w/2, h/2, 50 )
local px, py, pz = [http://http://development.mtasa.com/index.php?title=GetCameraMatrix getCameraMatrix()]
hit, x, y, z, elementHit = processLineOfSight ( px, py, pz, tx, ty, tz )
if hit then
outputChatBox ( "Looking at " .. x .. ", " .. y .. ", " .. z )
if elementHit then
outputChatBox ( "Hit element " .. getElementType(elementHit) )
end
end
</syntaxhighlight>

==See Also==
{{Client world functions}}

ProcessLineOfSight

2009-06-12T19:19:42Z

DakiLLa: /* Example */

Interior IDs

2009-05-21T15:51:18Z

DakiLLa:

San Andreas Interior ID list.
<br>
<br>
*'''ID 0:'''
{| class="prettytable" style="width:50%;"
|-
| '''Normal world''' ||
|-
|}
<br>
*'''ID 1:'''
{| class="prettytable" style="width:50%;"
|-
| '''Ammu-nation 1''' || 289.7870 || -35.7190 || 1003.5160
|-
| '''Burglary House''' ||
|-
| '''Cafe shop (Catalina?)''' || 681.65 || -452.86 || -25.62
|-
| '''Restaurant 1''' || 446.6941 || -9.7977 || 1000.7340
|-
| '''Caligulas Casino''' || 2235.2524 || 1708.5146 || 1010.6129
|-
| '''Denise's Place''' || 244.0892 || 304.8456 || 999.1484
|-
| '''Shamal cabin''' || 1.6127 || 34.7411 || 1199.0
|-
| '''Liberty City''' || -750.80 || 491.00 || 1371.70
|-
| '''Sweet's House''' || 2525.0420 || -1679.1150 || 1015.4990
|-
| '''Transfender''' || 621.7850 || -12.5417 || 1000.9220
|-
| '''Safe House 4''' || 2216.5400 || -1076.2900 || 1050.4840
|-
| '''Trials Stadium''' ||
|-
| '''Warehouse 1''' || 1405.3120 || -8.2928 || 1000.9130
|-
| '''Doherty Garage''' || -2042.42 || 178.59 || 28.84 ||
|-
| '''Sindacco Abatoir''' || 963.6078 || 2108.3970 || 1011.0300
|-
| '''Sub Urban''' || 203.8173 || -46.5385 || 1001.8050
|-
| '''Wu Zi Mu's Betting place''' || -2159.9260 || 641.4587 || 1052.3820
|-
|}
<br>
*'''ID 2:'''
{| class="prettytable" style="width:50%;"
|-
| '''Ryder's House''' || 2464.2110 || -1697.9520 || 1013.5080
|-
| '''Angel Pine Trailer''' || 0.3440 || -0.5140 || 1000.5490¨
|-
| '''The Pig Pen''' || 1213.4330 ||-6.6830 || 1000.9220
|-
| '''BDups Crack Palace''' || 1523.7510 || -46.0458 || 1002.1310
|-
| '''Big Smoke's Crack Palace''' || 2543.6610 || -1303.9320 || 1025.0700
|-
| '''Burglary House 2''' ||
|-
| '''Burglary House 9''' ||
|-
| '''Burglary House 10''' ||
|-
| '''Katie's Place''' || 267.2290 || 304.7100 || 999.1480
|-
| '''Loco Low Co.''' || 612.5910 || -75.6370 || 997.9920
|-
| '''Reece's Barbershop''' || 612.5910 || -75.6370 || 997.9920
|-
|}

<br>
*'''ID 3:'''
{| class="prettytable" style="width:50%;"
|-
| '''Jizzy's Pleasure Domes''' || -2636.7190 || 1402.9170 || 906.4609
|-
| '''Brothel''' || 940.6520 || -18.4860 || 1000.9300
|-
| '''Brothel 2''' || 967.5334 || -53.0245 || 1001.1250
|-
| '''BDups Apartment''' || 1527.38 || -11.02 || 1002.10
|-
| '''Bike School''' || 1494.3350 || 1305.6510 || 1093.2890
|-
| '''Big Spread Ranch''' || 1210.2570 || -29.2986 || 1000.8790
|-
| '''LV Tattoo Parlour''' || -204.4390 || -43.6520 || 1002.2990
|-
| '''LVPD HQ''' || 289.7703 || 171.7460 || 1007.1790
|-
| '''OG Loc's House''' || 516.8890 || -18.4120 || 1001.5650
|-
| '''Pro-Laps''' || 207.3560 || -138.0029 || 1003.3130
|-
| '''Las Venturas Planning Dep.''' || 374.6708 || 173.8050 || 1008.3893
|-
| '''Record Label Hallway''' || 1038.2190 || 6.9905 || 1001.2840
|-
| '''Driving School''' || -2027.9200 || -105.1830 || 1035.1720
|-
| '''Johnson House''' || 2496.0500 || -1693.9260 || 1014.7420
|-
| '''Budget Inn Motel Room''' ||
|-
| '''Burglary House 1''' ||
|-
| '''Gay Gordo's Barbershop''' || 418.6530 || -82.6390 || 1001.8050
|-
| '''Helena's Place''' || 292.4459 || 308.7790 || 999.1484
|-
| '''Inside Track Betting''' || 826.8863 || 5.5091 || 1004.4830
|-
| '''Sex Shop''' || -106.7268 || -19.6444 || 1000.7190
|-
| '''Wheel Arch Angels''' || 614.3889 || -124.0991 || 997.9950
|-
|}

<br>
*'''ID 4:'''
{| class="prettytable" style="width:50%;"
|-
| '''24/7 shop 1''' || -27.3769 || -27.6416 || 1003.5570
|-
| '''Ammu-Nation 2''' || 285.8000 || -84.5470 || 1001.5390
|-
| '''Burglary House 12''' ||
|-
| '''Burglary House 13''' ||
|-
| '''Burglary House 15''' ||
|-
| '''Diner 2''' ||
|-
| '''Dirtbike Stadium''' || -1435.8690 || -662.2505 || 1052.4650
|-
| '''Michelle's Place''' || 302.6404 || 304.8048 || 999.1484
|-
|}

<br>
*'''ID 5:'''
{| class="prettytable" style="width:50%;"
|-
| '''Madd Dogg's Mansion''' || 1272.9116 || -768.9028 || 1090.5097
|-
| '''Well Stacked Pizza Co.''' || 377.7758 || -126.2766 || 1001.4920
|-
| '''Victim''' || 221.3310 || -6.6169 || 1005.1977
|-
| '''Burning Desire House''' || 2351.1540 || -1180.5770 || 1027.9770
|-
| '''Barbara's Place''' ||
|-
| '''Burglary House 11''' ||
|-
| '''Burglary House 16''' ||
|-
| '''Burglary House 17''' ||
|-
| '''The Crack Den''' || 322.1117 || 1119.3270 || 1083.8830
|-
| '''Police Station (Barbara's)''' || 322.72 || 306.43 || 999.15
|-
| '''Diner place''' || 448.7435 || -110.0457 || 1000.0772
|-
| '''Ganton Gym''' || 768.0793 || 5.8606 || 1000.7160
|-
| '''Vank Hoff Hotel ''' || 2232.8210 || -1110.0180 || 1050.8830
|-
|}

<br>
*'''ID 6:'''
{| class="prettytable" style="width:50%;"
|-
| '''Ammu-Nation 3''' || 297.4460 || -109.9680 || 1001.5160
|-
| '''Ammu-Nation 4''' || 317.2380 || -168.0520 || 999.5930
|-
| '''LSPD HQ ''' || 246.4510 || 65.5860 ||1003.6410
|-
| '''Safe House 3''' || 2333.0330 || -1073.9600 || 1049.0230
|-
| '''Safe House 5''' || 2194.2910 || -1204.0150 || 1049.0230
|-
| '''Safe House 6''' || 2308.8710 || -1210.7170 || 1049.0230
|-
| '''Cobra Marital Arts Gym''' || 774.0870 ||-47.9830 || 1000.5860
|-
| '''24/7 shop 2''' || -26.7180 || -55.9860 || 1003.5470
|-
| '''Millie's Bedroom''' || 344.5200 || 304.8210 || 999.1480
|-
| '''Fanny Batter's Brothel''' || 744.2710 || 1437.2530 || 1102.7030
|-
| '''Restaurant 2''' || 443.9810 || -65.2190 || 1050.0000
|-
|}

<br>
*'''ID 7:'''
{| class="prettytable" style="width:50%;"
|-
| '''Ammu-Nation 5 (2 Floors)''' || 315.3850 || -142.2420 || 999.6010
|-
| '''8-Track Stadium''' || -1417.8720 || -276.4260 || 1051.1910
|-
| '''Burglary House 4''' ||
|-
| '''Below the Belt Gym''' || 774.2430 || -76.0090 || 1000.6540
|-
|}

<br>
*'''ID 8:'''
{| class="prettytable" style="width:50%;"
|-
| '''Safe house 2''' ||
|-
| '''Colonel Fuhrberger's House''' || 2807.8990 || -1172.9210 || 1025.5700
|-
|}

<br>
*'''ID 9:'''
{| class="prettytable" style="width:50%;"
|-
| '''Onbekend safe house''' || 2253.1740 || -1139.0100 || 1050.6330
|-
| '''Andromada Cargo hold''' || 315.48 || 984.13 || 1959.11
|-
|}

<br>
*'''ID 10:'''
{| class="prettytable" style="width:50%;"
|-
| '''Four Dragons Casino''' || 2009.4140 || 1017.8990 || 994.4680
|-
| '''RC Zero's Battlefield''' || -975.5766 || 1061.1312 || 1345.6719
|-
| '''Burger Shot''' || 366.4220 ||-73.4700 || 1001.5080
|-
| '''Burglary House 14''' ||
|-
| '''Janitor room''' || 1891.3960 ||1018.1260 || 31.8820
|-
| '''Safe House 1''' ||
|-
| '''Hashbury safe house''' || 2264.5231 || -1210.5229 || 1049.0234
|-
| '''24/7 shop 3''' || 6.0780 || -28.6330 || 1003.5490
|-
| '''Abandoned AC Tower''' || 419.6140 || 2536.6030 || 10.0000
|-
| '''SFPD HQ''' || 246.4410 || 112.1640 || 1003.2190
|-
|}

<br>
*'''ID 11:'''
{| class="prettytable" style="width:50%;"
|-
| '''The Four Dragons Office''' || 2011.6030 || 1017.0230 || 39.0910
|-
| '''Los Santos safe house''' ||
|-
| '''Ten Green Bottles Bar''' || 502.3310 || -70.6820 || 998.7570
|-
|}

<br>
*'''ID 12:'''
{| class="prettytable" style="width:50%;"
|-
| '''Budget Inn Motel Room''' ||
|-
| '''The Casino''' || 1132.9450 || -8.6750 || 1000.6800
|-
| '''Macisla's Barbershop''' || 411.6410 || -51.8460 || 1001.8980
|-
| '''Safe house 7''' || 2237.2970 || -1077.9250 || 1049.0230
|-
| '''Modern safe house''' || 2324.4990 || -1147.0710 || 1050.7100
|-
|}

<br>
*'''ID 13:'''
{| class="prettytable" style="width:50%;"
|-
|'''LS Atrium''' || 1724.33 || -1625.784 || 20.211
|-
|'''CJ's Garage''' || -2043.966 || 172.932 || 28.835
|-
|}

<br>
*'''ID 14:'''
{| class="prettytable" style="width:50%;"
|-
| '''Kickstart Stadium''' || -1464.5360 || 1557.6900 || 1052.5310
|-
| '''Didier Sachs''' || 204.1789 || -165.8740 || 1000.5230
|-
| '''Francis Int. Airport (Front ext.)''' || -1827.1473 || 7.2074 || 1061.1435
|-
| '''Francis Int. Airport (Baggage Claim/Ticket Sales)''' || -1855.5687 || 41.2631 || 1061.1435
|-
| '''Wardrobe''' || 255.7190 || -41.1370 || 1002.0230
|-
|}

<br>
*'''ID 15:'''
{| class="prettytable" style="width:50%;"
|-
| '''Binco''' || 207.5430 || -109.0040 || 1005.1330
|-
| '''Blood Bowl Stadium''' || -1394.20 || 987.62 || 1023.96
|-
| '''Jefferson Motel''' || 2217.6250 || -1150.6580 || 1025.7970
|-
| '''Burglary House 5''' ||
|-
| '''Burglary House 6''' ||
|-
| '''Burglary House 7''' ||
|-
| '''Burglary House 8''' ||
|-
|}

<br>
*'''ID 16:'''
{| class="prettytable" style="width:50%;"
|-
| '''24/7 shop 4''' || -25.3730 || -139.6540 || 1003.5470
|-
| '''LS Tattoo Parlour''' || -204.5580 || -25.6970 || 1002.2730
|-
|}

<br>
*'''ID 17:'''
{| class="prettytable" style="width:50%;"
|-
| '''24/7 shop 5''' || -25.3930 || -185.9110 || 1003.5470
|-
| '''Club''' || 493.4687 || -23.0080 || 1000.6796
|-
| '''Rusty Brown's - Ring Donuts''' || 377.0030 || -192.5070 || 1000.6330
|-
| '''The Sherman's Dam Generator Hall''' || -942.1320 || 1849.1420 || 5.0050
|-
| '''Hemlock Tattoo''' || 377.0030 || -192.5070 || 1000.6330
|-
|}

<br>
*'''ID 18:'''
{| class="prettytable" style="width:50%;"
|-
| '''Lil Probe Inn''' || -227.0280 || 1401.2290 || 27.7690
|-
| '''24/7 shop 6''' || -30.9460 || -89.6090 || 1003.5490
|-
| '''Atrium''' || 1726.1370 || -1645.2300 || 20.2260
|-
| '''Warehouse 2''' || 1296.6310 || 0.5920 || 1001.0230
|-
| '''Zip''' || 161.4620 || -91.3940 || 1001.8050
|-
|}

<br>
==See Also==
[[id|ID Lists]]
[[Category:Scripting Concepts]]

OnClientMouseEnter

2009-05-10T13:48:18Z

DakiLLa: /* Example */

{{Client event}}
__NOTOC__
This event is fired when the user moves the mouse over a GUI element.

==Parameters==
<syntaxhighlight lang="lua">
int absoluteX, int absoluteY
</syntaxhighlight>
* '''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 pointed at.

==Example==
This example shows a message when you move over a GUI element.
<syntaxhighlight lang="lua">
addEventHandler( "onClientMouseEnter", getRootElement(),
function(aX, aY)
outputChatBox( "You're pointing at a GUI element at ("..tostring(aX)..", "..tostring(aY)..")")
end
)
</syntaxhighlight>

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

RemoveAccount

2009-05-06T14:46:30Z

DakiLLa: /* Example */

{{Server function}}
__NOTOC__
This function is used to delete existing player accounts.

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

===Required Arguments===
*'''theAccount:''' The account you wish to remove

===Returns===
Returns ''true'' if account was successfully removed, ''false'' if the account does not exist.

==Example==

This example does...

<syntaxhighlight lang="lua">
function onCmdRemove(playerSource,commandName,playerName)
-- Lets make sure they didn't put nothing for the playername
if playerName ~= nil then
-- Lets get the player from the nick provided
local targetPlayer = getPlayerFromNick(playerName)
-- Checking if the player actually exists
if targetPlayer ~= nil then
-- grab the accounts
local sourceAccount = getClientAccount(playerSource)
local targetAccount = getClientAccount(targetPlayer)
-- Now check to see if the player has greater priviledges (or levels)
if getAccountLevel(sourceAccount) > getAccountLevel(targetAccount) then
removeAccount(targetAccount)
outputChatBox(getClientName(playerSource).." removed "..playerName.."'s account")
else outputChatBox("You don't have authority to remove "..playerName.."'s account",playerSource) end
else outputChatBox("There is no player by the name of "..playerName,playerSource) end
else outputChatBox("USAGE: /remove [playername]",playerSource) end
end

addCommandHandler("remove",onCmdRemove)
</syntaxhighlight>

==See Also==

{{Account_functions}}

SetPedAnimation

2009-05-04T13:57:00Z

DakiLLa: /* Syntax */

__NOTOC__
{{Server client function}}

Sets the current animation of a player or ped. Not specifying the type of animation will automatically cancel the current one.

==Syntax==
<syntaxhighlight lang="lua">
bool setPedAnimation ( ped thePed, [string block=nil, string name=nil, int time=-1,bool loop=true, bool updatePosition=true, bool interruptible=true] )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the player or ped you want to apply an animation to.

===Optional Arguments===
*'''block:''' the [[Animations|animation]] block's name.
*'''anim:''' the name of the [[Animations|animation]] within the block.
*'''time:''' the duration for the animation. Defaults to -1, which is the default time.
*'''loop:''' indicates whether or not the animation will loop.
*'''updatePosition:''' will change the actual coordinates of the ped according to the animation. Use this for e.g. walking animations.
*'''interuptable:''' Defines whether the animation can be interrupted by normal movements

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

==Example==

<section name="Client" class="client" show="true">
This example creates a ped, rotates them, and makes them walk:
<syntaxhighlight lang="lua">
function makePed ( )
ped1 = createPed ( 56, 1, 1, 4 )
setPedRotation( ped1, 315 )
setPedAnimation( ped1, "ped", "WOMAN_walknorm")
end
addEventHandler ( "onResourceStart", getRootElement(), makePed )
</syntaxhighlight>
</section>

==See Also==
{{Ped_functions}}

OnClientMouseEnter

2009-04-04T10:15:04Z

DakiLLa: /* Example */

{{Client event}}
__NOTOC__
This event is fired when the user moves the mouse over a GUI element.

==Parameters==
<syntaxhighlight lang="lua">
int absoluteX, int absoluteY
</syntaxhighlight>
* '''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 pointed at.

==Example==
This example shows a message when you move over a GUI element.
<syntaxhighlight lang="lua">
addEventHandler("onClientMouseEnter", getRootElement(), function(aX, aY)
outputChatBox("You're pointing at a GUI element at (" .. tostring(aX) .. ', ' .. tostring(aY) .. ')')
end)
</syntaxhighlight>

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

CountPlayersInTeam

2008-10-25T17:38:15Z

DakiLLa: /* Example */

__NOTOC__
{{Server client function}}
This function is for returning the number of players in the specified team.

==Syntax==
<syntaxhighlight lang="lua">
int countPlayersInTeam ( team theTeam )
</syntaxhighlight>

===Optional Arguments===
*'''theTeam:''' The team you wish to retrieve the player count of.

===Returns===
Returns an integer containing the number of players in the team, ''false'' if it could not be retrieved.

==Example==
<section name="Example 1" class="server">
This example adds a command in the console to find out how many players are on your team.
<syntaxhighlight lang="lua">
function outputTeamSize ( source, commandName )
-- Get player's team
local theTeam = getPlayerTeam ( source )
-- If the player is in any team
if theTeam then
-- Tell the player how big his team is
outputChatBox ( "Your team has " .. countPlayersInTeam ( theTeam ) .. " players.", source )
else
outputChatBox ( "You're not in a team.", source )
end
end
addCommandHandler ( "teamsize", outputTeamSize )
</syntaxhighlight>
</section>
<section name="Example 2" class="client">
This example adds a command in the console to find out how many players are on your team, clientside
<syntaxhighlight lang="lua">
function outputTeamSize ( commandName )
-- Get player's team
local theTeam = getPlayerTeam ( getLocalPlayer() )
-- If the player is in any team
if team then
-- Tell the player how big his team is
outputChatBox ( "Your team has " .. countPlayersInTeam ( theTeam ) .. " players." )
else
outputChatBox ( "You're not in a team." )
end
end
addCommandHandler ( "teamsize", outputTeamSize )
</syntaxhighlight>
</section>
<section name="Example 3" class="server">
This example balances a gamemode, to ensure equal number of players between the "grove" and "ballas" teams. This could be triggered when a player joins the server, or for all players currently in the server when the gamemode starts.
<syntaxhighlight lang="lua">
function balanceTeams ( thePlayer )
--get the team pointers from their names
local groveTeam = getTeamFromName ( "grove" )
local ballasTeam = getTeamFromName ( "ballas" )
--count the number of players in each team, and store them
local groveCount = countPlayersInTeam ( groveTeam )
local ballasCount = countPlayersInTeam ( ballasTeam )
if groveCount == ballasCount then --if the teams are equal
setPlayerTeam ( thePlayer , groveTeam ) --place the player in grove
elseif groveCount > ballasCount then --if there are more in grove
setPlayerTeam ( thePlayer , ballasTeam ) --place him in ballas
elseif groveCount < ballasCount then --if there are more in ballas
setPlayerTeam ( thePlayer , groveTeam ) --place him in grove.
end
end</syntaxhighlight>
</section>

==See Also==
{{Team functions}}

SetPedHeadless

2008-10-16T18:28:41Z

DakiLLa: /* Example */

__NOTOC__
{{Client function}}
With this function, you can set if a ped has a head or not.
==Syntax==
<syntaxhighlight lang="lua">bool setPedHeadless ( ped thePed )</syntaxhighlight>

===Required Arguments===
*'''thePed''': The [[ped]] to check.

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

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