luxe API (2025.1.2)

---

luxe: system/text.modifier module

• Data
• System
• Text
• TextAlignH
• TextAlignV

---

Data

import "luxe: system/text.modifier" for Data

no docs found

• var text : String = "hello"
• var size : Num = 16
• var align : TextAlignH = TextAlignH.center
• var vertical : TextAlignV = TextAlignV.center
• var color : Color = [1, 1, 1, 1]
• var bounds : Float4 = [0, 0, 0, 0]
• var font : Asset = "luxe: font/lato"
• var material : Asset = "luxe: material/font"

---

System

import "luxe: system/text.modifier" for System

no docs found

• new(world: World)

---

System.new(world: World) returns System

no docs found

Text

import "luxe: system/text.modifier" for Text

no docs found

• create(entity: Any, material: Any, default_size: Any, default_font: Any, default_color: Any)
• destroy(entity: Any)
• set_size(entity: Any, default_size: Any)
• get_size(entity: Any)
• set_font(entity: Any, default_font: Any)
• get_font(entity: Any)
• set_style(entity: Entity, style: TextStyle)
• get_style(entity: Entity)
• set_outline(entity: Entity, radius: Num, softness: Num, color: Color, offset: Float2)
• set_shadow(entity: Entity, radius: Num, softness: Num, color: Color, offset: Float2)
• set_max_visible(entity: Entity, max_visible: Num)
• get_max_visible(entity: Entity)
• set_color(entity: Any, default_color: Any)
• get_color(entity: Any)
• set_align(entity: Any, align: Any, align_vertical: Any)
• set_align(entity: Any, align: Any)
• get_align(entity: Any)
• set_align_vertical(entity: Any, align_vertical: Any)
• get_align_vertical(entity: Any)
• set_bounds(entity: Any, x: Any, y: Any, w: Any, h: Any)
• get_bounds(entity: Any)
• set_attr(entity: Entity, start: Num, length: Num, type: TextAttrType, key: String, value: Any)
• attr_clear(entity: Any)
• commit(entity: Any)
• get_render_text(entity: Any)
• get_geometry(entity: Any)
• get_extents(entity: Any, offset: Any, count: Any)
• get_extents(entity: Any)
• contains(entity: Any, x: Any, y: Any)
• has(entity: Any)
• set_loc(entity: Entity, space: String, key: String)
• set_loc(entity: Entity, key: String)
• set_loc_with_args(entity: Entity, space: String, key: String, args: List)
• set_loc_with_args(entity: Entity, key: String, args: List)
• get_text(entity: Any)
• set_text_buffer(entity: Any, string: Any)
• set_text(entity: Any, string: Any)

---

Text.create(entity: Any, material: Any, default_size: Any, default_font: Any, default_color: Any) returns unknown

no docs found

Text.destroy(entity: Any) returns unknown

no docs found

Text.set_size(entity: Any, default_size: Any) returns unknown

no docs found

Text.get_size(entity: Any) returns unknown

no docs found

Text.set_font(entity: Any, default_font: Any) returns unknown

no docs found

Text.get_font(entity: Any) returns unknown

no docs found

Text.set_style(entity: Entity, style: TextStyle) returns None

no docs found

Text.get_style(entity: Entity) returns TextStyle

no docs found

Text.set_outline(entity: Entity, radius: Num, softness: Num, color: Color, offset: Float2) returns unknown

no docs found

Text.set_shadow(entity: Entity, radius: Num, softness: Num, color: Color, offset: Float2) returns unknown

no docs found

Text.set_max_visible(entity: Entity, max_visible: Num) returns None

no docs found

Text.get_max_visible(entity: Entity) returns Num

no docs found

Text.set_color(entity: Any, default_color: Any) returns unknown

no docs found

Text.get_color(entity: Any) returns unknown

no docs found

Text.set_align(entity: Any, align: Any, align_vertical: Any) returns unknown

no docs found

Text.set_align(entity: Any, align: Any) returns unknown

no docs found

Text.get_align(entity: Any) returns unknown

no docs found

Text.set_align_vertical(entity: Any, align_vertical: Any) returns unknown

no docs found

Text.get_align_vertical(entity: Any) returns unknown

no docs found

Text.set_bounds(entity: Any, x: Any, y: Any, w: Any, h: Any) returns unknown

no docs found

Text.get_bounds(entity: Any) returns unknown

no docs found

Text.set_attr(entity: Entity, start: Num, length: Num, type: TextAttrType, key: String, value: Any) returns None

no docs found

Text.attr_clear(entity: Any) returns unknown

no docs found

Text.commit(entity: Any) returns unknown

no docs found

Text.get_render_text(entity: Any) returns unknown

no docs found

Text.get_geometry(entity: Any) returns unknown

no docs found

Text.get_extents(entity: Any, offset: Any, count: Any) returns unknown

no docs found

Text.get_extents(entity: Any) returns unknown

no docs found

Text.contains(entity: Any, x: Any, y: Any) returns unknown

no docs found

Text.has(entity: Any) returns unknown

no docs found

Text.set_loc(entity: Entity, space: String, key: String) returns unknown

no docs found

Text.set_loc(entity: Entity, key: String) returns unknown

no docs found

Text.set_loc_with_args(entity: Entity, space: String, key: String, args: List) returns unknown

no docs found

Text.set_loc_with_args(entity: Entity, key: String, args: List) returns unknown

no docs found

Text.get_text(entity: Any) returns unknown

no docs found

Text.set_text_buffer(entity: Any, string: Any) returns unknown

no docs found

Text.set_text(entity: Any, string: Any) returns unknown

no docs found

TextAlignH

import "luxe: system/text.modifier" for TextAlignH

no docs found

• left
• center
• right

---

TextAlignH.left returns unknown

no docs found

TextAlignH.center returns unknown

no docs found

TextAlignH.right returns unknown

no docs found

TextAlignV

import "luxe: system/text.modifier" for TextAlignV

no docs found

• top
• center
• bottom

---

TextAlignV.top returns unknown

no docs found

TextAlignV.center returns unknown

no docs found

TextAlignV.bottom returns unknown

no docs found