GetPickupAmount - Revision history

Mtaowner: /* Example */

2023-12-15T09:57:38Z

Example

← Older revision		Revision as of 09:57, 15 December 2023
Line 24:		Line 24:
	end		end
	end		end
	addEventHandler ( "onPickupHit", ~~getRootElement()~~, onPickupHitFunction ) -- add an event handler for onPickupHit		addEventHandler ( "onPickupHit", root, onPickupHitFunction ) -- add an event handler for onPickupHit
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

Arc at 18:21, 19 August 2007

2007-08-19T18:21:23Z

← Older revision		Revision as of 18:21, 19 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	This function ~~retreives~~ the amount of health or ~~armour~~ given from a pickup.		This function retrieves the amount of health or armor given from a pickup.

	==Syntax==		==Syntax==
Line 18:		Line 18:
	<section show="true" name="Server" class="server">		<section show="true" name="Server" class="server">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function onPickupHitFunction ( thePlayer ) ~~--when someone hits a pickup~~		function onPickupHitFunction ( thePlayer )
	if getPickupType ( source ) == 0 then --check the type of pickup, if it is a health pickup then		if getPickupType ( source ) == 0 then -- check the type of pickup, if it is a health pickup then
	amount = getPickupAmount ( source )		amount = getPickupAmount ( source )
	outputChatBox("You picked up "..amount.." health", thePlayer)		outputChatBox ( "You picked up " .. amount .. " health", thePlayer)
	end		end
	end		end
	addEventHandler ( "onPickupHit", getRootElement(), onPickupHitFunction ) --add an event handler for onPickupHit		addEventHandler ( "onPickupHit", getRootElement(), onPickupHitFunction ) -- add an event handler for onPickupHit
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

Driver2 at 22:16, 4 August 2007

2007-08-04T22:16:12Z

← Older revision		Revision as of 22:16, 4 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
			{{Server client function}}
	This function retreives the amount of health or armour given from a pickup.		This function retreives the amount of health or armour given from a pickup.

Line 15:		Line 16:
	==Example==		==Example==
	This example outputs the amount of health a player picked up.		This example outputs the amount of health a player picked up.
			<section show="true" name="Server" class="server">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function onPickupHitFunction ( thePlayer ) --when someone hits a pickup		function onPickupHitFunction ( thePlayer ) --when someone hits a pickup
Line 24:		Line 26:
	addEventHandler ( "onPickupHit", getRootElement(), onPickupHitFunction ) --add an event handler for onPickupHit		addEventHandler ( "onPickupHit", getRootElement(), onPickupHitFunction ) --add an event handler for onPickupHit
	</syntaxhighlight>		</syntaxhighlight>
			</section>

	==See Also==		==See Also==
	{{Pickup functions}}		{{Pickup functions}}

Driver2 at 15:49, 29 July 2007

2007-07-29T15:49:45Z

← Older revision		Revision as of 15:49, 29 July 2007
Line 11:		Line 11:

	===Returns===		===Returns===
	Returns an ''integer'' of the amount the pickup is set to, ''false'' if it's invalid or 0 if it's no health or amor pickup.		Returns an ''integer'' of the amount the pickup is set to, ''false'' if it's invalid, 0 if it's no health or amor pickup.

	==Example==		==Example==

Driver2 at 15:49, 29 July 2007

2007-07-29T15:49:12Z

← Older revision		Revision as of 15:49, 29 July 2007
Line 11:		Line 11:

	===Returns===		===Returns===
	Returns an ''integer'' of the amount the pickup is set to, ''false'' if it's invalid.		Returns an ''integer'' of the amount the pickup is set to, ''false'' if it's invalid or 0 if it's no health or amor pickup.

	==Example==		==Example==

Talidan at 15:06, 29 July 2007

2007-07-29T15:06:49Z

← Older revision		Revision as of 15:06, 29 July 2007
Line 16:		Line 16:
	This example outputs the amount of health a player picked up.		This example outputs the amount of health a player picked up.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function onPickupHitFunction ( ~~player~~ ) --when someone hits a pickup		function onPickupHitFunction ( thePlayer ) --when someone hits a pickup
	if getPickupType ( source ) == 0 then --check the type of pickup, if it is a health pickup then		if getPickupType ( source ) == 0 then --check the type of pickup, if it is a health pickup then
	amount = getPickupAmount ( source )		amount = getPickupAmount ( source )
	outputChatBox("You picked up "..amount.." health",~~player~~)		outputChatBox("You picked up "..amount.." health", thePlayer)
	end		end
	end		end

Driver2 at 22:43, 28 July 2007

2007-07-28T22:43:20Z

← Older revision		Revision as of 22:43, 28 July 2007
Line 22:		Line 22:
	end		end
	end		end
	addEventHandler ( "onPickupHit", ~~root~~, onPickupHitFunction ) --add an event handler for onPickupHit		addEventHandler ( "onPickupHit", getRootElement(), onPickupHitFunction ) --add an event handler for onPickupHit
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Pickup functions}}		{{Pickup functions}}

Driver2 at 20:35, 28 July 2007

2007-07-28T20:35:52Z

← Older revision		Revision as of 20:35, 28 July 2007
Line 4:		Line 4:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~float~~ getPickupAmount ( pickup ~~pickup~~ )		int getPickupAmount ( pickup thePickup )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''~~pickup~~:''' The pickup you wish to retrieve the amount from.		*'''thePickup:''' The pickup you wish to retrieve the amount from.

	===Returns===		===Returns===
	Returns an integer of the amount the pickup is set to.		Returns an ''integer'' of the amount the pickup is set to, ''false'' if it's invalid.

	==Example==		==Example==
	This example ~~takes a player's money appropriately according to~~ the amount of health ~~he 'buys'~~.		This example outputs the amount of health a player picked up.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~addEventHandler ( "onPickupHit", root, "onPickupHit" ) --add an event handler for onPickupHit~~		function onPickupHitFunction ( player ) --when someone hits a pickup
	function ~~onPickupHit~~ ( player ) --when someone hits a pickup
	if getPickupType ( source ) == 0 then --check the type of pickup, if it is a health pickup then		if getPickupType ( source ) == 0 then --check the type of pickup, if it is a health pickup then
	amount = getPickupAmount ( source )		amount = getPickupAmount ( source )
	~~takePlayerMoney~~ ( player~~, amount~~ ) ~~-- take the player's money according to the amount in the pickup~~		outputChatBox("You picked up "..amount.." health",player)
	end		end
	end		end
			addEventHandler ( "onPickupHit", root, onPickupHitFunction ) --add an event handler for onPickupHit
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Pickup functions}}		{{Pickup functions}}

JonChappell: /* Example */

2006-11-28T11:01:04Z

Example

← Older revision		Revision as of 11:01, 28 November 2006
Line 14:		Line 14:

	==Example==		==Example==
	This example takes a player's money appropriately according to the amount of ~~heakth~~ he 'buys'.		This example takes a player's money appropriately according to the amount of health he 'buys'.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addEventHandler ( "onPickupHit", root, "onPickupHit" ) --add an event handler for onPickupHit		addEventHandler ( "onPickupHit", root, "onPickupHit" ) --add an event handler for onPickupHit

MrJax at 10:54, 28 November 2006

2006-11-28T10:54:14Z

← Older revision		Revision as of 10:54, 28 November 2006
Line 4:		Line 4:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~int~~ getPickupAmount ( pickup pickup )		float getPickupAmount ( pickup pickup )
	</syntaxhighlight>		</syntaxhighlight>