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.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
ClosebuttonName | The name of the button such as Jump. |
bool True when an axis has been pressed and not released.
Returns true while the virtual button identified by buttonName
is held down.
Note: This API is part of the legacy Input
class, and not recommended for new projects. The documentation is provided here to support legacy projects that use the old Input Manager and Input class. For new projects you should use the newer and Input System Package. (read more).
Think auto fire - this will return true as long as the button is held down.
Use this only when implementing events that trigger an action, eg, shooting a weapon.
The buttonName
argument will normally be one of the names in InputManager such as Jump or
Fire1. GetButton will return to false
when it is released.
Note: Use GetAxis for input that controls continuous movement.
// Instantiates a projectile every 0.5 seconds, // if the Fire1 button (default is Ctrl) is pressed.
using UnityEngine; using System.Collections;
public class ExampleClass : MonoBehaviour { public GameObject projectile; public float fireDelta = 0.5F;
private float nextFire = 0.5F; private GameObject newProjectile; private float myTime = 0.0F;
void Update() { myTime = myTime + Time.deltaTime;
if (Input.GetButton("Fire1") && myTime > nextFire) { nextFire = myTime + fireDelta; newProjectile = Instantiate(projectile, transform.position, transform.rotation) as GameObject;
// create code here that animates the newProjectile
nextFire = nextFire - myTime; myTime = 0.0F; } } }
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.