OnElementColShapeHit - Revision history

Mkl: /* Use of predefine variable root instead of getRootElement() in example */

2022-12-31T14:08:55Z

Use of predefine variable root instead of getRootElement() in example

← Older revision		Revision as of 14:08, 31 December 2022
Line 24:		Line 24:
	end		end
	end		end
	addEventHandler( "onElementColShapeHit", ~~getRootElement()~~, elementColShapeHit ) -- add a handler function for the event		addEventHandler( "onElementColShapeHit", root, elementColShapeHit ) -- add a handler function for the event
	</syntaxhighlight>		</syntaxhighlight>

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

2018-09-27T02:56:22Z

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

	==See ~~Also==~~		{{See also/Server event\|Element events}}
	~~===~~Element events~~===~~
	~~{{Element_events}}~~
	~~===Event functions===~~
	~~{{Event functions~~}}

2018-09-27T02:06:40Z

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

	{{See ~~also/Server event\|~~Element events}}		==See Also==
			===Element events===
			{{Element_events}}
			===Event functions===
			{{Event functions}}

2018-04-02T22:02:03Z

Parameters

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

	*'''theColShape''': ~~The~~ [[colshape]] that this element collided with.		*'''theColShape''': the [[colshape]] that this [[element]] collided with.
	*'''matchingDimension''': ~~True~~ if the element and the colshape are in the same dimension.		*'''matchingDimension''': a [[boolean]] representing if the [[element]] and the [[colshape]] are in the same [[dimension]].

	==Source==		==Source==

2018-04-02T21:19:34Z

Parameters

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

	*'''theColShape''': The [[colshape]] that this element collided with		*'''theColShape''': The [[colshape]] that this element collided with.
	*'''matchingDimension''': True if the element and the colshape are in the same dimension		*'''matchingDimension''': True if the element and the colshape are in the same dimension.

	==Source==		==Source==

2008-02-03T20:07:02Z

← Older revision		Revision as of 20:07, 3 February 2008
Line 15:		Line 15:

	==Example==		==Example==
	~~<!-- Explain what the example is in a single sentance -->~~		This example prints type of the element which entered the created colshape to chatbox.
	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.~~..		colArea = createColCircle( 1400.0, -700.0, 5.0 ) -- create the colshape
	~~blah~~()
	--~~This line does this.~~..		function elementColShapeHit( colShapeHit )
	~~mooo~~		if colShapeHit == colArea then -- if element entered the created colshape
			outputChatBox( getElementType( source ) .. " entered the colCircle!" ) -- print the type of the element to chatbox
			end
			end
			addEventHandler( "onElementColShapeHit", getRootElement(), elementColShapeHit ) -- add a handler function for the event
	</syntaxhighlight>		</syntaxhighlight>

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

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

2008-01-12T17:38:33Z

2007-12-30T04:38:30Z

← Older revision		Revision as of 04:38, 30 December 2007
Line 1:		Line 1:
	~~[[Category:Incomplete Event]]~~		__NOTOC__
			{{Server event}}
			This event is triggered when an player or vehicle element collides with a colshape.

	~~__NOTOC__~~		==Parameters==
	~~This event is triggered when an element collides with a [[colshape]].~~

	==~~Syntax~~==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~void onElementColShapeHit (~~ colshape ~~hitcolshape~~, bool matchingDimension )		colshape theColShape, bool matchingDimension
	</syntaxhighlight>		</syntaxhighlight>

			*'''theColShape''': The [[colshape]] that this element collided with
			*'''matchingDimension''': True if the element and the colshape are in the same dimension

			==Source==
			The [[event system#Event source\|source]] of this event is the [[player]] or [[vehicle]] that collided with the colshape.

	==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]]

2006-11-19T04:23:51Z

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

	__NOTOC__		__NOTOC__
	This event is ~~blahblah and is used for blahblah~~.		This event is triggered when an element collides with a [[colshape]].

	==Syntax==		==Syntax==

2006-10-23T14:23:13Z

← Older revision		Revision as of 14:23, 23 October 2006
Line 6:		Line 6:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	void onElementColShapeHit ( colshape ~~colshape~~, bool matchingDimension )		void onElementColShapeHit ( colshape hitcolshape, bool matchingDimension )
	</syntaxhighlight>		</syntaxhighlight>

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

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