GetWeaponFlags - Revision history

Fernando187: Remove obsolete Requirements section

2024-11-07T17:06:28Z

Remove obsolete Requirements section

← Older revision		Revision as of 17:06, 7 November 2024
Line 37:		Line 37:
	end		end
	</syntaxhighlight>		</syntaxhighlight>

	~~==Requirements==~~
	~~{{Requirements\|n/a\|1.3.0-9.04555\|}}~~

	==See also==		==See also==
	{{Client weapon creation functions}}		{{Client weapon creation functions}}

Walid: Added example

2016-07-04T14:23:44Z

Added example

← Older revision		Revision as of 14:23, 4 July 2016
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	~~{{Needs_Example}}~~
	This function gets the flags of a [[Element/Weapon\|custom weapon]].		This function gets the flags of a [[Element/Weapon\|custom weapon]].

Line 29:		Line 28:

	==Example==		==Example==
	<syntaxhighlight lang="lua">--~~TODO~~</syntaxhighlight>		This example checks whether the instant_reload flag is enabled or disabled.
			<syntaxhighlight lang="lua">
			local weapon = createWeapon("silenced", 0, 0, 10) -- Create the weapon
			if weapon then -- if the weapon exist then
			setWeaponFlags(weapon, "instant_reload", true) -- enable instant_reload
			local flag = (getWeaponFlags (weapon,"instant_reload") and "instant_reload enabled") or "instant_reload disabled"
			outputChatBox (flag)
			end
			</syntaxhighlight>

	==Requirements==		==Requirements==

AlexTMjugador: Fixed some Copy & Paste things

2014-12-23T17:30:24Z

Fixed some Copy & Paste things

← Older revision		Revision as of 17:30, 23 December 2014
Line 2:		Line 2:
	{{Client function}}		{{Client function}}
	{{Needs_Example}}		{{Needs_Example}}
	This function gets the flags of a [[Element/Weapon\|custom weapon]]~~. Please refer to [[setWeaponFlags]] for details~~.		This function gets the flags of a [[Element/Weapon\|custom weapon]].

	==Syntax==		==Syntax==
