SetWeaponOwner: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Does a disabled function really need and example?)
 
(9 intermediate revisions by 7 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}} <!-- for some revisions this function was serverside too -->
Sets the owner (a player) of the custom weapon.
<!--{{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 ( 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===
Returns ''true'' on success, ''false'' otherwise.
Returns ''true'' on success, ''false'' otherwise.
==Example==
<syntaxhighlight lang="lua">--TODO</syntaxhighlight>


==Requirements==
==Requirements==
{{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}}

Latest revision as of 09:05, 21 February 2016

Dialog-warning.png 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

Requirements

Minimum server version n/a
Minimum client version 1.3.0-9.04555

Note: Using this feature 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