IsElementWithinColShape - Revision history

Surge at 12:06, 10 October 2018

2018-10-10T12:06:21Z

← Older revision		Revision as of 12:06, 10 October 2018
Line 39:		Line 39:
	==See Also==		==See Also==
	{{element functions}}		{{element functions}}

			[[hu:isElementWithinColShape]]

VenadHD: /* Example */

2015-08-18T12:27:07Z

Example

← Older revision		Revision as of 12:27, 18 August 2015
Line 34:		Line 34:
	--message to confirm this		--message to confirm this
	end		end
	addEventHandler ( "onColShapeHit", ~~getRootElement()~~, ColShapeHit )		addEventHandler ( "onColShapeHit", root, ColShapeHit )
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{element functions}}		{{element functions}}

Qaisjp: fix oop syntax

2015-01-01T22:51:35Z

fix oop syntax

← Older revision		Revision as of 22:51, 1 January 2015
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">bool isElementWithinColShape ( element theElement, colshape theShape )</syntaxhighlight>		<syntaxhighlight lang="lua">bool isElementWithinColShape ( element theElement, colshape theShape )</syntaxhighlight>
	{{OOP\|~~This function is also a static function underneath the Element class.~~\|[[element]]:isWithinColShape\|\|}}		{{OOP\|\|[[element]]:isWithinColShape}}

	===Required Arguments===		===Required Arguments===

Jaysds: /* Syntax */ OOP

2014-08-16T16:32:37Z

Syntax: OOP

← Older revision		Revision as of 16:32, 16 August 2014
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">bool isElementWithinColShape ( element theElement, colshape theShape )</syntaxhighlight>		<syntaxhighlight lang="lua">bool isElementWithinColShape ( element theElement, colshape theShape )</syntaxhighlight>
			{{OOP\|This function is also a static function underneath the Element class.\|[[element]]:isWithinColShape\|\|}}

	===Required Arguments===		===Required Arguments===

Wielebny at 18:46, 24 June 2013

2013-06-24T18:46:35Z

← Older revision		Revision as of 18:46, 24 June 2013
Line 25:		Line 25:
	--who entered a colshape is within the specific colshape called 'circlearea'.		--who entered a colshape is within the specific colshape called 'circlearea'.
	--The result is either true or false.		--The result is either true or false.
			detection = detection and getElementDimension( thePlayer ) == getElementDimension( circlearea )
			--Let's additionally check element dimensions.
	if detection then		if detection then
	outputChatBox ( getPlayerName(thePlayer).." is in the 'circle area' col shape" )		outputChatBox ( getPlayerName(thePlayer).." is in the 'circle area' col shape" )

Wielebny at 09:10, 19 December 2011

2011-12-19T09:10:07Z

← Older revision		Revision as of 09:10, 19 December 2011
Line 2:		Line 2:
	__NOTOC__		__NOTOC__
	This function is used to determine if an element is within a collision shape. Please note that for legacy reasons, a colshape created on the client does not collide with elements already existing at that location until they first move. Please also note that before 1.0.3, this did not function correctly when moving a colshape.		This function is used to determine if an element is within a collision shape. Please note that for legacy reasons, a colshape created on the client does not collide with elements already existing at that location until they first move. Please also note that before 1.0.3, this did not function correctly when moving a colshape.

			Please note that this function doesn't verify whether element is in the same dimension and interior, additional checks could be implemented manually if they are needed.

	==Syntax==		==Syntax==

Sebassje: /* Example was incomplete !! */

2010-02-12T20:40:56Z

Example was incomplete !!

