scala-native-gdextension
API
Generated with
scala-native-gdextension/gdext/gdext.classes/TextParagraph

TextParagraph

gdext.classes.TextParagraph
See theTextParagraph companion object
abstract class TextParagraph extends RefCounted

Generated wrapper for Godot's TextParagraph, extends RefCounted.

Attributes

Companion
object
Graph
Supertypes
class RefCounted
class Object
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

final def clear(): Unit

TextParagraph.clear

TextParagraph.clear

Attributes

final def clearDropcap(): Unit

TextParagraph.clear_dropcap

TextParagraph.clear_dropcap

Attributes

final def duplicate(): TextParagraph

TextParagraph.duplicate. Returns an owned reference: release it with unref() or inside Gd.scoped.

TextParagraph.duplicate. Returns an owned reference: release it with unref() or inside Gd.scoped.

Attributes

final def getAlignment(): Long

TextParagraph.get_alignment

TextParagraph.get_alignment

Attributes

final def getBreakFlags(): Long

TextParagraph.get_break_flags

TextParagraph.get_break_flags

Attributes

final def getCustomPunctuation(): String

TextParagraph.get_custom_punctuation

TextParagraph.get_custom_punctuation

Attributes

final def getDirection(): Long

TextParagraph.get_direction

TextParagraph.get_direction

Attributes

final def getDropcapLines(): Long

TextParagraph.get_dropcap_lines

TextParagraph.get_dropcap_lines

Attributes

final def getDropcapSize(): Vector2

TextParagraph.get_dropcap_size

TextParagraph.get_dropcap_size

Attributes

final def getEllipsisChar(): String

TextParagraph.get_ellipsis_char

TextParagraph.get_ellipsis_char

Attributes

final def getInferredDirection(): Long

TextParagraph.get_inferred_direction

TextParagraph.get_inferred_direction

Attributes

final def getJustificationFlags(): Long

TextParagraph.get_justification_flags

TextParagraph.get_justification_flags

Attributes

final def getLineAscent(line: Long): Double

TextParagraph.get_line_ascent

TextParagraph.get_line_ascent

Attributes

final def getLineCount(): Long

TextParagraph.get_line_count

TextParagraph.get_line_count

Attributes

final def getLineDescent(line: Long): Double

TextParagraph.get_line_descent

TextParagraph.get_line_descent

Attributes

final def getLineRange(line: Long): Vector2i

TextParagraph.get_line_range

TextParagraph.get_line_range

Attributes

final def getLineSize(line: Long): Vector2

TextParagraph.get_line_size

TextParagraph.get_line_size

Attributes

final def getLineSpacing(): Double

TextParagraph.get_line_spacing

TextParagraph.get_line_spacing

Attributes

final def getLineUnderlinePosition(line: Long): Double

TextParagraph.get_line_underline_position

TextParagraph.get_line_underline_position

Attributes

final def getLineUnderlineThickness(line: Long): Double

TextParagraph.get_line_underline_thickness

TextParagraph.get_line_underline_thickness

Attributes

final def getLineWidth(line: Long): Double

TextParagraph.get_line_width

TextParagraph.get_line_width

Attributes

final def getMaxLinesVisible(): Long

TextParagraph.get_max_lines_visible

TextParagraph.get_max_lines_visible

Attributes

final def getNonWrappedSize(): Vector2

TextParagraph.get_non_wrapped_size

TextParagraph.get_non_wrapped_size

Attributes

final def getOrientation(): Long

TextParagraph.get_orientation

TextParagraph.get_orientation

Attributes

final def getPreserveControl(): Boolean

TextParagraph.get_preserve_control

TextParagraph.get_preserve_control

Attributes

final def getPreserveInvalid(): Boolean

TextParagraph.get_preserve_invalid

TextParagraph.get_preserve_invalid

Attributes

final def getRange(): Vector2i

TextParagraph.get_range

TextParagraph.get_range

Attributes

final def getSize(): Vector2

TextParagraph.get_size

TextParagraph.get_size

Attributes

final def getTextOverrunBehavior(): Long

TextParagraph.get_text_overrun_behavior

