GetPlayerWeaponSlot: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
m (Changed "DeprecatedWithAlt" template to "Deprecated")
 
(7 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
{{Deprecated|getPedWeaponSlot|}}
This fake function is for use with blah & blah and does blahblahblabhalbhl
 
This function gets the player's weapon slot.


==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 -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int getPlayerWeaponSlot ( player thePlayer )
int getPlayerWeaponSlot ( player thePlayer )
Line 10: Line 10:


===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 -->
*'''thePlayer''': the [[player]] you want to get the weapon slot from.
*'''argumentName:''' description


<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===  
===Optional Arguments===  
{{OptionalArg}}
none
*'''argumentName2:''' description
*'''argumentName3:''' description


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns the weapon slot (as ''number'') on success, returns ''false'' otherwise.
Returns ''true'' if blah, ''false'' otherwise.
{{Weapon_Slots}}


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example does...
<!-- 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">
--This line does...
Pending.
blabhalbalhb --abababa
--This line does this...
mooo
</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 -->
* [[SetPlayerWeaponSlot]]
{{FunctionArea_functions}}
[[Category:Incomplete]] -- leave this unless you complete the function

Latest revision as of 16:27, 13 February 2015


Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.
Please use getPedWeaponSlot instead.


This function gets the player's weapon slot.

Syntax

int getPlayerWeaponSlot ( player thePlayer )

Required Arguments

  • thePlayer: the player you want to get the weapon slot from.

Optional Arguments

none

Returns

Returns the weapon slot (as number) on success, returns false otherwise.

Weapon Slots
  • 0: WEAPONSLOT_TYPE_UNARMED
  • 1: WEAPONSLOT_TYPE_MELEE
  • 2: WEAPONSLOT_TYPE_HANDGUN
  • 3: WEAPONSLOT_TYPE_SHOTGUN
  • 4: WEAPONSLOT_TYPE_SMG (used for driveby's)
  • 5: WEAPONSLOT_TYPE_RIFLE
  • 6: WEAPONSLOT_TYPE_SNIPER
  • 7: WEAPONSLOT_TYPE_HEAVY
  • 8: WEAPONSLOT_TYPE_THROWN
  • 9: WEAPONSLOT_TYPE_SPECIAL
  • 10: WEAPONSLOT_TYPE_GIFT
  • 11: WEAPONSLOT_TYPE_PARACHUTE
  • 12: WEAPONSLOT_TYPE_DETONATOR

Example

Pending.

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/GetPlayerWeaponSlot?oldid=44590"