Multi Theft Auto: Wiki - User contributions [en]

MakePedUseGun

2010-07-28T08:54:13Z

Robhol: x86/Sebas is a mushroom

__NOTOC__
{{Client function}}
[[Category:Needs_Example]]
This function is used to force a ped to use a gun.

==Syntax==
<syntaxhighlight lang="lua">
bool makePedUseGun ( ped thePed, int useType, element target )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' The [[ped]] you wish to force the use of a gun upon.
*'''useType:''' How the weapon should be used, will accept the following values:
** '''0:''' Do nothing
** '''1:''' Aim weapon
** '''2:''' Fire
** '''3:''' Burst-fire
** '''4:''' Reload
** '''5:''' Pistolwhip (Weapon melee)
** '''6:''' Cancel use
** '''7:''' Cancel use immediately
*'''target:''' An [[element]] referring to the target that the ped will use its weapon against.

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

==Example==
This page lacks an example.

==See Also==
{{Client_ped_functions}}

MakePedUseGun

2010-07-28T08:53:24Z

Robhol: /* Example */

__NOTOC__
{{Client function}}
This function is used to force a ped to use a gun.

==Syntax==
<syntaxhighlight lang="lua">
bool makePedUseGun ( ped thePed, int useType, element target )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' The [[ped]] you wish to force the use of a gun upon.
*'''useType:''' How the weapon should be used, will accept the following values:
** '''0:''' Do nothing
** '''1:''' Aim weapon
** '''2:''' Fire
** '''3:''' Burst-fire
** '''4:''' Reload
** '''5:''' Pistolwhip (Weapon melee)
** '''6:''' Cancel use
** '''7:''' Cancel use immediately
*'''target:''' An [[element]] referring to the target that the ped will use its weapon against.

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

==Example==
This page lacks an example.

==See Also==
{{Client_ped_functions}}

GetPedWeapon

2010-06-25T09:38:06Z

Robhol:

__NOTOC__
{{Server client function}}
This function tells you which weapon type is in a certain weapon slot of a ped. See [[weapon|Weapon Info]]

==Syntax==
<syntaxhighlight lang="lua">
int getPedWeapon ( ped thePed, [ int weaponSlot = current ] )
</syntaxhighlight>

===Required Arguments===
*'''thePed''': the [[ped]] you want to get the weapon type from.

