SetWeaponProperty: Difference between revisions

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


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">bool success = setWeaponProperty ( int weaponID, string weaponType, string property, int theValue )</syntaxhighlight>
<syntaxhighlight lang="lua">bool success = setWeaponProperty ( int weaponID/string weaponName, string weaponType, string property/int property, int/float theValue )</syntaxhighlight>


==Required Arguments==
==Required Arguments==
Line 14: Line 14:
*'''property:''' The property you want to get the value of:
*'''property:''' The property you want to get the value of:


** "weapon_range"
** "weapon_range" - float
** "target_range"
** "target_range" - float
** "accuracy"
** "accuracy" - float
** "damage"
** "damage" - int
** "life_span" // Disabled for release
** "maximum_clip_ammo" - int
** "firing_speed" // Disabled for release
** "flags" - int (specify a flag to toggle it on/off)
** "spread" // Disabled for release
** "move_speed" - float
** "maximum_clip_ammo" )
 
** "move_speed" )
** "flags" )
** "anim_group" ) // Disabled for release
** // Set is Disabled >= FIRETYPE - Move above WEAPON_TYPE_SET_DISABLED to re-enable and move it above here to make it less confusing.
** "fire_type"
** "model"
** "model2"
** "weapon_slot"
** "fire_offset"
** "skill_level"
** "required_skill_level"
** "anim_loop_start"
** "anim_loop_stop"
** "anim_loop_bullet_fire"
** "anim2_loop_start"
** "anim2_loop_stop"
** "anim2_loop_bullet_fire"
** "anim_breakout_time" 
** "radius" 
** "aim_offset"
** "default_combo"
** "combos_available"


==Returns==
==Returns==

Revision as of 00:12, 17 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 success = 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
    • "flags" - int (specify a flag to toggle it on/off)
    • "move_speed" - float


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 = getWeaponProperty(31, "poor", "weapon_range", 75)
if (rangeSet) then
    outputChatBox("M4 range at poor skill is set now 75!")
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetWeaponProperty?oldid=27963"