[DOCS] ARVR, AStar, AtlasTexture, Basis

This commit is contained in:
Will Nations 2017-12-07 00:16:27 -06:00
parent b38378dd6c
commit 5b820bc247
5 changed files with 28 additions and 21 deletions

View File

@ -31,7 +31,7 @@
<return type="bool"> <return type="bool">
</return> </return>
<description> <description>
Returns true if the controller bound to this node is currently active and being tracked. Returns [code]true[/code] if the bound controller is active. ARVR systems attempt to track active controllers.
</description> </description>
</method> </method>
<method name="get_joystick_axis" qualifiers="const"> <method name="get_joystick_axis" qualifiers="const">
@ -56,7 +56,7 @@
<argument index="0" name="button" type="int"> <argument index="0" name="button" type="int">
</argument> </argument>
<description> <description>
Is the given button currently pressed? Returns [code]true[/code] if the button at index [code]button[/code] is pressed.
</description> </description>
</method> </method>
</methods> </methods>
@ -65,6 +65,7 @@
The controller's id. The first controller that the [ARVRServer] detects will have id 1, the second id 2, the third id 3, etc. When a controller is turned off, it's slot is freed. This ensures controllers will keep the same id even when controllers with lower ids are turned off. The controller's id. The first controller that the [ARVRServer] detects will have id 1, the second id 2, the third id 3, etc. When a controller is turned off, it's slot is freed. This ensures controllers will keep the same id even when controllers with lower ids are turned off.
</member> </member>
<member name="rumble" type="float" setter="set_rumble" getter="get_rumble"> <member name="rumble" type="float" setter="set_rumble" getter="get_rumble">
The degree to which the tracker rumbles. Ranges from [code]0.0[/code] to [code]1.0[/code] with precision [code].01[/code]. If changed, updates [member ARVRPositionalTracker.rumble] accordingly.
</member> </member>
</members> </members>
<signals> <signals>
@ -72,14 +73,14 @@
<argument index="0" name="button" type="int"> <argument index="0" name="button" type="int">
</argument> </argument>
<description> <description>
When a button on this controller is pressed, this signal is given. Emitted when a button on this controller is pressed.
</description> </description>
</signal> </signal>
<signal name="button_release"> <signal name="button_release">
<argument index="0" name="button" type="int"> <argument index="0" name="button" type="int">
</argument> </argument>
<description> <description>
When a button on this controller is released, this signal is given. Emitted when a button on this controller is released.
</description> </description>
</signal> </signal>
</signals> </signals>

View File

@ -31,35 +31,35 @@
<return type="String"> <return type="String">
</return> </return>
<description> <description>
If available this returns the name of the controller or anchor point. Returns the controller or anchor point's name if available.
</description> </description>
</method> </method>
<method name="get_orientation" qualifiers="const"> <method name="get_orientation" qualifiers="const">
<return type="Basis"> <return type="Basis">
</return> </return>
<description> <description>
Returns the orientation matrix of the controller. Returns the controller's orientation matrix.
</description> </description>
</method> </method>
<method name="get_position" qualifiers="const"> <method name="get_position" qualifiers="const">
<return type="Vector3"> <return type="Vector3">
</return> </return>
<description> <description>
Returns the position of the controller adjusted by world scale. Returns the world-space controller position.
</description> </description>
</method> </method>
<method name="get_tracks_orientation" qualifiers="const"> <method name="get_tracks_orientation" qualifiers="const">
<return type="bool"> <return type="bool">
</return> </return>
<description> <description>
Returns true if the orientation of this device is being tracked. Returns [code]true[/code] if this device tracks orientation.
</description> </description>
</method> </method>
<method name="get_tracks_position" qualifiers="const"> <method name="get_tracks_position" qualifiers="const">
<return type="bool"> <return type="bool">
</return> </return>
<description> <description>
Returns true if the position of this device is being tracked. Returns [code]true[/code] if this device tracks position.
</description> </description>
</method> </method>
<method name="get_transform" qualifiers="const"> <method name="get_transform" qualifiers="const">
@ -68,19 +68,20 @@
<argument index="0" name="adjust_by_reference_frame" type="bool"> <argument index="0" name="adjust_by_reference_frame" type="bool">
</argument> </argument>
<description> <description>
Returns the transform combining the orientation and position of this device. Returns the transform combining this device's orientation and position.
</description> </description>
</method> </method>
<method name="get_type" qualifiers="const"> <method name="get_type" qualifiers="const">
<return type="int" enum="ARVRServer.TrackerType"> <return type="int" enum="ARVRServer.TrackerType">
</return> </return>
<description> <description>
Type of tracker. Returns the tracker's type.
</description> </description>
</method> </method>
</methods> </methods>
<members> <members>
<member name="rumble" type="float" setter="set_rumble" getter="get_rumble"> <member name="rumble" type="float" setter="set_rumble" getter="get_rumble">
The degree to which the tracker rumbles. Ranges from [code]0.0[/code] to [code]1.0[/code] with precision [code].01[/code].
</member> </member>
</members> </members>
<constants> <constants>

View File

@ -223,6 +223,7 @@
<return type="Array"> <return type="Array">
</return> </return>
<description> <description>
Returns an array of all points.
</description> </description>
</method> </method>
<method name="has_point" qualifiers="const"> <method name="has_point" qualifiers="const">

View File

@ -18,6 +18,7 @@
The texture that contains the atlas. Can be any [Texture] subtype. The texture that contains the atlas. Can be any [Texture] subtype.
</member> </member>
<member name="filter_clip" type="bool" setter="set_filter_clip" getter="has_filter_clip"> <member name="filter_clip" type="bool" setter="set_filter_clip" getter="has_filter_clip">
If [code]true[/code] clips the area outside of the region to avoid bleeding of the surrounding texture pixels.
</member> </member>
<member name="margin" type="Rect2" setter="set_margin" getter="get_margin"> <member name="margin" type="Rect2" setter="set_margin" getter="get_margin">
The margin around the region. The [Rect2]'s 'size' parameter ('w' and 'h' in the editor) resizes the texture so it fits within the margin. The margin around the region. The [Rect2]'s 'size' parameter ('w' and 'h' in the editor) resizes the texture so it fits within the margin.

View File

@ -171,10 +171,13 @@
</methods> </methods>
<members> <members>
<member name="x" type="Vector3" setter="" getter=""> <member name="x" type="Vector3" setter="" getter="">
The basis matrix's x vector.
</member> </member>
<member name="y" type="Vector3" setter="" getter=""> <member name="y" type="Vector3" setter="" getter="">
The basis matrix's y vector.
</member> </member>
<member name="z" type="Vector3" setter="" getter=""> <member name="z" type="Vector3" setter="" getter="">
The basis matrix's z vector.
</member> </member>
</members> </members>
<constants> <constants>