GetElementsWithinColShape - Revision history

Lvrent at 17:10, 20 September 2021

2021-09-20T17:10:32Z

← Older revision		Revision as of 17:10, 20 September 2021
Line 3:		Line 3:
	This function is used to retrieve a list of all elements in a colshape, of the specified type.		This function is used to retrieve a list of all elements in a colshape, of the specified type.
	{{Note\|		{{Note\|
	* For legacy reasons, a colshape created on the client does not collide with elements already existing at that location until they first move		* For legacy reasons, a colshape created on the client does not collide with elements already existing at that location until they first move.
	* This function doesn't verify whether elements are in the same dimension and interior, additional checks could be implemented manually if they are needed		* This function doesn't verify whether elements are in the same dimension and interior, additional checks could be implemented manually if they are needed.
	}}		}}
	==Syntax==		==Syntax==
Line 32:		Line 32:
	This example retrieves a [[table]] of players inside a colshape and prints their name to the chat.		This example retrieves a [[table]] of players inside a colshape and prints their name to the chat.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local newColShape = createColSphere( 1, 2, 3, 4 ) -- create our new colshape		local newColShape = createColSphere (1, 2, 3, 4) -- create our new colshape
	local players = getElementsWithinColShape( newColShape, "player" ) -- get all the players inside the sphere		local players = getElementsWithinColShape (newColShape, "player") -- get all the players inside the sphere
	for _, thePlayer in ipairs( players ) do -- use a generic for loop to step through each player
	outputChatBox( getPlayerName( thePlayer ) .. " is in our new sphere" ) -- print their name to the chat		for _, thePlayer in ipairs (players) do -- use a generic for loop to step through each player
			outputChatBox (getPlayerName (thePlayer).." is in our new sphere") -- print their name to the chat
	end		end
	</syntaxhighlight>		</syntaxhighlight>

Surge at 11:47, 10 October 2018

2018-10-10T11:47:10Z

← Older revision		Revision as of 11:47, 10 October 2018
Line 45:		Line 45:
	==See Also==		==See Also==
	{{Element_functions}}		{{Element_functions}}

			[[hu:getElementsWithinColShape]]

Myonlake: Undo revision 57133 by Octalype (talk) Actually, this function has been in MTA since 2009.

2018-07-29T16:05:38Z

Undo revision 57133 by Octalype (talk) Actually, this function has been in MTA since 2009.

