Falco Engine 3.9.0.1 (beta)
FalcoEngine.TextInput Class Reference
Inheritance diagram for FalcoEngine.TextInput:
FalcoEngine.UIElement FalcoEngine.Component

Public Types

enum  TextHorizontalAlignment { Left , Center , Right }
 TextHorizontalAlignment enum More...
 
enum  TextVerticalAlignment { Top , Middle , Bottom }
 TextVerticalAlignment enum More...
 
- Public Types inherited from FalcoEngine.UIElement
enum  CanvasHorizontalAlignment { Left , Center , Right }
 CanvasHorizontalAlignment enum More...
 
enum  CanvasVerticalAlignment { Top , Middle , Bottom }
 CanvasVerticalAlignment enum More...
 

Properties

Texture normalStateTexture [getset]
 Returns the texture in the normal state More...
 
Texture hoverStateTexture [getset]
 Returns the texture in the hover state (when the mouse cursor is above this text input) More...
 
Texture activeStateTexture [getset]
 Returns the texture in the active state (when the mouse is clicked and held down on this text input) More...
 
Texture disabledStateTexture [getset]
 Returns the texture in the disabled state More...
 
Color hoverStateColor [getset]
 Returns the color in the hover state (when the mouse cursor is above this text input) More...
 
Color activeStateColor [getset]
 Returns the color in the active state (when the mouse is clicked and held down on this text input) More...
 
Color disabledStateColor [getset]
 Returns the color in the disabled state More...
 
bool interactable [getset]
 Gets or sets the text input interactability (i.e. disable or enable this text input or get its state) More...
 
string text [getset]
 Get or set the text More...
 
Font font [getset]
 Get or set the font More...
 
float fontSize [getset]
 Get or set the font size More...
 
TextHorizontalAlignment textHorizontalAlignment [getset]
 Get or set text horizontal alignment More...
 
TextVerticalAlignment textVerticalAlignment [getset]
 Get or set text vertical alignment More...
 
- Properties inherited from FalcoEngine.UIElement
CanvasHorizontalAlignment horizontalAlignment [getset]
 Get or set horizontal alignment of this element More...
 
CanvasVerticalAlignment verticalAlignment [getset]
 Get or set vertical alignment of this element More...
 
Color color [getset]
 Get or set the main color of this element More...
 
Vector2 anchor [getset]
 Get or set the anchor of this element (pivot point) More...
 
Vector2 size [getset]
 Get or set the size of this element (width and height) More...
 
bool hovered [get]
 Returns if this element is hovered by mouse cursor More...
 
Canvas canvas [get]
 Returns a canvas of this element More...
 
Vector3 position [getset]
 
Rect rect [get]
 
object userData [getset]
 Get or set the user data More...
 
- Properties inherited from FalcoEngine.Component
bool enabled [getset]
 Enable or disable this component More...
 
GameObject gameObject [get]
 Get game object at which this component is attached More...
 
bool isUiComponent [get]
 Returns if this component is derived from UIElement (or this is a canvas) or not More...
 

Additional Inherited Members

- Public Member Functions inherited from FalcoEngine.UIElement
delegate void MouseButtonEvent (UIElement sender, int button, Vector2 cursorPosition)
 
delegate void MouseMoveEvent (UIElement sender, Vector2 cursorPosition)
 
- Protected Member Functions inherited from FalcoEngine.Component
 Component ()
 
- Events inherited from FalcoEngine.UIElement
MouseButtonEvent onMouseDown
 
MouseButtonEvent onMouseUp
 
MouseMoveEvent onMouseMove
 
MouseMoveEvent onMouseEnter
 
MouseMoveEvent onMouseExit
 

Detailed Description

Definition at line 7 of file TextInput.cs.

Member Enumeration Documentation

◆ TextHorizontalAlignment

TextHorizontalAlignment enum

Enumerator
Left 
Center 
Right 

Definition at line 90 of file TextInput.cs.

◆ TextVerticalAlignment

TextVerticalAlignment enum

Enumerator
Top 
Middle 
Bottom 

Definition at line 95 of file TextInput.cs.

Property Documentation

◆ activeStateColor

Color FalcoEngine.TextInput.activeStateColor
getset

Returns the color in the active state (when the mouse is clicked and held down on this text input)

Definition at line 53 of file TextInput.cs.

◆ activeStateTexture

Texture FalcoEngine.TextInput.activeStateTexture
getset

Returns the texture in the active state (when the mouse is clicked and held down on this text input)

Definition at line 27 of file TextInput.cs.

◆ disabledStateColor

Color FalcoEngine.TextInput.disabledStateColor
getset

Returns the color in the disabled state

Definition at line 69 of file TextInput.cs.

◆ disabledStateTexture

Texture FalcoEngine.TextInput.disabledStateTexture
getset

Returns the texture in the disabled state

Definition at line 32 of file TextInput.cs.

◆ font

Font FalcoEngine.TextInput.font
getset

Get or set the font

Definition at line 105 of file TextInput.cs.

◆ fontSize

float FalcoEngine.TextInput.fontSize
getset

Get or set the font size

Definition at line 110 of file TextInput.cs.

◆ hoverStateColor

Color FalcoEngine.TextInput.hoverStateColor
getset

Returns the color in the hover state (when the mouse cursor is above this text input)

Definition at line 37 of file TextInput.cs.

◆ hoverStateTexture

Texture FalcoEngine.TextInput.hoverStateTexture
getset

Returns the texture in the hover state (when the mouse cursor is above this text input)

Definition at line 22 of file TextInput.cs.

◆ interactable

bool FalcoEngine.TextInput.interactable
getset

Gets or sets the text input interactability (i.e. disable or enable this text input or get its state)

Definition at line 85 of file TextInput.cs.

◆ normalStateTexture

Texture FalcoEngine.TextInput.normalStateTexture
getset

Returns the texture in the normal state

Definition at line 17 of file TextInput.cs.

◆ text

string FalcoEngine.TextInput.text
getset

Get or set the text

Definition at line 100 of file TextInput.cs.

◆ textHorizontalAlignment

TextHorizontalAlignment FalcoEngine.TextInput.textHorizontalAlignment
getset

Get or set text horizontal alignment

Definition at line 115 of file TextInput.cs.

◆ textVerticalAlignment

TextVerticalAlignment FalcoEngine.TextInput.textVerticalAlignment
getset

Get or set text vertical alignment

Definition at line 130 of file TextInput.cs.


The documentation for this class was generated from the following file: