Difference between revisions of "GetWeaponFlags"

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:
 
__NOTOC__
 
__NOTOC__
 
{{Client function}}
 
{{Client function}}
 +
{{Needs_Example}}
 
Gets the flags of the custom weapon (used to determine what to hit)
 
Gets the flags of the custom weapon (used to determine what to hit)
  
Line 25: Line 26:
 
===Returns===
 
===Returns===
 
Returns the ''value(s)'' on success (flags have 8 values), ''false'' otherwise.
 
Returns the ''value(s)'' on success (flags have 8 values), ''false'' otherwise.
 +
 +
==Example==
 +
<syntaxhighlight lang="lua">--TODO</syntaxhighlight>
  
 
==Requirements==
 
==Requirements==

Revision as of 22:43, 9 September 2013

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

Before submitting check out Editing Guidelines Script Examples.

Gets the flags of the custom weapon (used to determine what to hit)

Syntax

value getWeaponFlags ( weapon theWeapon, string theFlag )

Required Arguments

  • theWeapon: The weapon to set the flag of.
  • theFlag: The weapon flag to get:
    • 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

Returns

Returns the value(s) on success (flags have 8 values), false otherwise.

Example

--TODO

Requirements

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