SetWeaponOwner: Difference between revisions
Jump to navigation
Jump to search
m (Added an example section and added this function to "Needs Example" template.) |
Fernando187 (talk | contribs) (Remove obsolete Requirements section) |
||
(8 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} <!-- for some revisions this function was serverside too --> | ||
{{Needs_Example}} | <!--{{Needs_Example}}-->{{Disabled|This function was disabled in revision {{r|4872}}.}} | ||
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> | ||
{{OOP|This function is completely disabled, so it lacks a method.||owner|getWeaponOwner}} | |||
===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 17: | Line 18: | ||
<syntaxhighlight lang="lua">--TODO</syntaxhighlight> | <syntaxhighlight lang="lua">--TODO</syntaxhighlight> | ||
==See also== | |||
==See | |||
{{Client weapon creation functions}} | {{Client weapon creation functions}} |
Latest revision as of 17:06, 7 November 2024
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 )
OOP Syntax Help! I don't understand this!
- Note: This function is completely disabled, so it lacks a method.
- Variable: .owner
- Counterpart: getWeaponOwner
Required Arguments
- theWeapon: The weapon to set the owner of.
- theOwner: The new weapon owner.
Returns
Returns true on success, false otherwise.
Example
--TODO
See also
- createWeapon
- fireWeapon
- getWeaponAmmo
- getWeaponClipAmmo
- getWeaponFiringRate
- getWeaponFlags
- getWeaponOwner
- getWeaponProperty
- getWeaponState
- getWeaponTarget
- resetWeaponFiringRate
- setWeaponAmmo
- setWeaponClipAmmo
- setWeaponFiringRate
- setWeaponFlags
- setWeaponProperty
- setWeaponState
- setWeaponTarget