GetWeaponTarget: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Explained a little better the function)
(Added example)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
{{Needs Example}}
This functions gets the target of a [[Element/Weapon|custom weapon]].
This functions gets the target of a [[Element/Weapon|custom weapon]].


Line 12: Line 11:


===Returns===
===Returns===
Returns the ''target'' of the [[Element/Weapon|custom weapon]], which can be ''[[nil]]'' (if the weapon is in rotation based targeting), 3 [[float|floats]] (if the weapon is firing at a fixed point) or an [[element]] (if the weapon is firing an entity). Returns ''false'' oif the weapon element is not valid.
* Returns the ''target'' of the [[Element/Weapon|custom weapon]], which can be:
**''[[nil]]'' if the weapon is in rotation based targeting.
**3 [[float|floats]] if the weapon is firing at a fixed point.
**an [[element]] if the weapon is firing an entity.
* Returns ''false'' if the weapon element is not valid.


==Example==
==Example==
<syntaxhighlight lang="lua">
This example gets the weapon target when the player hit the colshape and outputs it to the chatbox.
-- TODO
<syntaxhighlight lang="lua">local col = createColSphere(1647.33984375,1785.03125,10.671875,8) -- Create col sphere near to LV hospital
</syntaxhighlight>
local weapon = createWeapon ("m4",1647.33984375,1785.03125,10.671875) -- Create the weapon
 
function onClientColShapeHit(element, matchDim )
  if (element == getLocalPlayer()) then  -- Checks whether the entering element is the local player
    if weapon then -- if the weapon exist then
        setWeaponTarget (weapon,element,8) -- Set the weapon target to the localPlayer
        local target = getWeaponTarget (weapon) -- get weapon target
          if target and isElement(target) and getElementType(target) == "player" then
            outputChatBox("The target of the custom weapon: "..getPlayerName(target)) -- output to the chatbox
          end
      end
    end
end
addEventHandler("onClientColShapeHit",col,onClientColShapeHit)</syntaxhighlight>


==Requirements==
==Requirements==

Latest revision as of 13:49, 4 July 2016

This functions gets the target of a custom weapon.

Syntax

nil/element/float getWeaponTarget ( weapon theWeapon )

OOP Syntax Help! I don't understand this!

Note: Variable is read only.
Method: weapon:getTarget(...)
Variable: .target
Counterpart: setWeaponTarget


Required Arguments

  • theWeapon: The weapon to get the target of.

Returns

  • Returns the target of the custom weapon, which can be:
    • nil if the weapon is in rotation based targeting.
    • 3 floats if the weapon is firing at a fixed point.
    • an element if the weapon is firing an entity.
  • Returns false if the weapon element is not valid.

Example

This example gets the weapon target when the player hit the colshape and outputs it to the chatbox. 

local col = createColSphere(1647.33984375,1785.03125,10.671875,8) -- Create col sphere near to LV hospital
local weapon = createWeapon ("m4",1647.33984375,1785.03125,10.671875) -- Create the weapon

function onClientColShapeHit(element, matchDim )
   if (element == getLocalPlayer()) then  -- Checks whether the entering element is the local player 
     if weapon then -- if the weapon exist then
        setWeaponTarget (weapon,element,8) -- Set the weapon target to the localPlayer 
        local target = getWeaponTarget (weapon) -- get weapon target
          if target and isElement(target) and getElementType(target) == "player" then 
            outputChatBox("The target of the custom weapon: "..getPlayerName(target)) -- output to the chatbox
          end 
       end 
    end 
end
addEventHandler("onClientColShapeHit",col,onClientColShapeHit)

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/GetWeaponTarget?oldid=47989"