OnPlayerMarkerHit - Revision history

AirNewSCR: Many errors

2024-07-06T14:54:41Z

Many errors

← Older revision		Revision as of 14:54, 6 July 2024
Line 18:		Line 18:
	This example outputs when a player hits a marker.		This example outputs when a player hits a marker.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addEventHandler('onPlayerMarkerHit', root, function(marker, ~~dimension~~)		addEventHandler('onPlayerMarkerHit', root, function(marker, matchingDimension)
	if not ~~dimension~~ then return end -- ~~check~~ if player is ~~actually going into~~ the marker		if not matchingDimension then return end -- checks if the dimension of the player who activated the marker is the same as the one the marker is in (in this case, if not, it will stop here)
	outputChatBox('You have just entered a marker!', source, 255, 255, 0) -- output something		outputChatBox('You have just entered a marker!', source, 255, 255, 0) -- output something
	end)		end)

2024-07-06T14:52:50Z

← Older revision		Revision as of 14:52, 6 July 2024
Line 19:		Line 19:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addEventHandler('onPlayerMarkerHit', root, function(marker, dimension)		addEventHandler('onPlayerMarkerHit', root, function(marker, dimension)
	if not dimension then return end -- check if player is actually going into the marker		if not dimension then return end -- check if player is actually going into the marker
	outputChatBox('You have just entered a marker!', source, 255, 255, 0) -- output something		outputChatBox('You have just entered a marker!', source, 255, 255, 0) -- output something
	end)		end)
	</syntaxhighlight>		</syntaxhighlight>

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

2024-07-06T14:52:34Z

Fixed variable name incorrect (change dim to dimension)

← Older revision		Revision as of 14:52, 6 July 2024
Line 19:		Line 19:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addEventHandler('onPlayerMarkerHit', root, function(marker, dimension)		addEventHandler('onPlayerMarkerHit', root, function(marker, dimension)
	if not ~~dim~~ then return end -- check if player is actually going into the marker		if not dimension then return end -- check if player is actually going into the marker
	outputChatBox('You have just entered a marker!', source, 255, 255, 0) -- output something		outputChatBox('You have just entered a marker!', source, 255, 255, 0) -- output something
	end)		end)

2023-09-02T18:20:17Z

Changed example, added note about attaching this event

← Older revision		Revision as of 18:20, 2 September 2023
Line 2:		Line 2:
	{{Server event}}		{{Server event}}
	This event is triggered when a [[player]] hits a [[marker]].		This event is triggered when a [[player]] hits a [[marker]].
			{{Note\|This event is triggered for <b>players</b> only. Attaching this event to a marker does nothing.}}

	==Parameters==		==Parameters==
Line 17:		Line 18:
	This example outputs when a player hits a marker.		This example outputs when a player hits a marker.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function ~~markerAlert~~(~~markerHit~~,~~matchingDimension~~)		addEventHandler('onPlayerMarkerHit', root, function(marker, dimension)
	if ~~(matchingDimension)~~ then -- ~~Make sure the~~ player is ~~in the same dimension as the marker (so they're~~ actually going into ~~it).~~		if not dim then return end -- check if player is actually going into the marker
	outputChatBox("You have just entered a marker.",source,255,255,0) -- ~~Output that they are.~~		outputChatBox('You have just entered a marker!', source, 255, 255, 0) -- output something
	~~end~~		end)
	end
	~~addEventHandler("onPlayerMarkerHit",getRootElement(),markerAlert~~)
	</syntaxhighlight>		</syntaxhighlight>

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

2018-09-27T03:01:31Z

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

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

2018-09-27T02:14:11Z

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

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

2018-04-02T21:44:08Z

Parameters

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

	*'''markerHit''': ~~The~~ marker the player hit.		*'''markerHit''': the [[marker]] the [[player]] hit.
	*'''matchingDimension''': ~~Whether~~ the player and the marker ~~he hit~~ are in the same dimension.		*'''matchingDimension''': a [[boolean]] representing whether the [[player]] and the hit [[marker]] are in the same [[dimension]].

	==Source==		==Source==

2018-04-02T21:28:16Z

Parameters

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

	*'''markerHit''': The marker the player hit		*'''markerHit''': The marker the player hit.
	*'''matchingDimension''': Whether the player and the marker he hit are in the same dimension		*'''matchingDimension''': Whether the player and the marker he hit are in the same dimension.

	==Source==		==Source==

2010-05-31T02:58:27Z

Added an example.

← Older revision		Revision as of 02:58, 31 May 2010
Line 15:		Line 15:

	==Example==		==Example==
	~~<!-- Explain what the~~ example ~~is in~~ a ~~single sentance -->~~		This example outputs when a player hits a marker.
	~~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 markerAlert(markerHit,matchingDimension)
	~~blah~~()		if (matchingDimension) then -- Make sure the player is in the same dimension as the marker (so they're actually going into it).
	--~~This line does this..~~.		outputChatBox("You have just entered a marker.",source,255,255,0) -- Output that they are.
	~~mooo~~		end
			end
			addEventHandler("onPlayerMarkerHit",getRootElement(),markerAlert)
	</syntaxhighlight>		</syntaxhighlight>

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

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

2008-01-12T17:47:42Z

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

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