Multi Theft Auto: Wiki - User contributions [en]

How you can help

2014-06-14T15:44:22Z

Szybki: Undo revision 39885 by Le'CC (talk)

__NOTOC__
Multi Theft Auto has loads of areas in which you can help us. In turn, we'll be more than happy to help you get started with any ideas you have, help test them and - if they're good enough - release them to the whole community. This page outlines the key areas you could do something in, of course, there's many things we've not thought of, so think outside the box!

==Coding for MTASA==
* Submit source patches for the mod, containing requested features or bugfixes. ([[Coding guidelines]])
* Translate MTA:SA to your native language - http://translate.multitheftauto.com/

==Scripting==
* Create a gamemode
**[[Scripting Introduction]]
**[http://www.lua.org/pil/index.html "Programming in Lua" Manual]
* Create an administration page on the HTTP server.
**[[Resource Web Access]]
* Make a general purpose resource that provides useful functions to other resources.

==Mapping==
* Create a map with the map editor for an existing gamemode.
**[[Resource:Editor|Map Editor Manual]]

==Web development==
* Work with lil_Toady to add new features and improvements to community.mtasa.com.
* Create your own system for statistics - using the [[PHP SDK]] as a basis. Contact eAi or jbeta for help.

==Documentation==
Before you make changes check out: [[Help:Editing Guidelines|Editing Guidelines]]
* Finish documentation for [[:Category:Incomplete|Incomplete functions]] - ask in #mta.scripting if you're not sure of something.
* Add examples to [[:Category:Needs Example|functions & events missing examples]] - please test them, and again, as if you need help.
* Review and verify [[:Category:Needs Checking|pages that need checking]] - make sure highlighted issues are solved before removing pages from the category.
* Expand the pages that explain [[:Category:Scripting_Concepts|MTA core concepts]].
* Write tutorials to help new people.
* Translate the wiki pages so people from other countries can get started in MTA too.
* Create documentation for undocumented functions and events [[Undocumented Items]]

==Specific tasks==
* Create a fuzzer to check for crashes in our scripting functions.
* Help develop/fix existing gamemodes. Contact the original author on IRC (or ask a developer) to tell the author so you can work together.
* The web interface resources (resourcemanager, resourcebrowser and webadmin chiefly) are really only compatible with Firefox. Someone could put in some time to make these work on Internet Explorer, Opera and Safari. See [[User_talk:EAi|eAi]] for help.

[[pl:Jak możesz pomóc]]
[[ru:How you can help]]
[[es:Cómo puedes ayudar]]
[[hu:How you can help]]

CreateBlip

2014-05-15T13:37:19Z

Szybki: Undo revision 39533 by Iromand (talk)

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

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

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

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

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

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

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

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

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

==See Also==
{{Blip_functions}}

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

User:Lopez

2013-06-02T03:35:29Z

Szybki: Undo revision 36306 by MOJRM-511 (talk)

Hello, my name is lopez(loo) and I'm from [[PL/Strona_Główna|Poland]][[File:Plflag.png]].

[[File:Oilschaps.jpg|thumb|350px|I don't have idea what I am doing.]]

Greetings.

== [http://bugs.mtasa.com/view.php?id=7631 playGTAScriptSound] ==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
playGTAScriptSound(int soundID, [bool looped = false])
playGTAScriptSound3D(int soundID, float x, float y, float z, [bool looped = false])
</syntaxhighlight>
</section>

=== Sounds ID ===
* http://pastebin.com/cfMR0phi -- list of all GTA script sounds from data/AudioEvents.txt (ex. casino conversations etc.)

=== Memory adress ===
Memory adress of main.scm function to play sound.
<section name="from main.scm" class="client" show="true">
<syntaxhighlight lang="lua">

0952: load_soundtrack 0 -- 0 is id?
0953: get_soundtrack_status_to @23 - I think last argument is main.scm code block

0954: start_playing_loaded_soundtrack
0955: end_playing_loaded_soundtrack
^ i think this is the old, bugged playMissionAudio function

043C: disable_sounds_after_fade 1 -- can be 1 or 0

I think this is what Im looking for
018C: play_sound 1052 at 0.0 0.0 0.0 - this? SOUND_AMMUNATION_BUY_WEAPON 1052; I think 0 0 0 = no 3D sound
018C: play_sound 65535 at 2181.127 -2251.999 14.036 - another example; id 65535 doesnt exist in AudioEvents.txt
018C: play_sound 1058 at 0.0 0.0 0.0
018C: play_sound 1053 at 0.0 0.0 0.0

'--> 018C <--

</syntaxhighlight>
</section>

== ? ==

MOJRM-511
<meta http-equiv="Content-Language" content="ar-sa">

<center><font size="64px"> ̿̿ ̿̿ ̿̿ ̿'̿'\̵͇̿̿\з=( ͡° ͜ʖ ͡°)=ε/̵͇̿̿/’̿’̿ ̿ ̿̿ ̿̿ ̿̿</font></center>

CreateElement

2013-06-02T03:34:40Z

Szybki: Undo revision 36309 by MOJRM-511 (talk)

__NOTOC__
{{Server client function}}
This function is used to create a new dummy element in the [[element tree]] which do not necessarily represent an entity within the San Andreas world. A common use for this function is for creating custom elements, such as a Flag or a Base.

Elements created using this function are placed in the element tree with their parent as the 'dynamic' map element.

==Syntax==
<syntaxhighlight lang="lua">
element createElement ( string elementType, [ string elementID = nil ] )
</syntaxhighlight>

===Required Arguments===
*'''elementType:''' The type of element being created.

===Optional Arguments===
*'''elementID:''' The ID of the element being created.

===Returns===
Returns the element if it was successfully created. Returns ''false'' if the arguments are wrong.

==Example==
This example creates a "flag" element, named "blue", which will be at the resource's dynamic map.

<syntaxhighlight lang="lua">
blueTeamFlag = createElement( "flag", "blue" )
</syntaxhighlight>

Except for it being placed in a different map root, that line will have the same effect as having this in a .map file:
<syntaxhighlight lang="xml">
<flag id="blue" />
</syntaxhighlight>

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

GetAttachedElements

2013-06-02T03:34:22Z

Szybki: Undo revision 36308 by MOJRM-511 (talk)

{{Server client function}}
__NOTOC__
This function returns a table of all the elements attached to the specified element

==Syntax==
<syntaxhighlight lang="lua">
table getAttachedElements ( element theElement )
</syntaxhighlight>

===Required Arguments===
*'''theElement''': The [[element]] which you require the information from.

===Returns===
Returns a table of all the elements attached to the specified element.

==Example==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
-- Print a list of all the players attached to the specified element
local Inf = getElementByID ( "infernus1" )
local attachedElements = getAttachedElements ( Inf )
if ( attachedElements ) then -- if we got the table
local attachedElementsList = "none"
-- Loop through the table
for ElementKey, ElementValue in ipairs ( attachedElements ) do
-- add their name to the list
if ( getElementType ( ElementValue ) == "player" ) then
if ( attachedElementsList == "none" ) then
attachedElementsList = getPlayerName ( ElementValue )
else
attachedElementsList = attachedElementsList .. ", " .. getPlayerName ( ElementValue )
end
end
end
outputConsole ( "Players attached to the infernus: " .. attachedElementsList )
end
</syntaxhighlight>
</section>

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

GetCameraTarget

2013-06-02T03:34:05Z

Szybki: Undo revision 36307 by MOJRM-511 (talk)

{{Server client function}}
__NOTOC__
This function returns an [[element]] that corresponds to the current target of the specified player's camera (i.e. what it is following).
==Syntax==
<section class="server" name="Server" show="true">
<syntaxhighlight lang="lua">
element getCameraTarget ( player thePlayer )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player whose camera you wish to receive the target of.
</section>
<section class="client" name="Client" show="true">
<syntaxhighlight lang="lua">
element getCameraTarget ()
</syntaxhighlight>
</section>

===Returns===
* Returns an [[element]] of the target if the function was successful, or ''false'' if bad arguments were specified
{{New feature|3|1.0|
* Returns ''false'' if the camera is in Fixed mode and has no target.
}}

==Example==
This example checks whether a player's camera's target is another player, and returns true or false accordingly.
<section class="server" name="Server script" show="true">
<syntaxhighlight lang="lua">
function isTargetPlayer( thePlayer )
local target = getCameraTarget ( thePlayer )
if ( getElementType ( target ) == "player" ) then -- If target is a player
return true -- Return true
else
return false -- Otherwise, return false.
end
end
</syntaxhighlight>
</section>

==See Also==
{{Camera functions}}

OnClientPlayerDamage

2013-06-02T00:14:08Z

Szybki: Undo revision 36278 by MOJRM-511 (talk)

__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 being run over or falling off a bike).
*'''weapon''': An integer representing the weapon ID the attacker used
*'''bodypart''': An integer representing the bodypart the player was damaged
{{BodyParts}}
{{New feature/item|3|1.0||
*'''loss''': A float representing the percentage of health the player lost.
}}

==Source==
The [[event system#Event source|source]] of this event is the [[player]] that got damaged. (Streamed in players only)

==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}}

OnClientPlayerDamage

2013-06-02T00:13:56Z

Szybki: Undo revision 36277 by MOJRM-511 (talk)

__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 being run over or falling off a bike).
*'''weapon''': An integer representing the weapon ID the attacker used
*'''bodypart''': An integer representing the bodypart the player was damaged
{{BodyParts}}
{{New feature/item|3|1.0||
*'''loss''': A float representing the percentage of health the player lost.
}}

==Source==
The [[event system#Event source|source]] of this event is the [[player]] that got damaged. (Streamed in players only)

==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 == MOJRM-511 ) then --if the weapon used was the MOJRM-511
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}}

OnClientPickupHit

2013-06-02T00:13:35Z

Szybki: Undo revision 36273 by MOJRM-511 (talk)

{{Client event}}
__NOTOC__
This event triggers whenever a pickup is hit clientside.

==Parameters==
<syntaxhighlight lang="lua">
player thePlayer, bool matchingDimension
</syntaxhighlight>
*'''thePlayer:''' the player that hit the pickup
*'''matchingDimension:''' ''true'' if thePlayer is in the same dimension as the pickup, ''false'' otherwise.

==Source==
The source of this event is the pickup that was hit.

==Example==
This example outputs a message whenever a player hits a pickup locally.
<syntaxhighlight lang="lua">
local function clientPickupHit(thePlayer, matchingDimension)
outputChatBox("* "..getPlayerName(thePlayer).." hit a pickup!", 255, 0, 0)
end
addEventHandler("onClientPickupHit", root, clientPickupHit)
</syntaxhighlight>

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

OnPlayerConnect

2013-06-02T00:07:45Z

Szybki: Undo revision 36268 by MOJRM-511 (talk)

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

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

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

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

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

==Example==

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

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

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

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

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

OnClientPlayerSpawn

2013-06-01T23:59:51Z

Szybki: Undo revision 36279 by MOJRM-511 (talk)

{{Client event}}
__NOTOC__
This event is triggered when any player, including a remote player, spawns.

==Parameters==
<syntaxhighlight lang="lua">
team hisTeam
</syntaxhighlight>

*'''hisTeam''': A team element representing the team the player spawned on.

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

==Example==
This code will create an explosion for the local player when they spawn.
<syntaxhighlight lang="lua">function explosionOnSpawn ( )
-- get the spawned player's position
local pX, pY, pZ = getElementPosition ( source )
-- and create an explosion there
createExplosion ( pX, pY, pZ, 6 )
end
-- add this function as a handler for any player that spawns
addEventHandler ( "onClientPlayerSpawn", getLocalPlayer(), explosionOnSpawn )
</syntaxhighlight>

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