Multi Theft Auto: Wiki - User contributions [en]

Damage Types

2014-10-26T19:19:23Z

NeXTreme:

The following death reasons are used by event like onPlayerWasted for the killerWeapon argument to describe the reason, why a ped died.<br>
When a player was shot by a weapon, the respective weapon ID is the death reason ID. The weapon IDs can be found [[Weapons|here]].
<br>
<br>
:{|class="wikitable sortable" style="width: auto; table-layout: fixed;"
|-
!ID
! class="unsortable" |Death reason
! class="unsortable" |Additional info
|-
!19
|Rocket
|Actual death reason / weapon ID when dying from a rocket launcher
|-
!37
|Burnt
|This is used by a death by fire, even when the fire is created by a rocket explosion or a molotov
|-
!49
|Rammed
|
|-
!50
|Ranover
|This is also called when dying because of helicopter blades
|-
!51
|Explosion
|This may sometimes also be used at an indirect death through an exploding rocket
|-
!52
|Driveby
|This is NOT used for a driveby kill with e.g. the 'realdriveby' resource
|-
!53
|Drowned
|
|-
!54
|Fall
|
|-
!55
|Unknown
|No known information about this death reason
|-
!56
|Melee
|Seems to be never called (?); for an actual melee death, the fist weapon ID (0) is used (see [[Weapons|here]])
|-
!57
|Weapon
|Seems to be never called (?)
|-
!59
|Tank Grenade
|
|-
!63
|Blown
|Actual death reason when dying in a vehicle explosion
|-
|}

Death Reasons in lua table
<syntaxhighlight lang="lua">
local deathReasons = {
[19] = "Rocket",
[37] = "Burnt",
[49] = "Rammed",
[50] = "Ranover/Helicopter Blades",
[51] = "Explosion",
[52] = "Driveby",
[53] = "Drowned",
[54] = "Fall",
[55] = "Unknown",
[56] = "Melee",
[57] = "Weapon",
[59] = "Tank Grenade",
[63] = "Blown"
}
</syntaxhighlight>

[[ru:Death Reasons]]
[[de:Todesgründe]]

[[Category:ID Lists]]

FileWrite

2014-08-12T01:54:50Z

NeXTreme:

__NOTOC__
{{Server client function}}
Writes one or more strings to a given file, starting at the current read/write position. Advances the position over the number of bytes that were written.

==Syntax==
<syntaxhighlight lang="lua">
int fileWrite ( file theFile, string string1 [, string string2, string string3 ...])
</syntaxhighlight>

===Required Arguments===
*'''theFile:''' A handle to the file you wish to write to. The file must have been opened with write access, i.e. the file handle must be a result of [[fileCreate]] or [[fileOpen]] with the readonly parameter set to ''false''.
*'''string1:''' The string to write.

===Optional Arguments===
*You can provide any number of additional strings to write after '''string1'''. These will be written in the order in which they are specified.

===Returns===
Returns the number of bytes successfully written to the file.

