Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.


Suggest a change


Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.


Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.



Switch to Manual
protected static function StateForMouseButton(buttonId: int): FramePressState;
protected static FramePressState StateForMouseButton(int buttonId);
protected static def StateForMouseButton(buttonId as int) as FramePressState


buttonId Mouse Button id.


Given a mouse button return the current state for the frame.