GetElementDistanceFromCentreOfMassToBaseOfModel - Revision history

Fernando187: Add note on element streamed in requirement

2023-12-08T21:22:57Z

Add note on element streamed in requirement

← Older revision		Revision as of 21:22, 8 December 2023
Line 2:		Line 2:
	{{Client function}}		{{Client function}}
	This function is used to retrieve the distance between a [[element]]'s centre of mass to the base of the model. This can be used to calculate the position the [[element]] has to be set to, to have it on ground level.		This function is used to retrieve the distance between a [[element]]'s centre of mass to the base of the model. This can be used to calculate the position the [[element]] has to be set to, to have it on ground level.
			{{Note\|The distance value is only available when the element is streamed in, otherwise 0 is returned. If you create an element at the player's position which is going to be streamed in, call the function in the next frame to obtain the correct value (with setTimer 0ms, for example).}}
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

TAPL-93: /* Example */

2015-02-20T17:06:45Z

Example

← Older revision		Revision as of 17:06, 20 February 2015
Line 17:		Line 17:
	This example outputs the value for the local player.		This example outputs the value for the local player.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~local localPlayer = getLocalPlayer()~~
	local distance = getElementDistanceFromCentreOfMassToBaseOfModel(localPlayer)		local distance = getElementDistanceFromCentreOfMassToBaseOfModel(localPlayer)
	outputChatBox(tostring(distance))		outputChatBox(tostring(distance))

Qaisjp: oop remove incorrect note

2014-12-31T19:13:19Z

oop remove incorrect note

← Older revision		Revision as of 19:13, 31 December 2014
Line 6:		Line 6:
	float getElementDistanceFromCentreOfMassToBaseOfModel ( element theElement )		float getElementDistanceFromCentreOfMassToBaseOfModel ( element theElement )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|~~This function is also a static function underneath the Element class.~~\|[[element]]:getDistanceFromCentreOfMassToBaseOfModel\|distanceFromCentreOfMassToBaseOfModel}}		{{OOP\|\|[[element]]:getDistanceFromCentreOfMassToBaseOfModel\|distanceFromCentreOfMassToBaseOfModel}}

	===Required Parameters===		===Required Parameters===

AlexTMjugador: Added OOP variable

2014-12-31T13:34:40Z

Added OOP variable

← Older revision		Revision as of 13:34, 31 December 2014
Line 6:		Line 6:
	float getElementDistanceFromCentreOfMassToBaseOfModel ( element theElement )		float getElementDistanceFromCentreOfMassToBaseOfModel ( element theElement )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|This function is also a static function underneath the Element class.\|[[element]]:getDistanceFromCentreOfMassToBaseOfModel\|\|}}		{{OOP\|This function is also a static function underneath the Element class.\|[[element]]:getDistanceFromCentreOfMassToBaseOfModel\|distanceFromCentreOfMassToBaseOfModel}}

	===Required Parameters===		===Required Parameters===

Banex: /* Syntax */

2014-12-05T20:40:28Z

Syntax

← Older revision		Revision as of 20:40, 5 December 2014
Line 6:		Line 6:
	float getElementDistanceFromCentreOfMassToBaseOfModel ( element theElement )		float getElementDistanceFromCentreOfMassToBaseOfModel ( element theElement )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[element]]:getDistanceFromCentreOfMassToBaseOfModel}}		{{OOP\|This function is also a static function underneath the Element class.\|[[element]]:getDistanceFromCentreOfMassToBaseOfModel\|\|}}

	===Required Parameters===		===Required Parameters===

AlexTMjugador: Added OOP syntax

2014-11-26T16:58:44Z

Added OOP syntax

← Older revision		Revision as of 16:58, 26 November 2014
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	This function is used to retrieve the distance between a element's centre of mass to the base of the model. This can be used to calculate the position the element has to be set to, to have it on ground level.		This function is used to retrieve the distance between a [[element]]'s centre of mass to the base of the model. This can be used to calculate the position the [[element]] has to be set to, to have it on ground level.
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	float getElementDistanceFromCentreOfMassToBaseOfModel ( element theElement )		float getElementDistanceFromCentreOfMassToBaseOfModel ( element theElement )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[element]]:getDistanceFromCentreOfMassToBaseOfModel}}

	===Required Parameters===		===Required Parameters===
	'''theElement:''' The element you want to retrieve the value of.		'''theElement:''' The element you want to retrieve the value of.

	===Returns===		===Returns===
	Returns a ''float'' with the distance, or ''false'' if the element is invalid.		Returns a ''float'' with the distance, or ''false'' if the element is invalid.

	==Example==		==Example==
	This example outputs the value for the local player.		This example outputs the value for the local player.
Line 17:		Line 21:
	outputChatBox(tostring(distance))		outputChatBox(tostring(distance))
	</syntaxhighlight>		</syntaxhighlight>

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

Atroxide: Removed precalculated outputs, incorrect.

2012-01-02T06:28:03Z

Removed precalculated outputs, incorrect.

@@ Line 16: / Line 16: @@
 local distance = getElementDistanceFromCentreOfMassToBaseOfModel(localPlayer)
 outputChatBox(tostring(distance))
 </syntaxhighlight>
 ==See Also==
 {{Client element functions}}

Atroxide: Added pre-caclulated outputs for this function.

2012-01-02T06:21:15Z

Added pre-caclulated outputs for this function.

@@ Line 16: / Line 16: @@
 local distance = getElementDistanceFromCentreOfMassToBaseOfModel(localPlayer)
 outputChatBox(tostring(distance))
 </syntaxhighlight>
 ==See Also==
 {{Client element functions}}

LordAzamath: As the function is a client function, changed /* See also */ to client element functions

2009-06-28T10:58:56Z

As the function is a client function, changed See also: to client element functions

← Older revision		Revision as of 10:58, 28 June 2009
Line 18:		Line 18:
	</syntaxhighlight>		</syntaxhighlight>
	==See Also==		==See Also==
	{{~~Element~~ functions}}		{{Client element functions}}

Talidan at 15:01, 26 August 2007

2007-08-26T15:01:22Z

← Older revision		Revision as of 15:01, 26 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	This function is used to retrieve the distance between a element's centre of ~~bas~~ to the base of the model. This can be used to calculate the position the element has to be set to, to have it on ground level.		This function is used to retrieve the distance between a element's centre of mass to the base of the model. This can be used to calculate the position the element has to be set to, to have it on ground level.
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">