===Optional Arguments===
*'''weaponSlot''': an integer representing the weapon slot (set to the ped's current slot if not given).

===Returns===
Returns an [[int]] indicating the type of the weapon the ped has in the specified slot. If the slot is empty, it returns 0.

It should be noted that if a ped runs out of ammo for a weapon, it will still return the ID of that weapon in the slot (even if it appears as if the ped does not have a weapon at all), though [[getPedTotalAmmo]] will return '''0'''. Therefore, [[getPedTotalAmmo]] should be used in conjunction with [[getPedWeapon]] in order to check if a ped has a weapon.

==Example==
This serverside example will display a player's current weapon type. In this case, it is hard coded to use the player called ''someguy''.
<syntaxhighlight lang="lua">
-- Find a player called someguy and find his current weapon id.
local weaponType = getPedWeapon ( getPlayerFromNick ( "someguy" ) )
-- If a weapon type was returned then
if ( weaponType ) then
outputChatBox ( "someguy's current Weapon-type: " .. weaponType .. "." ) -- Display the weapon type in the chat box
end
</syntaxhighlight>

==See Also==
{{Client_ped_functions}}

GetPlayerWeapon

2010-06-25T09:30:43Z

Robhol: Deprecated

__NOTOC__
{{Server client function}}

{{Deprecated}}

This function tells you which weapon type is in the player's current slot (clientside, you can optionally specify a slot other than the current one). See [[weapon|Weapon Info]]

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

===Required Arguments===
*'''thePlayer''': the [[player]] you want to get the weapon type from.

===Returns===
Returns an [[int]] indicating the type of the weapon the player has currently equipped.
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
int getPlayerWeapon ( player thePlayer, [ int weaponSlot = current ] )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer''': the [[player]] you want to get the weapon type from.

===Optional Arguments===
*'''weaponSlot''': an integer representing the weapon slot (set to the players current slot if not given).

===Returns===
Returns an [[int]] indicating the type of the weapon the player has in the specified slot.

It should be noted that if a player runs out of ammo for a weapon, it will still return the ID of that weapon in the slot (even if it appears as if the player does not have a weapon at all), though [[getPlayerTotalAmmo]] will return '''0'''. Therefore, [[getPlayerTotalAmmo]] should be used in conjunction with [[getPlayerWeapon]] in order to check if a player has a weapon.
</section>

==Example==
<section name="Example" class="server" show="true">
This serverside example will display a player's current weapon type. In this case, it is hard coded to use the player called ''someguy''.
<syntaxhighlight lang="lua">
-- Find a player called someguy and find his current weapon id.
local weaponType = getPlayerWeapon ( getPlayerFromNick ( "someguy" ) )
-- If a weapon type was returned then
if ( weaponType ) then
outputChatBox ( "someguy's current Weapon-type: " .. weaponType .. "." ) -- Display the weapon type in the chat box
end
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}

Modules/IRCEcho

2010-03-30T22:38:47Z

Robhol: By now, I should think DP2 quirks are largely irrelevant.

{{Module_Info|
name = MTASA IRC Echo |
version = 2.1 |
author = [[User:VRocker|VRocker]] |
module_website = ''Not available'' |
download_link = [http://liberty-unleashed.co.uk/MTA/IRC%20Echo%20Script%20v2.zip Here] |
license = ''Unlicensed'' |
}}
MTASA IRC Echo is a module that provides an IRC echo for an MTASA server. It is available for both Windows and Linux.

==Installation==
===Windows===
Uncompress the file ml_ircecho.dll into your ''%PROGRAMFILES%\MTA San Andreas\server\mods\deathmatch\modules\'' directory.

Then, add the following line in mtaserver.conf:
<syntaxhighlight lang="xml">
<module src="ml_ircecho.dll" />
</syntaxhighlight>

===Linux===
Uncompress the file ml_ircecho.so into your ''%MTASERVER%\mods\deathmatch\modules\'' directory.

Then, add the following line in mtaserver.conf:
<syntaxhighlight lang="xml">
<module src="ml_ircecho.so" />
</syntaxhighlight>

==Functions==
{{Modules/IRCEcho/Functions}}

==Callbacks==
{{Modules/IRCEcho/Callbacks}}

[[Category:Modules]]

GetElementsByType

2010-02-25T22:13:39Z

Robhol:

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

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

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

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

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

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

<span style="color: #FFF"> (PS: lil_Toady is a commie) </span>

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

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

==See Also==
{{Element_functions}}

Resource:Rh help

2009-12-19T10:17:39Z

Robhol: /* Scripters */

{{Resource page}}
This is intended as a replacement for the standard help manager resource. It looks for help.xml files in running resources and displays the text.

This resource does not support the GUI customization from helpmanager, but does offer more flexibility when dealing with help.xml files. This resource will let you provide your own titles (instead of using resource names only) and a set order in which your "chapters" or help resources will appear.

==Download==
The resource can be found on the resource center.
[http://community.mtasa.com/index.html?p=resources&s=details&id=540 Resource page]

==Usage==
===Scripters===
To add a help entry/chapter to a resource, include the following line in its meta.xml.
<syntaxhighlight lang="xml">
<config src="help.xml" type="client"/>
</syntaxhighlight>
This will make sure the help.xml file is downloaded and accessible.

The actual help chapter must be entered in this help.xml file. A normal help.xml file syntax looks like this:

<syntaxhighlight lang="xml">
<help title="My title" ordering="42">
Help text here
</help>
</syntaxhighlight>

The part inside the actual tag ("Help text here") is what will be displayed in the text box. The title attribute is what will be displayed for this chapter in the list. The ordering attribute "sorts" the chapters so you can have them in a certain order. (Ascending, that is, higher numbers go lower in the list.) Both attributes are optional. If title is not given, then the list item will show up as the resource name. If ordering is not given, it will be decided by the order in which the resources are started and/or restarted.

rh_help is backwards-compatible with helpmanager, which means you don't have to do anything more than running this resource (and disabling the old one) to start using it. It can tackle the old help.xml layout just fine.

===Players===
'''F9''': toggles the help window.

'''/gamehelp''': also toggles the help window. :)

'''Note:''' both the key and the command can be changed to something else in the script, although this is not recommended for two reasons. It will make things harder for players who are used to these fairly standardized ways of opening a help GUI, and unless you rename the script file (I didn't really care to bother putting in a server-side file just for settings when they ideally shouldn't be changed to begin with...) clients will need to download it again on other servers, and AGAIN when they returns to yours.

Resource:Rh help

2009-12-19T10:13:31Z

Robhol: Added link

{{Resource page}}
This is intended as a replacement for the standard help manager resource. It looks for help.xml files in running resources and displays the text.

This resource does not support the GUI customization from helpmanager, but does offer more flexibility when dealing with help.xml files. This resource will let you provide your own titles (instead of using resource names only) and a set order in which your "chapters" or help resources will appear.

==Download==
The resource can be found on the resource center.
[http://community.mtasa.com/index.html?p=resources&s=details&id=540 Resource page]

==Usage==
===Scripters===
To add a help entry/chapter to a resource, include the following line in its meta.xml.
<syntaxhighlight lang="xml">
<config src="help.xml" type="client"/>
</syntaxhighlight>
This will make sure the help.xml file is downloaded and accessible.

The actual help chapter must be entered in this help.xml file. A normal help.xml file syntax looks like this:

<syntaxhighlight lang="xml">
<help title="My title" ordering="42">
Help text here
</help>
</syntaxhighlight>

The part inside the actual tag ("Help text here") is what will be displayed in the text box. The title attribute is what will be displayed for this chapter in the list. The ordering attribute "sorts" the chapters so you can have them in a certain order. Both attributes are optional. If title is not given, then the list item will show up as the resource name. If ordering is not given, it will be decided by the order in which the resources are started and/or restarted.

rh_help is backwards-compatible with helpmanager, which means you don't have to do anything more than running this resource (and disabling the old one) to start using it. It can tackle the old help.xml layout just fine.

===Players===
'''F9''': toggles the help window.

'''/gamehelp''': also toggles the help window. :)

'''Note:''' both the key and the command can be changed to something else in the script, although this is not recommended for two reasons. It will make things harder for players who are used to these fairly standardized ways of opening a help GUI, and unless you rename the script file (I didn't really care to bother putting in a server-side file just for settings when they ideally shouldn't be changed to begin with...) clients will need to download it again on other servers, and AGAIN when they returns to yours.

Resource:Rh help

2009-12-19T10:12:19Z

Robhol: /* Players */

{{Resource page}}
This is intended as a replacement for the standard help manager resource. It looks for help.xml files in running resources and displays the text.

This resource does not support the GUI customization from helpmanager, but does offer more flexibility when dealing with help.xml files. This resource will let you provide your own titles (instead of using resource names only) and a set order in which your "chapters" or help resources will appear.

==Download==
The resource can be found on the resource center.
(Link coming soon.)

==Usage==
===Scripters===
To add a help entry/chapter to a resource, include the following line in its meta.xml.
<syntaxhighlight lang="xml">
<config src="help.xml" type="client"/>
</syntaxhighlight>
This will make sure the help.xml file is downloaded and accessible.

The actual help chapter must be entered in this help.xml file. A normal help.xml file syntax looks like this:

<syntaxhighlight lang="xml">
<help title="My title" ordering="42">
Help text here
</help>
</syntaxhighlight>

The part inside the actual tag ("Help text here") is what will be displayed in the text box. The title attribute is what will be displayed for this chapter in the list. The ordering attribute "sorts" the chapters so you can have them in a certain order. Both attributes are optional. If title is not given, then the list item will show up as the resource name. If ordering is not given, it will be decided by the order in which the resources are started and/or restarted.

rh_help is backwards-compatible with helpmanager, which means you don't have to do anything more than running this resource (and disabling the old one) to start using it. It can tackle the old help.xml layout just fine.

===Players===
'''F9''': toggles the help window.

'''/gamehelp''': also toggles the help window. :)

'''Note:''' both the key and the command can be changed to something else in the script, although this is not recommended for two reasons. It will make things harder for players who are used to these fairly standardized ways of opening a help GUI, and unless you rename the script file (I didn't really care to bother putting in a server-side file just for settings when they ideally shouldn't be changed to begin with...) clients will need to download it again on other servers, and AGAIN when they returns to yours.

Resource:Rh help

2009-12-19T10:11:54Z

Robhol: /* Players */

{{Resource page}}
This is intended as a replacement for the standard help manager resource. It looks for help.xml files in running resources and displays the text.

This resource does not support the GUI customization from helpmanager, but does offer more flexibility when dealing with help.xml files. This resource will let you provide your own titles (instead of using resource names only) and a set order in which your "chapters" or help resources will appear.

==Download==
The resource can be found on the resource center.
(Link coming soon.)

==Usage==
===Scripters===
To add a help entry/chapter to a resource, include the following line in its meta.xml.
<syntaxhighlight lang="xml">
<config src="help.xml" type="client"/>
</syntaxhighlight>
This will make sure the help.xml file is downloaded and accessible.

The actual help chapter must be entered in this help.xml file. A normal help.xml file syntax looks like this:

<syntaxhighlight lang="xml">
<help title="My title" ordering="42">
Help text here
</help>
</syntaxhighlight>

The part inside the actual tag ("Help text here") is what will be displayed in the text box. The title attribute is what will be displayed for this chapter in the list. The ordering attribute "sorts" the chapters so you can have them in a certain order. Both attributes are optional. If title is not given, then the list item will show up as the resource name. If ordering is not given, it will be decided by the order in which the resources are started and/or restarted.

rh_help is backwards-compatible with helpmanager, which means you don't have to do anything more than running this resource (and disabling the old one) to start using it. It can tackle the old help.xml layout just fine.

===Players===
'''F9''': toggles the help window.

'''/gamehelp''': also toggles the help window. :)

'''Note:''' both the key and the command can be changed to something else in the script, although this is not recommended for two reasons. It will make things harder for players who are used to these fairly standardized ways of opening a help GUI, and unless you rename the script file (I didn't really care to bother putting in a server-side file just for settings when they ideally shouldn't be used anyways) clients will need to download it again on other servers, and AGAIN when they returns to yours.

Resource:Rh help

2009-12-19T10:11:39Z

Robhol: /* Commands */

{{Resource page}}
This is intended as a replacement for the standard help manager resource. It looks for help.xml files in running resources and displays the text.

This resource does not support the GUI customization from helpmanager, but does offer more flexibility when dealing with help.xml files. This resource will let you provide your own titles (instead of using resource names only) and a set order in which your "chapters" or help resources will appear.

==Download==
The resource can be found on the resource center.
(Link coming soon.)

==Usage==
===Scripters===
To add a help entry/chapter to a resource, include the following line in its meta.xml.
<syntaxhighlight lang="xml">
<config src="help.xml" type="client"/>
</syntaxhighlight>
This will make sure the help.xml file is downloaded and accessible.

The actual help chapter must be entered in this help.xml file. A normal help.xml file syntax looks like this:

<syntaxhighlight lang="xml">
<help title="My title" ordering="42">
Help text here
</help>
</syntaxhighlight>

The part inside the actual tag ("Help text here") is what will be displayed in the text box. The title attribute is what will be displayed for this chapter in the list. The ordering attribute "sorts" the chapters so you can have them in a certain order. Both attributes are optional. If title is not given, then the list item will show up as the resource name. If ordering is not given, it will be decided by the order in which the resources are started and/or restarted.

rh_help is backwards-compatible with helpmanager, which means you don't have to do anything more than running this resource (and disabling the old one) to start using it. It can tackle the old help.xml layout just fine.

===Players===
'''F9''': toggles the help window.
'''/gamehelp''': also toggles the help window. :)

'''Note:''' both the key and the command can be changed to something else in the script, although this is not recommended for two reasons. It will make things harder for players who are used to these fairly standardized ways of opening a help GUI, and unless you rename the script file (I didn't really care to bother putting in a server-side file just for settings when they ideally shouldn't be used anyways) clients will need to download it again on other servers, and AGAIN when they returns to yours.

Resource:Rh help

2009-12-19T10:11:30Z

Robhol: /* Keys */

{{Resource page}}
This is intended as a replacement for the standard help manager resource. It looks for help.xml files in running resources and displays the text.

This resource does not support the GUI customization from helpmanager, but does offer more flexibility when dealing with help.xml files. This resource will let you provide your own titles (instead of using resource names only) and a set order in which your "chapters" or help resources will appear.

==Download==
The resource can be found on the resource center.
(Link coming soon.)

==Usage==
===Scripters===
To add a help entry/chapter to a resource, include the following line in its meta.xml.
<syntaxhighlight lang="xml">
<config src="help.xml" type="client"/>
</syntaxhighlight>
This will make sure the help.xml file is downloaded and accessible.

The actual help chapter must be entered in this help.xml file. A normal help.xml file syntax looks like this:

<syntaxhighlight lang="xml">
<help title="My title" ordering="42">
Help text here
</help>
</syntaxhighlight>

The part inside the actual tag ("Help text here") is what will be displayed in the text box. The title attribute is what will be displayed for this chapter in the list. The ordering attribute "sorts" the chapters so you can have them in a certain order. Both attributes are optional. If title is not given, then the list item will show up as the resource name. If ordering is not given, it will be decided by the order in which the resources are started and/or restarted.

rh_help is backwards-compatible with helpmanager, which means you don't have to do anything more than running this resource (and disabling the old one) to start using it. It can tackle the old help.xml layout just fine.

===Players===
'''F9''': toggles the help window.
'''/gamehelp''': also toggles the help window. :)

===Commands===
'''gamehelp''': toggles the help window.

'''Note:''' both the key and the command can be changed to something else in the script, although this is not recommended for two reasons. It will make things harder for players who are used to these fairly standardized ways of opening a help GUI, and unless you rename the script file (I didn't really care to bother putting in a server-side file just for settings when they ideally shouldn't be used anyways) clients will need to download it again on other servers, and AGAIN when they returns to yours.

Resource:Rh help

2009-12-19T10:10:57Z

Robhol: /* Simple GUI */

{{Resource page}}
This is intended as a replacement for the standard help manager resource. It looks for help.xml files in running resources and displays the text.

This resource does not support the GUI customization from helpmanager, but does offer more flexibility when dealing with help.xml files. This resource will let you provide your own titles (instead of using resource names only) and a set order in which your "chapters" or help resources will appear.

==Download==
The resource can be found on the resource center.
(Link coming soon.)

==Usage==
===Scripters===
To add a help entry/chapter to a resource, include the following line in its meta.xml.
<syntaxhighlight lang="xml">
<config src="help.xml" type="client"/>
</syntaxhighlight>
This will make sure the help.xml file is downloaded and accessible.

The actual help chapter must be entered in this help.xml file. A normal help.xml file syntax looks like this:

<syntaxhighlight lang="xml">
<help title="My title" ordering="42">
Help text here
</help>
</syntaxhighlight>

The part inside the actual tag ("Help text here") is what will be displayed in the text box. The title attribute is what will be displayed for this chapter in the list. The ordering attribute "sorts" the chapters so you can have them in a certain order. Both attributes are optional. If title is not given, then the list item will show up as the resource name. If ordering is not given, it will be decided by the order in which the resources are started and/or restarted.

rh_help is backwards-compatible with helpmanager, which means you don't have to do anything more than running this resource (and disabling the old one) to start using it. It can tackle the old help.xml layout just fine.

===Keys===
'''F9''': toggles the help window.

===Commands===
'''gamehelp''': toggles the help window.

'''Note:''' both the key and the command can be changed to something else in the script, although this is not recommended for two reasons. It will make things harder for players who are used to these fairly standardized ways of opening a help GUI, and unless you rename the script file (I didn't really care to bother putting in a server-side file just for settings when they ideally shouldn't be used anyways) clients will need to download it again on other servers, and AGAIN when they returns to yours.

Resource:Rh help

2009-12-19T10:10:31Z

Robhol: /* Commands */

{{Resource page}}
This is intended as a replacement for the standard help manager resource. It looks for help.xml files in running resources and displays the text.

This resource does not support the GUI customization from helpmanager, but does offer more flexibility when dealing with help.xml files. This resource will let you provide your own titles (instead of using resource names only) and a set order in which your "chapters" or help resources will appear.

==Download==
The resource can be found on the resource center.
(Link coming soon.)

==Usage==
===Simple GUI===
To add a help entry/chapter to a resource, include the following line in its meta.xml.
<syntaxhighlight lang="xml">
<config src="help.xml" type="client"/>
</syntaxhighlight>
This will make sure the help.xml file is downloaded and accessible.

The actual help chapter must be entered in this help.xml file. A normal help.xml file syntax looks like this:

<syntaxhighlight lang="xml">
<help title="My title" ordering="42">
Help text here
</help>
</syntaxhighlight>

The part inside the actual tag ("Help text here") is what will be displayed in the text box. The title attribute is what will be displayed for this chapter in the list. The ordering attribute "sorts" the chapters so you can have them in a certain order. Both attributes are optional. If title is not given, then the list item will show up as the resource name. If ordering is not given, it will be decided by the order in which the resources are started and/or restarted.

rh_help is backwards-compatible with helpmanager, which means you don't have to do anything more than running this resource (and disabling the old one) to start using it. It can tackle the old help.xml layout just fine.

===Keys===
'''F9''': toggles the help window.

===Commands===
'''gamehelp''': toggles the help window.

'''Note:''' both the key and the command can be changed to something else in the script, although this is not recommended for two reasons. It will make things harder for players who are used to these fairly standardized ways of opening a help GUI, and unless you rename the script file (I didn't really care to bother putting in a server-side file just for settings when they ideally shouldn't be used anyways) clients will need to download it again on other servers, and AGAIN when they returns to yours.

Resource:Rh help

2009-12-19T10:10:14Z

Robhol: /* Commands */

{{Resource page}}
This is intended as a replacement for the standard help manager resource. It looks for help.xml files in running resources and displays the text.

This resource does not support the GUI customization from helpmanager, but does offer more flexibility when dealing with help.xml files. This resource will let you provide your own titles (instead of using resource names only) and a set order in which your "chapters" or help resources will appear.

==Download==
The resource can be found on the resource center.
(Link coming soon.)

==Usage==
===Simple GUI===
To add a help entry/chapter to a resource, include the following line in its meta.xml.
<syntaxhighlight lang="xml">
<config src="help.xml" type="client"/>
</syntaxhighlight>
This will make sure the help.xml file is downloaded and accessible.

The actual help chapter must be entered in this help.xml file. A normal help.xml file syntax looks like this:

<syntaxhighlight lang="xml">
<help title="My title" ordering="42">
Help text here
</help>
</syntaxhighlight>

The part inside the actual tag ("Help text here") is what will be displayed in the text box. The title attribute is what will be displayed for this chapter in the list. The ordering attribute "sorts" the chapters so you can have them in a certain order. Both attributes are optional. If title is not given, then the list item will show up as the resource name. If ordering is not given, it will be decided by the order in which the resources are started and/or restarted.

rh_help is backwards-compatible with helpmanager, which means you don't have to do anything more than running this resource (and disabling the old one) to start using it. It can tackle the old help.xml layout just fine.

===Keys===
'''F9''': toggles the help window.

===Commands===
'''gamehelp''': toggles the help window.

'''Note:''' both the key and the command can be changed to something else in the script, although this is not recommended for two reasons. It will make things harder for players who are used to these fairly standardized ways of opening a help GUI, and unless you rename the script file (I didn't really care to bother putting in a server-side file just for settings when they ideally shouldn't be used anyways) clients will need to download it again on other servers, and AGAIN when they returns to yours.

Resource:Rh help

2009-12-19T10:10:08Z

Robhol: /* Keys */

{{Resource page}}
This is intended as a replacement for the standard help manager resource. It looks for help.xml files in running resources and displays the text.

This resource does not support the GUI customization from helpmanager, but does offer more flexibility when dealing with help.xml files. This resource will let you provide your own titles (instead of using resource names only) and a set order in which your "chapters" or help resources will appear.

==Download==
The resource can be found on the resource center.
(Link coming soon.)

==Usage==
===Simple GUI===
To add a help entry/chapter to a resource, include the following line in its meta.xml.
<syntaxhighlight lang="xml">
<config src="help.xml" type="client"/>
</syntaxhighlight>
This will make sure the help.xml file is downloaded and accessible.

The actual help chapter must be entered in this help.xml file. A normal help.xml file syntax looks like this:

<syntaxhighlight lang="xml">
<help title="My title" ordering="42">
Help text here
</help>
</syntaxhighlight>

The part inside the actual tag ("Help text here") is what will be displayed in the text box. The title attribute is what will be displayed for this chapter in the list. The ordering attribute "sorts" the chapters so you can have them in a certain order. Both attributes are optional. If title is not given, then the list item will show up as the resource name. If ordering is not given, it will be decided by the order in which the resources are started and/or restarted.

rh_help is backwards-compatible with helpmanager, which means you don't have to do anything more than running this resource (and disabling the old one) to start using it. It can tackle the old help.xml layout just fine.

===Keys===
'''F9''': toggles the help window.

==Commands==
'''gamehelp''': toggles the help window.

'''Note:''' both the key and the command can be changed to something else in the script, although this is not recommended for two reasons. It will make things harder for players who are used to these fairly standardized ways of opening a help GUI, and unless you rename the script file (I didn't really care to bother putting in a server-side file just for settings when they ideally shouldn't be used anyways) clients will need to download it again on other servers, and AGAIN when they returns to yours.

Resource:Rh help

2009-12-19T10:09:45Z

Robhol: /* Commands */

{{Resource page}}
This is intended as a replacement for the standard help manager resource. It looks for help.xml files in running resources and displays the text.

This resource does not support the GUI customization from helpmanager, but does offer more flexibility when dealing with help.xml files. This resource will let you provide your own titles (instead of using resource names only) and a set order in which your "chapters" or help resources will appear.

==Download==
The resource can be found on the resource center.
(Link coming soon.)

==Usage==
===Simple GUI===
To add a help entry/chapter to a resource, include the following line in its meta.xml.
<syntaxhighlight lang="xml">
<config src="help.xml" type="client"/>
</syntaxhighlight>
This will make sure the help.xml file is downloaded and accessible.

The actual help chapter must be entered in this help.xml file. A normal help.xml file syntax looks like this:

<syntaxhighlight lang="xml">
<help title="My title" ordering="42">
Help text here
</help>
</syntaxhighlight>

The part inside the actual tag ("Help text here") is what will be displayed in the text box. The title attribute is what will be displayed for this chapter in the list. The ordering attribute "sorts" the chapters so you can have them in a certain order. Both attributes are optional. If title is not given, then the list item will show up as the resource name. If ordering is not given, it will be decided by the order in which the resources are started and/or restarted.

rh_help is backwards-compatible with helpmanager, which means you don't have to do anything more than running this resource (and disabling the old one) to start using it. It can tackle the old help.xml layout just fine.

==Keys==
'''F9''': toggles the help window.

==Commands==
'''gamehelp''': toggles the help window.

'''Note:''' both the key and the command can be changed to something else in the script, although this is not recommended for two reasons. It will make things harder for players who are used to these fairly standardized ways of opening a help GUI, and unless you rename the script file (I didn't really care to bother putting in a server-side file just for settings when they ideally shouldn't be used anyways) clients will need to download it again on other servers, and AGAIN when they returns to yours.

Resource:Rh help

2009-12-19T10:08:25Z

Robhol: Created page.

{{Resource page}}
This is intended as a replacement for the standard help manager resource. It looks for help.xml files in running resources and displays the text.

This resource does not support the GUI customization from helpmanager, but does offer more flexibility when dealing with help.xml files. This resource will let you provide your own titles (instead of using resource names only) and a set order in which your "chapters" or help resources will appear.

==Download==
The resource can be found on the resource center.
(Link coming soon.)

==Usage==
===Simple GUI===
To add a help entry/chapter to a resource, include the following line in its meta.xml.
<syntaxhighlight lang="xml">
<config src="help.xml" type="client"/>
</syntaxhighlight>
This will make sure the help.xml file is downloaded and accessible.

The actual help chapter must be entered in this help.xml file. A normal help.xml file syntax looks like this:

<syntaxhighlight lang="xml">
<help title="My title" ordering="42">
Help text here
</help>
</syntaxhighlight>

The part inside the actual tag ("Help text here") is what will be displayed in the text box. The title attribute is what will be displayed for this chapter in the list. The ordering attribute "sorts" the chapters so you can have them in a certain order. Both attributes are optional. If title is not given, then the list item will show up as the resource name. If ordering is not given, it will be decided by the order in which the resources are started and/or restarted.

rh_help is backwards-compatible with helpmanager, which means you don't have to do anything more than running this resource (and disabling the old one) to start using it. It can tackle the old help.xml layout just fine.

==Keys==
'''F9''': toggles the help window.

==Commands==
'''gamehelp''': toggles the help window.

'''Note:''' both the key and the command can be changed to something else in the script, although this is not recommended because it will make things harder for players who are used to these fairly standardized ways of opening a help GUI.

Git Coding Guidelines

2009-12-06T18:24:51Z

Robhol: /* Why Git? */

This page is to discuss a new set of coding guidelines that will be used for the rest of the development phase through [http://git-scm.com/ Git] and [http://www.github.com/ GitHub]. It also covers related aspects of the development process such as nightly builds.

Before you start reading, ask for a link to the Git guide. It does a pretty good job of explaining how Git works.

== Quick tutorial ==
For a quick tutorial on how to setup and use TortoiseGit, go to the [http://wiki.github.com/multitheftauto/multitheftauto/how-to-use-tortoisegit How to use TortoiseGit] wiki page on GitHub.

== Why Git? ==
Git has several advantages compared to the previous source code management system Subversion. Some relevant features are outlined below.

=== Forks and patches ===
One of the differences of Git is that it is distributed. That is, everyone owns his/her own repository that is [http://en.wikipedia.org/wiki/Fork_(software_development) forked] from our main repository [http://github.com/multitheftauto/multitheftauto/tree multitheftauto/multitheftauto], and all the changes that one would normally commit to the SVN trunk (or branch) are kept in that forked repository.

The advantage of this approach is that any programmer in the world that is registered at GitHub is capable of forking the multitheftauto repository and work on their own changes. All forks based on multitheftauto will show up on the [http://github.com/multitheftauto/multitheftauto/network/members Networks] page at GitHub, so it'll be easy to track. No need to mess around with patches: if we see someone doing good work, whether it be a known or unknown developer, it's just a matter of reviewing the commits (comments can be posted for every commit, in every file, on every line) and pull (fetch & merge) them into the multitheftauto repository. See the guide (p.39) for more details.

==== Offline commits ====
Another feature of Git is that you don't need an internet connection in order to commit. You can commit as much as you want to your local (off-line) repository, and just push all of these when you feel like it. Obviously, this benefits the speed at which you commit as there's no need to send any data to the remote repository. This can also be advantageous when you're doing a lot of work that you want to split up in commits for maintainability and push in one go.

==== Synchronization with SVN ====
Git is fully compatible with our current SVN repository. This means that any changes that are made in git repositories can be committed to the SVN repository, and any changes that are made in the SVN repository can be fetched into the git repository. As far as migration goes, this is pretty valuable as we will be able to work side-to-side with SVN and git while people are switching over.

== Master, experimental, trunks and branches ==
[[File:Gitsetup.png|thumb|400px]]

The main repository ''multitheftauto/multitheftauto'' will be set up with write access for all current project contributors and owners. The repository is structed as follows:
* master
* merge
* untested
* experimental
* 1.0-Release (tag)

=== Master ===
The ''master'' is the default (top) branch that will contain the stable version that will ultimately form the next release.. and nothing more than that. This is not the SVN trunk. On release, it will be forked into 1.x-Release and the entire cycle starts over again. In order to keep the master stable, we will only merge the changes in that are planned and outlined in the [[Roadmap]]. Nightly builds will be available for anyone who wishes to test and use the stable version. Nothing should get into this master branch without having been thoroughly tested. This branch should remain as stable as a release build.

=== Merge ===
The ''merge'' branch is the first stop for code that originates from a developer's fork and is intended for the release. All code should naturally be tested to the extent of the developer's own ability first. Experimental code that is more likely to break should go into the ''experimental'' branch instead.

The ''merge'' branch will be a collection/mess of untested changes that have been pulled in from forks by anyone with write access. The changes can be rapidly tested in the ''unstable'' build. This build is comparable to a nightly trunk build, which can be seriously broken at times.

=== Untested ===
The ''untested'' branch sits below ''merge'' and is intended to act as a barrier to ''master''. By using this barrier, we can selectively choose sets of multiple (related) changes from ''merge'' that are considered to be complete. While ''merge'' may contain all sorts of unrelated pulled-in changes from various developers that are still only half working (due to programmer error), the ''untested'' branch will only pull these changes in when they're considered complete every few days. A build containing a specific set of changes is then generated and tested (ideally this would be automated at some point).

=== Experimental ===
The ''experimental'' branch is for risky code or work-in-progress code that needs to be built by the build system so that it can be tested. Once it has been found to be stable, it can be merged up to ''merge'' from the original fork. Periodically this fork may be reset to being identical to ''merge'', and will be kept in sync with ''merge''. If necessary more experimental branches could be created if more than one experimental feature requires a build at once.

=== Your forks ===
You should generally fork either ''merge'' or ''experimental'' and work there, then merge up to the relevant branch when you're ready.

== Guidelines ==
Commits that are merged from a fork into ''merge'' must be:
* reviewed by other developers
* tested for stability and correctness (if necessary, the commit can be pulled into ''experimental'' first for testing purposes)

Commits that have already been merged into ''experimental'' and were found to be stable must be:
* reviewed by other developers in the originating fork
* pulled from the originating fork into ''master''

== Nightly builds ==
As mentioned above, nightly builds will be available in four different flavours:
* rc (release candidate, compiled from ''multitheftauto/multitheftauto/master''), rarely built
* untested (compiled from ''multitheftauto/multitheftauto/untested''), built on-change
* unstable (compiled from ''multitheftauto/multitheftauto/merge''), frequently built
* experimental (compiled from ''multitheftauto/multitheftauto/experimental''), built on-demand

For more information, head over to the [http://nightly.mtasa.com Nightly Builds] page.

OnClientRender

2009-12-01T15:00:46Z

Robhol:

__NOTOC__
{{Client event}}
This event is triggered every time GTA renders a new frame. It is required for the DirectX drawing functions, and also useful for other clientside operations that have to be applied repeatedly with very short time differences between them.

==Parameters==
''None''

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

==Example==
[[Category:Needs Example]]

==See Also==
===Other client events===
{{Client_other_events}}
===Client event functions===
{{Client_event_functions}}

MTASE

2009-08-30T21:27:05Z

Robhol: Wtf... Did Borat write this or something?

{| style="float: right; border-collapse: collapse; width: 270px"
|[[Image:MTASElogo_wiki.png]]
|}
__TOC__

==Intoduction==
MTA Script Editor is a tool for Lua scripters. What we are aiming for is to speed up process of developing resources. We thought that process of creating new resources and testing them is, let's be honest... a pain in the ass. Management of the resources is a bit annoying sometimes. For instance, if you want to add a new script file to your resource you have to create it and add path to it into meta.xml, it happens that you forget about adding the file to meta.xml and you end up being surprised that your script didn't work at all. We wanted to do something that would speed this up so you could add a new file within a few seconds. If you use custom sounds, you can preview them within Script Editor just by double-clicking it in the resource explorer. We are aiming for something that reminds Visual Studio IDE.

==Things the tool offers==
We have been working on this tool for long but we had a long break due to lack of time and now I'm the only one working on this because education is more important than "having nice time". Even though I'm working alone we are progressing smoothly. Currently we have implemented the followings:

*Loading resources
*Easy resource management
*Preview sound files
*Preview image files
*Lua and XML syntax highlighting
*On-the-fly Lua syntax checker
*New resource wizard - allows you to create new resource with a few clicks
*Switching between resources
*C#'s #region-like grouping code - useful when working in teams and to keep the code clean
*Start/stop server and client
*Join your local server with 1 click
*Switch between game and Script Editor with only one key on the keyboard

==Screenshots==
*'''Main window''' - overall look of the application. On the right you can see a list of MTA functions. You can choose what functions you want to be displayed by changing item in the combo box above it. Are you going to ask what this "silly table" at the bottom of the window is doing? I knew it... It's the syntax checker. As you script the syntax is checked by Lua engine and outputs any errors you've made in the script. It speed up progress because you don't have to go into game and restart the resource to check if you fixed the syntax error. I made a little error on line 1 to show you how it looks:
[[Image:MTASEmainwnd.png]]

*'''New resource wizard''' - create a resource with 5 simple steps (3 steps are optional):
[[Image:MTASEnewreswizard.png]]

*'''Sound player''' - preview sounds by double-clicking sound file in the resource explorer:
[[Image:MTASEsoundplayer.png]]

*'''Image viewer''' - preview images by hovering you cursor over nodes in resource explorer:
[[Image:MTASEimageviewer.png]]

*'''Suggested functions''' - a "window" similar to the one in Visual Studio showing a list of functions. It also shows a tooltip telling you what the function does and its parameters. It also contains all exported functions from every resource. You can add a 3 new attributes to your exported function tag in meta.xml to let Script Editor display descriptive tooltip, like on the screenshot:
**'''retval:''' return type (eg. bool, marker, int, etc.)
**'''params:''' list of parameters
**'''description:''' short description of the function[/list]
[[Image:MTSEsuggestedfuncs.png]]
:(screenshot show an example of exported function that in meta.xml looks like the following:)
<syntaxhighlight lang="lua" lang="xml"><export function="getBankMarkers" retval="table" params="void" description="Returns a table containing all bank markers." /></syntaxhighlight>

*'''MTA Server Configuration''' - a window where you can change server's settings. You won't have to open mtaserver.conf and change the server settings, startup resources, adding modules, etc.
[[Image:MTASEserverconfig.png]]

*'''Customize syntax highlighter''' - you can customize many syntax highlighter properties
[[Image:MTASEcustomizesyntax.png]]

*'''Exported functions''' - you can view all exported functions from every resource
[[Image:MTASEfuncs.png]]

==Overview==
As you can see we want to simplify resource development and it seems to look pretty nice but we are still in development. There are some good key features that would attract you as a scripter. While we are still in development we wanted to ask you what you think about this tool and what would you like to see included in the release (do not ask when! we do not know when). Any suggestions? You're welcome to suggest some features and if possible we will do our best to implement it.

==Requirements==
* To run this application you need to have .NET 2.0 Framework installed.
* You should be able to run it on Windows XP and Vista. Never tested on Windows 7.
* You must have both MTA Client and Server installed.

==Download==
To download the tool go to our thread on MTA forum [http://forum.multitheftauto.com/viewtopic.php?f=91&t=24834 HERE]. That thread is updated frequently.

==FAQ==
===Error/Warning messages at startup===

====File name: 'irrKlang.NET2.0, Version=1.1.3.0, Culture=neutral, PublicKeyToken=a854741bd80517c7' ---> System.Runtime.InteropServices.COMException (0x800736B1): This application has failed to start because the application configuration is incorrect. Reinstalling the application may fix this problem. (Exception from HRESULT: 0x800736B1)====
This message appears most likely for Windows XP/Vista '''64bit''' users. It may occur on 32bit OS if that machine doesn't have .NET 2.0 SP1 installed.

There is only 1 known way to solve the problem...: Make sure you have .NET 2.0 SP1 installed, if you don't have it you can download it from [http://www.microsoft.com/Downloads/details.aspx?familyid=79BC3B77-E02C-4AD3-AACF-A7633F706BA5&displaylang=en Microsoft Download Center].

====Error parsing meta.xml====
The reason why this window comes up should be explained in the message. It's most likely that your meta.xml has the following XML declarations:
<syntaxhighlight lang="lua" lang="xml"><?xml version="1.0" encoding="UTF-8" ?>
<?xml version="1.0" encoding="UTF-16" ?></syntaxhighlight>
To solve the problem, simply open the file in WordPad or Notepad (Notepad++ may not solve the problem so use the Windows one), remove that line and save the changes.

.NET 2.0 XML parser doesn't like not "well-formed" XML files, so you may get different messages with different meta.xml files.

==Contact==
We have an IRC channel on GTANet.com network which you can join, ask questions or even give suggestions. The channel name is #mtatools. You can also find us on [http://forum.multitheftauto.com/viewtopic.php?f=91&t=24834 MTA forum]

==Credits==
* [http://forum.multitheftauto.com/memberlist.php?mode=viewprofile&u=19953 50p] - programmer & UI designer
* [http://forum.multitheftauto.com/memberlist.php?mode=viewprofile&u=30686 Fenix1042] - programmer
* [http://forum.multitheftauto.com/memberlist.php?mode=viewprofile&u=22437 Cazomino05] - xml files with mta functions and events
* MTA Developers - delivering the amazing GTA:SA multiplayer mod that has almost unlimited possibilities

BindKey

2009-07-21T16:40:20Z

Robhol: Added string to the handler function prototypes for consistency and clarity.

{{Server client function}}
__NOTOC__
Binds a player's key to a handler function or command, which will be called when the key is pressed.

==Syntax==
<section name="Server - Syntax 1" class="server" show="true">
<syntaxhighlight lang="lua">bindKey ( player thePlayer, string key, string keyState, function handlerFunction, [ var arguments, ... ] )</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you wish to bind the key of.
*'''key:''' The key or control you wish to bind to the command. See [[key names]] for a list of possible keys and [[control names]] for a list of possible controls.
*'''keyState:''' A string that has one of the following values:
**'''"up":''' If the bound key should trigger the function when the key is released
**'''"down":''' If the bound key should trigger the function when the key is pressed
**'''"both":''' If the bound key should trigger the function when the key is pressed or released
*'''handlerFunction:''' The function that will be triggered when the player's key is pressed. This function should have the form:
:<syntaxhighlight lang="lua">function functionName ( player keyPresser, string key, string keyState, [ var arguments, ... ] )</syntaxhighlight>
:The values passed to this function are:
:*'''keyPresser:''' The player who pressed the key
:*'''key:''' The key that was pressed
:*'''keyState:''' The state of the key that was pressed, ''down'' if it was pressed, ''up'' if it was released.
:*'''arguments''' The optional arguments you specified when calling [[bindKey]] (see below).
</section>

{{New feature|3|1.0|
<section name="Server - Syntax 2" class="server" show="false">
This alternative syntax allows you to bind a key with a command. This will also allow users to customize the control in their Settings menu. Use in conjunction with [[addCommandHandler]] to add handler functions to the keybind.

<syntaxhighlight lang="lua">bindKey ( player thePlayer, string key, string keyState, string commandName, string arguments )</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you wish to bind the key of.
*'''key:''' The key or control you wish to bind to the command. See [[key names]] for a list of possible keys.
*'''keyState:''' A string that has one of the following values:
**'''"up":''' If the bound key should trigger the function when the key is released
**'''"down":''' If the bound key should trigger the function when the key is pressed
**'''"both":''' If the bound key should trigger the function when the key is pressed or released
*'''commandName:''' The name of the command that the key should be binded to.
*'''arguments''' Space delimited arguments that are entered as if one was typing the command.
</section>
}}

<section name="Client - Syntax 1" class="client" show="true">
<syntaxhighlight lang="lua">bindKey ( string key, string keyState, function handlerFunction, [ var arguments, ... ] ) </syntaxhighlight>

===Required Arguments===
*'''key:''' The key or control you wish to bind to the command. See [[key names]] for a list of possible keys and [[control names]] for a list of possible controls.
*'''keyState:''' A string that has one of the following values:
**'''"up":''' If the bound key should trigger the function when the key is released
**'''"down":''' If the bound key should trigger the function when the key is pressed
**'''"both":''' If the bound key should trigger the function when the key is pressed or released

*'''handlerFunction:''' The function that will be triggered when the player's key is pressed. This function should have the form:
:<syntaxhighlight lang="lua">function functionName ( string key, string keyState, [ var arguments, ... ] )</syntaxhighlight>
:The values passed to this function are:
:*'''key:''' The key that was pressed
:*'''keyState:''' The state of the key that was pressed, ''down'' if it was pressed, ''up'' if it was released.
:*'''arguments''' The optional arguments you specified when calling [[bindKey]] (see below).
</section>

{{New feature|3|1.0|
<section name="Client - Syntax 2" class="client" show="false">
This alternative syntax allows you to bind a key with a command. This will also allow users to customize the control in their Settings menu. Use in conjunction with [[addCommandHandler]] to add handler functions to the keybind.

<syntaxhighlight lang="lua">bindKey ( string key, string keyState, string commandName, string arguments )</syntaxhighlight>

===Required Arguments===
*'''key:''' The key or control you wish to bind to the command. See [[key names]] for a list of possible keys.
*'''keyState:''' A string that has one of the following values:
**'''"up":''' If the bound key should trigger the function when the key is released
**'''"down":''' If the bound key should trigger the function when the key is pressed
**'''"both":''' If the bound key should trigger the function when the key is pressed or released
*'''commandName:''' The name of the command that the key should be binded to.
*'''arguments''' Space delimited arguments that are entered as if one was typing the command.
</section>
}}

===Optional Arguments===
{{OptionalArg}}
*'''arguments:''' Any arguments you may want to pass to the function when the key is pressed by the user. Any number of arguments of can be specified, each being passed to the designated function.

==Example==
Example 1
<section name="Server" class="server" show="true">
This example will bind a player's 'F1' key and 'fire' control to 1 input function.
<syntaxhighlight lang="lua">
function funcInput ( player, key, keyState )
local state = "let go of"
if ( keyState == "down" ) then
state = "pressed"
end
outputChatBox ( getClientName ( player) .. " " .. state .. " the " .. key .. " key!" )
end

function bindTheKeys ( player, commandName )
bindKey ( player, "F1", "down", funcInput ) -- bind the player's F1 down key
bindKey ( player, "F1", "up", funcInput ) -- bind the player's F1 up key
bindKey ( player, "fire", "both", funcInput ) -- bind the player's fire down and up control
end
addCommandHandler ( "bindme", bindTheKeys )
</syntaxhighlight>
</section>

Example 2
<section name="Client" class="client" show="true">
This example will bind a player's 'F1' key and 'fire' control to 1 input function, clientside.
<syntaxhighlight lang="lua">
function funcInput ( key, keyState )
local state = "let go of"
if ( keyState == "down" ) then
state = "pressed"
end
outputChatBox ( "You " .. state .. " the " .. key .. " key!" )
end

function bindTheKeys ()
bindKey ( "F1", "down", funcInput ) -- bind the player's F1 down key
bindKey ( "F1", "up", funcInput ) -- bind the player's F1 up key
bindKey ( "fire", "both", funcInput ) -- bind the player's fire down and up control
end
addCommandHandler ( "bindme", bindTheKeys )
</syntaxhighlight>
</section>

==See Also==
{{Input functions}}

Server Scripting Functions

2009-07-03T18:22:08Z

Robhol: hmm..

<pageclass class="server"></pageclass>
This page lists all the '''server-side''' scripting functions that have been implemented and are available as native functions from the Deathmatch mod. To request a function or event, use [[Requested Functions and Events]].

Please note that the scripting functions can now be extended by loading in dynamic modules that provide new functionality, such as MySQL database access. 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]].'''

==Account functions==
{{Account_functions}}

==ACL functions==
{{ACL_functions}}

==Admin functions==
{{Admin_functions}}

==Audio functions==
{{Audio_functions}}

==Announcement functions==
{{Announce_functions}}

==Blip functions==
{{Blip_functions}}

==Camera functions==
{{Camera functions}}

==Collision shape functions==
{{Collision shape functions}}

==Client functions==
{{Client functions}}

==Clothes and body functions==
{{Clothes and body functions}}

==Cursor functions==
{{Cursor_functions}}

==Element functions==
{{Element functions}}

==Event functions==
{{Event_functions}}

==Explosion functions==
{{Explosion_functions}}

==File functions==
{{File_functions}}

==HTTP functions==
{{HTTP_functions}}

==Input functions==
{{Input_functions}}

==Map functions==
{{Map_functions}}

==Marker functions==
{{Marker functions}}

==Module functions==
{{Module functions}}

==Object functions==
{{Object functions}}

==Ped functions==
{{Ped_functions}}

==Pickup functions==
{{Pickup functions}}

==Player functions==
{{Player functions}}

==Radar area functions==
{{Radar area functions}}

==Resource functions==
{{Resource functions}}

==Serial functions==
{{Serial functions}}

==Server functions==
{{Server functions}}

==Settings registry functions==
{{Settings registry functions}}

==SQL functions==
{{SQL_functions}}

==Team functions==
{{Team functions}}

==Text functions==
{{Text functions}}

==Utility functions==
{{Utility functions}}

==Vehicle functions==
{{Vehicle functions}}

==Water functions==
{{Water functions}}

==Weapon functions==
{{Weapon functions}}

==World functions==
{{World functions}}

==XML functions==
{{XML functions}}

Server Scripting Functions

2009-07-03T18:21:07Z

Robhol: Added Useful Functions link since eAi won't :@

<pageclass class="server"></pageclass>
This page lists all the '''server-side''' scripting functions that have been implemented and are available as native functions from the Deathmatch mod. To request a function or event, use [[Requested Functions and Events]].

Please note that the scripting functions can now be extended by loading in dynamic modules that provide new functionality, such as MySQL database access. 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 [[Useful_Functions]].

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

==Account functions==
{{Account_functions}}

==ACL functions==
{{ACL_functions}}

==Admin functions==
{{Admin_functions}}

==Audio functions==
{{Audio_functions}}

==Announcement functions==
{{Announce_functions}}

==Blip functions==
{{Blip_functions}}

==Camera functions==
{{Camera functions}}

==Collision shape functions==
{{Collision shape functions}}

==Client functions==
{{Client functions}}

==Clothes and body functions==
{{Clothes and body functions}}

==Cursor functions==
{{Cursor_functions}}

==Element functions==
{{Element functions}}

==Event functions==
{{Event_functions}}

==Explosion functions==
{{Explosion_functions}}

==File functions==
{{File_functions}}

==HTTP functions==
{{HTTP_functions}}

==Input functions==
{{Input_functions}}

==Map functions==
{{Map_functions}}

==Marker functions==
{{Marker functions}}

==Module functions==
{{Module functions}}

==Object functions==
{{Object functions}}

==Ped functions==
{{Ped_functions}}

==Pickup functions==
{{Pickup functions}}

==Player functions==
{{Player functions}}

==Radar area functions==
{{Radar area functions}}

==Resource functions==
{{Resource functions}}

==Serial functions==
{{Serial functions}}

==Server functions==
{{Server functions}}

==Settings registry functions==
{{Settings registry functions}}

==SQL functions==
{{SQL_functions}}

==Team functions==
{{Team functions}}

==Text functions==
{{Text functions}}

==Utility functions==
{{Utility functions}}

==Vehicle functions==
{{Vehicle functions}}

==Water functions==
{{Water functions}}

==Weapon functions==
{{Weapon functions}}

==World functions==
{{World functions}}

==XML functions==
{{XML functions}}

Template:Useful Functions

2009-06-28T10:22:55Z

Robhol:

*[[CallClientFunction]]
This function allows you to call any clientside function from the server's side.
<br/><br/>

*[[CallServerFunction]]
This function allows you to call any server-side function from the client's side.
<br/><br/>

*[[Explode]]
This function splits a string at a given separator and returns a table with the pieces.
<br/><br/>

*[[findRotation]]
Takes two points and returns the direction from point A to point B.
<br/><br/>

*[[getPointFromDistanceRotation]]
Finds a point based on a starting point, direction and distance.
<br/><br/>

*[[GetTimestamp]]
With this function you can get the [http://en.wikipedia.org/wiki/Unix_time UNIX timestamp].
<br/><br/>

*[[IfElse]]
Returns one of two values based on a boolean expression.
<br/><br/>

*[[IsYearALeapYear]]
Checks if the given year is a leap year
<br/><br/>

*[[setTableProtected]]
Protects a table and makes it read-only
<br/><br/>

*[[table.copy]]
This function copies a whole table and all the tables in that table.
<br/><br/>

*[[table.map]]
This function goes through a table and replaces every field with the return of the passed function, where the field's value is passed as first argument and optionally more arguments.
<br/><br/>

*[[table.size]]
Finds the absolute size of a table.

[[Category:Useful Functions]]

Useful Functions

2009-06-28T09:35:13Z

Robhol: Minor formatting

<pageclass class="#228B22"></pageclass>

This page lists functions that are not included in the server nor the client, but are still useful.
<br/><br/>
{{Useful_Functions}}
<br/><br/>

Template:Useful Functions

2009-06-28T09:34:33Z

Robhol: Added descriptions and links to my own functions

*[[CallClientFunction]]
This function allows you to call any clientside function from the server's side.
<br/><br/>

*[[CallServerFunction]]
This function allows you to call any server-side function from the client's side.
<br/><br/>

*[[Explode]]
This function splits a string at a given separator and returns a table with the pieces.
<br/><br/>

*[[FindRotation]]
Takes two points and returns the direction from point A to point B.
<br/><br/>

*[[GetPointFromDistanceRotation]]
Finds a point based on a starting point, direction and distance.
<br/><br/>

*[[GetTimestamp]]
With this function you can get the [http://en.wikipedia.org/wiki/Unix_time UNIX timestamp].
<br/><br/>

*[[IfElse]]
Returns one of two values based on a boolean expression.
<br/><br/>

*[[IsYearALeapYear]]
Checks if the given year is a leap year
<br/><br/>

*[[setTableProtected]]
Protects a table and makes it read-only
<br/><br/>

*[[table.copy]]
This function copies a whole table and all the tables in that table.
<br/><br/>

*[[table.map]]
This function goes through a table and replaces every field with the return of the passed function, where the field's value is passed as first argument and optionally more arguments.
<br/><br/>

*[[table.size]]
Finds the absolute size of a table.

[[Category:Useful Functions]]

Useful Functions

2009-06-28T09:25:13Z

Robhol: Looks better now, huh. ;P

<pageclass class="#228B22"></pageclass>

This page lists functions that are not included in the server nor the client, but are still useful.

{{Useful_Functions}}

Useful Functions

2009-06-28T09:22:30Z

Robhol: Category pages are fugly. Made this page to list all "custom" useful functions.

FindRotation

2009-06-28T09:19:37Z

Robhol: Durr...

{{Useful Function}}
__NOTOC__
This function takes two sets of XY coordinates. It returns the direction from point A to point B. This can for example be used to make peds face a given point.

==Syntax==
<syntaxhighlight lang="lua">float findRotation(float Xa, float Ya, float Xb, float Yb)</syntaxhighlight>

===Required Arguments===
* '''Xa''': The X coordinate of the starting point.
* '''Ya''': The Y coordinate of the starting point.
* '''Xb''': The X coordinate of the target point.
* '''Yb''': The Y coordinate of the target point.

==Code==
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function findRotation(x1,y1,x2,y2)

local t = -math.deg(math.atan2(x2-x1,y2-y1))
if t < 0 then t = t + 360 end;
return t;

end
</syntaxhighlight>
</section>

==Example==
<section name="Example" class="both" show="true">
This command makes the player who enters it face the player whose name is given.
<syntaxhighlight lang="lua">
addCommandHandler("facePlayer",
function (player, cmd, targetName)

local target = getPlayerFromNick(targetName);

if target == false then
outputChatBox("Invalid player", player);
end

local x,y,z = getElementPosition(player);
local tx,ty,tz = getElementPosition(target);

setPedRotation(player, findRotation(x,y,tx,ty) );

end
);
</syntaxhighlight>
</section>

Original function by '''Doomed_Space_Marine'''. Fixed, tested and wiki-fied by '''robhol'''.

==See Also==
{{Useful_Functions}}

FindRotation

2009-06-28T09:19:10Z

Robhol: Created page

{{Useful Function}}
__NOTOC__
This function takes two sets of XY coordinates. It returns the direction from point A to point B. This can for example be used to make peds face a given point.

==Syntax==
<syntaxhighlight lang="lua">float findRotation(float Xa, float Ya, float Xb, float Yb)</syntaxhighlight>

===Required Arguments===
* '''Xa''': The X coordinate of the starting point.
* '''Ya''': The Y coordinate of the starting point.
* '''Xb''': The Y coordinate of the target point.
* '''Yb''': The Y coordinate of the target point.

==Code==
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function findRotation(x1,y1,x2,y2)

local t = -math.deg(math.atan2(x2-x1,y2-y1))
if t < 0 then t = t + 360 end;
return t;

end
</syntaxhighlight>
</section>

==Example==
<section name="Example" class="both" show="true">
This command makes the player who enters it face the player whose name is given.
<syntaxhighlight lang="lua">
addCommandHandler("facePlayer",
function (player, cmd, targetName)

local target = getPlayerFromNick(targetName);

if target == false then
outputChatBox("Invalid player", player);
end

local x,y,z = getElementPosition(player);
local tx,ty,tz = getElementPosition(target);

setPedRotation(player, findRotation(x,y,tx,ty) );

end
);
</syntaxhighlight>
</section>

Original function by '''Doomed_Space_Marine'''. Fixed, tested and wiki-fied by '''robhol'''.

==See Also==
{{Useful_Functions}}

GetPointFromDistanceRotation

2009-06-28T09:04:12Z

Robhol: Created page.

{{Useful Function}}
__NOTOC__
This function takes a set of XY coordinates, a distance and a rotation argument. It returns XY coordinates of the point that is the given distance away from the given point, in the given direction.

==Syntax==
<syntaxhighlight lang="lua">float, float function getPointFromDistanceRotation(float x, float y, float dist, float angle)</syntaxhighlight>

===Required Arguments===
* '''x''': The X coordinate of the starting point.
* '''y''': The Y coordinate of the starting point.
* '''dist''': The distance from the starting point to the target point.
* '''angle''': The direction from the starting point to the target point.

==Code==
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function getPointFromDistanceRotation(x, y, dist, angle)

local a = math.rad(90 - angle);

local dx = math.cos(a) * dist;
local dy = math.sin(a) * dist;

return x+dx, y+dy;

end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This command surrounds a player with peds.
<syntaxhighlight lang="lua">
addCommandHandler("surround",
function (player)

local x,y,z = getElementPosition(player);

for i=1, 8 do
local newX, newY = getPointFromDistanceRotation(x, y, 2, 360 * (i/8));
createPed(10, newX, newY, z)
end

end
);
</syntaxhighlight>
</section>

Author: robhol.

==See Also==
{{Useful_Functions}}

CreatePed

2009-06-27T13:45:00Z

Robhol: Zomg teh linkage (Added link to skin lists)

__NOTOC__
{{Server client function}}
Creates a Ped in the GTA world.

==Syntax==
<syntaxhighlight lang="lua">ped createPed ( int modelid, float x, float y, float z )</syntaxhighlight>

===Required Arguments===
*'''modelid:''' A whole integer specifying the [[Character_Skins|GTASA skin 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.

===Returns===
Returns the ped element.

==Example==

<section name="Server" class="server" show="true">
This example creates an ped when the resource starts:
<syntaxhighlight lang="lua">
function pedLoad ( name )
createPed ( 120, 5540.6654, 1020.55122, 1240.545 )
end
addEventHandler ( "onResourceStart", getRootElement(), pedLoad )
</syntaxhighlight>
</section>

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

Interior IDs

2009-06-04T13:27:11Z

Robhol: Onbekend? :o

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%;"
|-
| '''Unknown 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]]

OnClientPlayerDamage

2009-05-23T12:53:06Z

Robhol: I have no idea what falling of a bike means. Corrected.

__NOTOC__
{{Client event}}
This event is triggered whenever a player is damaged.

==Parameters==
<syntaxhighlight lang="lua">
element attacker, int weapon, int bodypart [, float loss ]
</syntaxhighlight>

*'''attacker''': A [[player]] [[element]] representing the attacker or [[vehicle]] [[element]] (when you fall off a bike).
*'''weapon''': An integer representing the weapon ID the attacker used
*'''bodypart''': An integer representing the bodypart the player was damaged
{{BodyParts}}
*'''loss''': A float representing the percentage of health the player lost. ('''from DP3''')

==Source==
The [[event system#Event source|source]] of this event is the [[player]] that got damaged

==Cancel effect==
If this event is [[Event system#Canceling|canceled]], then any damaging effects to the local player will cease.

==Example==
This example prevents any damage from the minigun.
<syntaxhighlight lang="lua">
function stopMinigunDamage ( attacker, weapon, bodypart )
if ( weapon == 38 ) then --if the weapon used was the minigun
cancelEvent() --cancel the event
end
end
addEventHandler ( "onClientPlayerDamage", getLocalPlayer(), stopMinigunDamage )
</syntaxhighlight>

==See Also==
===Client player events===
{{Client_player_events}}
===Client event functions===
{{Client_event_functions}}

IsElementInWater

2009-05-23T12:15:35Z

Robhol: /* Example */

__NOTOC__
{{Server client function}}
This function checks whether an [[element]] is submerged in water.

==Syntax==
<section name="Server and client" class="both" show="true">
<syntaxhighlight lang="lua">bool isElementInWater ( element theElement )</syntaxhighlight>

===Required Arguments===
* '''theElement''': The element to check.

===Returns===
Returns ''true'' if the passed element is in water, ''false'' if it isn't, or if the element is invalid.
</section>

==Example==
Creates a command that checks if the player is in water or not.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">

function waterCheck(thePlayer)
if isElementInWater(thePlayer) then
outputChatBox("Wet.", thePlayer)
else
outputChatBox("Dry.", thePlayer)
end
end

addCommandHandler("check", waterCheck)
</syntaxhighlight>
</section>

==See Also==
{{Element functions}}

GetLoadedModules

2009-05-18T13:52:34Z

Robhol: /* Example */

__NOTOC__
{{Server function}}

This function returns all the currently loaded [[modules]] of the server.

==Syntax==

<syntaxhighlight lang="lua">
table getLoadedModules ()
</syntaxhighlight>

===Returns===

Returns a table of all the currently loaded [[modules]]. If no modules are loaded, the table will be empty.

==Example==

Adds a command that lists all loaded modules in the server log.
<syntaxhighlight lang="lua">
function checkModules()
local modules = getLoadedModules()

if #modules == 0 then
outputServerLog("No modules are loaded!")
else

for k,v in ipairs(modules) do
outputServerLog( v )
end

outputServerLog("Loaded " .. #modules .. " modules in total.")
end
end
addCommandHandler("modules", checkModules)
</syntaxhighlight>

==See Also==

{{Module_functions}}

GetLoadedModules

2009-05-18T13:51:46Z

Robhol: Added.

__NOTOC__
{{Server function}}

This function returns all the currently loaded [[modules]] of the server.

==Syntax==

<syntaxhighlight lang="lua">
table getLoadedModules ()
</syntaxhighlight>

===Returns===

Returns a table of all the currently loaded [[modules]]. If no modules are loaded, the table will be empty.

==Example==

<syntaxhighlight lang="lua">
function checkModules()
local modules = getLoadedModules()

if #modules == 0 then
outputServerLog("No modules are loaded!")
else

for k,v in ipairs(modules) do
outputServerLog( v )
end

outputServerLog("Loaded " .. #modules .. " modules in total.")
end
end
addCommandHandler("modules", checkModules)
</syntaxhighlight>

==See Also==

{{Module_functions}}

Template:Module functions

2009-05-18T13:46:31Z

Robhol: BLARRRRRRGGGGGGHHHHH :3

*[[getLoadedModules]]
*[[getModuleInfo]]

Server Scripting Functions

2009-05-18T13:42:09Z

Robhol: Added Module category

<pageclass class="server"></pageclass>
This page lists all the '''server-side''' scripting functions that have been implemented and are available as native functions from the Deathmatch mod. To request a function or event, use [[Requested Functions and Events]].

Please note that the scripting functions can now be extended by loading in dynamic modules that provide new functionality, such as MySQL database access. 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.

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

==Account functions==
{{Account_functions}}

==ACL functions==
{{ACL_functions}}

==Admin functions==
{{Admin_functions}}

==Audio functions==
{{Audio_functions}}

==Announcement functions==
{{Announce_functions}}

==Blip functions==
{{Blip_functions}}

==Camera functions==
{{Camera functions}}

==Collision shape functions==
{{Collision shape functions}}

==Client functions==
{{Client functions}}

==Clothes and body functions==
{{Clothes and body functions}}

==Cursor functions==
{{Cursor_functions}}

==Element functions==
{{Element functions}}

==Event functions==
{{Event_functions}}

==Explosion functions==
{{Explosion_functions}}

==File functions==
{{File_functions}}

==HTTP functions==
{{HTTP_functions}}

==Input functions==
{{Input_functions}}

==Map functions==
{{Map_functions}}

==Marker functions==
{{Marker functions}}

==Module functions==
{{Module functions}}

==Object functions==
{{Object functions}}

==Ped functions==
{{Ped_functions}}

==Pickup functions==
{{Pickup functions}}

==Player functions==
{{Player functions}}

==Radar area functions==
{{Radar area functions}}

==Resource functions==
{{Resource functions}}

==Serial functions==
{{Serial functions}}

==Server functions==
{{Server functions}}

==Settings registry functions==
{{Settings registry functions}}

==SQL functions==
{{SQL_functions}}

==Team functions==
{{Team functions}}

==Text functions==
{{Text functions}}

==Utility functions==
{{Utility functions}}

==Vehicle functions==
{{Vehicle functions}}

==Water functions==
{{Water functions}}

==Weapon functions==
{{Weapon functions}}

==World functions==
{{World functions}}

==XML functions==
{{XML functions}}

Template:Module functions

2009-05-18T13:41:41Z

Robhol: Created.

*[[getModules]]
*[[getModuleInfo]]

Template:Ped events

2009-05-18T13:36:55Z

Robhol: Added onPedWeaponSwitch

OnPedWeaponSwitch

2009-05-18T13:36:06Z

Robhol: Added.

__NOTOC__
{{Server event}}
This event is triggered when a ped switches weapons.

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

*'''previousWeaponID''': An integer representing the weapon that was switched from
*'''currentWeaponID''': An integer representing the weapon that was switched to

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

==Example==
This example outputs a line to the chat box whenever a ped changes weapons.
<syntaxhighlight lang="lua">
function weaponSwitch ( previousWeaponID, currentWeaponID )

outputChatBox("A ped switched weapons from " .. previousWeaponID .. " to " .. currentWeaponID .. "!")

end

addEventHandler ( "onPedWeaponSwitch", getRootElement(), weaponSwitch )
</syntaxhighlight>

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

OnPlayerQuit

2009-05-18T04:45:23Z

Robhol: Added resp. argument, updated list, updated example.

__NOTOC__
{{Server event}}
This event is triggered when a player disconnects from the server.

==Parameters==
<syntaxhighlight lang="lua">
string quitType, string reason, element responsibleElement
</syntaxhighlight>

*'''quitType''': How the player left.
This argument can be:
* "Unknown"
* "Quit"
* "Kicked"
* "Banned"
* "Bad Connection"
* "Timed out"

{{New feature|3|1.0|
*'''reason''': If the player was kicked or banned, the reason given goes here. If the player was '''not''' kicked or banned, this will be false.

*'''responsibleElement''': The element that was responsible for kicking or banning the player. This is commonly another player, but can also be the console element.
}}

==Source==
The [[event system#Event source|source]] of this event is the [[player]] that left the server.

==Example==
This example gets the quitting client's name and outputs that he is gone

<syntaxhighlight lang="lua">
-- we register quitPlayer as a handler for the event
function quitPlayer ( quitType )
-- we store the player's name
local quittingPlayerName = getClientName ( source )
-- and send the message to the server
outputChatBox ( quittingPlayerName .. " has left the server (" .. quitType .. ")" )
end
addEventHandler ( "onPlayerQuit", getRootElement(), quitPlayer )
</syntaxhighlight>

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

[[Category:Incomplete]]

OnPlayerQuit

2009-05-17T15:03:02Z

Robhol: added kick/ban reason, renamed old reason arg to quitType

__NOTOC__
{{Server event}}
This event is triggered when a player disconnects from the server.

==Parameters==
<syntaxhighlight lang="lua">
string quitType, string reason
</syntaxhighlight>

*'''quitType''': How the player left.
This argument can be:
- "Unknown"
- "Quit"
- "Kicked"
- "Banned"
- "Bad Connection"
- "Timed out"

*'''reason''': If the player was kicked or banned, the reason given goes here. If the player was '''not''' kicked or banned, this will be false.

==Source==
The [[event system#Event source|source]] of this event is the [[player]] that left the server.

==Example==
This example gets the quitting client's name and outputs that he is gone

<syntaxhighlight lang="lua">
-- we register quitPlayer as a handler for the event
function quitPlayer ( reason )
-- we store the player's name
local quittingPlayerName = getClientName ( source )
-- and send the message to the server
outputChatBox ( quittingPlayerName .. " has left the server (" .. reason .. ")" )
end
addEventHandler ( "onPlayerQuit", getRootElement(), quitPlayer )
</syntaxhighlight>

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

[[Category:Incomplete]]

IsElementInWater

2009-04-20T17:45:50Z

Robhol: Dedicated to Talidan. <3

__NOTOC__
{{Server client function}}
This function checks whether an [[element]] is submerged in water.

==Syntax==
<section name="Server and client" class="both" show="true">
<syntaxhighlight lang="lua">bool isElementInWater ( element theElement )</syntaxhighlight>

===Required Arguments===
* '''theElement''': The element to check.

===Returns===
Returns ''true'' if the passed element is in water, ''false'' if it isn't, or if the element is invalid.
</section>

==Example==
Creates a command that checks if the player is in water or not.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">

function waterCheck(player)
if isElementInWater(player) then
outputChatBox("Wet.", player)
else
outputChatBox("Dry.", player)
end
end

addCommandHandler("check", waterCheck)
</syntaxhighlight>
</section>

==See Also==
{{Element functions}}

Template:Client element functions

2009-04-20T17:40:07Z

Robhol: Added isElementInWater

*[[createElement]]
*[[destroyElement]]
*[[getElementBoundingBox]]
*[[getElementChild]]
*[[getElementChildren]]
*[[getElementChildrenCount]]
*[[getElementData]]
*[[getElementDimension]]
*[[getElementHealth]]
*[[getElementID]]
*[[getElementInterior]]
*[[getElementsByType]]
*[[getElementType]]
*[[getElementParent]]
*[[getElementPosition]]
*[[getElementVelocity]]
*[[getElementRadius]]
*[[getRootElement]]
*[[isElement]]
*[[isElementLocal]]
*[[isElementStreamable]]
*[[isElementStreamedIn]]
*[[isElementWithinColShape]]
*[[getElementsWithinColShape]]
*[[isElementAttached]]
*[[isElementOnScreen]]
*[[getElementAttachedTo]]
*[[getAttachedElements]]
*[[getElementDistanceFromCentreOfMassToBaseOfModel]]
*[[setElementAlpha]]
*[[setElementCollisionsEnabled]]
*[[setElementData]]
*[[setElementDimension]]
*[[setElementHealth]]
*[[setElementInterior]]
*[[setElementParent]]
*[[setElementPosition]]
*[[setElementVelocity]]
*[[setElementStreamable]]
{{Deprecated_feature|3|1.0|
*[[attachElementToElement]]
*[[detachElementFromElement]]
}}
*[[getElementByID]]
{{New feature|3|1.0|
*[[getElementColShape]]
*[[getElementRotation]]
*[[setElementRotation]]
*[[getElementModel]]
*[[setElementModel]]
*[[attachElements]]
*[[detachElements]]
*[[isElementSyncer]]
*[[isElementInWater]]
}}

Template:Element functions

2009-04-20T17:39:09Z

Robhol: Added isElementInWater

*[[createElement]]
*[[destroyElement]]
*[[cloneElement]]
*[[isElement]]
*[[getAllElementData]]
*[[getElementByID]]
*[[getElementByIndex]]
*[[getElementChild]]
*[[getElementChildren]]
*[[getElementChildrenCount]]
*[[getElementData]]
*[[getElementHealth]]
*[[getElementID]]
*[[getElementParent]]
*[[getElementsByType]]
*[[getElementType]]
*[[getRootElement]]
*[[isElementVisibleTo]]
*[[isElementWithinColShape]]
*[[getElementsWithinColShape]]
*[[getElementPosition]]
*[[getElementVelocity]]
*[[getElementInterior]]
*[[getElementDimension]]
*[[getElementZoneName]]
*[[isElementAttached]]
*[[getElementAttachedTo]]
*[[getAttachedElements]]
*[[getElementColShape]]
*[[getElementAlpha]]
*[[setElementData]]
*[[removeElementData]]
*[[setElementHealth]]
*[[setElementID]]
*[[setElementParent]]
*[[setElementVisibleTo]]
*[[clearElementVisibleTo]]
*[[setElementPosition]]
*[[setElementVelocity]]
*[[setElementInterior]]
*[[setElementDimension]]
{{Deprecated_feature|3|1.0|
*[[attachElementToElement]]
*[[detachElementFromElement]]
}}
*[[setElementAlpha]]
{{New feature|3|1.0|
*[[getElementModel]]
*[[setElementModel]]
*[[attachElements]]
*[[detachElements]]
*[[setElementAttachedOffsets]]
*[[getElementSyncer]]
*[[isElementInWater]]

}}

Template:Element functions

2009-04-20T17:38:21Z

Robhol:

IsElementInWater

2009-04-20T17:37:19Z

Robhol: Let there be light?

__NOTOC__
{{Server client function}}
This function checks whether an [[element]] is submerged in water.

==Syntax==
<section name="Server and client" class="both" show="true">
<syntaxhighlight lang="lua">bool isElementInWater ( element theElement )</syntaxhighlight>

===Required Arguments===
* '''theElement''': The element to check.

===Returns===
Returns ''true'' if the passed element is in water, ''false'' if it isn't, or if the element is invalid.
</section>

==Example==
Creates a command that checks if the player is in water or not.
<syntaxhighlight lang="lua">

function waterCheck(player)
if isElementInWater(player) then
outputChatBox("Wet.", player)
else
outputChatBox("Dry.", player)
end
end

addCommandHandler("check", waterCheck)
</syntaxhighlight>

==See Also==
{{Element functions}}