Difference between revisions of "SetWeaponFlags"

From Multi Theft Auto: Wiki
Jump to: navigation, search
(Added an example section and added this function to "Needs Example" template.)
Line 1: Line 1:
{{Client function}}
{{Client function}}
Set a custom weapons flags.
Set a custom weapons flags.
Line 28: Line 29:
Returns ''true'' on success (flags have 8 values), ''false'' otherwise.
Returns ''true'' on success (flags have 8 values), ''false'' otherwise.
<syntaxhighlight lang="lua">--TODO</syntaxhighlight>

Revision as of 22:42, 9 September 2013

Accessories-text-editor.png Script Example Missing Function SetWeaponFlags needs a script example, help out by writing one.

Before submitting check out Editing Guidelines Script Examples.

Set a custom weapons flags.

Note: This is not the same as setWeaponProperty. These flags are different and can only be set for custom weapon types. You cannot set these flags for 'normal' weapons. This is true despite the ability in setWeaponProperty to set any number of supported Weapon Flags.


bool setWeaponFlags ( weapon theWeapon, string theFlag, value theValue )

Required Arguments

  • theWeapon: the weapon to set the flag of
  • theFlag: the weapon flag to set:
    • bool disable_model disable the weapon model of the weapon
    • flags edit the processLineOfSight flags used to find the hit position
    • bool checkBuildings
    • bool checkCarTires
    • bool checkDummies
    • bool checkObjects
    • bool checkPeds
    • bool checkVehicles
    • bool checkSeeThroughStuff
    • bool checkShootThroughStuff
    • bool instant_reload reload the weapon instantly rather than doing a reload
    • bool shoot_if_out_of_range shoot the target position if out of weapon range
    • bool shoot_if_blocked shoot the target position if blocked
  • theValue: the value to set


Returns true on success (flags have 8 values), false otherwise.




Minimum supported server n/a
Minimum supported client 1.3.0-9.04555
Note: Using this function requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.3.0-9.04555" />

See Also

sets the flags of the weapon ( used to determine what to hit )