TextParagraph.get_text_overrun_behavior

Attributes

final def getWidth(): Double

TextParagraph.get_width

TextParagraph.get_width

Attributes

override def godotClassName: String

The Godot class name for this instance. Engine wrappers override with the baked literal; user classes fall back to their Scala simple name (which is how registration names them).

The Godot class name for this instance. Engine wrappers override with the baked literal; user classes fall back to their Scala simple name (which is how registration names them).

Attributes

Definition Classes
final def hitTest(coords: Vector2): Long

TextParagraph.hit_test

TextParagraph.hit_test

Attributes

final def setAlignment(alignment: Long): Unit

TextParagraph.set_alignment

TextParagraph.set_alignment

Attributes

final def setBreakFlags(flags: Long): Unit

TextParagraph.set_break_flags

TextParagraph.set_break_flags

Attributes

final def setCustomPunctuation(custom_punctuation: String): Unit

TextParagraph.set_custom_punctuation

TextParagraph.set_custom_punctuation

Attributes

final def setDirection(direction: Long): Unit

TextParagraph.set_direction

TextParagraph.set_direction

Attributes

final def setDropcap(text: String, font: Font, font_size: Long, dropcap_margins: Rect2, language: String): Boolean

TextParagraph.set_dropcap

TextParagraph.set_dropcap

Attributes

final def setEllipsisChar(char: String): Unit

TextParagraph.set_ellipsis_char

TextParagraph.set_ellipsis_char

Attributes

final def setJustificationFlags(flags: Long): Unit

TextParagraph.set_justification_flags

TextParagraph.set_justification_flags

Attributes

final def setLineSpacing(line_spacing: Double): Unit

TextParagraph.set_line_spacing

TextParagraph.set_line_spacing

Attributes

final def setMaxLinesVisible(max_lines_visible: Long): Unit

TextParagraph.set_max_lines_visible

TextParagraph.set_max_lines_visible

Attributes

final def setOrientation(orientation: Long): Unit

TextParagraph.set_orientation

TextParagraph.set_orientation

Attributes

final def setPreserveControl(enabled: Boolean): Unit

TextParagraph.set_preserve_control

TextParagraph.set_preserve_control

Attributes

final def setPreserveInvalid(enabled: Boolean): Unit

TextParagraph.set_preserve_invalid

TextParagraph.set_preserve_invalid

Attributes

final def setTextOverrunBehavior(overrun_behavior: Long): Unit

TextParagraph.set_text_overrun_behavior

TextParagraph.set_text_overrun_behavior

Attributes

final def setWidth(width: Double): Unit

TextParagraph.set_width

TextParagraph.set_width

Attributes

Inherited methods

def _can_handle(obj: GodotObject): Boolean

EditorInspectorPlugin: can this plugin handle obj's inspector?

EditorInspectorPlugin: can this plugin handle obj's inspector?

Attributes

Inherited from:
GodotScriptClass
def _enter_tree(): Unit

EditorPlugin/Node: entered the (editor) tree.

EditorPlugin/Node: entered the (editor) tree.

Attributes

Inherited from:
GodotScriptClass
def _exit_tree(): Unit

EditorPlugin/Node: leaving the (editor) tree.

EditorPlugin/Node: leaving the (editor) tree.

Attributes

Inherited from:
GodotScriptClass
def _input(event: InputEvent): Unit

Called for every unhandled-or-not input event (Node._input).

Called for every unhandled-or-not input event (Node._input).

Attributes

Inherited from:
GodotScriptClass
def _parse_property(obj: GodotObject, varType: Long, name: String, hintType: Long, hintString: String, usage: Long, wide: Boolean): Boolean

EditorInspectorPlugin: inspect one property. Return true to take it over (after calling addPropertyEditor), false to let the default editor render.

EditorInspectorPlugin: inspect one property. Return true to take it over (after calling addPropertyEditor), false to let the default editor render.

Attributes

Inherited from:
GodotScriptClass
def _physics_process(delta: Double): Unit

Called every physics frame; delta is the fixed physics step.

Called every physics frame; delta is the fixed physics step.

Attributes

Inherited from:
GodotScriptClass
def _process(delta: Double): Unit

