GetWeaponIDFromName - Revision history

LordHenry at 18:11, 26 May 2017

2017-05-26T18:11:22Z

← Older revision		Revision as of 18:11, 26 May 2017
Line 11:		Line 11:
	*'''name:''' A [[string]] containing the name of the weapon. Names can be: (Case is ignored)		*'''name:''' A [[string]] containing the name of the weapon. Names can be: (Case is ignored)
	{{All Weapon Types}}		{{All Weapon Types}}
	~~"Parachute" is not listed but it's also a valid string.~~

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

2017-05-26T16:33:40Z

Missing Parachute

← Older revision		Revision as of 16:33, 26 May 2017
Line 11:		Line 11:
	*'''name:''' A [[string]] containing the name of the weapon. Names can be: (Case is ignored)		*'''name:''' A [[string]] containing the name of the weapon. Names can be: (Case is ignored)
	{{All Weapon Types}}		{{All Weapon Types}}
			"Parachute" is not listed but it's also a valid string.

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

2012-10-18T00:11:39Z

← Older revision		Revision as of 00:11, 18 October 2012
Line 9:		Line 9:

	===Required Arguments===		===Required Arguments===
	*'''name:''' A [[string]] containing the name of the weapon.		*'''name:''' A [[string]] containing the name of the weapon. Names can be: (Case is ignored)
			{{All Weapon Types}}

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

2009-07-10T10:57:55Z

2007-08-04T15:01:50Z

← Older revision		Revision as of 15:01, 4 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
			{{Server client function}}
	This function will obtain the ID of a particular weapon from its name.		This function will obtain the ID of a particular weapon from its name.

Line 14:		Line 15:

	==Example==		==Example==
			<section name="Server" class="server" show="true">
	This example will give the player the weapon they specify 20 ammo whenever they type "weapon ''name''" into the console.		This example will give the player the weapon they specify 20 ammo whenever they type "weapon ''name''" into the console.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 35:		Line 37:
	addCommandHandler ( "weapon", consoleGiveWeapon )		addCommandHandler ( "weapon", consoleGiveWeapon )
	</syntaxhighlight>		</syntaxhighlight>
			</section>

	==See Also==		==See Also==
	{{Weapon functions}}		{{Weapon functions}}

2007-07-31T11:43:25Z

Example

← Older revision		Revision as of 11:43, 31 July 2007
Line 21:		Line 21:
	if ( playerSource ) then		if ( playerSource ) then
	-- Get the weapon ID from the name		-- Get the weapon ID from the name
	weapID = getWeaponIDFromName ( weapName )		local weapID = getWeaponIDFromName ( weapName )
	-- If it's a valid weapon		-- If it's a valid weapon
	if ( weapID ) then		if ( weapID ) then
	-- Give the weapon to the player		-- Give the weapon to the player
	giveWeapon ( playerSource, weapID, 20 )		giveWeapon ( playerSource, weapID, 20 )
	-- Output it in the chat box		-- Output it in the chat box
	outputChatBox ( "You got a " .. weapName, playerSource )		outputChatBox ( "You got a " .. weapName, playerSource )

2007-07-31T11:21:25Z

Example

← Older revision		Revision as of 11:21, 31 July 2007
Line 29:		Line 29:
	outputChatBox ( "You got a " .. weapName, playerSource )		outputChatBox ( "You got a " .. weapName, playerSource )
	else outputChatBox ( "Invalid weapon name." )		else outputChatBox ( "Invalid weapon name." )
			end
	end		end
	end		end

2007-07-31T11:20:06Z

Example

← Older revision		Revision as of 11:20, 31 July 2007
Line 19:		Line 19:
	function consoleGiveWeapon ( playerSource, commandName, weapName )		function consoleGiveWeapon ( playerSource, commandName, weapName )
	-- If a player triggered it (rather than the admin) then		-- If a player triggered it (rather than the admin) then
	if ( playerSource )		if ( playerSource ) then
	-- Get the weapon ID from the name		-- Get the weapon ID from the name
	weapID = getWeaponIDFromName ( weapName )		weapID = getWeaponIDFromName ( weapName )
	-- Give the weapon to the player		-- If it's a valid weapon
	giveWeapon ( playerSource, weapID, 20 )		if ( weapID ) then
	-- Output it in the chat box		-- Give the weapon to the player
	outputChatBox ( "You got a " .. weapName, playerSource )		giveWeapon ( playerSource, weapID, 20 )
			-- Output it in the chat box
			outputChatBox ( "You got a " .. weapName, playerSource )
			else outputChatBox ( "Invalid weapon name." )
	end		end
	end		end

2007-07-31T11:13:02Z

Example

← Older revision		Revision as of 11:13, 31 July 2007
Line 17:		Line 17:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- Define our function that will handle this command		-- Define our function that will handle this command
	function consoleGiveWeapon ( playerSource, commandName, ~~params~~)		function consoleGiveWeapon ( playerSource, commandName, weapName )
	-- If a player triggered it (rather than the admin) then		-- If a player triggered it (rather than the admin) then
	if ( playerSource )		if ( playerSource )
	-- Get the weapon ID from the name		-- Get the weapon ID from the name
	~~weapid~~ = getWeaponIDFromName ( ~~params~~ )		weapID = getWeaponIDFromName ( weapName )
	-- Give the weapon to the player		-- Give the weapon to the player
	giveWeapon ( playerSource, ~~weapid~~, 20 )		giveWeapon ( playerSource, weapID, 20 )
	-- Output it in the chat box		-- Output it in the chat box
	outputChatBox ( "You got a " .. ~~params~~, playerSource )		outputChatBox ( "You got a " .. weapName, playerSource )
	end		end
	end		end

2007-07-31T11:05:47Z

Example

← Older revision		Revision as of 11:05, 31 July 2007
Line 14:		Line 14:

	==Example==		==Example==
	This example will give the player the weapon they specify ~~with~~ 20 ammo whenever they type "weapon ''name''" into the console.		This example will give the player the weapon they specify 20 ammo whenever they type "weapon ''name''" into the console.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~-- Register the command handler and attach it to the 'consoleGiveWeapon' function~~
	~~addCommandHandler ( "weapon", "consoleGiveWeapon" )~~
	-- Define our function that will handle this command		-- Define our function that will handle this command
	function consoleGiveWeapon ( playerSource, commandName, params)		function consoleGiveWeapon ( playerSource, commandName, params)
Line 30:		Line 28:
	end		end
	end		end
			-- Register the command handler and attach it to the 'consoleGiveWeapon' function
			addCommandHandler ( "weapon", consoleGiveWeapon )
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Weapon functions}}		{{Weapon functions}}