SetWeaponAmmo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 39: Line 39:
==Returns==
==Returns==
Returns ''true'' on success, ''false'' otherwise.
Returns ''true'' on success, ''false'' otherwise.
==Requirements==
{{Requirements|1.3.0-4555|1.3.0-4555|}}
</section>
</section>
==See Also==


==See Also==
==See Also==
{{Weapon functions}}
{{Weapon functions}}
{{Client weapon functions}}
[[ru:setWeaponAmmo]]
[[ru:setWeaponAmmo]]

Revision as of 23:56, 25 August 2012

Click to collapse [-]
setWeaponAmmo

Sets the ammo to a certain amount for a specified weapon (if they already have it), regardless of current ammo.

Syntax

bool setWeaponAmmo ( player thePlayer, int weapon, int totalAmmo, [int ammoInClip = 0] )

Required Arguments

  • thePlayer: A player object referencing the specified player
  • weapon: A whole number integer that refers to a weapon ID.
  • totalAmmo: A whole number integer serving as the total ammo amount for the given weapon (including ammo in clip).

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • ammoInClip: The amount of ammo to set in the player's clip. This will be taken from the main ammo. If left unspecified or set to 0, the current clip will remain.

Returns

Returns a boolean value true or false that tells you if it was successful or not.

Example

local randPlayer = getRandomPlayer() -- Get a random player
giveWeapon(randPlayer,35,100) -- Give them a rocket launcher with 100 rockets.
setWeaponAmmo(randPlayer,35,50) -- Decide we're only going to give them 50 rockets.
Click to collapse [-]
setWeaponAmmo (custom weapons)

Set the ammo of a custom weapon.

Syntax

bool setWeaponAmmo ( weapon theWeapon, int Ammo )

Required Arguments

  • theWeapon: The weapon to set the ammo of.
  • Ammo: The amount of ammo the weapon has total.

Returns

Returns true on success, false otherwise.

Requirements

This template will be deleted.

See Also

See Also