Skip to content

Commit

Permalink
classref: Sync with current source
Browse files Browse the repository at this point in the history 
[ci skip]
  • Loading branch information
@akien-mga
akien-mga committed Nov 13, 2017
1 parent dc4be43 commit 2fce001
Show file tree
Hide file tree
Showing 22 changed files with 373 additions and 121 deletions.
2 changes: 1 addition & 1 deletion doc/classes/@GDScript.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1119,7 +1119,7 @@
<constant name="PI" value="3.141593" enum="">
Constant that represents how many times the diameter of a circle fits around its perimeter.
</constant>
<constant name="TAU" value="6.2831853" enum="">
<constant name="TAU" value="6.283185" enum="">
The circle constant, the circumference of the unit circle.
</constant>
<constant name="INF" value="inf" enum="">
Expand Down
6 changes: 5 additions & 1 deletion doc/classes/@Global Scope.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1038,7 +1038,11 @@
<constant name="JOY_AXIS_7" value="7">
Joypad Right Trigger Analog Axis
</constant>
<constant name="JOY_AXIS_MAX" value="8">
<constant name="JOY_AXIS_8" value="8">
</constant>
<constant name="JOY_AXIS_9" value="9">
</constant>
<constant name="JOY_AXIS_MAX" value="10">
</constant>
<constant name="JOY_ANALOG_LX" value="0">
Joypad Left Stick Horizontal Axis
Expand Down
16 changes: 16 additions & 0 deletions doc/classes/ARVRController.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,12 @@
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.
</description>
</method>
<method name="get_rumble" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="is_button_pressed" qualifiers="const">
<return type="int">
</return>
Expand All @@ -75,11 +81,21 @@
Changes the id that identifies the controller bound to this node. The first controller that the ARVR Server detects will have id 1, the second id 2, the third id 3, etc. When a controller is turned off that slot is freed ensuring that controllers will keep the same id while it is turned on even when controllers with lower ids are turned off.
</description>
</method>
<method name="set_rumble">
<return type="void">
</return>
<argument index="0" name="rumble" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="controller_id" type="int" setter="set_controller_id" getter="get_controller_id">
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 name="rumble" type="float" setter="set_rumble" getter="get_rumble">
</member>
</members>
<signals>
<signal name="button_pressed">
Expand Down
18 changes: 18 additions & 0 deletions doc/classes/ARVRPositionalTracker.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@
Returns the position of the controller adjusted by world scale.
</description>
</method>
<method name="get_rumble" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_tracks_orientation" qualifiers="const">
<return type="bool">
</return>
Expand Down Expand Up @@ -78,7 +84,19 @@
Type of tracker.
</description>
</method>
<method name="set_rumble">
<return type="void">
</return>
<argument index="0" name="rumble" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="rumble" type="float" setter="set_rumble" getter="get_rumble">
</member>
</members>
<constants>
<constant name="TRACKER_HAND_UNKNOWN" value="0">
The hand this tracker is held in is unknown or not applicable.
Expand Down
44 changes: 22 additions & 22 deletions doc/classes/AStar.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,28 @@
If you change the 2nd point's weight to 3, then the result will be [code][1, 4, 3][/code] instead, because now even though the distance is longer, it's "easier" to get through point 4 than through point 2.
</description>
</method>
<method name="get_point_connections">
<return type="PoolIntArray">
</return>
<argument index="0" name="arg0" type="int">
</argument>
<description>
Returns an array with the ids of the points that form the connect with the given point.
[codeblock]
var as = AStar.new()

as.add_point(1, Vector3(0,0,0))
as.add_point(2, Vector3(0,1,0))
as.add_point(3, Vector3(1,1,0))
as.add_point(4, Vector3(2,0,0))

as.connect_points(1, 2, true)
as.connect_points(1, 3, true)

var neighbors = as.get_point_connections(1) # returns [2, 3]
[/codeblock]
</description>
</method>
<method name="get_point_path">
<return type="PoolVector3Array">
</return>
Expand Down Expand Up @@ -243,28 +265,6 @@
Sets the [code]weight_scale[/code] for the point with the given id.
</description>
</method>
<method name="get_point_connections">
<return type="PoolIntArray">
</return>
<argument index="0" name="id" type="int">
</argument>
<description>
Returns an array with the ids of the points that form the connect with the given point.
[codeblock]
var as = AStar.new()

as.add_point(1, Vector3(0,0,0))
as.add_point(2, Vector3(0,1,0))
as.add_point(3, Vector3(1,1,0))
as.add_point(4, Vector3(2,0,0))

as.connect_points(1, 2, true)
as.connect_points(1, 3, true)

