Lua-Docs/textfield.lua at master · PlatformRacing3/Lua-Docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
--- Text field related variables and functions.
...

--- The x position, in pixels, of the text field when it is the child of a sprite. By default 0.
x = 0

--- The y position, in pixels, of the text field when it is the child of a sprite. By default 0.
y = 0

--- The horizontal scale of the text field when it is the child of a sprite. By default 1.
scaleX = 1.0

--- The vertical scale of the text field when it is the child of a sprite. By default 1.
scaleY = 1.0

--- The vertical scale of the text field when it is the child of a sprite. By default 1.
scaleY = 1.0

--- The rotation of the text field, in degrees, when it is the child of a sprite. By default 0.
rotation = 0

--- The alpha of the text field, represented by a number in the range of 0 - 1. An alpha of 0 means the text field is completely transparent; 1 means fully visible. By default 1.
alpha = 1

--- A number value that is multiplied with the red color channel when drawn. By default 1.
redMultiplier = 1

--- A number value that is multiplied with the green color channel when drawn. By default 1.
greenMultiplier = 1

--- A number value that is multiplied with the blue color channel when drawn. By default 1.
blueMultiplier = 1

--- Sets red, green, and blue multipliers based on a hexadecimal RGB value (e.g. 0xFF0000). Write-only.
colorMultiplier = 0xFFFFFF

--- A number value from -255 to 255 that is added to the alpha channel after it is multiplied by alpha. By default 0.
alphaOffset = 0

--- A number value from -255 to 255 that is added to the alpha channel after it is multiplied by redMultiplier. By default 0.
redOffset = 0

--- A number value from -255 to 255 that is added to the alpha channel after it is multiplied by greenMultiplier. By default 0.
greenOffset = 0

--- A number value from -255 to 255 that is added to the alpha channel after it is multiplied by blueMultiplier. By default 0.
blueOffset = 0

--- The blend mode of the text field. Use BlendMode enum values. By default BlendMode.NORMAL.
--- @see utils.BlendMode
blendMode = "normal"

--- Whether or not the text field was destroyed. Calling `destroy` sets this to true. Read-only.
destroyed = false

--- The text within the text field.
text = ""

--- Text field width in pixels. Setting this disables auto sizing if word wrap is also disabled.
width = 0

--- Text field height in pixels. Setting this disables auto sizing.
height = 0

--- Size of the text.
size = 14

--- RGB color of the text.
color = 0xFFFFFF

--- Text alignment mode. Use @{utils.TextFormatAlign|TextFormatAlign} enum values. By default `TextFormatAlign.LEFT`.
--- @see utils.TextFormatAlign
align = "left"

--- Whether the text automatically wraps around or not.
wordWrap = true

--- Whether the text is underlined or not. By default false.
underline = false

--- Text auto-sizing mode. Use @{utils.TextFieldAutoSize|TextFieldAutoSize} enum values. By default `TextFieldAutoSize.NONE`.
--- @see utils.TextFieldAutoSize
autoSize = "none"

--- Destroys the text field.
function destroy()
end

--- Returns the bounds of the text field as a [Rectangle](https://airsdk.dev/reference/actionscript/3.0/flash/geom/Rectangle.html), relative to itself.
--- @treturn Rectangle The bounds of the text field
function getBounds()
end

--- Returns the bounds of the text field as a [Rectangle](https://airsdk.dev/reference/actionscript/3.0/flash/geom/Rectangle.html), relative to itself, excluding any strokes on shapes.
--- @treturn Rectangle The bounds of the text field
function getRect()
end