TextLine
Holds a line of text.
TextLine.swift:11class TextLineAbstraction over TextServer for handling a single line of text.
Superclasses
class RefCountedBase class for reference-counted objects.
Citizens in SwiftGodot
Conformances
protocol CustomStringConvertibleA type with a customized textual representation.
protocol EquatableA type that can be compared for value equality.
protocol HashableA type that can be hashed into a
Hasherto produce an integer hash value.protocol Identifiable<ID>A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentableTypes that conform to VariantRepresentable can be stored directly in
Variantwith no conversion. These include all of the Variant types from Godot (for exampleGString,Rect,Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.protocol VariantStorableTypes that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.
Type members
Instance members
var alignment: HorizontalAlignmentSets text alignment within the line as if the line was horizontal.
var direction: TextServer.DirectionText writing direction.
var flags: TextServer.JustificationFlagLine alignment rules. For more info see
TextServer.var orientation: TextServer.OrientationText orientation.
var preserveControl: BoolIf set to
truetext will display control characters.var preserveInvalid: BoolIf set to
truetext will display invalid characters.var textOverrunBehavior: TextServer.OverrunBehaviorSets the clipping behavior when the text exceeds the text line’s set width. See
TextServer.OverrunBehaviorfor a description of all modes.var width: DoubleText line width.
func addObject(key: Variant, size: Vector2, inlineAlign: InlineAlignment, length: Int32, baseline: Double) -> Bool Adds inline object to the text buffer,
keymust be unique. In the text, object is represented aslengthobject replacement characters.func addString(text: String, font: Font?, fontSize: Int32, language: String, meta: Variant) -> Bool Adds text span and font to draw it.
func clear() Clears text line (removes text and inline objects).
func draw(canvas: RID, pos: Vector2, color: Color) Draw text into a canvas item at a given position, with
color.posspecifies the top left corner of the bounding box.func drawOutline(canvas: RID, pos: Vector2, outlineSize: Int32, color: Color) Draw text into a canvas item at a given position, with
color.posspecifies the top left corner of the bounding box.func getLineAscent() -> Double Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical).
func getLineDescent() -> Double Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical).
func getLineUnderlinePosition() -> Double Returns pixel offset of the underline below the baseline.
func getLineUnderlineThickness() -> Double Returns thickness of the underline.
func getLineWidth() -> Double Returns width (for horizontal layout) or height (for vertical) of the text.
func getObjectRect(key: Variant) -> Rect2 Returns bounding rectangle of the inline object.
func getObjects() -> GArray Returns array of inline objects.
func getRid() -> RID Returns TextServer buffer RID.
func getSize() -> Vector2 Returns size of the bounding box of the text.
func hitTest(coords: Double) -> Int32 Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position.
func resizeObject(key: Variant, size: Vector2, inlineAlign: InlineAlignment, baseline: Double) -> Bool Sets new size and alignment of embedded object.
func setBidiOverride(GArray) Overrides BiDi for the structured text.
func tabAlign(tabStops: PackedFloat32Array) Aligns text to the given tab-stops.