TextCreateTextItem: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| (10 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | |||
This function creates a text item. A text item represents a single area of text, much like a label does in standard GUI programming. A text item can only be seen by players if it is added to a [[textdisplay]] using [[textDisplayAddText]]. Each text item can be added to multiple displays, if need be. | This function creates a text item. A text item represents a single area of text, much like a label does in standard GUI programming. A text item can only be seen by players if it is added to a [[textdisplay]] using [[textDisplayAddText]]. Each text item can be added to multiple displays, if need be. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
textitem textCreateTextItem ( | textitem textCreateTextItem ( string text, float x, float y, [string priority, int red = 255, int green = 255, int blue = 255, int alpha = 255, float scale = 1, string alignX = "left", string alignY = "top", int shadowAlpha = 0] ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
'' | * '''text''': A string of text you want to display | ||
* '''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. | |||
===Optional Arguments=== | ===Optional Arguments=== | ||
{{OptionalArg}} | {{OptionalArg}} | ||
* '''priority''': How important it is that this text should be up to date on client's screens. Valid values are: "low", "medium", "high" which are aliases for 0, 1 and 2 respectively. | * '''priority''': How important it is that this text should be up to date on client's screens. Valid values are: "low", "medium", "high" which are aliases for 0, 1 and 2 respectively. | ||
* '''red''': A value between 0 and 255 indicating how red the text should be. | * '''red''': A value between 0 and 255 indicating how red the text should be. | ||
| Line 22: | Line 23: | ||
* '''alpha''': A value between 0 and 255 indicating how transparent the text should be, with 0 being fully transparent, and 255 being opaque. | * '''alpha''': A value between 0 and 255 indicating how transparent the text should be, with 0 being fully transparent, and 255 being opaque. | ||
* '''scale''': A floating point value indicating the scale of the text. The default is 1.0, which is around 12pt. | * '''scale''': A floating point value indicating the scale of the text. The default is 1.0, which is around 12pt. | ||
* '''alignX''': A string representing the X-alignment of the text. ("left", "center", "right") | |||
* '''alignY''': A string representing the Y-alignment of the text. ("top", "center", "bottom") | |||
*'''shadowAlpha''': A value between 0 and 255 indicating how dark the drop shadow should be. | |||
===Returns=== | ===Returns=== | ||
| Line 28: | Line 32: | ||
==Example== | ==Example== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
myDisplay = textCreateDisplay () -- | myDisplay = textCreateDisplay () -- create a display | ||
textDisplayAddObserver ( myDisplay, myPlayer ) -- | textDisplayAddObserver ( myDisplay, myPlayer ) -- make it visible to a player | ||
myTextItem = textCreateTextItem ( "Hello world!", 0.5, 0.5 ) -- | myTextItem = textCreateTextItem ( "Hello world!", 0.5, 0.5 ) -- create text item for the display | ||
textDisplayAddText ( myDisplay, myTextItem ) -- | textDisplayAddText ( myDisplay, myTextItem ) -- add created item to text display so it is displayed | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{ | {{Text functions}} | ||
[[ru:textCreateTextItem]] | |||
Latest revision as of 15:42, 27 May 2012
This function creates a text item. A text item represents a single area of text, much like a label does in standard GUI programming. A text item can only be seen by players if it is added to a textdisplay using textDisplayAddText. Each text item can be added to multiple displays, if need be.
Syntax
textitem textCreateTextItem ( string text, float x, float y, [string priority, int red = 255, int green = 255, int blue = 255, int alpha = 255, float scale = 1, string alignX = "left", string alignY = "top", int shadowAlpha = 0] )
Required Arguments
- text: A string of text you want to display
- 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.
Optional Arguments
NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.
- priority: How important it is that this text should be up to date on client's screens. Valid values are: "low", "medium", "high" which are aliases for 0, 1 and 2 respectively.
- red: A value between 0 and 255 indicating how red the text should be.
- green: A value between 0 and 255 indicating how green the text should be.
- blue: A value between 0 and 255 indicating how blue the text should be.
- alpha: A value between 0 and 255 indicating how transparent the text should be, with 0 being fully transparent, and 255 being opaque.
- scale: A floating point value indicating the scale of the text. The default is 1.0, which is around 12pt.
- alignX: A string representing the X-alignment of the text. ("left", "center", "right")
- alignY: A string representing the Y-alignment of the text. ("top", "center", "bottom")
- shadowAlpha: A value between 0 and 255 indicating how dark the drop shadow should be.
Returns
Returns a textitem object.
Example
myDisplay = textCreateDisplay () -- create a display textDisplayAddObserver ( myDisplay, myPlayer ) -- make it visible to a player myTextItem = textCreateTextItem ( "Hello world!", 0.5, 0.5 ) -- create text item for the display textDisplayAddText ( myDisplay, myTextItem ) -- add created item to text display so it is displayed
See Also
- textCreateDisplay
- textCreateTextItem
- textDestroyDisplay
- textDestroyTextItem
- textDisplayAddObserver
- textDisplayAddText
- textDisplayGetObservers
- textDisplayIsObserver
- textDisplayRemoveObserver
- textDisplayRemoveText
- textItemGetColor
- textItemGetPosition
- textItemGetPriority
- textItemGetScale
- textItemGetText
- textItemSetColor
- textItemSetPosition
- textItemSetPriority
- textItemSetScale
- textItemSetText