Line 12:		Line 12:
	* '''theFlag:''' the weapon flag to get:		* '''theFlag:''' the weapon flag to get:
	** '''disable_model''': makes the weapon and muzzle effect invisible or not.		** '''disable_model''': makes the weapon and muzzle effect invisible or not.
	** '''flags''': ~~configures~~ the flags used to get where the gun shoots at~~. They are based on [[processLineOfSight]]'s. You have to specify all the eight flags for the function to succeed~~. These flags are (by order):		** '''flags''': returns the flags used to get where the gun shoots at. These flags are (by order):
	*** '''checkBuildings''': allows the shoot to be blocked by GTA's internally placed buildings, i.e. the world map.		*** '''checkBuildings''': allows the shoot to be blocked by GTA's internally placed buildings, i.e. the world map.
	*** '''checkCarTires''': allows the shoot to be blocked by [[vehicle]] tires.		*** '''checkCarTires''': allows the shoot to be blocked by [[vehicle]] tires.
Line 21:		Line 21:
	*** '''checkSeeThroughStuff''': allows the shoot to be blocked by translucent game objects, e.g. glass.		*** '''checkSeeThroughStuff''': allows the shoot to be blocked by translucent game objects, e.g. glass.
	*** '''checkShootThroughStuff''': allows the shoot to be blocked by things that can be shot through.		*** '''checkShootThroughStuff''': allows the shoot to be blocked by things that can be shot through.
	** '''instant_reload''': if enabled, the weapon ~~will reload~~ instantly rather than waiting the reload time until shooting again.		** '''instant_reload''': if enabled, the weapon reloads instantly rather than waiting the reload time until shooting again.
	** '''shoot_if_out_of_range''': if enabled, the weapon ~~will~~ still ~~fire~~ its target beyond the weapon range distance.		** '''shoot_if_out_of_range''': if enabled, the weapon still fires its target beyond the weapon range distance.
	** '''shoot_if_blocked''': if enabled, the weapon ~~will~~ still ~~fire~~ its target even if it's blocked by something.		** '''shoot_if_blocked''': if enabled, the weapon still fires its target even if it's blocked by something.

	===Returns===		===Returns===

AlexTMjugador at 16:32, 23 December 2014

2014-12-23T16:32:43Z

← Older revision		Revision as of 16:32, 23 December 2014
Line 5:		Line 5:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">~~value~~ getWeaponFlags ( weapon theWeapon, string theFlag )</syntaxhighlight>		<syntaxhighlight lang="lua">bool getWeaponFlags ( weapon theWeapon, string theFlag )</syntaxhighlight>
			{{OOP\|\|[[Element/Weapon\|weapon]]:getFlags\|\|setWeaponFlags}}

	===Required Arguments===		===Required Arguments===

AlexTMjugador: Added OOP syntax and improved some things

2014-12-23T16:31:55Z

Added OOP syntax and improved some things

← Older revision		Revision as of 16:31, 23 December 2014
Line 2:		Line 2:
	{{Client function}}		{{Client function}}
	{{Needs_Example}}		{{Needs_Example}}
	~~Gets~~ the flags of ~~the~~ custom weapon ~~(used to determine what~~ to ~~hit)~~		This function gets the flags of a [[Element/Weapon\|custom weapon]]. Please refer to [[setWeaponFlags]] for details.

	==Syntax==		==Syntax==
Line 8:		Line 8:

	===Required Arguments===		===Required Arguments===
	* '''theWeapon:''' ~~The~~ weapon to get the flag of.		* '''theWeapon:''' the weapon to get the flag of.
	* '''theFlag:''' ~~The~~ weapon flag to get:		* '''theFlag:''' the weapon flag to get:
	** ~~bool~~ disable_model ~~disable the weapon model of~~ the weapon		** '''disable_model''': makes the weapon and muzzle effect invisible or not.
	** flags ~~edit~~ the ~~processLineOfSight~~ flags used to ~~find~~ the ~~hit position~~		** '''flags''': configures the flags used to get where the gun shoots at. They are based on [[processLineOfSight]]'s. You have to specify all the eight flags for the function to succeed. These flags are (by order):
	** ~~bool~~ checkBuildings		*** '''checkBuildings''': allows the shoot to be blocked by GTA's internally placed buildings, i.e. the world map.
	** ~~bool~~ checkCarTires		*** '''checkCarTires''': allows the shoot to be blocked by [[vehicle]] tires.
	** ~~bool~~ checkDummies		*** '''checkDummies''': allows the shoot to be blocked by GTA's internal dummies. These are not used in the current MTA version so this argument can be set to ''false''.
	** ~~bool~~ checkObjects		*** '''checkObjects''': allows the shoot to be blocked by [[object\|objects]].
	** ~~bool~~ checkPeds		*** '''checkPeds''': allows the shoot to be blocked by [[ped\|peds]] and [[player\|players]].
	** ~~bool~~ checkVehicles		*** '''checkVehicles''': allows the shoot to be blocked by [[vehicle\|vehicles]].
	** ~~bool~~ checkSeeThroughStuff		*** '''checkSeeThroughStuff''': allows the shoot to be blocked by translucent game objects, e.g. glass.
	** ~~bool~~ checkShootThroughStuff		*** '''checkShootThroughStuff''': allows the shoot to be blocked by things that can be shot through.
	** ~~bool~~ instant_reload ~~reload~~ the weapon instantly rather than ~~doing a~~ reload		** '''instant_reload''': if enabled, the weapon will reload instantly rather than waiting the reload time until shooting again.
	** ~~bool~~ shoot_if_out_of_range ~~shoot~~ the target ~~position if out of~~ weapon range		** '''shoot_if_out_of_range''': if enabled, the weapon will still fire its target beyond the weapon range distance.
	** ~~bool~~ shoot_if_blocked ~~shoot~~ the target ~~position~~ if blocked		** '''shoot_if_blocked''': if enabled, the weapon will still fire its target even if it's blocked by something.

	===Returns===		===Returns===
	Returns the ''~~value(s)~~'' on success (flags ~~have~~ 8 values), ''false'' ~~otherwise~~.		Returns the ''true'' or ''false'' on success (''flags'' flag returns 8 values) if the flag is enabled or not. Returns ''false'' if the weapon element isn't valid or an error occured.

	==Example==		==Example==
Line 33:		Line 33:
	{{Requirements\|n/a\|1.3.0-9.04555\|}}		{{Requirements\|n/a\|1.3.0-9.04555\|}}

	==See ~~Also~~==		==See also==
	{{Client weapon creation functions}}		{{Client weapon creation functions}}

HuX: /* Required Arguments */

2014-10-12T22:15:22Z

Required Arguments

← Older revision		Revision as of 22:15, 12 October 2014
Line 8:		Line 8:

	===Required Arguments===		===Required Arguments===
	* '''theWeapon:''' The weapon to ~~set~~ the flag of.		* '''theWeapon:''' The weapon to get the flag of.
	* '''theFlag:''' The weapon flag to get:		* '''theFlag:''' The weapon flag to get:
	** bool disable_model disable the weapon model of the weapon		** bool disable_model disable the weapon model of the weapon

Jaysds1: Added an example section and added this function to "Needs Example" template.

2013-09-09T22:43:37Z

Added an example section and added this function to "Needs Example" template.

← Older revision		Revision as of 22:43, 9 September 2013
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==

The GTA at 15:04, 9 September 2013

2013-09-09T15:04:00Z

← Older revision		Revision as of 15:04, 9 September 2013
Line 4:		Line 4:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">value getWeaponFlags ( theWeapon, string theFlag )</syntaxhighlight>		<syntaxhighlight lang="lua">value getWeaponFlags ( weapon theWeapon, string theFlag )</syntaxhighlight>

	===Required Arguments===		===Required Arguments===

Ccw at 22:45, 10 September 2012

2012-09-10T22:45:45Z

← Older revision		Revision as of 22:45, 10 September 2012
Line 27:		Line 27:

	==Requirements==		==Requirements==
	{{Requirements\|1.3.0-~~4555\|1~~.~~3.0-4555~~\|}}		{{Requirements\|n/a\|1.3.0-9.04555\|}}

	==See Also==		==See Also==
	{{Client weapon creation functions}}		{{Client weapon creation functions}}

Cazomino05 at 10:46, 26 August 2012

2012-08-26T10:46:19Z

← Older revision		Revision as of 10:46, 26 August 2012
Line 30:		Line 30:

	==See Also==		==See Also==
	{{Client weapon functions}}		{{Client weapon creation functions}}