SetWeaponProperty: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 10: Line 10:


==Required Arguments==
==Required Arguments==
*'''weaponID:''' The ID of the weapon you want to get info of see [[Weapons]]
*'''weaponID:''' The ID of the [[Weapons|weapon]] you want to set a property of
*'''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 set the value of:
** "weapon_range" - float
** "weapon_range" - float
** "target_range" - float
** "target_range" - float
Line 20: Line 20:
** "move_speed" - float
** "move_speed" - float
** "flags" - int (specify a flag to toggle it on/off) See [[Weapon Flags]]
** "flags" - int (specify a flag to toggle it on/off) See [[Weapon Flags]]
*'''theValue:''' The value to set the property too.
*'''theValue:''' The value to set the property to.


==Returns==
==Returns==

Revision as of 11:09, 18 December 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 set a property of
  • weaponType: Either: "pro", "std" or "poor"
  • property: The property you want to set 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 to.

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

This example makes the silenced pistol dual wielded at pro skill level

setWeaponProperty(23, "pro", "flags", 0x000800)
setWeaponProperty(23, "pro", "flags", 0x000002)
setWeaponProperty(23, "pro", "maximum_clip_ammo", 34)

This examples doubles the range of the colt 45 hand gun

setWeaponProperty(22, "poor", "weapon_range", 70)
setWeaponProperty(22, "std", "weapon_range", 70)
setWeaponProperty(22, "pro", "weapon_range", 70)

This example makes the minigun able to fire all its ammo without the short reload time

setWeaponProperty("minigun", "pro", "maximum_clip_ammo", 1000)

Requirements

Minimum server version 1.2
Minimum client version n/a

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version server="1.2" />

See Also