The color of the background plane.
The opacity of the background plane between 0 (fully transparent) and 1 (opaque).
The amount of background plane to keep around the text area as padding. This a multiplying factor of the text area size.
The color of the text.
Whether the text should be rendered or not.
The Font to use for rendering the text.
The 36-character identifier string of the Component. The id is unique within the Entity is belongs to. Currently, the same id may be used by another Component on a different Entity.
Whether the text and background are hidden when inside fog
See this.game.renderer.fog for more info on fog
If true, the offset is expressed along the world-space axes (going through the origin of the Entity). If false, the offset is expressed along the local axes of the Entity. Look at offset property for more information.
The spacing, in font-pixels, to use between characters in the rendered text.
The height, in font-pixels, between rendered lines of texts (when overrideLineHeight is true).
The offset from the Entity origin where the text should be rendered. If isWorldOffset is true, that axes is in world-space (going through the origin of the Entity). If it is false, it is the local axes of the Entity. The value of the offset is expressed in the local Entity's space unit. The scale property has no effect on the offset (only on the size of the text and optional background plane displayed at that position).
The opacity of the text between 0 (fully transparent) and 1 (opaque).
Whether the lineHeight property should be used instead of the default value associated with the Font.
The scaling factor, relative to the Entity, to apply to the rendered text and its optional background plane. This property doesn't affect the yOffset which is always expressed in the local Entity's space unit.
Indicates whether to show the single-color background plane behind the text.
The number of space characters to use for each tab character in the text.
The string of text to be displayed. This can contain newline ('\n') or tab characters ('\t').
The horizontal alignment of the text box relative to the offset from the entity origin
The vertical alignment of the text box relative to the offset from the entity origin
Indicates whether to render the text so it always faces the camera. When this is the case, the text box appears on screen, in 2D, with no rotation.
The type of the Component.
Whether the text should be rendered or not.
The width, in font-pixels, within which the text is laid out. This property has no effect when TextComponentWrapMode.OnlyWrapOnNewLine wrapping mode is used. A negative value means that no width is defined. When this is the case, width isn't taken into account for laying out the text (in TextComponentWrapMode.Default and TextComponentWrapMode.StrictlyRespectSpacing modes). Note that the height of the box where the text is laid out depends on the number of lines necessary to display the text.
The word-wrapping mode to use for laying out the text.
Gets the Entity the Component is part of. This throws an exception if the Component is not in an Entity. Use the isInEntity property to test for that.
Returns true if the Component is part of an Entity.
Returns true if the Component is part of the Game (via the Entity it belongs to).
If true, the yOffset is expressed along the world-space Y axis (going through the origin of the Entity). If false, the yOffset is expressed along the local Y axis of the Entity. Look at yOffset property for more information.
If true, the yOffset is expressed along the world-space Y axis (going through the origin of the Entity). If false, the yOffset is expressed along the local Y axis of the Entity. Look at yOffset property for more information.
The vertical offset along the Y axis, where the text should be rendered. If worldOffset is true, that axis is the world-space Y axis (going through the origin of the Entity). If it is false, it is the local Y axis of the Entity. The value of the offset is expressed in the local Entity's space unit. The scale property has no effect on the yOffset (only on the size of the text and optional background plane displayed at that position).
The vertical offset along the Y axis, where the text should be rendered. If worldOffset is true, that axis is the world-space Y axis (going through the origin of the Entity). If it is false, it is the local Y axis of the Entity. The value of the offset is expressed in the local Entity's space unit. The scale property has no effect on the yOffset (only on the size of the text and optional background plane displayed at that position).
The alignment of the text within the box defined by the width property and the number of lines necessary to display the text. This property has no effect when width is not defined (i.e set to a negative value).