tk2dUIHoverItem Class Reference

On HoverOver and HoverOut will switch states. Hover needs to be enabled to work (Hover actived(tk2dUIManager.areHoverEventsTracked), using a mouse and mult-touch is disabled (tk2dUIManager.useMultiTouch) More...

Inherits tk2dUIBaseItemControl.

List of all members.

Public Member Functions
void	SetState ()
	Manually updates state based on IsOver.
Static Public Member Functions
static void	ChangeGameObjectActiveState (GameObject go, bool isActive)
	Used for SetActive so easily works between Unity 3.x and Unity 4.x.
static void	ChangeGameObjectActiveStateWithNullCheck (GameObject go, bool isActive)
	Changes active state, but first checks to make sure it isn't null.
Public Attributes
GameObject	outStateGO
	This GameObject will be set to active if hover is not over. Deactivated if hover is over.
GameObject	overStateGO
	This GameObject will be set to active if hover is over. Deactivated if hover is out.
tk2dUIItem	uiItem
	Button(uiItem) for this control.
Properties
bool	IsOver [get, set]
	Is mouse currently over.
Events
System.Action< tk2dUIHoverItem >	OnToggleHover
	Event on hover status change.

---

Detailed Description

On HoverOver and HoverOut will switch states. Hover needs to be enabled to work (Hover actived(tk2dUIManager.areHoverEventsTracked), using a mouse and mult-touch is disabled (tk2dUIManager.useMultiTouch)

---

Member Function Documentation

static void tk2dUIBaseItemControl.ChangeGameObjectActiveState	(	GameObject	go,
		bool	isActive
	)		[static, inherited]

Used for SetActive so easily works between Unity 3.x and Unity 4.x.

static void tk2dUIBaseItemControl.ChangeGameObjectActiveStateWithNullCheck	(	GameObject	go,
		bool	isActive
	)		[static, inherited]

Changes active state, but first checks to make sure it isn't null.

void tk2dUIHoverItem.SetState

(

)

Manually updates state based on IsOver.

---

Member Data Documentation

GameObject tk2dUIHoverItem.outStateGO

This GameObject will be set to active if hover is not over. Deactivated if hover is over.

GameObject tk2dUIHoverItem.overStateGO

This GameObject will be set to active if hover is over. Deactivated if hover is out.

tk2dUIItem tk2dUIBaseItemControl.uiItem [inherited]

Button(uiItem) for this control.

---

Property Documentation

bool tk2dUIHoverItem.IsOver [get, set]

Is mouse currently over.

---

Event Documentation

System.Action<tk2dUIHoverItem> tk2dUIHoverItem.OnToggleHover

Event on hover status change.