{"_id":"594949e92be16d0026ec0560","category":{"_id":"594949e62be16d0026ec04d2","version":"594949e52be16d0026ec04cd","project":"571fa55ca0acd42000af9545","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-01-01T16:41:26.797Z","from_sync":false,"order":4,"slug":"locomotion","title":"Locomotion"},"project":"571fa55ca0acd42000af9545","user":"571fa519db52d01700f5cf3d","parentDoc":null,"version":{"_id":"594949e52be16d0026ec04cd","project":"571fa55ca0acd42000af9545","__v":2,"createdAt":"2017-06-20T16:14:29.816Z","releaseDate":"2017-06-20T16:14:29.816Z","categories":["594949e62be16d0026ec04ce","594949e62be16d0026ec04cf","594949e62be16d0026ec04d0","594949e62be16d0026ec04d1","594949e62be16d0026ec04d2","594949e62be16d0026ec04d3","594949e62be16d0026ec04d4","594949e62be16d0026ec04d5","594949e62be16d0026ec04d6","594949e62be16d0026ec04d7","594949e62be16d0026ec04d8","594949e62be16d0026ec04d9","594949e62be16d0026ec04da","594949e62be16d0026ec04db","594949e62be16d0026ec04dc","594949e62be16d0026ec04dd","594949e62be16d0026ec04de","594949e62be16d0026ec04df","594949e62be16d0026ec04e0","594949e62be16d0026ec04e1","59497219f4a8980024dd0631"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Kunekune","version_clean":"3.2.0","version":"3.2.0"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-02-25T10:14:47.094Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":8,"body":"> extends [VRTK_ObjectControl](doc:vrtk_objectcontrol)\n\n## Overview\n\nThe ability to control an object with a button press on a given button to control a specified direction.\n\nThe Button Control script forms the stub to allow for pre-defined actions to execute when a button press affects a direction axis.\n\nThis is enabled by the Button Control script emitting an event each time the pseudo X axis and pseudo Y Axis are changed by a button press and the corresponding Object Control Action registers with the appropriate axis event. This means that multiple Object Control Actions can be triggered per axis change.\n\nThis script is placed on the Script Alias of the Controller that is required to be affected by button presses.\n\nIf the controlled object is the play area and `VRTK_BodyPhysics` is also available, then additional logic is processed when the user is falling such as preventing the button control from affecting a falling user.\n\n## Inspector Parameters\n\n * **Forward Button:** The button to set the y axis to +1.\n * **Backward Button:** The button to set the y axis to -1.\n * **Left Button:** The button to set the x axis to -1.\n * **Right Button:** The button to set the x axis to +1.","excerpt":"","slug":"vrtk_buttoncontrol","type":"basic","title":"VRTK_ButtonControl"}

VRTK_ButtonControl


> extends [VRTK_ObjectControl](doc:vrtk_objectcontrol) ## Overview The ability to control an object with a button press on a given button to control a specified direction. The Button Control script forms the stub to allow for pre-defined actions to execute when a button press affects a direction axis. This is enabled by the Button Control script emitting an event each time the pseudo X axis and pseudo Y Axis are changed by a button press and the corresponding Object Control Action registers with the appropriate axis event. This means that multiple Object Control Actions can be triggered per axis change. This script is placed on the Script Alias of the Controller that is required to be affected by button presses. If the controlled object is the play area and `VRTK_BodyPhysics` is also available, then additional logic is processed when the user is falling such as preventing the button control from affecting a falling user. ## Inspector Parameters * **Forward Button:** The button to set the y axis to +1. * **Backward Button:** The button to set the y axis to -1. * **Left Button:** The button to set the x axis to -1. * **Right Button:** The button to set the x axis to +1.