Called every rendered frame; delta is seconds since the last frame.

Called every rendered frame; delta is seconds since the last frame.

Attributes

Inherited from:
GodotScriptClass
def _ready(): Unit

Called when the node enters the scene tree and is ready.

Called when the node enters the scene tree and is ready.

Attributes

Inherited from:
GodotScriptClass
def _shortcut_input(event: InputEvent): Unit

Called for shortcut input before _unhandled_input (Node._shortcut_input).

Called for shortcut input before _unhandled_input (Node._shortcut_input).

Attributes

Inherited from:
GodotScriptClass
def _unhandled_input(event: InputEvent): Unit

Called for input not consumed by the UI (Node._unhandled_input).

Called for input not consumed by the UI (Node._unhandled_input).

Attributes

Inherited from:
GodotScriptClass
def _unhandled_key_input(event: InputEvent): Unit

Called for unhandled key input (Node._unhandled_key_input).

Called for unhandled key input (Node._unhandled_key_input).

Attributes

Inherited from:
GodotScriptClass
def _update_property(): Unit

EditorProperty: refresh the widget from the edited property's value.

EditorProperty: refresh the widget from the edited property's value.

Attributes

Inherited from:
GodotScriptClass
final def canTranslateMessages(): Boolean

Object.can_translate_messages

Object.can_translate_messages

Attributes

Inherited from:
Object
final def cancelFree(): Unit

Object.cancel_free

Object.cancel_free

Attributes

Inherited from:
Object
def cast[U <: GodotScriptClass](using meta: ClassMeta[U]): U

Cast to a (super- or sub-) class U. Returns null if the object is not actually a U. Uses object_cast_to with U's class tag — a real engine type check, not a Scala cast.

Cast to a (super- or sub-) class U. Returns null if the object is not actually a U. Uses object_cast_to with U's class tag — a real engine type check, not a Scala cast.

Attributes

Inherited from:
GodotScriptClass
def free(): Unit

Free a manually-managed object via object_destroy. No-op for reference-counted objects — use unref for those. The wrapper is dead afterwards: calling an engine method on it throws.

Free a manually-managed object via object_destroy. No-op for reference-counted objects — use unref for those. The wrapper is dead afterwards: calling an engine method on it throws.

Attributes

Inherited from:
GodotScriptClass
final def getInstanceId(): Long

Object.get_instance_id

Object.get_instance_id

Attributes

Inherited from:
Object
final def getMethodArgumentCount(method: StringName): Long

Object.get_method_argument_count

Object.get_method_argument_count

Attributes

Inherited from:
Object
final def getReferenceCount(): Long

RefCounted.get_reference_count

RefCounted.get_reference_count

Attributes

Inherited from:
RefCounted
final def getTranslationDomain(): StringName

Object.get_translation_domain

Object.get_translation_domain

Attributes

Inherited from:
Object
final def hasConnections(signal: StringName): Boolean

Object.has_connections

Object.has_connections

Attributes

Inherited from:
Object
final def hasMeta(name: StringName): Boolean

Object.has_meta

Object.has_meta

Attributes

Inherited from:
Object
final def hasMethod(method: StringName): Boolean

Object.has_method

Object.has_method

Attributes

Inherited from:
Object
final def hasSignal(signal: StringName): Boolean

Object.has_signal

Object.has_signal

Attributes

Inherited from:
Object
final def hasUserSignal(signal: StringName): Boolean

Object.has_user_signal

Object.has_user_signal

Attributes

Inherited from:
Object
final def hostObject: GodotObject

The engine-side object handle for this instance.

The engine-side object handle for this instance.

Attributes

Inherited from:
GodotScriptClass
final def initRef(): Boolean

RefCounted.init_ref

RefCounted.init_ref

Attributes

Inherited from:
RefCounted
final def instanceId: InstanceId

This object's stable Godot InstanceId (the null sentinel if unbound). Mirrors Object.get_instance_id, but typed — pass it to APIs that key off a node's identity.

This object's stable Godot InstanceId (the null sentinel if unbound). Mirrors Object.get_instance_id, but typed — pass it to APIs that key off a node's identity.

