GetSlotFromWeapon: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (Minor changes) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
This allows you to identify the weapon slot that a weapon belongs to. | {{Server function}} | ||
This function allows you to identify the weapon slot that a weapon belongs to. | |||
==Syntax== | ==Syntax== | ||
| Line 11: | Line 12: | ||
===Returns=== | ===Returns=== | ||
Returns an integer representing the given weapon ID's associated weapon slot, ''false'' if the ID was invalid. | |||
==Example== | ==Example== | ||
This will output to the chatbox what weapon slot a given weapon number belongs to when entered into the console ( | This will output to the chatbox what weapon slot a given weapon number belongs to when entered into the console (i.e. 'getWeaponSlot 10'). | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function outputWeaponSlot ( source, commandName, weaponID ) | function outputWeaponSlot ( source, commandName, weaponID ) | ||
| Line 28: | Line 29: | ||
==See Also== | ==See Also== | ||
[[Weapons|Weapon IDs]] | [[Weapons|Weapon IDs]] | ||
{{Weapon_functions}} | {{Weapon_functions}} | ||
Revision as of 15:25, 13 August 2007
This function allows you to identify the weapon slot that a weapon belongs to.
Syntax
int getSlotFromWeapon ( int weaponid )
Required Arguments
- weaponid: The weapon ID 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
- getWeaponProperty
- getPickupWeapon
- getOriginalWeaponProperty
- getSlotFromWeapon
- getWeaponIDFromName
- getWeaponNameFromID
- setWeaponAmmo
- setWeaponProperty