==Example==
This example creates a text file and writes a string to it.
<syntaxhighlight lang="lua">
local fileHandle = fileCreate("test.txt") -- attempt to create a new file
if fileHandle then -- check if the creation succeeded
fileWrite(fileHandle, "This is a test file!") -- write a text line
fileClose(fileHandle) -- close the file once you're done with it
end
</syntaxhighlight>
Notice that you can't simply do fileWrite("test.txt", "File content"). Instead, file functions operate on a '''file handle''', which is a special object representing an open file.

It is also important to remember to close a file after you've finished all your operations on it, especially if you've been writing to the file. If you don't close a file and your resource crashes, all changes to the file may be lost.
==See Also==
{{File functions}}

Vehicle IDs

2014-08-11T16:16:18Z

NeXTreme:

==Introduction==
This is a list of GTA:SA's vehicle ID numbers, as listed in the vehicles.ide file. These vehicle ID numbers are used for several vehicle scripting functions.

Lua table of all the valid vehicle IDs listed on this page:
<syntaxhighlight lang="lua">vehicleIDS = { 602, 545, 496, 517, 401, 410, 518, 600, 527, 436, 589, 580, 419, 439, 533, 549, 526, 491, 474, 445, 467, 604, 426, 507, 547, 585,
405, 587, 409, 466, 550, 492, 566, 546, 540, 551, 421, 516, 529, 592, 553, 577, 488, 511, 497, 548, 563, 512, 476, 593, 447, 425, 519, 520, 460,
417, 469, 487, 513, 581, 510, 509, 522, 481, 461, 462, 448, 521, 468, 463, 586, 472, 473, 493, 595, 484, 430, 453, 452, 446, 454, 485, 552, 431,
438, 437, 574, 420, 525, 408, 416, 596, 433, 597, 427, 599, 490, 432, 528, 601, 407, 428, 544, 523, 470, 598, 499, 588, 609, 403, 498, 514, 524,
423, 532, 414, 578, 443, 486, 515, 406, 531, 573, 456, 455, 459, 543, 422, 583, 482, 478, 605, 554, 530, 418, 572, 582, 413, 440, 536, 575, 534,
567, 535, 576, 412, 402, 542, 603, 475, 449, 537, 538, 441, 464, 501, 465, 564, 568, 557, 424, 471, 504, 495, 457, 539, 483, 508, 571, 500,
444, 556, 429, 411, 541, 559, 415, 561, 480, 560, 562, 506, 565, 451, 434, 558, 494, 555, 502, 477, 503, 579, 400, 404, 489, 505, 479, 442, 458,
606, 607, 610, 590, 569, 611, 584, 608, 435, 450, 591, 594 }</syntaxhighlight>

Lua table of vehicles that are not lockable:
<syntaxhighlight lang="lua">notLockableVehicles = {594, 606, 607, 611, 584, 608, 435, 450, 591, 539, 441, 464, 501, 465, 564, 472, 473, 493, 595, 484, 430,
453, 452, 446, 454, 581, 509, 481, 462, 521, 463, 510, 522, 461, 448, 468, 586, 425, 520}</syntaxhighlight>
Lua table of vehicles without number plates:
<syntaxhighlight lang="lua">noNumberPlates = { 592, 553, 577, 488, 511, 497, 548, 563, 512, 476, 593, 447, 425, 519, 520, 460, 417, 469, 487, 513, 509, 481,
510, 472, 473, 493, 595, 484, 430, 453, 452, 446, 454 }</syntaxhighlight>

==2-Door and Compact cars==
<table border="1" class="unnamed1">
<tr><th>Name</th><th>ID</th><td></td><th>Name</th><th>ID</th></tr><tr><td>Alpha</td><td>602</td><td></td><td>Hustler</td><td>545</td></tr><tr><td>Blista Compact</td><td>496</td><td> </td><td>Majestic</td><td>517</td></tr><tr><td>Bravura</td><td>401</td><td> </td><td>Manana</td><td>410</td></tr><tr><td>Buccaneer</td><td>518</td><td> </td><td>Picador</td><td>600</td></tr><tr><td>Cadrona</td><td>527</td><td> </td><td>Previon</td><td>436</td></tr><tr><td>Club</td><td>589</td><td> </td><td>Stafford</td><td>580</td></tr><tr><td>Esperanto</td><td>419</td><td> </td><td>Stallion</td><td>439</td></tr><tr><td>Feltzer</td><td>533</td><td> </td><td>Tampa</td><td>549</td></tr><tr><td>Fortune</td><td>526</td><td> </td><td>Virgo</td><td>491</td></tr><tr><td>Hermes</td><td>474</td><td> </td><td> </td><td> </td></tr></table>

== 4-Door and Luxury cars==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th><td> </td><th>Name</th><th>ID</th></tr><tr><td>Admiral</td><td>445</td><td> </td><td>Oceanic</td><td>467</td></tr><tr><td>Damaged Glendale</td><td>604</td><td> </td><td>Premier</td><td>426</td></tr><tr><td>Elegant</td><td>507</td><td> </td><td>Primo</td><td>547</td></tr><tr><td>Emperor</td><td>585</td><td> </td><td>Sentinel</td><td>405</td></tr><tr><td>Euros</td><td>587</td><td> </td><td>Stretch</td><td>409</td></tr><tr><td>Glendale</td><td>466</td><td> </td><td>Sunrise</td><td>550</td></tr><tr><td>Greenwood</td><td>492</td><td> </td><td>Tahoma</td><td>566</td></tr><tr><td>Intruder</td><td>546</td><td> </td><td>Vincent</td><td>540</td></tr><tr><td>Merit</td><td>551</td><td> </td><td>Washington</td><td>421</td></tr><tr><td>Nebula</td><td>516</td><td> </td><td>Willard</td><td>529</td></tr></table>

==Aircraft==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th><td> </td><th>
Name</th><th>ID</th></tr><tr><td>Andromada</td><td>592</td><td> </td><td>
Nevada</td><td>553</td></tr><tr><td>AT-400</td><td>577</td><td> </td><td>

News Chopper</td><td>488</td></tr><tr><td>Beagle</td><td>511</td><td> </td><td>
Police Maverick</td><td>497</td></tr><tr><td>Cargobob</td><td>548</td><td> </td><td>
Raindance</td><td>563</td></tr><tr><td>Cropduster</td><td>512</td><td> </td><td>

Rustler</td><td>476</td></tr><tr><td>Dodo</td><td>593</td><td> </td><td>
Seasparrow</td><td>447</td></tr><tr><td>Hunter</td><td>425</td><td> </td><td>
Shamal</td><td>519</td></tr><tr><td>Hydra</td><td>520</td><td> </td><td>

Skimmer</td><td>460</td></tr><tr><td>Leviathan</td><td>417</td><td> </td><td>
Sparrow</td><td>469</td></tr><tr><td>Maverick</td><td>487</td><td> </td><td>
Stuntplane</td><td>513</td></tr></table>

==Bikes==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th><td> </td><th>Name</th><th>ID</th></tr><tr><td>BF-400</td><td>581</td><td> </td><td>Mountain Bike</td><td>510</td></tr><tr><td>Bike</td><td>509</td><td> </td><td>NRG-500</td><td>522</td> </tr><tr><td>BMX</td><td>481</td><td> </td><td>PCJ-600</td><td>461</td></tr><tr><td>Faggio</td><td>462</td><td> </td><td>Pizza Boy</td><td>448</td></tr><tr><td>FCR-900</td><td>521</td><td> </td><td>Sanchez</td><td> 468</td></tr><tr><td>Freeway</td><td>463</td><td> </td><td>Wayfarer</td><td>586</td></tr></table>

==Boats==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th></tr><tr><td>Coastguard</td><td>472</td></tr><tr><td>Dinghy</td><td>473</td></tr><tr><td>Jetmax</td><td>493</td></tr><tr><td>Launch</td><td>595</td></tr><tr><td>Marquis</td><td>484</td></tr><tr><td>Predator</td><td>430</td></tr><tr><td>Reefer</td><td>453</td></tr><tr><td>Speeder</td><td>452</td></tr><tr><td>Squalo</td><td>446</td></tr><tr><td>Tropic</td><td>454</td></tr></table>

==Civil Servant / Public Transportation (Road Vehicles)==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th></tr>
<tr><td>Baggage</td><td>485</td></tr>
<tr><td>Utility Van</td><td>552</td></tr>
<tr><td>Bus</td><td>431</td></tr>
<tr><td>Cabbie</td><td>438</td></tr>
<tr><td>Coach</td><td>437</td></tr>
<tr><td>Sweeper</td><td>574</td></tr>
<tr><td>Taxi</td><td>420</td></tr>
<tr><td>Towtruck</td><td>525</td></tr>
<tr><td>Trashmaster</td><td>408</td></tr></table>

==Government Vehicles==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th><td> </td><th>Name</th><th>ID</th></tr><tr><td>Ambulance</td><td>416</td><td> </td><td>Police Car (Los Santos)</td><td>596</td></tr><tr><td>Barracks</td><td>433</td><td> </td><td>Police Car (San Fierro)</td><td>597</td></tr><tr><td>Enforcer</td><td>427</td><td> </td><td>Police Ranger</td><td>599</td></tr><tr><td>FBI Rancher</td><td>490</td><td> </td><td>Rhino</td><td>432</td></tr><tr><td>FBI Truck</td><td>528</td><td> </td><td>S.W.A.T.</td><td>601</td></tr><tr><td>Fire Truck</td><td>407</td><td> </td><td>Securicar</td><td>428</td></tr><tr><td>Fire Truck (Ladder)</td><td>544</td><td> </td><td> </td><td> </td></tr><tr><td>HPV1000</td><td>523</td><td> </td><td> </td><td> </td></tr><tr><td>Patriot</td><td>470</td><td> </td><td> </td><td> </td></tr><tr><td>Police Car (Las Venturas)</td><td>598</td><td> </td><td> </td><td> </td></tr></table>

==Heavy and Utility Trucks==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th><td> </td><th>Name</th><th>ID</th></tr><tr><td>Benson</td><td>499</td><td> </td><td>Hotdog</td><td>588</td></tr><tr><td>Black Boxville</td><td>609</td><td> </td><td>Linerunner</td><td>403</td></tr><tr><td>Boxville</td><td>498</td><td> </td><td>Tanker</td><td>514</td></tr><tr><td>Cement Truck</td><td>524</td><td> </td><td>Mr. Whoopee</td><td>423</td></tr><tr><td>Combine Harvester</td><td>532</td><td> </td><td>Mule</td><td>414</td></tr><tr><td>DFT-30</td><td>578</td><td> </td><td>Packer</td><td>443</td></tr><tr><td>Dozer</td><td>486</td><td> </td><td>Roadtrain</td><td>515</td></tr><tr><td>Dumper</td><td>406</td><td> </td><td>Tractor</td><td>531</td></tr><tr><td>Dune</td><td>573</td><td> </td><td>Yankee</td><td>456</td></tr><tr><td>Flatbed</td><td>455</td><td> </td><td> </td><td> </td></tr></table>

==Light Trucks and Vans==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th><td> </td><th>Name</th><th>ID</th></tr><tr><td>Berkley's RC Van</td><td>459</td><td> </td><td>Sadler</td><td>543</td></tr><tr><td>Bobcat</td><td>422</td><td> </td><td>Tug</td><td>583</td></tr><tr><td>Burrito</td><td>482</td><td> </td><td>Walton</td><td>478</td></tr><tr><td>Damaged Sadler</td><td>605</td><td> </td><td>Yosemite</td><td>554</td></tr><tr><td>Forklift</td><td>530</td><td> </td><td> </td><td> </td></tr><tr><td>Moonbeam</td><td>418</td><td> </td><td> </td><td> </td></tr><tr><td>Mower</td><td>572</td><td> </td><td> </td><td> </td></tr><tr><td>News Van</td><td>582</td><td> </td><td> </td><td> </td></tr><tr><td>Pony</td><td>413</td><td> </td><td> </td><td> </td></tr><tr><td>Rumpo</td><td>440</td><td> </td><td> </td><td> </td></tr></table>

==Lowriders==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th></tr><tr><td>Blade</td><td>536</td></tr><tr><td>Broadway</td><td>575</td></tr><tr><td>Remington</td><td>534</td></tr><tr><td>Savanna</td><td>567</td></tr><tr><td>Slamvan</td><td>535</td></tr><tr><td>Tornado</td><td>576</td></tr><tr><td>Voodoo</td><td>412</td></tr></table>

==Muscle Cars==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th></tr><tr><td>Buffalo</td><td>402</td></tr><tr><td>Clover</td><td>542</td></tr><tr><td>Phoenix</td><td>603</td></tr><tr><td>Sabre</td><td>475</td></tr></table>

==Trains and Railroad Cars==

<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th><th>Notes</th></tr>
<tr><td>Tram</td><td>449</td><td></td></tr>
<tr><td>Freight</td><td>537</td><td></td></tr>
<tr><td>Brown Streak</td><td>538</td><td></td></tr>
<tr><td>Brown Streak Carriage</td><td>570</td><td>Removed in version [https://code.google.com/p/mtasa-blue/source/detail?r=2880 1.1-r2880], but available from [https://code.google.com/p/mtasa-blue/source/detail?r=5934 1.4-r5934] and forth.</tr>
<tr><td>Flat Freight</td><td>569</td><td></td></tr>
<tr><td>Box Freight</td><td>590</td><td></td></tr></table>

==RC Vehicles==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th></tr><tr><td>RC Bandit</td><td>441</td></tr><tr><td>RC Baron</td><td>464</td></tr><tr><td>RC Goblin</td><td>501</td></tr><tr><td>RC Raider</td><td>465</td></tr><tr><td>RC Tiger</td><td>564</td></tr></table>

==Recreational==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th><td> </td><th>Name</th><th>ID</th></tr><tr><td>Bandito</td><td>568</td><td> </td><td>Monster 3</td><td>557</td></tr><tr><td>BF Injection</td><td>424</td><td> </td><td>Quadbike</td><td>471</td></tr><tr><td>Bloodring Banger</td><td>504</td><td> </td><td>Sandking</td><td>495</td></tr><tr><td>Caddy</td><td>457</td><td> </td><td>Vortex</td><td>539</td></tr><tr><td>Camper</td><td>483</td><td> </td><td> </td><td> </td></tr><tr><td>Journey</td><td>508</td><td> </td><td> </td><td> </td></tr><tr><td>Kart</td><td>571</td><td> </td><td> </td><td> </td></tr><tr><td>Mesa</td><td>500</td><td> </td><td> </td><td> </td></tr><tr><td>Monster</td><td>444</td><td> </td><td> </td><td> </td></tr><tr><td>Monster 2</td><td>556</td><td> </td><td> </td><td> </td></tr></table>

==Street Racers==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th><td> </td><th>Name</th><th>ID</th></tr><tr><td>Banshee</td><td>429</td><td> </td><td>Infernus</td><td>411</td></tr><tr><td>Bullet</td><td>541</td><td> </td><td>Jester</td><td>559</td></tr><tr><td>Cheetah</td><td>415</td><td> </td><td>Stratum</td><td>561</td></tr><tr><td>Comet</td><td>480</td><td> </td><td>Sultan</td><td>560</td></tr><tr><td>Elegy</td><td>562</td><td> </td><td>Super GT</td><td>506</td></tr><tr><td>Flash</td><td>565</td><td> </td><td>Turismo</td><td>451</td></tr><tr><td>Hotknife</td><td>434</td><td> </td><td>Uranus</td><td>558</td></tr><tr><td>Hotring Racer</td><td>494</td><td> </td><td>Windsor</td><td>555</td></tr><tr><td>Hotring Racer 2</td><td>502</td><td> </td><td>ZR-350</td><td>477</td></tr><tr><td>Hotring Racer 3</td><td>503</td><td> </td><td> </td><td> </td></tr></table>

==SUVs and Wagons==
<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th></tr><tr><td>Huntley</td><td>579</td></tr><tr><td>Landstalker</td><td>400</td></tr><tr><td>Perennial</td><td>404</td></tr><tr><td>Rancher</td><td>489</td></tr><tr><td>Rancher (From "Lure")</td><td>505</td></tr><tr><td>Regina</td><td>479</td></tr><tr><td>Romero</td><td>442</td></tr><tr><td>Solair</td><td>458</td></tr></table>

==Trailers==
<table border="1" class="unnamed1"><tr><th width="218">Name</th><th width="24">ID</th></tr><tr><td>Baggage Trailer (covered)</td><td>606</td></tr><tr><td>Baggage Trailer (Uncovered)</td><td>607</td></tr><tr><td>Farm Trailer</td><td>610</td></tr><tr></tr><tr></tr><tr><td>"Street Clean" Trailer</td><td>611</td></tr><tr><td>Trailer (From "Tanker Commando")(*PRONE TO CRASHES*)</td><td>584</td></tr><tr><td>Trailer (Stairs)</td><td>608</td></tr><tr><td>Trailer 1</td><td>435</td></tr><tr><td>Trailer 2</td><td>450</td></tr><tr><td>Trailer 3</td><td>591</td></tr></table>

==Misc==
<table border="1" class="unnamed1"><tr><th width="218">Name</th><th width="24">ID</th></tr><tr><td>RC Cam (flower pot)</td><td>594</td></table>
<br>

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

==See Also==
[[id|ID Lists]]
[[it:ID Veicoli]]
[[ru:Vehicle IDs]]
[[de:Fahrzeug IDs]]

[[Category:ID Lists]]

OOP Introduction

2014-08-07T18:43:15Z

NeXTreme:

{{Note_box|If you've contributed by editing and tweaking this forum page, if you've benefited from this tutorial, or if you have anything to say; please give me feedback in the forum link provided on the left.}}
This is a scripting tutorial explaining to you what object orientated programming is and teaching you how to use the OOP features of MTA. This was originally created by [[User:Qais|qaisjp]] ([[User talk:Qais|talk]]) 22:48, 8 June 2014 (UTC). [http://forum.mtasa.com/viewtopic.php?f=148&t=76388 Forum post.]

__TOC__
== Introduction to OOP ==
OOP stands for ''object orientated programming''. Three simple words, and you'll probably understand the last word the most. OOP is where all functions relating to a single instance are called on that instance, an instance being a creation of a class - an element class, a database class, a player, a vehicle. Originally, everything was ''procedural'', you had to do things like:
<syntaxhighlight lang="lua">
local vehicle = createVehicle(411, 0, 0, 3)
setVehicleDamageProof(vehicle, true)
setElementFrozen(vehicle, true)
setElementHealth(vehicle, 1000)
setElementVelocity(vehicle, 0.2, 0.2, 0.2)
destroyElement(vehicle)
</syntaxhighlight>
More often than not, you know what you're dealing with. The variable almost always links back to the type, you would name a vehicle that exploded as '''explodedVehicle''', or at-least in context you would understand that '''exploded''' implies a vehicle when in the '''onVehicleExplode''' event. So you have to write a long function ''and'' refer to the vehicle manually when working procedurally. Painful. Object orientated programming is very different to this and works with each "object" individually. Instead of having to call a function and referencing it inside the call, you actually call the function INSIDE the class.

You probably think everything you can create and pass to functions are elements. A vehicle is an element. A player is an element. Anything that is an element is also a class. Connections create an instance of a class, but "'''connection'''" isn't an element, it's an instance - an object. Throughout the tutorial when I say ''object'', I don't mean [[createObject]] (unless I actually mention it, but to make things clearer I will avoid mentioning physical objects as I write this article. Here is a fancy venn diagram I created to show the simple organisation of classes and elements.
[[File:Classes,_Elements_and_Problem_children.png|500px|left|venn diagram]]
The functions on the left are sorted to show what kind of category the returned value rests in. We've got Classes, Elements and "Problem children".
Problem children aren't real categories written in the code, just functions that break rules. Everything you can play with are classes: resources, vehicles, and teams.
All elements are classes, you can do: <syntaxhighlight lang="lua">destroyElement(ped)</syntaxhighlight> but you can't do: <syntaxhighlight lang="lua">destroyElement(resource)</syntaxhighlight>

Problem children are weird things. You can't do all the functions mentioned in (actually, all elements don't allow the full assortment of functions to be applied to them, but I've especially mentioned a few of them) in the "Element functions" section of the functions list, but you can do destroyElement() on them.
There are children of classes, for example, with players, the system goes like: ''Element -> Ped -> Player". All Players are Peds and all Peds are Elements. Not all Peds are Players, and certainly not all Elements are Players. The main point here is that almost everything that you can create or retrieve and then reuse later use a class.

Instead of the code before, the code could be replaced with this:
<syntaxhighlight lang="lua">
local vehicle = createVehicle(411, 0, 0, 3)
vehicle:setDamageProof(true)
vehicle:setFrozen(true)
vehicle:setHealth(1000)
vehicle:setVelocity(0.2, 0.2, 0.2)
vehicle:destroy()
</syntaxhighlight>
It works pretty similar to how a table works, it's just like customTable.setSomething() except the use of ''':''' makes Lua convert customTable:setSomething() convert to customTable.setSomething(customTable). This is pretty internal stuff about ''syntactic sugar'' and you don't really need to worry much about it.

Those functions are pretty useful, but there are more changes with OOP, I'll explain this below.

== Enabling OOP ==
By default, object oriented programming is disabled - this is mainly because the vast majority of servers will prefer to stick to what they know - same old boring procedural functions. Of course, to support the great backwards-compatible-code feature of MTA, the old functions will always work and will never get removed (or atleast not in the near future). Even with OOP enabled everything will "just work". So, enabling OOP is as simple as adding:
<syntaxhighlight lang="xml"><oop>true</oop></syntaxhighlight>
to the resource meta file.

== Instantiation, variables ==
OOP removes the need to say the "create" part of the function, so instead of saying '''createVehicle''', you just say '''Vehicle'''. It works exactly the same way, it's almost just like doing '''Vehicle = createVehicle'''. Fancy, isn't it? The only difference here is that you miss out on the extra things offered, Vehicle doesn't have these extra things, but Player definitely does. For example, instead of doing getPlayerFromName(), you would do Player.getFromName(). It's a nice and simple way to organise functions.

Since OOP sits on top of procedural, many things have been inherited from the style of procedural, but to make things easier we have variables for all the functions that require a single input. We've shortened '''getElementDimension()''' down to '''element:getDimension()''', but we can also go one layer deeper: '''element.dimension'''. Yep, just like a variable. You can set this variable just like a normal variable and read from it just like a normal variable. Hey, you could even do this:
<syntaxhighlight lang="lua">local function incrementDimension()
local player = Player.getRandom() -- get a random player
player.dimension = player.dimension + 1 -- increment dimension
end
setTimer(incrementDimension, 60*1000, 10) -- set a timer for sixty thousand milliseconds, sixty seconds, one minute
</syntaxhighlight>
This code would take a random player and move them to the next dimension every minute for the next ten minutes.

== Vectors ==
player.position works too! But how do you change three arguments... using one variable? Vectors.
Vectors are very powerful classes and they come in multiple forms, for the purpose of this introduction I'll just cover a three dimensional vector in terms of elements. Using a vector is very simple, and is, of course, optional. Wherever you can currently use positions, you can use a vector.

So, this is a simple example of creating a vehicle and moving it to the the centre of the map using vectors
<syntaxhighlight lang="lua">
-- First, create a three-dimensional vector
local position = Vector3(300, -200, 2) -- some place far away
local vehicle = Vehicle(411, position) -- create a vehicle at the position
vehicle.position = centreOfMap - Vector3(300, -200, 0) -- move the vehicle two units above the center of the map
</syntaxhighlight>

Yes, I used the negative sign. Vectors aren't just fancy ways for positions or 3d rotations or whatever, you can use maths on them. The ''special'' maths hasn't been documented yet, but I'll try and work on that. So, as you can see in line one, I created a 3D vector at ''300, -200, 2'' and then in line two I created the vehicle at that position.

'''vehicle.position''' returned a vector and also takes a vector - it is pretty much setElementPosition() without the "()". Just a simple variable; so, in line three, I changed the vector value of the position of the vehicle. This is where the maths happened, in simple terms this is what is going on:
<syntaxhighlight lang="lua">
x = 300 - 300 (> 300-300 = 0)
y = -200 - -200 (> -200+200 = 0)
y = 2 - 0 (> 2-0 = 0)
</syntaxhighlight>

Vector maths is slightly complicated but it definitely allows for a wide variety of mathematical magic. Check out the useful links below related to Vectors and Matrices (Matrices = plural form of Matrix) to understand more about how this works.

== Useful links ==
Other useful OOP related tutorials:
* [[Manipulating Vectors]]
* [[Manipulating Matrices]]

[[Category:Incomplete]]
[[Category:Tutorials]]

Damage Types

2013-08-10T13:47:03Z

NeXTreme:

The following death reasons are used by event like onPlayerWasted for the killerWeapon argument to describe the reason, why a ped died.<br>
When a player was shot by a weapon, the respective weapon ID is the death reason ID. The weapon IDs can be found [[Weapons|here]].
<br>
<br>
:{|class="wikitable sortable" style="width: auto; table-layout: fixed;"
|-
!ID
! class="unsortable" |Death reason
! class="unsortable" |Additional info
|-
!19
|Rocket
|Actual death reason / weapon ID when dying from a rocket launcher
|-
!37
|Burnt
|This is used by a death by fire, even when the fire is created by a rocket explosion or a molotov
|-
!49
|Rammed
|
|-
!50
|Ranover
|This is also called when dying because of helicopter blades
|-
!51
|Explosion
|This may sometimes also be used at an indirect death through an exploding rocket
|-
!52
|Driveby
|This is NOT used for a driveby kill with e.g. the 'realdriveby' resource
|-
!53
|Drowned
|
|-
!54
|Fall
|
|-
!55
|Unknown
|No known information about this death reason
|-
!56
|Melee
|Seems to be never called (?); for an actual melee death, the fist weapon ID (0) is used (see [[Weapons|here]])
|-
!57
|Weapon
|Seems to be never called (?)
|-
!59
|Tank Grenade
|
|-
!63
|Blown
|Actual death reason when dying in a vehicle explosion
|-
|}

Death Reasons in lua table
<syntaxhighlight lang="lua">
local deathReasons = {
[19] = "Rocket",
[37] = "Burnt",
[49] = "Rammed",
[50] = "Ranover/Helicopter Blades",
[51] = "Explosion",
[52] = "Driveby",
[53] = "Drowned",
[54] = "Fall",
[55] = "Unknown",
[56] = "Meele",
[57] = "Weapon",
[59] = "Tank Grenade",
[63] = "Blown"
}
</syntaxhighlight>

[[ru:Death Reasons]]
[[de:Todesgründe]]

[[Category:ID Lists]]

OnClientCharacter

2012-04-30T14:42:45Z

NeXTreme: Created page with "{{Client event}} __NOTOC__ This event triggers whenever the user presses an alphanumeric character on their keyboard. This also includes special characters, ie. '''" / # % [ ] {..."

