GuiGetPosition - Revision history

LordHenry: /* See Also */

2018-11-21T17:16:57Z

StrixG: OOP syntax

2018-11-07T15:58:58Z

OOP syntax

← Older revision		Revision as of 15:58, 7 November 2018
Line 6:		Line 6:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	float, float guiGetPosition ( element guiElement, bool relative )		float, float guiGetPosition ( element guiElement, bool relative )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[GUI widgets\|GuiElement]]:getPosition\|position\|guiSetPosition}}

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

Jbeta at 01:35, 4 November 2007

2007-11-04T01:35:48Z

← Older revision		Revision as of 01:35, 4 November 2007
Line 10:		Line 10:
	===Required Arguments===		===Required Arguments===
	*'''guiElement:''' The gui element of which you wish to retrieve the position.		*'''guiElement:''' The gui element of which you wish to retrieve the position.
	*'''relative:''' A boolean representing whether the position should be relative to the element's parent width, or ~~an absolute pixel~~ offset from the parent's origin.		*'''relative:''' A boolean representing whether the position should be relative to the element's parent width, or the number of offset pixels from the parent's origin.

	===Returns===		===Returns===

Jbeta at 01:34, 4 November 2007

2007-11-04T01:34:12Z

← Older revision		Revision as of 01:34, 4 November 2007
Line 13:		Line 13:

	===Returns===		===Returns===
	Returns ~~two~~ floats of the ''x'' and ''y'' ~~positions of the~~ position of the element, or false if the position could not be retrieved.		Returns floats representing the ''x'' and ''y'' position of the element, or false if the position could not be retrieved.

	==Example==		==Example==

Jbeta: Fixed syntax description

2007-11-04T01:33:34Z

Fixed syntax description

← Older revision		Revision as of 01:33, 4 November 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	This function allows retrieval of a GUI element's current position ~~on the screen~~		This function allows retrieval of a GUI element's current position, relative to its parent.

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	float float guiGetPosition ( element guiElement, bool relative )		float, float guiGetPosition ( element guiElement, bool relative )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''guiElement:''' The gui element of which you wish to retrieve the position.		*'''guiElement:''' The gui element of which you wish to retrieve the position.
	*'''relative:''' A boolean representing whether the position should be relative to the element's parent, or absolute pixel ~~position~~.		*'''relative:''' A boolean representing whether the position should be relative to the element's parent width, or an absolute pixel offset from the parent's origin.

	===Returns===		===Returns===
	Returns two floats of the ''x'' and ''y'' positions of the position of the element ~~on the screen~~, or false if the position could not be retrieved.		Returns two floats of the ''x'' and ''y'' positions of the position of the element, or false if the position could not be retrieved.

	==Example==		==Example==

Talidan at 15:19, 15 August 2007

2007-08-15T15:19:38Z

← Older revision		Revision as of 15:19, 15 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
			{{Client function}}
	This function allows retrieval of a GUI element's current position on the screen		This function allows retrieval of a GUI element's current position on the screen

Line 15:		Line 16:

	==Example==		==Example==
	~~<!-- Explain what the~~ example is in ~~a single sentance -->~~		This example checks which corner a gui element exists in
	~~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 positionCheck ( guiElement )
	~~blabhalbalhb~~ --~~abababa~~		local x,y = guiGetPosition ( guiElement, true ) --get the position
	--~~This line does~~ this...		local position --define the position
	~~mooo~~		if ( x == 0.5 ) and ( y == 0.5 ) then --if its bang in the middle
			position = "middle" --set position to middle
			elseif ( x > 0.5 ) and ( y > 0.5 ) then --if its in the right bottom
			position = "right-bottom"
			elseif ( x < 0.5 ) and ( y < 0.5 ) then --if its in the left top
			position = "left-top"
			elseif ( x < 0.5 ) and ( y > 0.5 ) then --if its in the left bottom
			position = "left-bottom"
			elseif ( x > 0.5 ) and ( y < 0.5 ) then --if its in the right top
			position = "right-top"
			else --if it couldnt be retrieved
			position = "unknown"
			end
			--announce this into the chatbox
			outputChatBox ( "The gui element's position is "..position.."!" )
			end
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{GUI_functions}}		{{GUI_functions}}
	~~[[Category:Incomplete]] -- leave this unless you complete the function~~

Talidan at 15:06, 11 August 2007

2007-08-11T15:06:46Z

← Older revision		Revision as of 15:06, 11 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	~~<!-- Describe in plain english what this~~ function ~~does. Don~~'~~t go into details, just give an overview -->~~		This function allows retrieval of a GUI element's current position on the screen
	~~This fake function is for use with blah & blah and does blahblahblabhalbhl~~

	==Syntax==		==Syntax==
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	float float guiGetPosition ( element ~~guielement~~ )		float float guiGetPosition ( element guiElement, bool relative )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	~~<!-- List each argument one per line. This should be the argument~~'~~s name as in~~ the ~~argument list above, NOT the argument's data type -->~~		*'''guiElement:''' The gui element of which you wish to retrieve the position.
	*'''~~argumentName~~:''' ~~description~~		*'''relative:''' A boolean representing whether the position should be relative to the element's parent, or absolute pixel position.

	~~<!-- Only include this section below if there are optional arguments -->~~		===Returns===
	===~~Optional Arguments~~===		Returns two floats of the ''x'' and ''y'' positions of the position of the element on the screen, or false if the position could not be retrieved.
	~~{{OptionalArg}}~~
	*'''~~argumentName2:~~''' ~~description~~
	*''~~'argumentName3:''' description~~

	~~===Returns===~~
	~~<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->~~
	~~Returns ''true'' if blah, ''false'' otherwise.~~
	*x
	*y
	==Example==		==Example==
	<!-- Explain what the example is in a single sentance -->		<!-- Explain what the example is in a single sentance -->
