SetWeaponProperty - Revision history

Fernando187: Remove obsolete Requirements section

2024-11-07T15:36:03Z

Remove obsolete Requirements section

← Older revision		Revision as of 15:36, 7 November 2024
Line 97:		Line 97:

	</section>		</section>

	~~==Requirements==~~
	~~{{Requirements\|1.3\|1.3.0-9.04555\|}}~~

	==Changelog==		==Changelog==

StrixG at 09:11, 20 January 2020

2020-01-20T09:11:25Z

← Older revision		Revision as of 09:11, 20 January 2020
Line 27:		Line 27:

	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	<p>The client side function only applies to custom weapons created client sided</p>		<p>The client side function only applies to custom weapons created client sided.</p>
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">bool setWeaponProperty ( weapon theWeapon, string strProperty, value theValue )</syntaxhighlight>		<syntaxhighlight lang="lua">bool setWeaponProperty ( weapon theWeapon, string strProperty, value theValue )</syntaxhighlight>

NanoBob: Changed layout to be more consistent with the rest of the wiki

2019-03-08T15:36:02Z

Changed layout to be more consistent with the rest of the wiki

← Older revision		Revision as of 15:36, 8 March 2019
Line 1:		Line 1:
	{{Server client function}}		{{Server client function}}
	__NOTOC__		__NOTOC__
	<section name="~~setWeaponProperty~~" class="server" show="true">		<section name="Server" class="server" show="true">
	This function sets the weapon property of the specified weapons specified weapon type. See lower down the page for documentation related to weapon creation.		This function sets the weapon property of the specified weapons specified weapon type. See lower down the page for documentation related to weapon creation.

	==Syntax ~~(Server only)~~==		==Syntax==
	<syntaxhighlight lang="lua">bool setWeaponProperty ( int weaponID/string weaponName, string weaponSkill, string property, int/float theValue )</syntaxhighlight>		<syntaxhighlight lang="lua">bool setWeaponProperty ( int weaponID/string weaponName, string weaponSkill, string property, int/float theValue )</syntaxhighlight>

Line 23:		Line 23:

	'''bool:''' Returns false if the weapon property was unable to be set		'''bool:''' Returns false if the weapon property was unable to be set
			</section>


			<section name="Client" class="client" show="true">
			<p>The client side function only applies to custom weapons created client sided</p>
			==Syntax==
			<syntaxhighlight lang="lua">bool setWeaponProperty ( weapon theWeapon, string strProperty, value theValue )</syntaxhighlight>
			{{OOP\|\|[[Element/Weapon\|weapon]]:setProperty\|\|getWeaponProperty}}

			==Required Arguments==

			* '''theWeapon:''' the weapon to change the property of.
			* '''strProperty:''' the property to edit:
			{{Custom Weapon Properties Writable}}
			* '''theValue:''' The value to set the property to.

			==Returns==
			Returns ''true'' if the property was set.
			</section>

	==Example==		==Example==

			<section name="Server" class="server" show="true">
	This example sets the weapon range of the M4 at poor skill level to 75		This example sets the weapon range of the M4 at poor skill level to 75
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 75:		Line 96:
	</syntaxhighlight>		</syntaxhighlight>

	~~==Requirements==~~
	~~{{Requirements\|1.3\|n/a\|}}~~
	</section>		</section>

	~~<section name="setWeaponProperty" class="client" show="true">~~
	~~==Syntax (Custom weapons - Client only)==~~
	~~<syntaxhighlight lang="lua">bool setWeaponProperty ( weapon theWeapon, string strProperty, value theValue )</syntaxhighlight>~~
	~~{{OOP\|\|[[Element/Weapon\|weapon]]:setProperty\|\|getWeaponProperty}}~~

	~~==Required Arguments==~~

	* '''theWeapon:''' the weapon to change the property of.
	* '''strProperty:''' the property to edit:
	~~{{Custom Weapon Properties Writable}}~~
	* '''theValue:''' The value to set the property to.

	~~==Returns==~~
	~~Returns ''true'' if the property was set.~~

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

	==Changelog==		==Changelog==
	{{ChangelogHeader}}		{{ChangelogHeader}}
	{{ChangelogItem\|1.4.0-9.06339\|Added 'fire_rotation' property}}		{{ChangelogItem\|1.4.0-9.06339\|Added 'fire_rotation' property}}

	~~</section>~~

	==See also==		==See also==
	{{Weapon functions}}		{{Weapon functions}}

Ccw at 05:04, 21 December 2016

2016-12-21T05:04:05Z

← Older revision		Revision as of 05:04, 21 December 2016
Line 4:		Line 4:
	This function sets the weapon property of the specified weapons specified weapon type. See lower down the page for documentation related to weapon creation.		This function sets the weapon property of the specified weapons specified weapon type. See lower down the page for documentation related to weapon creation.

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

Line 80:		Line 80:

	<section name="setWeaponProperty" class="client" show="true">		<section name="setWeaponProperty" class="client" show="true">
	==Syntax (~~custom~~ weapons)==		==Syntax (Custom weapons - Client only)==
	<syntaxhighlight lang="lua">bool setWeaponProperty ( weapon theWeapon, string strProperty, value theValue )</syntaxhighlight>		<syntaxhighlight lang="lua">bool setWeaponProperty ( weapon theWeapon, string strProperty, value theValue )</syntaxhighlight>
	{{OOP\|\|[[Element/Weapon\|weapon]]:setProperty\|\|getWeaponProperty}}		{{OOP\|\|[[Element/Weapon\|weapon]]:setProperty\|\|getWeaponProperty}}

AlexTMjugador: Added OOP syntax to custom weapon syntax