Attributes

Inherited from:
GodotScriptClass
final def isBlockingSignals(): Boolean

Object.is_blocking_signals

Object.is_blocking_signals

Attributes

Inherited from:
Object
final def isClass(`class`: String): Boolean

Object.is_class

Object.is_class

Attributes

Inherited from:
Object
final def isQueuedForDeletion(): Boolean

Object.is_queued_for_deletion

Object.is_queued_for_deletion

Attributes

Inherited from:
Object
final def isRefCounted: Boolean

True if this object is reference-counted (RefCounted subtree, e.g. a Resource) vs manually-managed (Object/Node subtree). Drives the lifetime methods below.

True if this object is reference-counted (RefCounted subtree, e.g. a Resource) vs manually-managed (Object/Node subtree). Drives the lifetime methods below.

Attributes

Inherited from:
GodotScriptClass
def keep(): this.type

Keep a reference adopted inside Gd.scoped past the end of the block: the caller now owns it and releases it with unref. Returns this.

Keep a reference adopted inside Gd.scoped past the end of the block: the caller now owns it and releases it with unref. Returns this.

Attributes

Inherited from:
GodotScriptClass
final def notification(what: Long, reversed: Boolean): Unit

Object.notification

Object.notification

Attributes

Inherited from:
Object
final def notifyPropertyListChanged(): Unit

Object.notify_property_list_changed

Object.notify_property_list_changed

Attributes

Inherited from:
Object
final def propertyCanRevert(property: StringName): Boolean

Object.property_can_revert

Object.property_can_revert

Attributes

Inherited from:
Object
def refInc(): this.type

Take one more reference on a reference-counted object, owned by this wrapper until a matching unref. No-op for manually-managed objects (nodes). Returns this. (Named refInc rather than reference to avoid clashing with the generated RefCounted.reference(): Boolean method.)

Take one more reference on a reference-counted object, owned by this wrapper until a matching unref. No-op for manually-managed objects (nodes). Returns this. (Named refInc rather than reference to avoid clashing with the generated RefCounted.reference(): Boolean method.)

Attributes

Inherited from:
GodotScriptClass
final def reference(): Boolean

RefCounted.reference

RefCounted.reference

Attributes

Inherited from:
RefCounted
final def removeMeta(name: StringName): Unit

Object.remove_meta

Object.remove_meta

Attributes

Inherited from:
Object
final def removeUserSignal(signal: StringName): Unit

Object.remove_user_signal

Object.remove_user_signal

Attributes

Inherited from:
Object
final def setBlockSignals(enable: Boolean): Unit

Object.set_block_signals

Object.set_block_signals

Attributes

Inherited from:
Object
final def setMessageTranslation(enable: Boolean): Unit

Object.set_message_translation

Object.set_message_translation

Attributes

Inherited from:
Object
final def setTranslationDomain(domain: StringName): Unit

Object.set_translation_domain

Object.set_translation_domain

Attributes

Inherited from:
Object
final def tr(message: StringName, context: StringName): String

Object.tr

Object.tr

Attributes

Inherited from:
Object
final def trN(message: StringName, plural_message: StringName, n: Long, context: StringName): String

Object.tr_n

Object.tr_n

Attributes

Inherited from:
Object
def unref(): Unit

Release one reference this wrapper owns (an engine Ref<T> return, Gd.create, or refInc), destroying the object if it was the last reference. Does nothing when the wrapper owns no reference, so a borrowed object can never be freed from under the engine.

Release one reference this wrapper owns (an engine Ref<T> return, Gd.create, or refInc), destroying the object if it was the last reference. Does nothing when the wrapper owns no reference, so a borrowed object can never be freed from under the engine.

Attributes

Inherited from:
GodotScriptClass
final def unreference(): Boolean

RefCounted.unreference

RefCounted.unreference

Attributes

Inherited from:
RefCounted
final def withHost(o: GDExtensionObjectPtr): this.type

Set the handle and return this (fluent, for wrapping fetched objects).

Set the handle and return this (fluent, for wrapping fetched objects).

Attributes

Inherited from:
GodotScriptClass
Generated with