Line 36:		Line 26:

	==See Also==		==See Also==
	~~<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->~~		{{GUI_functions}}
	{{~~FunctionArea_functions~~}}
	~~[[Category:Need_Syntax]] -- leave this until syntax is available. Cannot document the function or event without syntax.~~
	[[Category:Incomplete]] -- leave this unless you complete the function		[[Category:Incomplete]] -- leave this unless you complete the function

Ransom at 23:51, 12 April 2007

2007-04-12T23:51:46Z

← Older revision		Revision as of 23:51, 12 April 2007
Line 6:		Line 6:
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->		<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~returnType functionName~~ ( ~~arguments~~ )		float float guiGetPosition ( element guielement )
	</syntaxhighlight>		</syntaxhighlight>

Line 22:		Line 22:
	<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->		<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
	Returns ''true'' if blah, ''false'' otherwise.		Returns ''true'' if blah, ''false'' otherwise.
			*x
			*y
	==Example==		==Example==
	<!-- Explain what the example is in a single sentance -->		<!-- Explain what the example is in a single sentance -->

Ransom at 23:47, 12 April 2007

2007-04-12T23:47:46Z

New page

__NOTOC__

This fake function is for use with blah & blah and does blahblahblabhalbhl

==Syntax==

<syntaxhighlight lang="lua">
returnType functionName ( arguments )
</syntaxhighlight>

===Required Arguments===

*'''argumentName:''' description


===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description

===Returns===

Returns ''true'' if blah, ''false'' otherwise.

==Example==

This example does...

<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==

{{FunctionArea_functions}}
[[Category:Need_Syntax]] -- leave this until syntax is available. Cannot document the function or event without syntax.
[[Category:Incomplete]] -- leave this unless you complete the function

← Older revision		Revision as of 17:16, 21 November 2018
Line 42:		Line 42:
	==See Also==		==See Also==
	{{GUI_functions}}		{{GUI_functions}}
			{{GUI_events}}