Multi Theft Auto: Wiki - User contributions [en]

CreatePickup

2008-03-30T08:39:38Z

Capsinurass: /* Required Arguments */ Added House (blue) model ID

__NOTOC__
{{Server client function}}
This function creates a pickup element, which is placed in the GTA world and can be picked up to retrieve a health, armour or a weapon.

==Syntax==
<syntaxhighlight lang="lua">
pickup createPickup ( float x, float y, float z, int type, int amount/weapon/model, [ int respawnTime = 30000, int ammo = 50 ] )
</syntaxhighlight>

===Required Arguments===
* '''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.
* '''type''': This is an integer representing the type of pickup, representing the following types:
** '''0''': Health Pickup
** '''1''': Armour Pickup
** '''2''': Weapon Pickup
** '''3''': Custom Pickup
* '''amount''': This is an integer representing the amount of Health points or Armour points a pickup has.
'''OR'''
* '''weapon''': If the type is a Weapon pickup, then it represents the [[Weapon|weapon ID]] of the weapon pickup the 'ammo' field must be entered if the type is Weapon Pickup.
'''OR'''
* '''model''': If the pickup is a custom model, this is the model id to use. Many non-pickup models can be used, though some may cause crashes. The following is a list of models designed to be used as pickups.
** '''1240:''' Health (heart)
** '''1242:''' Armour
** '''1272:''' House (blue)
** '''1273:''' House (green)
** '''1274:''' Money (dollar symbol)
** '''1277:''' Save (floppy disk)

===Optional Arguments===
{{OptionalArg}}
* '''respawnTime''': How long before the pickup respawns in milliseconds
* '''ammo''': An integer representing the amount of ammo a pickup contains. This is only valid when the pickup type is a Weapon Pickup, and must be entered.

==Example==
<section name="Server" class="server" show="true">
This example creates a pickup after a player dies so that he drops his weapon.
<syntaxhighlight lang="lua">
function createDeathPickup ( totalammo, killer, killerweapon, bodypart ) --when a player dies
x, y, z = getElementPosition ( source ) --get the position of the person who died and define it as x, y and z
currentweapon = getPlayerCurrentWeaponID ( source ) --get the current weapon of the dead person
createPickup ( x, y, z, 2, currentweapon, 10000, totalammo )
end
addEventHandler ( "onPlayerWasted", getRootElement(), createDeathPickup ) --add an event handler for onPlayerWasted
</syntaxhighlight>
</section>

==See Also==
{{IDs}}

{{Pickup functions}}

OnPlayerVehicleExit

2008-03-02T05:18:03Z

Capsinurass: /* Example */

__NOTOC__
{{Server event}}
This event is triggered when a player leaves a vehicle, for whatever reason.

==Parameters==
<syntaxhighlight lang="lua">
vehicle theVehicle, int seat, player jacker
</syntaxhighlight>

*'''theVehicle''': A vehicle element representing the vehicle in which the player exited from
*'''seat''': An integer representing the seat in which the player was before exiting
*'''jacker''': A player element representing the player who jacked the driver

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

==Example==
This example adds a 'moto' helmet to a player when he gets on a nrg bike, and removes it when he gets off.
<syntaxhighlight lang="lua">
function addHelmetOnEnter ( vehicle, seat, jacked )
if ( getVehicleID ( vehicle ) == 522 ) then -- if its a nrg
addPlayerClothes ( source, "moto", "moto", 16 ) -- add the helmet
end
end
addEventHandler ( "onPlayerVehicleEnter", getRootElement(), addHelmetOnEnter )

function removeHelmetOnExit ( vehicle, seat, jacked )
if ( getVehicleID ( vehicle ) == 522 ) then -- if its a nrg
removePlayerClothes ( source, 16 ) -- remove the helmet
end
end
addEventHandler ( "onPlayerVehicleExit", getRootElement(), removeHelmetOnExit )
</syntaxhighlight>

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

OnPlayerVehicleExit

2008-03-02T05:16:45Z

Capsinurass: /* Example */

__NOTOC__
{{Server event}}
This event is triggered when a player leaves a vehicle, for whatever reason.

==Parameters==
<syntaxhighlight lang="lua">
vehicle theVehicle, int seat, player jacker
</syntaxhighlight>

*'''theVehicle''': A vehicle element representing the vehicle in which the player exited from
*'''seat''': An integer representing the seat in which the player was before exiting
*'''jacker''': A player element representing the player who jacked the driver

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

==Example==
This example adds a 'moto' helmet to a player when he gets on a nrg bike, and removes it when he gets off.
<syntaxhighlight lang="lua">
function addHelmetOnEnter ( vehicle, seat, jacked )
if ( getVehicleID ( vehicle ) == 522 ) then -- if its a nrg
addPlayerClothes ( source, "moto", "moto", 16 ) -- add the helmet
end
end
addEventHandler ( "onPlayerEnterVehicle", getRootElement(), addHelmetOnEnter )

function removeHelmetOnExit ( vehicle, seat, jacked )
if ( getVehicleID ( vehicle ) == 522 ) then -- if its a nrg
removePlayerClothes ( source, 16 ) -- remove the helmet
end
end
addEventHandler ( "onPlayerVehicleExit", getRootElement(), removeHelmetOnExit )
</syntaxhighlight>

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