godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Sync classref with changes from godotengine/godot#24640

Browse Source
This commit is contained in:
Rémi Verschelde
2019-01-07 10:14:08 +01:00
parent 4f5d503b25
commit f70354d01c
521 changed files with 27321 additions and 22169 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
classes/class_arvrcontroller.rst
View File

@@ -19,39 +19,39 @@ A spatial node representing a spatially tracked controller.
Properties
----------
+---------------------------+----------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`controller_id<class_ARVRController_controller_id>` |
+---------------------------+----------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`rumble<class_ARVRController_rumble>` |
+---------------------------+----------------------------------------------------------+
+---------------------------+-------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`controller_id<class_ARVRController_property_controller_id>` |
+---------------------------+-------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`rumble<class_ARVRController_property_rumble>` |
+---------------------------+-------------------------------------------------------------------+
Methods
-------
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_controller_name<class_ARVRController_get_controller_name>` **(** **)** const |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`TrackerHand<enum_ARVRPositionalTracker_TrackerHand>` | :ref:`get_hand<class_ARVRController_get_hand>` **(** **)** const |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_is_active<class_ARVRController_get_is_active>` **(** **)** const |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_joystick_axis<class_ARVRController_get_joystick_axis>` **(** :ref:`int<class_int>` axis **)** const |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_joystick_id<class_ARVRController_get_joystick_id>` **(** **)** const |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`is_button_pressed<class_ARVRController_is_button_pressed>` **(** :ref:`int<class_int>` button **)** const |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_controller_name<class_ARVRController_method_get_controller_name>` **(** **)** const |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`TrackerHand<enum_ARVRPositionalTracker_TrackerHand>` | :ref:`get_hand<class_ARVRController_method_get_hand>` **(** **)** const |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_is_active<class_ARVRController_method_get_is_active>` **(** **)** const |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_joystick_axis<class_ARVRController_method_get_joystick_axis>` **(** :ref:`int<class_int>` axis **)** const |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_joystick_id<class_ARVRController_method_get_joystick_id>` **(** **)** const |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`is_button_pressed<class_ARVRController_method_is_button_pressed>` **(** :ref:`int<class_int>` button **)** const |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
Signals
-------
.. _class_ARVRController_button_pressed:
.. _class_ARVRController_signal_button_pressed:
- **button_pressed** **(** :ref:`int<class_int>` button **)**
Emitted when a button on this controller is pressed.
.. _class_ARVRController_button_release:
.. _class_ARVRController_signal_button_release:
- **button_release** **(** :ref:`int<class_int>` button **)**
@@ -69,7 +69,7 @@ The position of the controller node is automatically updated by the ARVR Server.
Property Descriptions
---------------------
.. _class_ARVRController_controller_id:
.. _class_ARVRController_property_controller_id:
- :ref:`int<class_int>` **controller_id**
@@ -87,7 +87,7 @@ For any other controller that the :ref:`ARVRServer<class_ARVRServer>` detects we
When a controller is turned off, its slot is freed. This ensures controllers will keep the same id even when controllers with lower ids are turned off.
.. _class_ARVRController_rumble:
.. _class_ARVRController_property_rumble:
- :ref:`float<class_float>` **rumble**
@@ -97,42 +97,42 @@ When a controller is turned off, its slot is freed. This ensures controllers wil
| *Getter* | get_rumble() |
+----------+-------------------+
The degree to which the tracker rumbles. Ranges from ``0.0`` to ``1.0`` with precision ``.01``. If changed, updates :ref:`ARVRPositionalTracker.rumble<class_ARVRPositionalTracker_rumble>` accordingly.
The degree to which the tracker rumbles. Ranges from ``0.0`` to ``1.0`` with precision ``.01``. If changed, updates :ref:`ARVRPositionalTracker.rumble<class_ARVRPositionalTracker_property_rumble>` accordingly.
Method Descriptions
-------------------
.. _class_ARVRController_get_controller_name:
.. _class_ARVRController_method_get_controller_name:
- :ref:`String<class_String>` **get_controller_name** **(** **)** const
If active, returns the name of the associated controller if provided by the AR/VR SDK used.
.. _class_ARVRController_get_hand:
.. _class_ARVRController_method_get_hand:
- :ref:`TrackerHand<enum_ARVRPositionalTracker_TrackerHand>` **get_hand** **(** **)** const
Returns the hand holding this controller, if known. See TRACKER\_\* constants in :ref:`ARVRPositionalTracker<class_ARVRPositionalTracker>`.
.. _class_ARVRController_get_is_active:
.. _class_ARVRController_method_get_is_active:
- :ref:`bool<class_bool>` **get_is_active** **(** **)** const
Returns ``true`` if the bound controller is active. ARVR systems attempt to track active controllers.
.. _class_ARVRController_get_joystick_axis:
.. _class_ARVRController_method_get_joystick_axis:
- :ref:`float<class_float>` **get_joystick_axis** **(** :ref:`int<class_int>` axis **)** const
Returns the value of the given axis for things like triggers, touchpads, etc. that are embedded into the controller.
.. _class_ARVRController_get_joystick_id:
.. _class_ARVRController_method_get_joystick_id:
- :ref:`int<class_int>` **get_joystick_id** **(** **)** const
Returns the ID of the joystick object bound to this. Every controller tracked by the ARVR Server that has buttons and axis will also be registered as a joystick within Godot. This means that all the normal joystick tracking and input mapping will work for buttons and axis found on the AR/VR controllers. This ID is purely offered as information so you can link up the controller with its joystick entry.
.. _class_ARVRController_is_button_pressed:
.. _class_ARVRController_method_is_button_pressed:
- :ref:`int<class_int>` **is_button_pressed** **(** :ref:`int<class_int>` button **)** const