GetPickupWeapon - Revision history

FeaturedPro: Removed leading whitespace from syntax

2022-01-22T20:23:39Z

Removed leading whitespace from syntax

← Older revision		Revision as of 20:23, 22 January 2022
Line 4:		Line 4:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	int getPickupWeapon ( pickup thePickup )		int getPickupWeapon ( pickup thePickup )
	</syntaxhighlight>		</syntaxhighlight>

XLive at 08:08, 4 November 2020

2020-11-04T08:08:01Z

← Older revision		Revision as of 08:08, 4 November 2020
Line 26:		Line 26:
	end		end
	end		end
	addEventHandler ( "onPickupHit", ~~getRootElement()~~, onPickupHitFunc ) -- add the function as handler for onPickupHit		addEventHandler ( "onPickupHit", root, onPickupHitFunc ) -- add the function as handler for onPickupHit
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

Driver2: /* Example */

2007-08-26T14:42:12Z

Example

← Older revision		Revision as of 14:42, 26 August 2007
Line 15:		Line 15:
	==Example==		==Example==
	This example gives extra ammo to a player if a pickup only has a small amount of ammo.		This example gives extra ammo to a player if a pickup only has a small amount of ammo.
			<section name="Server" class="server" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function onPickupHitFunc ( thePlayer ) -- when a pickup is hit		function onPickupHitFunc ( thePlayer ) -- when a pickup is hit
Line 27:		Line 28:
	addEventHandler ( "onPickupHit", getRootElement(), onPickupHitFunc ) -- add the function as handler for onPickupHit		addEventHandler ( "onPickupHit", getRootElement(), onPickupHitFunc ) -- add the function as handler for onPickupHit
	</syntaxhighlight>		</syntaxhighlight>
			</section>

	==See Also==		==See Also==

Arc at 15:04, 19 August 2007

2007-08-19T15:04:51Z

← Older revision		Revision as of 15:04, 19 August 2007
Line 1:		Line 1:
	__NOTOC__		{{Server client function}}
	This function retrieves the ~~Weapon~~ ID of ~~the Weapon Pickup~~		__NOTOC__
			This function retrieves the weapon ID of a weapon pickup.
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 7:		Line 8:

	===Required Arguments===		===Required Arguments===
	*'''thePickup:''' The pickup in which you wish to retrieve the weapon of		*'''thePickup:''' The pickup of which you wish to retrieve the weapon

	===Returns===		===Returns===
	Returns ~~an integer of~~ the [[Weapons\|Weapon ID]] of the pickup, ''false'' if ~~it's an~~ invalid ~~pickup~~.		Returns the [[Weapons\|Weapon ID]] of the pickup, or ''false'' if the pickup is invalid.

	==Example==		==Example==
	This example gives extra ammo to a player if a pickup only has a small amount of ammo.		This example gives extra ammo to a player if a pickup only has a small amount of ammo.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function onPickupHitFunc ( ~~player~~ ) --when a pickup is hit		function onPickupHitFunc ( thePlayer ) -- when a pickup is hit
	if (getPickupType(source) == 2) then -- check if it's a weapon pickup		if getPickupType ( source ) == 2 then -- check if it's a weapon pickup
	local ammo = getPickupAmmo(source) -- get ammo		local ammo = getPickupAmmo ( source ) -- get the pickup ammo
	if (ammo < 50) then -- if ammo is less than 50		if ammo < 50 then -- if ammo is less than 50
	local weapon = getPickupWeapon(source) -- store pickup weapon		local weapon = getPickupWeapon ( source ) -- store pickup weapon
	giveWeaponAmmo(~~player~~,weapon,50) -- give an extra 50 ammo		giveWeaponAmmo ( thePlayer, weapon, 50 ) -- give an extra 50 ammo
	end		end
	end		end
	end		end
	addEventHandler ( "onPickupHit", getRootElement(), onPickupHitFunc ) -- add ~~an event~~ for onPickupHit		addEventHandler ( "onPickupHit", getRootElement(), onPickupHitFunc ) -- add the function as handler for onPickupHit
	</syntaxhighlight>		</syntaxhighlight>

Driver2 at 21:42, 29 July 2007

2007-07-29T21:42:28Z

