GetSlotFromWeapon: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
 
(13 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 -->
{{Server client function}}
This fake function is for use with blah & blah and does blahblahblabhalbhl
This function 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 -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
returnType functionName ( arguments )
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 -->
*'''weaponid:''' [[Weapon]] to find the weapon slot of.
*'''argumentName:''' description
 
<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===
{{OptionalArg}}
*'''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 an integer representing the given weapon ID's associated weapon slot, ''false'' if the ID was invalid.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This will output to the chatbox what weapon slot a given weapon number belongs to when entered into the console (i.e. 'getWeaponSlot 10').
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...
function outputWeaponSlot ( source, commandName, weaponID )
blabhalbalhb --abababa
local weaponSlot = getSlotFromWeapon ( weaponID )
--This line does this...
mooo
if (weaponSlot) then
</syntaxhighlight>
    outputChatBox ( "Weapon ID " .. weaponID .. " is in weapon slot " .. weaponSlot)
else
    outputChatBox ( "Invalid weapon ID" )
end
end
addCommandHandler ( "getWeaponSlot", outputWeaponSlot )</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 -->
[[Weapons|Weapon IDs]]
{{FunctionArea_functions}}
{{Weapon_functions}}
[[Category:Need_Syntax]]  -- leave this until syntax is available. Cannot document the function or event without syntax.
[[ru:getSlotFromWeapon]]
[[Category:Incomplete]] -- leave this unless you complete the function

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

Retrieved from "https://wiki.multitheftauto.com/wiki/GetSlotFromWeapon?oldid=22273"