2014-12-23T16:51:40Z

Added OOP syntax to custom weapon syntax

← Older revision		Revision as of 16:51, 23 December 2014
Line 80:		Line 80:

	<section name="setWeaponProperty" class="client" show="true">		<section name="setWeaponProperty" class="client" show="true">
	==Syntax (~~weapon creation~~)==		==Syntax (custom weapons)==

	<syntaxhighlight lang="lua">bool setWeaponProperty ( weapon theWeapon, string strProperty, value theValue )</syntaxhighlight>		<syntaxhighlight lang="lua">bool setWeaponProperty ( weapon theWeapon, string strProperty, value theValue )</syntaxhighlight>
			{{OOP\|\|[[Element/Weapon\|weapon]]:setProperty\|\|getWeaponProperty}}

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

	* '''theWeapon:''' the weapon to change the property of.		* '''theWeapon:''' the weapon to change the property of.
	* '''strProperty:''' the property to edit ~~such as damage per hit ( "damage" )~~:		* '''strProperty:''' the property to edit:
	{{Custom Weapon Properties Writable}}		{{Custom Weapon Properties Writable}}
	* '''theValue:''' The value to set the property to.		* '''theValue:''' The value to set the property to.

	==Returns==		==Returns==
	Returns true if the property was set.		Returns ''true'' if the property was set.

	==Requirements==		==Requirements==
Line 103:		Line 103:
	</section>		</section>

	==See ~~Also~~==		==See also==
	{{Weapon functions}}		{{Weapon functions}}

Ccw at 04:41, 20 July 2014

2014-07-20T04:41:54Z

← Older revision		Revision as of 04:41, 20 July 2014
Line 89:		Line 89:
	* '''strProperty:''' the property to edit such as damage per hit ( "damage" ):		* '''strProperty:''' the property to edit such as damage per hit ( "damage" ):
	{{Custom Weapon Properties Writable}}		{{Custom Weapon Properties Writable}}
	* '''theValue:''' ~~whatever you wish~~ to set ~~it to ( different properties use different data types so damage could be an int where as accuracy is a float ).~~		* '''theValue:''' The value to set the property to.

	~~Sets an individual weapons property. Only a handful of useful properties are supported now and it uses~~ the ~~same~~ property ~~names as setWeaponProperty server side~~.

			==Returns==
	Returns true if the property was set.		Returns true if the property was set.

Ccw at 04:31, 20 July 2014

2014-07-20T04:31:09Z

← Older revision		Revision as of 04:31, 20 July 2014
Line 97:		Line 97:
	==Requirements==		==Requirements==
	{{Requirements\|n/a\|1.3.0-9.04555\|}}		{{Requirements\|n/a\|1.3.0-9.04555\|}}

			==Changelog==
			{{ChangelogHeader}}
			{{ChangelogItem\|1.4.0-9.06339\|Added 'fire_rotation' property}}

	</section>		</section>

Ccw at 16:15, 25 February 2014

2014-02-25T16:15:36Z

@@ Line 12: / Line 12: @@
 *'''weaponSkill:''' Either: "pro", "std" or "poor". The player must have this skill level set to have the effect.
 *'''property:''' The property you want to set the value of:
-** "weapon_range" - float
+{{Weapon Properties Writable}}
 *'''theValue:''' The value to set the property to.
@@ Line 101: / Line 88: @@
 * '''theWeapon:''' the weapon to change the property of.
 * '''strProperty:''' the property to edit such as damage per hit ( "damage" ):
-** "weapon_range" - float
+{{Custom Weapon Properties Writable}}
 * '''theValue:''' whatever you wish to set it to ( different properties use different data types so damage could be an int where as accuracy is a float ).

Ccw at 04:25, 12 February 2014

2014-02-12T04:25:38Z

← Older revision		Revision as of 04:25, 12 February 2014
Line 65:		Line 65:
	</syntaxhighlight>		</syntaxhighlight>

	This turns off auto aim for all weapons		This example turns off auto aim for all weapons
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

	function setAutoAimForAllWeapons( bEnable )		function setAutoAimForAllWeapons( bEnable )
	weaponList = { "colt 45", "silenced", "deagle", "shotgun", "sawed-off", "combat shotgun", "uzi", "mp5", "ak-47", "m4", "tec-9", "rifle", "sniper", "minigun" }		weaponList = { "colt 45", "silenced", "deagle", "shotgun", "sawed-off", "combat shotgun", "uzi", "mp5", "ak-47", "m4", "tec-9", "rifle", "sniper", "minigun" }
Line 87:		Line 86:
	-- Turn off auto aim		-- Turn off auto aim
	setAutoAimForAllWeapons( false )		setAutoAimForAllWeapons( false )

	</syntaxhighlight>		</syntaxhighlight>

Ccw at 04:22, 12 February 2014

2014-02-12T04:22:29Z

@@ Line 48: / Line 48: @@
 This example makes the silenced pistol dual wielded at pro skill level
 <syntaxhighlight lang="lua">
-setWeaponProperty(23, "pro", "flags", 0x000800)
+setWeaponProperty(23, "pro", "flags", 0x000800) -- Warning - Depends on the current flag setting
-setWeaponProperty(23, "pro", "flags", 0x000002)
+setWeaponProperty(23, "pro", "flags", 0x000002) -- Warning - Depends on the current flag setting
 setWeaponProperty(23, "pro", "maximum_clip_ammo", 34)
 </syntaxhighlight>
@@ Line 63: / Line 63: @@
 <syntaxhighlight lang="lua">
 setWeaponProperty("minigun", "pro", "maximum_clip_ammo", 1000)
 </syntaxhighlight>