TextItemSetPosition: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
__NOTOC__ | __NOTOC__ | ||
This | This function allows the setting of the position of a text item | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool textItemSetPosition ( textitem textitem, float x, float y ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''textitem:''' The text item you wish to change the position of. | ||
*'''x:''' A floating point number between 0.0 and 1.0 indicating how far across the screen the text should be shown, as a percentage of the width, from the left hand side. | |||
*'''y:''' A floating point number between 0.0 and 1.0 indicating how far down the screen the text should be shown, as a percentage of the height, from the top. | |||
*''' | |||
*''' | |||
===Returns=== | ===Returns=== | ||
Returns ''true'' if | Returns ''true'' if the position was successfully set, ''false'' otherwise. | ||
==Example== | ==Example== | ||
This 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. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | myDisplay = textCreateDisplay () --created display | ||
textDisplayAddObserver ( myDisplay, myPlayer ) --made display visible to 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 the otherTextItem down | |||
end | |||
myTextItem = textCreateTextItem ( "Hello world!", 0.5, 0.5 ) --and create a new item for the display in the middle saying "Hello world" in the middle | |||
textDisplayAddText ( myDisplay, myTextItem ) --and add it to the text display | |||
end | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{ | {{Text functions}} | ||
Revision as of 16:25, 16 August 2006
This function allows the setting of the position of a text item
Syntax
bool textItemSetPosition ( textitem textitem, float x, float y )
Required Arguments
- textitem: The text item you wish to change the position of.
- x: A floating point number between 0.0 and 1.0 indicating how far across the screen the text should be shown, as a percentage of the width, from the left hand side.
- y: A floating point number between 0.0 and 1.0 indicating how far down the screen the text should be shown, as a percentage of the height, from the top.
Returns
Returns true if the position was successfully set, false otherwise.
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.
myDisplay = textCreateDisplay () --created display
textDisplayAddObserver ( myDisplay, myPlayer ) --made display visible to 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 the otherTextItem down
end
myTextItem = textCreateTextItem ( "Hello world!", 0.5, 0.5 ) --and create a new item for the display in the middle saying "Hello world" in the middle
textDisplayAddText ( myDisplay, myTextItem ) --and add it to the text display
end
See Also
- textCreateDisplay
- textCreateTextItem
- textDestroyDisplay
- textDestroyTextItem
- textDisplayAddObserver
- textDisplayAddText
- textDisplayGetObservers
- textDisplayIsObserver
- textDisplayRemoveObserver
- textDisplayRemoveText
- textItemGetColor
- textItemGetPosition
- textItemGetPriority
- textItemGetScale
- textItemGetText
- textItemSetColor
- textItemSetPosition
- textItemSetPriority
- textItemSetScale
- textItemSetText