← Older revision		Revision as of 20:40, 12 February 2010
Line 16:		Line 16:
	This small script is an example of detecting if a player is within a certain defined colshape. This could serve as a base to perform many functions, rather than just an output.		This small script is an example of detecting if a player is within a certain defined colshape. This could serve as a base to perform many functions, rather than just an output.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
			local circlearea = createColCircle ( 0, 0, 10 )

	function ColShapeHit ( thePlayer, matchingDimension )		function ColShapeHit ( thePlayer, matchingDimension )
	detection = isElementWithinColShape ( thePlayer, circlearea )		local detection = isElementWithinColShape ( thePlayer, circlearea )
	--A variable called 'detection' stores the result of asking if the player		--A variable called 'detection' stores the result of asking if the player
	--who entered a colshape is within the specific colshape called 'circlearea'.		--who entered a colshape is within the specific colshape called 'circlearea'.
	--The result is either true or false.		--The result is either true or false.
	if detection ~~== true~~ then		if detection then
	outputChatBox ( "~~Player~~ is in the 'circle area' col shape" )		outputChatBox ( getPlayerName(thePlayer).." is in the 'circle area' col shape" )
	end		end
	--if detection was true then the player is in the col shape. Output a		--if detection was true then the player is in the col shape. Output a

Ccw: Add version notes

2009-12-18T19:12:05Z

Add version notes

← Older revision		Revision as of 19:12, 18 December 2009
Line 1:		Line 1:
	{{Server client function}}		{{Server client function}}
	__NOTOC__		__NOTOC__
	This function is used to determine if an element is within a collision shape.		This function is used to determine if an element is within a collision shape. Please note that for legacy reasons, a colshape created on the client does not collide with elements already existing at that location until they first move. Please also note that before 1.0.3, this did not function correctly when moving a colshape.

	==Syntax==		==Syntax==

Arc at 14:32, 17 August 2007

2007-08-17T14:32:11Z

← Older revision		Revision as of 14:32, 17 August 2007
Line 1:		Line 1:
			{{Server client function}}
	__NOTOC__		__NOTOC__
	This function is used to ~~tell~~ if an element is within a collision shape.		This function is used to determine if an element is within a collision shape.

	==Syntax==		==Syntax==
Line 15:		Line 16:
	This small script is an example of detecting if a player is within a certain defined colshape. This could serve as a base to perform many functions, rather than just an output.		This small script is an example of detecting if a player is within a certain defined colshape. This could serve as a base to perform many functions, rather than just an output.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function ColShapeHit ( ~~player~~, matchingDimension )		function ColShapeHit ( thePlayer, matchingDimension )
	detection = isElementWithinColShape ( ~~player~~, circlearea )		detection = isElementWithinColShape ( thePlayer, circlearea )
	--A variable called 'detection' stores the result of asking if the player		--A variable called 'detection' stores the result of asking if the player
	--who entered a colshape is within the specific colshape called 'circlearea'.		--who entered a colshape is within the specific colshape called 'circlearea'.

Arc: Corrected addEventHandler call

2007-08-15T15:05:24Z

Corrected addEventHandler call

← Older revision		Revision as of 15:05, 15 August 2007
Line 15:		Line 15:
	This small script is an example of detecting if a player is within a certain defined colshape. This could serve as a base to perform many functions, rather than just an output.		This small script is an example of detecting if a player is within a certain defined colshape. This could serve as a base to perform many functions, rather than just an output.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~addEventHandler ( "onColShapeHit", getRootElement(), "ColShapeHit" )~~
	function ColShapeHit ( player, matchingDimension )		function ColShapeHit ( player, matchingDimension )
	detection = isElementWithinColShape ( player, circlearea )		detection = isElementWithinColShape ( player, circlearea )
	--A ~~varible~~ called 'detection' stores the result of asking if the player		--A variable called 'detection' stores the result of asking if the player
	--who entered a colshape is within the specific colshape called 'circlearea'.		--who entered a colshape is within the specific colshape called 'circlearea'.
	--The result is either true or false.		--The result is either true or false.
	if detection == true then		if detection == true then
	outputChatBox ( "Player is in the 'circle area' col shape" )		outputChatBox ( "Player is in the 'circle area' col shape" )
	end		end
	--if detection was true then the player is in the col shape. Output a		--if detection was true then the player is in the col shape. Output a
	--message to confirm this		--message to confirm this
	end		end
			addEventHandler ( "onColShapeHit", getRootElement(), ColShapeHit )
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{element functions}}		{{element functions}}