var neighbors = as.get_point_connections(1) # returns [2, 3]
[/codeblock]
</description>
</method>
</methods>
<constants>
</constants>
Expand Down
8 changes: 8 additions & 0 deletions doc/classes/Array.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,8 @@
</description>
</method>
<method name="back">
<return type="var">
</return>
<description>
Returns the last element of the array if the array is not empty (size&gt;0).
</description>
Expand Down Expand Up @@ -142,6 +144,8 @@
</description>
</method>
<method name="front">
<return type="var">
</return>
<description>
Returns the first element of the array if the array is not empty (size&gt;0).
</description>
Expand Down Expand Up @@ -183,11 +187,15 @@
</description>
</method>
<method name="pop_back">
<return type="var">
</return>
<description>
Remove the last element of the array.
</description>
</method>
<method name="pop_front">
<return type="var">
</return>
<description>
Remove the first element of the array.
</description>
Expand Down
16 changes: 16 additions & 0 deletions doc/classes/AtlasTexture.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@
<description>
</description>
</method>
<method name="has_filter_clip" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_atlas">
<return type="void">
</return>
Expand All @@ -38,6 +44,14 @@
<description>
</description>
</method>
<method name="set_filter_clip">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_margin">
<return type="void">
</return>
Expand All @@ -59,6 +73,8 @@
<member name="atlas" type="Texture" setter="set_atlas" getter="get_atlas">
The texture that contains the atlas. Can be any [Texture] subtype.
</member>
<member name="filter_clip" type="bool" setter="set_filter_clip" getter="has_filter_clip">
</member>
<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.
</member>
Expand Down
15 changes: 15 additions & 0 deletions doc/classes/BulletPhysicsDirectBodyState.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BulletPhysicsDirectBodyState" inherits="PhysicsDirectBodyState" category="Core" version="3.0.alpha.custom_build">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<constants>
</constants>
</class>
2 changes: 1 addition & 1 deletion doc/classes/PhysicsDirectBodyStateSW.xml → doc/classes/BulletPhysicsServer.xml
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PhysicsDirectBodyStateSW" inherits="PhysicsDirectBodyState" category="Core" version="3.0.alpha.custom_build">
<class name="BulletPhysicsServer" inherits="PhysicsServer" category="Core" version="3.0.alpha.custom_build">
<brief_description>
</brief_description>
<description>
Expand Down
40 changes: 20 additions & 20 deletions doc/classes/Geometry.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,26 @@
Returns an array of [Plane]s closely bounding a faceted cylinder centered at the origin with radius [code]radius[/code] and height [code]height[/code]. The parameter [code]sides[/code] defines how many planes will be generated for the round part of the cylinder. The parameter [code]axis[/code] describes the axis along which the cylinder is oriented (0 for X, 1 for Y, 2 for Z).
</description>
</method>
<method name="clip_polygon">
<return type="PoolVector3Array">
</return>
<argument index="0" name="points" type="PoolVector3Array">
</argument>
<argument index="1" name="plane" type="Plane">
</argument>
<description>
Clips the polygon defined by the points in [code]points[/code] against the [code]plane[/code] and returns the points of the clipped polygon.
</description>
</method>
<method name="convex_hull_2d">
<return type="PoolVector2Array">
</return>
<argument index="0" name="points" type="PoolVector2Array">
</argument>
<description>
Given an array of [Vector2]s, returns the convex hull as a list of points in counter-clockwise order. The last point is the same as the first one.
</description>
</method>
<method name="get_closest_point_to_segment">
<return type="Vector3">
</return>
Expand Down Expand Up @@ -280,26 +300,6 @@
Triangulates the polygon specified by the points in [code]polygon[/code]. Returns a [PoolIntArray] where each triangle consists of three consecutive point indices into [code]polygon[/code] (i.e. the returned array will have [code]n * 3[/code] elements, with [code]n[/code] being the number of found triangles). If the triangulation did not succeed, an empty [PoolIntArray] is returned.
</description>
</method>
<method name="convex_hull_2d">
<return type="PoolVector2Array">
</return>
<argument index="0" name="points" type="PoolVector2Array">
</argument>
<description>
Given an array of [Vector2]s, returns the convex hull as a list of points in counter-clockwise order. The last point is the same as the first one.
</description>
</method>
<method name="clip_polygon">
<return type="PoolVector3Array">
</return>
<argument index="0" name="points" type="PoolVector3Array">
</argument>
<argument index="1" name="plane" type="Plane">
</argument>
<description>
Clips the polygon defined by the points in [code]points[/code] against the [code]plane[/code] and returns the points of the clipped polygon.
</description>
</method>
</methods>
<constants>
</constants>
Expand Down
14 changes: 8 additions & 6 deletions doc/classes/LineEdit.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@
Return the text in the [code]LineEdit[/code].
</description>
</method>
<method name="is_context_menu_enabled" qualifiers="const">
<method name="is_context_menu_enabled">
<return type="bool">
</return>
<description>
Expand Down Expand Up @@ -180,7 +180,7 @@
<method name="set_context_menu_enabled">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
<argument index="0" name="enable" type="bool">
</argument>
<description>
Set the status of the context menu. When enabled, the context menu will appear when the [code]LineEdit[/code] is right clicked.
Expand Down Expand Up @@ -268,6 +268,9 @@
<member name="caret_blink_speed" type="float" setter="cursor_set_blink_speed" getter="cursor_get_blink_speed">
Duration (in seconds) of a caret's blinking cycle.
</member>
<member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled">
If [code]true[/code] the context menu will appear when right clicked.
</member>
<member name="editable" type="bool" setter="set_editable" getter="is_editable">
If [code]false[/code] existing text cannot be modified and new text cannot be added.
</member>
Expand All @@ -292,9 +295,6 @@
<member name="text" type="String" setter="set_text" getter="get_text">
String value of the [LineEdit].
</member>
<member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled">
If [code]true[/code] the context menu will appear when right clicked.
</member>
</members>
<signals>
<signal name="text_changed">
Expand Down Expand Up @@ -343,7 +343,9 @@
<constant name="MENU_UNDO" value="5">
Undoes the previous action.
</constant>
<constant name="MENU_MAX" value="6">
<constant name="MENU_REDO" value="6">
</constant>
<constant name="MENU_MAX" value="7">
</constant>
</constants>
<theme_items>
Expand Down
Loading

0 comments on commit 2fce001

Please sign in to comment.