SetWeaponProperty: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 13: Line 13:
*'''weaponType:''' Either: "pro", "std" or "poor"
*'''weaponType:''' Either: "pro", "std" or "poor"
*'''property:''' The property you want to get the value of:
*'''property:''' The property you want to get the value of:
** "weapon_range" - float
** "weapon_range" - float
** "target_range" - float
** "target_range" - float
Line 20: Line 19:
** "maximum_clip_ammo" - int
** "maximum_clip_ammo" - int
** "move_speed" - float
** "move_speed" - float
** "flags" - int (specify a flag to toggle it on/off)
** "flags" - int (specify a flag to toggle it on/off) See [[Weapon Flags]]
 
*'''theValue:''' The value to set the property too.


==Returns==
==Returns==

Revision as of 15:18, 26 November 2011

Only available in MTA:SA v1.2 and onwards. This function sets the weapon property of the specified weapons specified weapon type.

Syntax

bool setWeaponProperty ( int weaponID/string weaponName, string weaponType, string property/int property, int/float theValue )

Required Arguments

  • weaponID: The ID of the weapon you want to get info of see Weapons
  • weaponType: Either: "pro", "std" or "poor"
  • property: The property you want to get the value of:
    • "weapon_range" - float
    • "target_range" - float
    • "accuracy" - float
    • "damage" - int
    • "maximum_clip_ammo" - int
    • "move_speed" - float
    • "flags" - int (specify a flag to toggle it on/off) See Weapon Flags
  • theValue: The value to set the property too.

Returns

On success:

bool: Returns true if the weapon property was successfully set

On failure:

bool: Returns false if the weapon property was unable to be set

Example

This example sets the weapon range of the M4 at poor skill level to 75

local rangeSet = setWeaponProperty(31, "poor", "weapon_range", 75)
if (rangeSet) then
    outputChatBox("M4 range at poor skill is set now 75!")
end

See Also