Entity Fields

Callback to execute every frame after this entity is rendered.

Callback to execute every frame after this entity updates.

Optional data you can attach to this entity and retrieve later (for example when handling events).

Callback to execute every frame before this entity is rendered.

Callback to execute every frame before this entity updates.

If this boolean is true, events will just "go through" this entity to its children or entities behind it. This bool comes to solve conditions where you have two panels without skin that hide each other but you want users to be able to click on the bottom panel through the upper panel, provided it doesn't hit any of the first panel's children.

Default size this entity will have when no size is provided or when -1 is set for either width or height.

Basic default style that all entities share. Note: loaded from UI theme xml file.

If true, this entity and its children will be drawn in greyscale effect and will not respond to events.

Adds extra space outside the dest rect for collision detection. In other words, if extra margin is set to 10 and the user points with its mouse 5 pixels above this entity, it would still think the user points on the entity.

Optional identifier you can attach to entities so you can later search and retrieve by.

If true, users will not be able to drag this entity outside its parent boundaries.

If true, this entity and its children will not respond to events (but will be drawn normally, unlike when disabled).

Callback to execute when user clicks on this entity (eg release mouse over it).

Callback to execute every time this entity focus / unfocus.

Callback to execute when mouse button is pressed over this entity (called once when button is pressed).

Callback to execute when mouse start hovering over this entity (eg enters its region).

Callback to execute when mouse stop hovering over this entity (eg leaves its region).

Callback to execute when mouse button is released over this entity (called once when button is released).

Callback to execute when mouse wheel scrolls and this entity is the active entity.

Called when entity starts getting dragged (only if draggable).

Called when entity stop getting dragged (only if draggable).

Callback to execute when entity value changes (relevant only for entities with value).

Callback to execute every time the visibility of this entity changes (also invokes when parent becomes invisible / visible again).

If in promiscuous mode, mouse button is pressed *outside* the entity and then released on the entity, click event will be fired. If false, in order to fire click event the mouse button must be pressed AND released over this entity (but can travel outside while being held down, as long as its released inside). Note: Windows default behavior is non promiscuous mode.

Optional tooltip text to show if the user points on this entity for long enough.

A special size used value to use when you want to get the entity default size.

If true (default), will use the actual object size for collision detection. If false, will use the size property. This is useful for paragraphs, for example, where the actual width is based on text content and can vary and be totally different than the size set in the constructor.

Called every frame while the entity is being dragged.

Callback to execute every frame while mouse button is pressed over the entity.

Callback to execute every frame while mouse is hovering over the entity.