GetWeaponTarget: Difference between revisions
Jump to navigation
Jump to search
(Added OOP syntax) |
m (Explained a little better the function) |
||
| Line 5: | Line 5: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">element getWeaponTarget ( weapon theWeapon )</syntaxhighlight> | <syntaxhighlight lang="lua">nil/element/float getWeaponTarget ( weapon theWeapon )</syntaxhighlight> | ||
{{OOP|Variable is read only.|[[Element/Weapon|weapon]]:getTarget|target|setWeaponTarget}} | {{OOP|Variable is read only.|[[Element/Weapon|weapon]]:getTarget|target|setWeaponTarget}} | ||
| Line 12: | Line 12: | ||
===Returns=== | ===Returns=== | ||
Returns the ''target | 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. | ||
==Example== | ==Example== | ||
Revision as of 17:28, 23 December 2014
|
Script Example Missing Function GetWeaponTarget needs a script example, help out by writing one. |
Before submitting check out Editing Guidelines Script Examples. |
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) or an element (if the weapon is firing an entity). Returns false oif the weapon element is not valid.
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