PixelCrushers.UIButtonKeyTrigger Class Reference

This script adds a key or button trigger to a Unity UI Selectable. More...

Inheritance diagram for PixelCrushers.UIButtonKeyTrigger:

Collaboration diagram for PixelCrushers.UIButtonKeyTrigger:

Public Attributes
KeyCode	key = KeyCode.None
string	buttonName = string.Empty
bool	anyKeyOrButton = false
bool	skipIfBeingClickedBySubmit = true
bool	simulateButtonClick = true
float	simulateButtonDownDuration = 0.1f

Static Public Attributes
static bool	monitorInput = true
	Set false to prevent all UIButtonKeyTrigger components from listening for input.

Protected Member Functions
virtual void	Awake ()
virtual void	OnEnable ()
virtual void	OnDisable ()
void	Update ()
virtual bool	IsBeingClickedBySubmit ()
virtual void	Click ()
IEnumerator	SimulateButtonClick ()

Properties
UnityEngine.UI.Selectable	selectable [get, set]
UnityEngine.EventSystems.EventSystem	eventSystem [get, set]
Properties inherited from PixelCrushers.IEventSystemUser

Detailed Description

This script adds a key or button trigger to a Unity UI Selectable.

Member Function Documentation

Awake()

virtual void PixelCrushers.UIButtonKeyTrigger.Awake ( )

inlineprotectedvirtual

Click()

virtual void PixelCrushers.UIButtonKeyTrigger.Click ( )

inlineprotectedvirtual

IsBeingClickedBySubmit()

virtual bool PixelCrushers.UIButtonKeyTrigger.IsBeingClickedBySubmit ( )

inlineprotectedvirtual

OnDisable()

virtual void PixelCrushers.UIButtonKeyTrigger.OnDisable ( )

inlineprotectedvirtual

OnEnable()

virtual void PixelCrushers.UIButtonKeyTrigger.OnEnable ( )

inlineprotectedvirtual

SimulateButtonClick()

IEnumerator PixelCrushers.UIButtonKeyTrigger.SimulateButtonClick ( )

inlineprotected

Update()

void PixelCrushers.UIButtonKeyTrigger.Update ( )

inlineprotected

Member Data Documentation

anyKeyOrButton

bool PixelCrushers.UIButtonKeyTrigger.anyKeyOrButton = false

buttonName

string PixelCrushers.UIButtonKeyTrigger.buttonName = string.Empty

key

KeyCode PixelCrushers.UIButtonKeyTrigger.key = KeyCode.None

monitorInput

bool PixelCrushers.UIButtonKeyTrigger.monitorInput = true

static

Set false to prevent all UIButtonKeyTrigger components from listening for input.

simulateButtonClick

bool PixelCrushers.UIButtonKeyTrigger.simulateButtonClick = true

simulateButtonDownDuration

float PixelCrushers.UIButtonKeyTrigger.simulateButtonDownDuration = 0.1f

skipIfBeingClickedBySubmit

bool PixelCrushers.UIButtonKeyTrigger.skipIfBeingClickedBySubmit = true

Property Documentation

eventSystem

UnityEngine.EventSystems.EventSystem PixelCrushers.UIButtonKeyTrigger.eventSystem

getset

Implements PixelCrushers.IEventSystemUser.

selectable

UnityEngine.UI.Selectable PixelCrushers.UIButtonKeyTrigger.selectable

getsetprotected

---

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

• C:/Dev/Dialogue System/Dev/Release2/Assets/Plugins/Pixel Crushers/Common/Scripts/UI/UIButtonKeyTrigger.cs