FalcoEngine.Button Class Reference

Inheritance diagram for FalcoEngine.Button:

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 button) More...
Texture	activeStateTexture [getset]
	Returns the texture in the active state (when the mouse is clicked and held down on this button) More...
Texture	disabledStateTexture [getset]
	Returns the texture in the disabled state More...
Color	hoverStateColor [getset]
	Returns the button color in the hover state (when the mouse cursor is above this button) More...
Color	activeStateColor [getset]
	Returns the button color in the active state (when the mouse is clicked and held down on this button) More...
Color	disabledStateColor [getset]
	Returns the button color in the disabled state More...
bool	interactable [getset]
	Gets or sets the button interactability (i.e. disable or enable this button or get its state) 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 Types inherited from FalcoEngine.UIElement
enum	CanvasHorizontalAlignment { Left , Center , Right }
	CanvasHorizontalAlignment enum More...
enum	CanvasVerticalAlignment { Top , Middle , Bottom }
	CanvasVerticalAlignment enum More...
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 Button.cs.

Property Documentation

activeStateColor

Color FalcoEngine.Button.activeStateColor

getset

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

Definition at line 53 of file Button.cs.

activeStateTexture

Texture FalcoEngine.Button.activeStateTexture

getset

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

Definition at line 27 of file Button.cs.

disabledStateColor

Color FalcoEngine.Button.disabledStateColor

getset

Returns the button color in the disabled state

Definition at line 69 of file Button.cs.

disabledStateTexture

Texture FalcoEngine.Button.disabledStateTexture

getset

Returns the texture in the disabled state

Definition at line 32 of file Button.cs.

hoverStateColor

Color FalcoEngine.Button.hoverStateColor

getset

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

Definition at line 37 of file Button.cs.

hoverStateTexture

Texture FalcoEngine.Button.hoverStateTexture

getset

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

Definition at line 22 of file Button.cs.

interactable

bool FalcoEngine.Button.interactable

getset

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

Definition at line 85 of file Button.cs.

normalStateTexture

Texture FalcoEngine.Button.normalStateTexture

getset

Returns the texture in the normal state

Definition at line 17 of file Button.cs.

---

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

• API/Components/UI/Button.cs