SetWeaponOwner: Difference between revisions
Jump to navigation
Jump to search
(Note about disabled function.) |
(Added more explanatory text) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} <!-- for some revisions this function was serverside too --> | {{Client function}} <!-- for some revisions this function was serverside too --> | ||
{{Needs_Example}}{{Disabled| | {{Needs_Example}}{{Disabled|This function was disabled in revision r4872.}} | ||
This function sets the owner (which is a player) of a [[Element/Weapon|custom weapon]]. The owner of a weapon was used for lag compensation, and it was also intended to only allow him to shoot the weapon. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool setWeaponOwner ( weapon theWeapon, player theOwner )</syntaxhighlight> | <syntaxhighlight lang="lua">bool setWeaponOwner ( weapon theWeapon, player theOwner )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
* '''theWeapon:''' The weapon to set the owner of | * '''theWeapon:''' The weapon to set the owner of | ||
* '''theOwner:''' The weapon owner | * '''theOwner:''' The new weapon owner. | ||
===Returns=== | ===Returns=== | ||
| Line 20: | Line 21: | ||
{{Requirements|n/a|1.3.0-9.04555|}} | {{Requirements|n/a|1.3.0-9.04555|}} | ||
==See | ==See also== | ||
{{Client weapon creation functions}} | {{Client weapon creation functions}} | ||
Revision as of 17:58, 23 December 2014
|
Script Example Missing Function SetWeaponOwner needs a script example, help out by writing one. |
Before submitting check out Editing Guidelines Script Examples. |
|
Function has been disabled. |
Reason/Note: This function was disabled in revision r4872. |
This function sets the owner (which is a player) of a custom weapon. The owner of a weapon was used for lag compensation, and it was also intended to only allow him to shoot the weapon.
Syntax
bool setWeaponOwner ( weapon theWeapon, player theOwner )
Required Arguments
- theWeapon: The weapon to set the owner of
- theOwner: The new weapon owner.
Returns
Returns true on success, false otherwise.
Example
--TODO
Requirements
This template will be deleted.
See also
- createWeapon
- fireWeapon
- getWeaponAmmo
- getWeaponClipAmmo
- getWeaponFiringRate
- getWeaponFlags
- getWeaponOwner
- getWeaponProperty
- getWeaponState
- getWeaponTarget
- resetWeaponFiringRate
- setWeaponAmmo
- setWeaponClipAmmo
- setWeaponFiringRate
- setWeaponFlags
- setWeaponProperty
- setWeaponState
- setWeaponTarget