GetWeaponTarget: Difference between revisions
		
		
		
		
		
		Jump to navigation
		Jump to search
		
				
		
		
	
| m (Explained a little better the function) | m (Mistake fix at →Returns) | ||
| Line 12: | Line 12: | ||
| ===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''  | 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'' if the weapon element is not valid. | ||
| ==Example== | ==Example== | ||
Revision as of 17:54, 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 if the weapon element is not valid.
Example
-- TODO
Requirements
This template will be deleted.
See also
- createWeapon
- fireWeapon
- getWeaponFiringRate
- getWeaponClipAmmo
- getWeaponAmmo
- getWeaponFlags
- getWeaponState
- getWeaponTarget
- resetWeaponFiringRate
- setWeaponClipAmmo
- setWeaponFiringRate
- setWeaponFlags
- setWeaponState
- setWeaponTarget