{{Client event}}
__NOTOC__
This event triggers whenever the user presses an alphanumeric character on their keyboard. This also includes special characters, ie. '''" / # % [ ] { }'''.

==Parameters==
<syntaxhighlight lang="lua">string character
</syntaxhighlight>
* '''character''': This represents the pressed character
==Source==
The [[event system#Event source|source]] of this event is the client's [[root element]].

==Example==
This example will output the pressed character in the chatbox.
<syntaxhighlight lang="lua">
function outputPressedCharacter(character)
outputChatBox("You pressed the character "..character.."!")
end
addEventHandler("onClientCharacter", getRootElement(), outputPressedCharacter)
</syntaxhighlight>

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

OnPlayerMarkerLeave

2011-05-01T17:30:05Z

NeXTreme: /* Example */

__NOTOC__
{{Server event}}
This event is triggered when a [[player]] leaves the area of a [[marker]].

==Parameters==
<syntaxhighlight lang="lua">
marker markerLeft, bool matchingDimension
</syntaxhighlight>

*'''markerLeft''': The marker the player left
*'''matchingDimension''': Whether the player and the marker he left are in the same dimension

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

==Example==
This example will output the name of the player that has left a specific marker to the chatbox.
<syntaxhighlight lang="lua">
-- Create our marker
marker = createMarker(1248,2012,123,"corona",7,255,255,255,255)

function someoneLeftMarker(markerLeft,matchingDimension)
-- Output our message
outputChatBox(getPlayerName(source).." has left the marker!",getRootElement(),255,0,0)
end
-- Add an event handler to trigger our function
addEventHandler("onPlayerMarkerLeave",marker,someoneLeftMarker)
</syntaxhighlight>

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

DxGetFontHeight

2011-05-01T17:08:06Z

NeXTreme: /* Example */

__NOTOC__
{{Client function}}
This function retrieves the theoretical height of a certain piece of text, if it were to be drawn using [[dxDrawText]].

==Syntax==
<syntaxhighlight lang="lua">
int dxGetFontHeight ( [float scale=1, string font="default"] )
</syntaxhighlight>

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

===Optional Arguments===
{{OptionalArg}}
* '''scale:''' The size of the text.
* '''font:''' The font of the text.
{{DxFonts}}

===Returns===
Returns an integer of the height of the text.

==Example==
The following example will draw two lines of text one above the other.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
screenWidth, screenHeight = guiGetScreenSize() -- Get the screen resolution
scale = 2 -- The scale of both texts

-- We add an event handler to keep drawing the text
addEventHandler("onClientRender",getRootElement(),function()

-- Draw the first text 400 pixels from the top and left of the screen
dxDrawText("Hello!", 400, 400, screenWidth,screenHeight,tocolor(255,255,255,255),scale,"pricedown")

-- Draw the second text above the first one.
-- The variable "offset" will return the height of the first text, so we can position the second text above the first one.
-- If we changed the scale, the second text would still be above the first one, since we calculated the height of the font.
offset = dxGetFontHeight("Hello!",scale,"pricedown")
dxDrawText("Hello!", 400, 400 - offset, screenWidth, screenHeight,tocolor(255,255,255,255),scale,"pricedown")
end)
</syntaxhighlight>
</section>

==See Also==
{{Drawing_functions}}
[[Category:Needs_Example]]

ShowPlayerHudComponent

2011-05-01T16:27:25Z

NeXTreme: /* Syntax */

__NOTOC__
{{Server client function}}
This function will show or hide a part of the player's HUD.
{{Deprecated_feature|3|1.0|
Component 'clock' does not hide the clock
}}

==Syntax==

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool showPlayerHudComponent ( player thePlayer, string component, bool show )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player element for which you wish to show/hide a HUD component
*'''component:''' The component you wish to show or hide. Valid values are:
:*'''ammo:''' The display showing how much ammo the player has in their weapon
:*'''area_name:''' The text that appears containing the name of the area a player has entered
:*'''armour:''' The display showing the player's armor
:*'''breath:''' The display showing the player's breath
:*'''clock:''' The display showing the in-game time
:*'''health:''' The display showing the player's health
:*'''money:''' The display showing how much money the player has
:*'''radar:''' The bottom-left corner miniradar
:*'''vehicle_name:''' The text that appears containing the player's vehicle name when the player enters a vehicle
:*'''weapon:''' The display showing the player's weapon
{{New feature|3.0110|1.1|
:*'''radio:''' The display showing the radio label
:*'''wanted:''' The display showing the player's wanted level
:*'''all:''' All of the above at the same time
}}
*'''show:''' Specify if the component should be shown (''true'') or hidden (''false'')
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool showPlayerHudComponent ( string component, bool show )
</syntaxhighlight>

===Required Arguments===
*'''component:''' The component you wish to show or hide. Valid values are:
:*'''ammo:''' The display showing how much ammo the player has in their weapon
:*'''area_name:''' The text that appears containing the name of the area a player has entered
:*'''armour:''' The display showing the player's armor
:*'''breath:''' The display showing the player's breath
:*'''clock:''' The display showing the in-game time
:*'''health:''' The display showing the player's health
:*'''money:''' The display showing how much money the player has
:*'''radar:''' The bottom-left corner miniradar
:*'''vehicle_name:''' The text that appears containing the player's vehicle name when the player enters a vehicle
:*'''weapon:''' The display showing the player's weapon
{{New feature|3.0110|1.1|
:*'''radio:''' The display showing the radio label
:*'''wanted:''' The display showing the player's wanted level
:*'''all:''' All of the above at the same time
}}
*'''show:''' Specify if the component should be shown (''true'') or hidden (''false'')
</section>

===Returns===
Returns ''true'' if the component was shown or hidden succesfully, ''false'' if an invalid argument was specified.

==Example==
<section name="Server" class="server" show="true">
This example hides the ammo and weapon displays for players when they join.
<syntaxhighlight lang="lua">
function hudChanger ()
showPlayerHudComponent ( source, "ammo", false ) -- Hide the ammo displays for the newly joined player
showPlayerHudComponent ( source, "weapon", false ) -- Hide the weapon displays for the newly joined player
end
-- Make our hudChanger function called when the player joins
addEventHandler ( "onPlayerJoin", getRootElement(), hudChanger )
</syntaxhighlight>
</section>

==See Also==
{{Player_functions}}

GuiGridListSetSortingEnabled

2010-12-27T16:52:20Z

NeXTreme: /* Example */

{{Client function}}
__NOTOC__
This function allows the disabling or enabling of ''sorting'' within a gridlist. Sorting is achieved by clicking a column header. Gridlist items will be sorted according to the clicked column. By default, gridlists have sorting enabled. This function will allow you to toggle this.

==Syntax==
<syntaxhighlight lang="lua">
bool guiGridListSetSortingEnabled ( element guiGridlist, bool enabled )
</syntaxhighlight>

===Required Arguments===
*'''guiGridlist:''' The GUI gridlist you wish to toggle the sorting of.
*'''enabled:''' A boolean representing whether the sorting is enabled, or disabled.

===Returns===
Returns ''true'' if sorting was successfully toggled., ''false'' otherwise.

==Example==

'''Example 1:''' This example creates a gridlist, fills it with players connected to the server and disables the sorting for that gridlist

<syntaxhighlight lang="lua">
function createGridList ()
--Create the grid list element
local newGridlist = guiCreateGridList ( 0.50, 0.50, 0.20, 0.30, true )
--Create a new grid list
local column = guiGridListAddColumn( newGridlist, "Players", 0.85 )
if ( column ) then --If the column has been created, fill it with players
for id, player in ipairs(getElementsByType("player")) do
local row = guiGridListAddRow ( newGridlist )
guiGridListSetItemText ( newGridlist, row, column, getPlayerName ( player ), false, false )
end
end
guiGridListSetSortingEnabled ( newGridlist, false )
--Disable sorting for the gridlist
end
</syntaxhighlight>

==See Also==
{{GUI functions}}
[[Category:Needs_Example]]