GiveWeapon

2010-11-11T13:34:54Z

Mab: /* Required Arguments */

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

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

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

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

===Returns===
Returns ''true'' if weapon was successfully acquired, ''false'' otherwise.

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

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

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

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

==See Also==
{{Weapon functions}}
[[ru:giveWeapon]]

Multi Theft Auto: Wiki - User contributions [en]

GiveWeapon