OnPlayerPickupHit - Revision history

Botder at 03:02, 27 September 2018

2018-09-27T03:02:06Z

← Older revision		Revision as of 03:02, 27 September 2018
Line 28:		Line 28:
	</syntaxhighlight>		</syntaxhighlight>

	==See ~~Also==~~		{{See also/Server event\|Player events}}
	~~===~~Player events~~===~~
	~~{{Player_events}}~~
	~~===Event functions===~~
	~~{{Event functions~~}}

Botder at 02:14, 27 September 2018

2018-09-27T02:14:47Z

← Older revision		Revision as of 02:14, 27 September 2018
Line 29:		Line 29:

	==See Also==		==See Also==
	{{~~Player events~~}}		===Player events===
			{{Player_events}}
			===Event functions===
			{{Event functions}}

Myonlake at 00:56, 2 July 2018

2018-07-02T00:56:57Z

← Older revision		Revision as of 00:56, 2 July 2018
Line 13:		Line 13:
	The [[event system#Event source\|source]] of this event is the [[player]] that hit the pickup.		The [[event system#Event source\|source]] of this event is the [[player]] that hit the pickup.

	~~<!-- Only include this section below if cancelling the event has any effect. If you don't know if it does, ask a dev! -->~~
	==Cancel effect==		==Cancel effect==
	If this event is [[Event system#Canceling\|canceled]], the player will not be able to pick up this pickup.		If this event is [[Event system#Canceling\|canceled]], the player will not be able to pick up this pickup.

	==Example==		==Example==
	~~<!-- Explain what the example is in a single sentance -->~~
	This example disables the use of armour pickups.		This example disables the use of armour pickups.
	~~<!-- 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">
	function armourBlock(pickup)		function armourBlock(pickup)
	if (getPickupType(pickup) == 1) then -- If it's an armour pickup		if (getPickupType(pickup) == 1) then -- If it's an armour pickup
	cancelEvent() -- Cancel the event		cancelEvent() -- Cancel the event
	outputChatBox("Armour pickups are disabled.",source,255,0,0)		outputChatBox("Armour pickups are disabled.", source, 255, 0, 0)
	end		end
	end		end
	addEventHandler("onPlayerPickupHit",~~getRootElement()~~,armourBlock)		addEventHandler("onPlayerPickupHit", root, armourBlock)
	</syntaxhighlight>		</syntaxhighlight>

	{{~~See also/Server event\|~~Player events}}		==See Also==
			{{Player events}}

Myonlake: /* Parameters */

2018-04-02T21:49:22Z

Parameters

← Older revision		Revision as of 21:49, 2 April 2018
Line 8:		Line 8:
	</syntaxhighlight>		</syntaxhighlight>

	*'''pickupHit''': ~~The~~ [[pickup]] the [[player]] hit.		*'''pickupHit''': the [[pickup]] the [[player]] hit.

	==Source==		==Source==

Myonlake: /* Parameters */

2018-04-02T21:48:55Z

Parameters

← Older revision		Revision as of 21:48, 2 April 2018
Line 8:		Line 8:
	</syntaxhighlight>		</syntaxhighlight>

	*'''pickupHit''': The pickup the player hit		*'''pickupHit''': The [[pickup]] the [[player]] hit.

	==Source==		==Source==

Bonus: There is no "matchingDimension" in onPlayerPickupHit!

2017-11-29T15:21:30Z

There is no "matchingDimension" in onPlayerPickupHit!

← Older revision		Revision as of 15:21, 29 November 2017
Line 5:		Line 5:
	==Parameters==		==Parameters==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	pickup pickupHit~~, bool matchingDimension~~		pickup pickupHit
	</syntaxhighlight>		</syntaxhighlight>

	*'''pickupHit''': The pickup the player hit		*'''pickupHit''': The pickup the player hit
	*'''matchingDimension''': Whether the player and the pickup he hit are in the same dimension

	==Source==		==Source==
Line 23:		Line 22:
	<!-- 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 -->		<!-- 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">
	function armourBlock(pickup~~,dimension~~)		function armourBlock(pickup)
	if (getPickupType(pickup) == 1) then -- If it's an armour pickup		if (getPickupType(pickup) == 1) then -- If it's an armour pickup
	cancelEvent() -- Cancel the event		cancelEvent() -- Cancel the event

Ca11um: /* Example */

2010-08-19T04:16:37Z

Example

← Older revision		Revision as of 04:16, 19 August 2010
Line 20:		Line 20:
	==Example==		==Example==
	<!-- Explain what the example is in a single sentance -->		<!-- Explain what the example is in a single sentance -->
	This example ~~does..~~.		This example disables the use of armour pickups.
	<!-- 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 -->		<!-- 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 armourBlock(pickup,dimension)
	~~blah~~()		if (getPickupType(pickup) == 1) then -- If it's an armour pickup
	--~~This line does this..~~.		cancelEvent() -- Cancel the event
	~~mooo~~		outputChatBox("Armour pickups are disabled.",source,255,0,0)
			end
			end
			addEventHandler("onPlayerPickupHit",getRootElement(),armourBlock)
	</syntaxhighlight>		</syntaxhighlight>

	{{See also/Server event\|Player events}}		{{See also/Server event\|Player events}}

	~~[[Category:Needs Example]]~~

D0c: See Also for server events

2008-01-12T17:47:38Z

ChrML at 05:37, 30 December 2007

2007-12-30T05:37:32Z

← Older revision		Revision as of 05:37, 30 December 2007
Line 1:		Line 1:
	[[~~Category:Incomplete Event~~]]		__NOTOC__
			{{Server event}}
			This event is triggered when a [[player]] hits a [[pickup]].

	~~__NOTOC__~~		==Parameters==
	~~This event is triggered when a player hits a pickup.~~

	==~~Syntax~~==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~void onPlayerPickupHit (~~ pickup ~~hitpickup~~, bool matchingDimension )		pickup pickupHit, bool matchingDimension
	</syntaxhighlight>		</syntaxhighlight>

			*'''pickupHit''': The pickup the player hit
			*'''matchingDimension''': Whether the player and the pickup he hit are in the same dimension

			==Source==
			The [[event system#Event source\|source]] of this event is the [[player]] that hit the pickup.

			<!-- Only include this section below if cancelling the event has any effect. If you don't know if it does, ask a dev! -->
			==Cancel effect==
			If this event is [[Event system#Canceling\|canceled]], the player will not be able to pick up this pickup.

	==Example==		==Example==
			<!-- Explain what the example is in a single sentance -->
	This example does...		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...		--This line does...
	~~blabhalbalhb --abababa~~		blah()
	--This line does this...		--This line does this...
	mooo		mooo
	</syntaxhighlight>		</syntaxhighlight>

			==See Also==
			{{Event_functions}}
			[[Category:Needs Example]]

JonChappell at 04:31, 19 November 2006

2006-11-19T04:31:34Z

← Older revision		Revision as of 04:31, 19 November 2006
Line 2:		Line 2:

	__NOTOC__		__NOTOC__
	This event is ~~blahblah and is used for blahblah~~.		This event is triggered when a player hits a pickup.

	==Syntax==		==Syntax==

← Older revision		Revision as of 17:47, 12 January 2008
Line 29:		Line 29:
	</syntaxhighlight>		</syntaxhighlight>

	~~==See Also==~~		{{See also/Server event\|Player events}}
	{{~~Event_functions~~}}
	[[Category:Needs Example]]		[[Category:Needs Example]]