GetSlotFromWeapon: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
<!-- Describe in plain english what this function does. Don't go into details, just give an overview --> | <!-- Describe in plain english what this function does. Don't go into details, just give an overview --> | ||
This | This allows you to identify the weapon slot that a weapon belongs to | ||
==Syntax== | ==Syntax== | ||
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd --> | <!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd --> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
int getSlotFromWeapon ( int | int getSlotFromWeapon ( int weaponid ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type --> | <!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type --> | ||
*''' | *'''weaponid:''' Specify the weapon whose weapon slot you want to know | ||
===Returns=== | ===Returns=== | ||
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check --> | <!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check --> | ||
Returns ' | *Returns the player's current weapon slot ID | ||
false | *Returns false if it fails to retrieve current weapon slot | ||
==Example== | ==Example== | ||
<!-- Explain what the example is in a single sentance --> | <!-- Explain what the example is in a single sentance --> | ||
This | This will output to the chatbox what weapon slot a player is using when the player switches weapons | ||
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized --> | <!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized --> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | addEventHandler ( "onPlayerWeaponSwitch", root, "PlayerWeaponSwitched" ) | ||
function PlayerWeaponSwitched ( previousWeaponID, currentWeaponID ) | |||
-- | currentslot = getSlotFromWeapon ( currentWeaponID ) | ||
--Make the varible equal the current weapon slot. The current weapon slot was stored by the event | |||
outputChatBox ( "You switched to weapon slot "..currentslot ) | |||
--Output what weapon slot the player is now using | |||
end | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc --> | <!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc --> | ||
{{ | {{Weapon_functions}} | ||
Revision as of 03:51, 12 April 2007
This allows you to identify the weapon slot that a weapon belongs to
Syntax
int getSlotFromWeapon ( int weaponid )
Required Arguments
- weaponid: Specify the weapon whose weapon slot you want to know
Returns
- Returns the player's current weapon slot ID
- Returns false if it fails to retrieve current weapon slot
Example
This will output to the chatbox what weapon slot a player is using when the player switches weapons
addEventHandler ( "onPlayerWeaponSwitch", root, "PlayerWeaponSwitched" ) function PlayerWeaponSwitched ( previousWeaponID, currentWeaponID ) currentslot = getSlotFromWeapon ( currentWeaponID ) --Make the varible equal the current weapon slot. The current weapon slot was stored by the event outputChatBox ( "You switched to weapon slot "..currentslot ) --Output what weapon slot the player is now using end
See Also
- getOriginalWeaponProperty
- getSlotFromWeapon
- getWeaponIDFromName
- getWeaponNameFromID
- getWeaponProperty
- giveWeapon
- setWeaponAmmo
- setWeaponProperty
- takeAllWeapons
- takeWeapon