← Older revision		Revision as of 16:05, 29 July 2018
Line 1:		Line 1:
	{{Server client function}}		{{Server client function}}
	__NOTOC__		__NOTOC__
	~~{{New feature/item\|3.0156\|1.5.6\|\|~~This function is used to retrieve a list of all elements in a colshape, of the specified type.}}		This function is used to retrieve a list of all elements in a colshape, of the specified type.
	{{Note\|		{{Note\|
	* For legacy reasons, a colshape created on the client does not collide with elements already existing at that location until they first move		* For legacy reasons, a colshape created on the client does not collide with elements already existing at that location until they first move

Botder at 13:43, 29 July 2018

2018-07-29T13:43:37Z

← Older revision		Revision as of 13:43, 29 July 2018
Line 1:		Line 1:
	{{Server client function}}		{{Server client function}}
	__NOTOC__		__NOTOC__
	This function is used to retrieve a list of all elements in a colshape, of the specified type.		{{New feature/item\|3.0156\|1.5.6\|\|This function is used to retrieve a list of all elements in a colshape, of the specified type.}}
	{{Note\|		{{Note\|
	* For legacy reasons, a colshape created on the client does not collide with elements already existing at that location until they first move		* For legacy reasons, a colshape created on the client does not collide with elements already existing at that location until they first move

Ccw at 05:42, 29 July 2018

2018-07-29T05:42:30Z

← Older revision		Revision as of 05:42, 29 July 2018
Line 1:		Line 1:
	{{Server client function}}		{{Server client function}}
	__NOTOC__		__NOTOC__
	This function is used to retrieve a list of all elements in a colshape, of the specified type. ~~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.		This function is used to retrieve a list of all elements in a colshape, of the specified type.
			{{Note\|
	~~Please note that this~~ function doesn't verify whether elements are in the same dimension and interior, additional checks could be implemented manually if they are needed.		* For legacy reasons, a colshape created on the client does not collide with elements already existing at that location until they first move
			* This function doesn't verify whether elements are in the same dimension and interior, additional checks could be implemented manually if they are needed
			}}
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Ccw at 05:40, 29 July 2018

2018-07-29T05:40:07Z

← Older revision		Revision as of 05:40, 29 July 2018
Line 1:		Line 1:
	{{Server client function}}		{{Server client function}}
	__NOTOC__		__NOTOC__
	This function is used to retrieve a list of all elements in a colshape, of the specified type. 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 retrieve a list of all elements in a colshape, of the specified type. 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 note that this function doesn't verify whether elements are in the same dimension and interior, additional checks could be implemented manually if they are needed.		Please note that this function doesn't verify whether elements are in the same dimension and interior, additional checks could be implemented manually if they are needed.

Myonlake: /* Example */

2018-07-29T05:12:37Z

Example

← Older revision		Revision as of 05:12, 29 July 2018
Line 29:		Line 29:

	==Example==		==Example==
	This example retrieves a table of ~~the~~ players ~~in the~~ colshape and prints their name to the chat.		This example retrieves a [[table]] of players inside a colshape and prints their name to the chat.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local ~~newcolshape~~ = createColSphere( 1, 2, 3, 4 )		local newColShape = createColSphere( 1, 2, 3, 4 ) -- create our new colshape
	local players = getElementsWithinColShape( ~~newcolshape~~, "player" ) -- get all the players inside the sphere		local players = getElementsWithinColShape( newColShape, "player" ) -- get all the players inside the sphere
	for _, thePlayer in ipairs( players ) do -- use a generic for loop to step through each player		for _, thePlayer in ipairs( players ) do -- use a generic for loop to step through each player
	outputChatBox( getPlayerName( thePlayer ) .. " is in our new sphere" ) -- print their name to the chat		outputChatBox( getPlayerName( thePlayer ) .. " is in our new sphere" ) -- print their name to the chat

Myonlake: /* Returns */

2018-07-29T05:11:34Z

Returns

← Older revision		Revision as of 05:11, 29 July 2018
Line 26:		Line 26:

	===Returns===		===Returns===
	Returns a ''table'' containing all the elements inside the colshape, of the specified type. Returns an empty ''table'' if there are no elements inside. Returns ''false'' if the colshape is invalid.		Returns a [[table]] containing all the elements inside the colshape, of the specified type. Returns an empty [[table]] if there are no elements inside. Returns ''false'' if the colshape is invalid.

	==Example==		==Example==

Myonlake at 04:58, 29 July 2018

2018-07-29T04:58:07Z

← Older revision		Revision as of 04:58, 29 July 2018
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	table getElementsWithinColShape ( colshape theShape, [ string elemType = nil ] )		table getElementsWithinColShape ( colshape theShape [, string elemType = nil ] )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\| \|[[colshape]]:getElementsWithin\|elementsWithin\|}}		{{OOP\| \|[[colshape]]:getElementsWithin\|elementsWithin\|}}
Line 31:		Line 31:
	This example retrieves a table of the players in the colshape and prints their name to the chat.		This example retrieves a table of the players in the colshape and prints their name to the chat.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local newcolshape = createColSphere ( 1, 2, 3, 4 )		local newcolshape = createColSphere( 1, 2, 3, 4 )
	local players = getElementsWithinColShape ( newcolshape, "player" ) -- get all the players inside the sphere		local players = getElementsWithinColShape( newcolshape, "player" ) -- get all the players inside the sphere
	for ~~theKey~~,thePlayer in ipairs(players) do -- use a generic for loop to step through each player		for _, thePlayer in ipairs( players ) do -- use a generic for loop to step through each player
	outputChatBox ( getPlayerName ( thePlayer ) .. " is in our new sphere" ) -- print their name to the chat		outputChatBox( getPlayerName( thePlayer ) .. " is in our new sphere" ) -- print their name to the chat
	end		end
	</syntaxhighlight>		</syntaxhighlight>

Myonlake: /* Syntax */

2018-07-08T04:38:05Z

Syntax

← Older revision		Revision as of 04:38, 8 July 2018
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	table getElementsWithinColShape ( colshape ~~shape~~, [ string elemType = nil ] )		table getElementsWithinColShape ( colshape theShape, [ string elemType = nil ] )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\| \|[[colshape]]:getElementsWithin\|elementsWithin\|}}		{{OOP\| \|[[colshape]]:getElementsWithin\|elementsWithin\|}}
	===Required Arguments===		===Required Arguments===
	*'''~~shape~~:''' The colshape you want to get the elements from.		*'''theShape:''' The colshape you want to get the elements from.

	===Optional Arguments===		===Optional Arguments===