Frame Object

Frame

Properties

Name	Category	Type	Description	ReadOnly
PERCENT X	POSITION	float	X Position as a percent.
PERCENT Y	POSITION	float	Y Position as a percent.
OFFSET X	POSITION	float	X offset in pixels.
OFFSET Y	POSITION	float	Y offset in pixels
WIDTH	SIZE	float	Width in actual pixels.
HEIGHT	SIZE	float	Height in actual pixels.
SCALE WIDTH	SIZE	float	Width in actual pixels.
SCALE HEIGHT	SIZE	float	Height in actual pixels.
TOOL TIP	ADVANCED	string	The tool tip of this window.
TOOL TIP VISUAL	ADVANCED	string	The visual tooltip file.
TOOL TIP INHERITED	ADVANCED	bool	Does the tooltip inherit from parent?
CLIPPED	ADVANCED	bool	If true it's clipped by the parent.
MOUSE PASS THROUGH	ADVANCED	bool	If false the mouse will give the object events.
LIST INDEX	ADVANCED	int	Used for sorting items in lists and reflow windows
ALWAYS ON TOP	ADVANCED	bool	If true the widget will always be on top.
ALPHA	ADVANCED	float	The alpha of the window.
PUSH BACK	ADVANCED	bool	If true when the widget loads it gets pushed back.
ADD PROPS	ADVANCED	string	Additional properties. PropName=Value
SORT OFFSET	ADVANCED	int	Offset to the window's sort order
VISIBLE	VISIBILITY AND ENABLED	bool	Is it visible.
ENABLED	VISIBILITY AND ENABLED	bool	Is it enabled.
VERTICLE	FRAME ALIGNMENT	string	Vertical alignment of the frame.
HORIZONTAL	FRAME ALIGNMENT	string	Horizontal alignment of frame.
WIDGET NAME	DATA	string	The name used in code for ref.
STRING DATA	DATA	string	Data used by code.
INTEGER DATA	DATA	int	Integer Data used by code.
RENDER WINDOW	ADVANCED	bool	If true render window will try to sort itself with other render windows. Usually you only have a single render window per menu.
TEMPLATE	TEMPLATE	string	The template to use.
HOVER	TEMPLATE	string	The template to use for the mouse over.
RESIZE TO FIT	CHILDREN PROPERTIES	bool	Will resize the window to fit the children.
CLICK	SOUNDS	string	Click sound
MARGIN OFFSET X	CHILDREN PROPERTIES	float	when sizing to fit children, the frame will offset by this value on the X
MARGIN OFFSET Y	CHILDREN PROPERTIES	float	when sizing to fit children, the frame will offset by this value on the Y
MIN PERCENT WIDTH	MIN AND MAX SIZE	float	Min percent width.
MIN PERCENT HEIGHT	MIN AND MAX SIZE	float	Min percent height.
MIN PIXEL WIDTH	MIN AND MAX SIZE	float	Min pixel width.
MIN PIXEL HEIGHT	MIN AND MAX SIZE	float	Min pixel height.
MAX PERCENT WIDTH	MIN AND MAX SIZE	float	Max percent width.
MAX PERCENT HEIGHT	MIN AND MAX SIZE	float	Max percent height.
MAX PIXEL WIDTH	MIN AND MAX SIZE	float	Max pixel width.
MAX PIXEL HEIGHT	MIN AND MAX SIZE	float	Max pixel height.

Input Events

Show

Hide

Toggle Visibility

Disable

Enable

Click

Output Events

On Visible

On Invisible

Mouse Entered

Mouse Leave

Clicked

Double Clicked

MButton Up

MButton Down

Right MButton Up

Right MButton Down

Middle MButton Up

Middle MButton Down