GetWeaponOwner: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Added OOP syntax)
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
{{Needs_Example}}
This function gets the owner of a [[Element/Weapon|custom weapon]]. Weapon ownership system was, however, disabled, so this function always returns ''false''. Please refer to [[setWeaponOwner]] for details.
This function gets the owner of a [[Element/Weapon|custom weapon]]. Please refer to [[setWeaponOwner]] for details.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">player getWeaponOwner ( weapon theWeapon )</syntaxhighlight>
<syntaxhighlight lang="lua">bool getWeaponOwner ( weapon theWeapon )</syntaxhighlight>
{{OOP||[[Element/Weapon|weapon]]:getOwner|owner|setWeaponOwner}}
{{OOP|Pair is completely disabled at the moment (its value is ''[[nil]]'').|[[Element/Weapon|weapon]]:getOwner|owner|setWeaponOwner}}


===Required Arguments===
===Required Arguments===
Line 12: Line 11:


===Returns===
===Returns===
Returns the ''[[player]] element'' of the [[Element/Weapon|custom weapon]] owner, ''false'' otherwise.
This function was intended to return the [[player]] which owns the [[Element/Weapon|custom weapon]], and ''false'' if an error occured. However, at the moment it always returns ''false''.


==Example==
==Example==
<syntaxhighlight lang="lua">--TODO</syntaxhighlight>
<syntaxhighlight lang="lua">function arma()
minigun = createWeapon("minigun", 1, 1, 3)--Create the weapon
setWeaponClipAmmo(minigun, 99999)
        setWeaponState(minigun, "firing")
setWeaponProperty(minigun, "fire_rotation", 0, -30, 0)
dueno = getWeaponOwner(minigun)--This gets the owner
outputChatBox(tostring(dueno))--And this say it in the chatbox
end
addCommandHandler("weapon", arma)--CommandHandler</syntaxhighlight>


==Requirements==
==Requirements==

Latest revision as of 20:42, 20 May 2015

This function gets the owner of a custom weapon. Weapon ownership system was, however, disabled, so this function always returns false. Please refer to setWeaponOwner for details.

Syntax

bool getWeaponOwner ( weapon theWeapon )

OOP Syntax Help! I don't understand this!

Note: Pair is completely disabled at the moment (its value is nil).
Method: weapon:getOwner(...)
Variable: .owner
Counterpart: setWeaponOwner


Required Arguments

  • theWeapon: The weapon to get the owner of.

Returns

This function was intended to return the player which owns the custom weapon, and false if an error occured. However, at the moment it always returns false.

Example

function arma()
	minigun = createWeapon("minigun", 1, 1, 3)--Create the weapon
	setWeaponClipAmmo(minigun, 99999)
        setWeaponState(minigun, "firing")
	setWeaponProperty(minigun, "fire_rotation", 0, -30, 0)
	dueno = getWeaponOwner(minigun)--This gets the owner
	outputChatBox(tostring(dueno))--And this say it in the chatbox
end
addCommandHandler("weapon", arma)--CommandHandler

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


Retrieved from "https://wiki.multitheftauto.com/wiki/GetWeaponOwner?oldid=45219"