Toggle Button Object

Toggle Button

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.
DISABLED	TOGGLE IMAGES	string	If disabled image.
NORMAL	TOGGLE IMAGES	string	The normal image.
TOGGLED	TOGGLE IMAGES	string	The toggled image.
HOVER	TOGGLE IMAGES	string	The mouse over image.
HOVER TOGGLED	TOGGLE IMAGES	string	The mouse over image when toggled.
IS TOGGLED	TOGGLE PROPERTIES	bool	Is it toggled.
RADIAL BUTTON	RADIAL TOGGLE PROPERTIES	bool	If it's a radial button it'll toggle other radial buttons that share the same parent frame.
ALLOW UNTOGGLE	RADIAL TOGGLE PROPERTIES	bool	If it's a radial button it allows it untoggle states.
UNTOGGLE ON START	RADIAL TOGGLE PROPERTIES	bool	If true all the toggle buttons start off.
DISABLED FRAME	FRAMES	string	The frame to use.
NORMAL FRAME	FRAMES	string	The frame to use for the mouse over.
TOGGLED FRAME	FRAMES	string	The frame to use for the mouse over.
HOVER FRAME	FRAMES	string	The frame to use for the mouse over.
HOVER TOGGLED FRAME	FRAMES	string	The mouse over frame when toggled.
CLICK	SOUNDS	string	Click sound
BROADCAST ON INPUT	TOGGLE PROPERTIES	bool	If true it'll only broadcast when broadcast is called via editor logic.
SETTING	TOGGLE PROPERTIES	string	settings property to bind to this toggle
APPLY ON TOGGLE	TOGGLE PROPERTIES	bool	if true, the settings bind will apply when the control is toggled (otherwise you have to apply it through logic)

Input Events

Show

Hide

Toggle Visibility

Disable

Enable

Toggle

Toggle off

Toggle on

Toggled or Not

Apply Settings Bind

Sync Settings Bind

Broadcast

Output Events

On Visible

On Invisible

Mouse Entered

Mouse Leave

Toggled

Toggled off

Toggled on

Toggled on then off

Mouse Entered

Mouse Leave

MButton Up

Right MButton Up

Right MButton Down

Middle MButton Up

Middle MButton Down