TextItemGetPosition: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(Remove spaces)
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Incomplete]]
__NOTOC__
 
{{Server function}}
__NOTOC__
This function allows retrieval of the position of a text item.
This fake function is for use with blah & blah and does blahblahblabhalbhl


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
float float textItemGetPosition ( textitem textitem )            
float float textItemGetPosition ( textitem theTextItem )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''argumentName:''' description
*'''theTextItem:''' The textitem you wish to retrieve the position of
 
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' descriptiona
*'''argumentName3:''' description


===Returns===
===Returns===
Returns ''true'' if blah, ''false'' otherwise.
Returns two floats of the ''x'' and ''y'' position on the screen, where the maximum value is 1.0.


==Example==  
==Example==  
This example does...
This example creates a text item 'myTextItem' only if the text item 'otherTextItem' is not in the same position, to prevent overlap. If it is in the same position, then it moves it down.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
function MyTestTextFunction ()
blabhalbalhb --abababa
myDisplay = textCreateDisplay ( )                  -- create a text display
--This line does this...
textDisplayAddObserver ( myDisplay, myPlayer )      -- make it visible to the player
mooo
x,y = textItemGetPosition ( otherTextItem )        -- get the position of 'otherTextItem'
if ( x == 0.5 ) and ( y == 0.5 ) then              -- if the x and y of the text item are in the middle
    textItemSetPosition ( otherTextItem, 0.5, 0.6 ) -- move otherTextItem down
end
myTextItem = textCreateTextItem ( "Hello world!", 0.5, 0.5 ) -- create a new textitem in the middle saying "Hello world"
textDisplayAddText ( myDisplay, myTextItem )                -- and add it to the text display
end
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{FunctionArea_Functions}}
{{Text functions}}

Latest revision as of 21:14, 29 October 2023

This function allows retrieval of the position of a text item.

Syntax

float float textItemGetPosition ( textitem theTextItem )

Required Arguments

  • theTextItem: The textitem you wish to retrieve the position of

Returns

Returns two floats of the x and y position on the screen, where the maximum value is 1.0.

Example

This example creates a text item 'myTextItem' only if the text item 'otherTextItem' is not in the same position, to prevent overlap. If it is in the same position, then it moves it down.

function MyTestTextFunction ()
myDisplay = textCreateDisplay ( )                   -- create a text display
textDisplayAddObserver ( myDisplay, myPlayer )      -- make it visible to the player
x,y = textItemGetPosition ( otherTextItem )         -- get the position of 'otherTextItem'
if ( x == 0.5 ) and ( y == 0.5 ) then               -- if the x and y of the text item are in the middle
    textItemSetPosition ( otherTextItem, 0.5, 0.6 ) -- move otherTextItem down
end 
myTextItem = textCreateTextItem ( "Hello world!", 0.5, 0.5 ) -- create a new textitem in the middle saying "Hello world"
textDisplayAddText ( myDisplay, myTextItem )                 -- and add it to the text display
end

See Also