GetSlotFromWeapon: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server function}}
{{Server client function}}
This function allows you to identify the weapon slot that a weapon belongs to.
This function allows you to identify the weapon slot that a weapon belongs to.


Line 9: Line 9:


===Required Arguments===  
===Required Arguments===  
*'''weaponid:''' The weapon ID to find the weapon slot of.
*'''weaponid:''' [[Weapon]] to find the weapon slot of.


===Returns===
===Returns===

Latest revision as of 16:33, 10 January 2010

This function allows you to identify the weapon slot that a weapon belongs to.

Syntax

int getSlotFromWeapon ( int weaponid )

Required Arguments

  • weaponid: Weapon to find the weapon slot of.

Returns

Returns an integer representing the given weapon ID's associated weapon slot, false if the ID was invalid.

Example

This will output to the chatbox what weapon slot a given weapon number belongs to when entered into the console (i.e. 'getWeaponSlot 10').

function outputWeaponSlot ( source, commandName, weaponID )
	local weaponSlot = getSlotFromWeapon ( weaponID )
	
	if (weaponSlot) then
	    outputChatBox ( "Weapon ID " .. weaponID ..  " is in weapon slot " .. weaponSlot)
	else
	    outputChatBox ( "Invalid weapon ID" )
	end
end
addCommandHandler ( "getWeaponSlot", outputWeaponSlot )

See Also

Weapon IDs