← Older revision		Revision as of 21:42, 29 July 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	This function ~~retreives~~ the Weapon ID of the Weapon Pickup		This function retrieves the Weapon ID of the Weapon Pickup
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	int getPickupWeapon ( pickup ~~pickup~~ )		int getPickupWeapon ( pickup thePickup )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''~~pickup~~:''' The pickup in which you wish to retrieve the weapon of		*'''thePickup:''' The pickup in which you wish to retrieve the weapon of

	===Returns===		===Returns===
	Returns an integer of the Weapon ID of the pickup		Returns an integer of the [[Weapons\|Weapon ID]] of the pickup, ''false'' if it's an invalid pickup.

	==Example==		==Example==
	This example gives extra ammo to a player if a pickup only has a small amount of ammo.		This example gives extra ammo to a player if a pickup only has a small amount of ammo.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~addEventHandler ( "onPickupHit", root, "onPickupHit" ) -- add an event for onPickupHit~~		function onPickupHitFunc ( player ) --when a pickup is hit
	function ~~onPickupHit~~ ( player ) --when a pickup is hit		if (getPickupType(source) == 2) then -- check if it's a weapon pickup
	~~ammo~~ == ~~getPickupAmmo ( source~~ )		local ammo = getPickupAmmo(source) -- get ammo
	~~weapon~~ =~~= getPickupWeapon~~ ( source ) -- ~~define weapon as the weapon of the pickup~~		if (ammo < 50) then -- if ammo is less than 50
	if ammo < 50 then -- ~~the~~ ammo ~~of the pickup~~ is less ~~that~~ 50		local weapon = getPickupWeapon(source) -- store pickup weapon
	giveWeaponAmmo ( player, weapon, 50 ) --~~then~~ give an extra 50 ammo		giveWeaponAmmo(player,weapon,50) -- give an extra 50 ammo
	end		end
			end
	end		end
			addEventHandler ( "onPickupHit", getRootElement(), onPickupHitFunc ) -- add an event for onPickupHit
	</syntaxhighlight>		</syntaxhighlight>

Talidan at 15:48, 13 August 2006

2006-08-13T15:48:35Z

← Older revision		Revision as of 15:48, 13 August 2006
Line 15:		Line 15:
	This example gives extra ammo to a player if a pickup only has a small amount of ammo.		This example gives extra ammo to a player if a pickup only has a small amount of ammo.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addEventHandler ( onPickupHit, root, onPickupHit ) -- add an event for onPickupHit		addEventHandler ( "onPickupHit", root, "onPickupHit" ) -- add an event for onPickupHit
	function onPickupHit ( player ) --when a pickup is hit		function onPickupHit ( player ) --when a pickup is hit
	ammo == getPickupAmmo ( source )		ammo == getPickupAmmo ( source )

Talidan at 21:28, 12 August 2006

2006-08-12T21:28:20Z

← Older revision		Revision as of 21:28, 12 August 2006
Line 1:		Line 1:
	~~[[Category:Incomplete]]~~

	__NOTOC__		__NOTOC__
	This ~~fake~~ function ~~is for use with blah & blah and does blahblahblabhalbhl~~		This function retreives the Weapon ID of the Weapon Pickup

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 10:		Line 7:

	===Required Arguments===		===Required Arguments===
	*'''~~argumentName~~:''' ~~description~~		*'''pickup:''' The pickup in which you wish to retrieve the weapon of

	~~===Optional Arguments===~~
	~~{{OptionalArg}}~~
	*'''argumentName2:''' descriptiona
	*'''argumentName3:''' description

	===Returns===		===Returns===
	Returns ~~''true'' if blah, ''false'' otherwise.~~		Returns an integer of the Weapon ID of the pickup

	==Example==		==Example==
	This example ~~does..~~.		This example gives extra ammo to a player if a pickup only has a small amount of ammo.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--~~This line does...~~		addEventHandler ( onPickupHit, root, onPickupHit ) -- add an event for onPickupHit
	~~blabhalbalhb~~ --~~abababa~~		function onPickupHit ( player ) --when a pickup is hit
	--~~This line does this...~~		ammo == getPickupAmmo ( source )
	~~mooo~~		weapon == getPickupWeapon ( source ) -- define weapon as the weapon of the pickup
			if ammo < 50 then -- the ammo of the pickup is less that 50
			giveWeaponAmmo ( player, weapon, 50 ) --then give an extra 50 ammo
			end
			end
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{~~FunctionArea_Functions~~}}		{{IDs}}

			{{Pickup functions}}

Ransom at 22:26, 20 May 2006

2006-05-20T22:26:20Z

New page

[[Category:Incomplete]]

__NOTOC__
This fake function is for use with blah & blah and does blahblahblabhalbhl

==Syntax==
<syntaxhighlight lang="lua">
int getPickupWeapon ( pickup pickup )
</syntaxhighlight>

===Required Arguments===
*'''argumentName:''' description

===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' descriptiona
*'''argumentName3:''' description

===Returns===
Returns ''true'' if blah, ''false'' otherwise.

==Example==
This example does...
<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==
{{FunctionArea_Functions}}