asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

doc: Sync classref with current source

Browse source
This commit is contained in:
Rémi Verschelde 2019-01-26 22:21:53 +01:00
parent d9268265dc
commit 433b8ee526
12 changed files with 109 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
doc/classes/CollisionObject2D.xml
View file

@ -40,6 +40,14 @@
Returns the object's [RID]. Returns the object's [RID].
</description> </description>
</method> </method>
<method name="get_shape_owner_one_way_collision_margin" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="owner_id" type="int">
</argument>
<description>
</description>
</method>
<method name="get_shape_owners"> <method name="get_shape_owners">
<return type="Array"> <return type="Array">
</return> </return>
@ -185,6 +193,16 @@
If [code]enable[/code] is [code]true[/code], collisions for the shape owner originating from this [code]CollisionObject2D[/code] will not be reported to collided with [code]CollisionObject2D[/code]s. If [code]enable[/code] is [code]true[/code], collisions for the shape owner originating from this [code]CollisionObject2D[/code] will not be reported to collided with [code]CollisionObject2D[/code]s.
</description> </description>
</method> </method>
<method name="shape_owner_set_one_way_collision_margin">
<return type="void">
</return>
<argument index="0" name="owner_id" type="int">
</argument>
<argument index="1" name="margin" type="float">
</argument>
<description>
</description>
</method>
<method name="shape_owner_set_transform"> <method name="shape_owner_set_transform">
<return type="void"> <return type="void">
</return> </return>

2
doc/classes/CollisionPolygon2D.xml
View file

@ -22,6 +22,8 @@
<member name="one_way_collision" type="bool" setter="set_one_way_collision" getter="is_one_way_collision_enabled"> <member name="one_way_collision" type="bool" setter="set_one_way_collision" getter="is_one_way_collision_enabled">
If [code]true[/code], only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects. If [code]true[/code], only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects.
</member> </member>
<member name="one_way_collision_margin" type="float" setter="set_one_way_collision_margin" getter="get_one_way_collision_margin">
</member>
<member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon"> <member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon">
The polygon's list of vertices. The final point will be connected to the first. The polygon's list of vertices. The final point will be connected to the first.
</member> </member>

2
doc/classes/CollisionShape2D.xml
View file

@ -20,6 +20,8 @@
<member name="one_way_collision" type="bool" setter="set_one_way_collision" getter="is_one_way_collision_enabled"> <member name="one_way_collision" type="bool" setter="set_one_way_collision" getter="is_one_way_collision_enabled">
Sets whether this collision shape should only detect collision on one side (top or bottom). Sets whether this collision shape should only detect collision on one side (top or bottom).
</member> </member>
<member name="one_way_collision_margin" type="float" setter="set_one_way_collision_margin" getter="get_one_way_collision_margin">
</member>
<member name="shape" type="Shape2D" setter="set_shape" getter="get_shape"> <member name="shape" type="Shape2D" setter="set_shape" getter="get_shape">
The actual shape owned by this collision shape. The actual shape owned by this collision shape.
</member> </member>

14
doc/classes/EditorProperty.xml
View file

@ -9,6 +9,20 @@
<demos> <demos>
</demos> </demos>
<methods> <methods>
<method name="emit_changed">
<return type="void">
</return>
<argument index="0" name="property" type="String">
</argument>
<argument index="1" name="value" type="Variant">
</argument>
<argument index="2" name="field" type="String" default="&quot;&quot;">
</argument>
<argument index="3" name="changing" type="bool" default="false">
</argument>
<description>
</description>
</method>
<method name="get_edited_object"> <method name="get_edited_object">
<return type="Object"> <return type="Object">
</return> </return>

33
doc/classes/InputEventMIDI.xml Normal file
View file

@ -0,0 +1,33 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventMIDI" inherits="InputEvent" category="Core" version="3.1">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<members>
<member name="channel" type="int" setter="set_channel" getter="get_channel">
</member>
<member name="controller_number" type="int" setter="set_controller_number" getter="get_controller_number">
</member>
<member name="controller_value" type="int" setter="set_controller_value" getter="get_controller_value">
</member>
<member name="instrument" type="int" setter="set_instrument" getter="get_instrument">
</member>
<member name="message" type="int" setter="set_message" getter="get_message">
</member>
<member name="pitch" type="int" setter="set_pitch" getter="get_pitch">
</member>
<member name="pressure" type="int" setter="set_pressure" getter="get_pressure">
</member>
<member name="velocity" type="int" setter="set_velocity" getter="get_velocity">
</member>
</members>
<constants>
</constants>
</class>

2
doc/classes/Physics2DServer.xml
View file

@ -735,6 +735,8 @@
</argument> </argument>
<argument index="2" name="enable" type="bool"> <argument index="2" name="enable" type="bool">
</argument> </argument>
<argument index="3" name="margin" type="float">
</argument>
<description> <description>
Enables one way collision on body if [code]enable[/code] is [code]true[/code]. Enables one way collision on body if [code]enable[/code] is [code]true[/code].
</description> </description>

6
doc/classes/StyleBox.xml
View file

@ -27,6 +27,12 @@
<description> <description>
</description> </description>
</method> </method>
<method name="get_current_item_drawn" qualifiers="const">
<return type="CanvasItem">
</return>
<description>
</description>
</method>
<method name="get_margin" qualifiers="const"> <method name="get_margin" qualifiers="const">
<return type="float"> <return type="float">
</return> </return>

8
doc/classes/SurfaceTool.xml
View file

@ -75,14 +75,6 @@
Specify a Tangent for the next Vertex to use. Specify a Tangent for the next Vertex to use.
</description> </description>
</method> </method>
<method name="add_to_format">
<return type="void">
</return>
<argument index="0" name="flags" type="int">
</argument>
<description>
</description>
</method>
<method name="add_triangle_fan"> <method name="add_triangle_fan">
<return type="void"> <return type="void">
</return> </return>

8
doc/classes/Theme.xml
View file

@ -80,6 +80,14 @@
Sets theme values to a copy of the default theme values. Sets theme values to a copy of the default theme values.
</description> </description>
</method> </method>
<method name="copy_theme">
<return type="void">
</return>
<argument index="0" name="other" type="Theme">
</argument>
<description>
</description>
</method>
<method name="get_color" qualifiers="const"> <method name="get_color" qualifiers="const">
<return type="Color"> <return type="Color">
</return> </return>

22
doc/classes/TileSet.xml
View file

@ -439,6 +439,16 @@
Returns the one-way collision value of a tile's shape. Returns the one-way collision value of a tile's shape.
</description> </description>
</method> </method>
<method name="tile_get_shape_one_way_margin" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="id" type="int">
</argument>
<argument index="1" name="shape_id" type="int">
</argument>
<description>
</description>
</method>
<method name="tile_get_shape_transform" qualifiers="const"> <method name="tile_get_shape_transform" qualifiers="const">
<return type="Transform2D"> <return type="Transform2D">
</return> </return>
@ -633,6 +643,18 @@
Enables one-way collision on a tile's shape. Enables one-way collision on a tile's shape.
</description> </description>
</method> </method>
<method name="tile_set_shape_one_way_margin">
<return type="void">
</return>
<argument index="0" name="id" type="int">
</argument>
<argument index="1" name="shape_id" type="int">
</argument>
<argument index="2" name="one_way" type="float">
</argument>
<description>
</description>
</method>
<method name="tile_set_shape_transform"> <method name="tile_set_shape_transform">
<return type="void"> <return type="void">
</return> </return>

2
scene/resources/theme.cpp
View file

@ -756,7 +756,7 @@ void Theme::_bind_methods() {
ClassDB::bind_method(D_METHOD("_emit_theme_changed"), &Theme::_emit_theme_changed); ClassDB::bind_method(D_METHOD("_emit_theme_changed"), &Theme::_emit_theme_changed);
ClassDB::bind_method("copy_default_theme", &Theme::copy_default_theme); ClassDB::bind_method("copy_default_theme", &Theme::copy_default_theme);
ClassDB::bind_method("copy_theme", &Theme::copy_theme); ClassDB::bind_method(D_METHOD("copy_theme", "other"), &Theme::copy_theme);
ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "default_font", PROPERTY_HINT_RESOURCE_TYPE, "Font"), "set_default_font", "get_default_font"); ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "default_font", PROPERTY_HINT_RESOURCE_TYPE, "Font"), "set_default_font", "get_default_font");
} }

2
servers/physics_2d_server.cpp
View file

@ -620,7 +620,7 @@ void Physics2DServer::_bind_methods() {
ClassDB::bind_method(D_METHOD("body_clear_shapes", "body"), &Physics2DServer::body_clear_shapes); ClassDB::bind_method(D_METHOD("body_clear_shapes", "body"), &Physics2DServer::body_clear_shapes);
ClassDB::bind_method(D_METHOD("body_set_shape_disabled", "body", "shape_idx", "disable"), &Physics2DServer::body_set_shape_disabled); ClassDB::bind_method(D_METHOD("body_set_shape_disabled", "body", "shape_idx", "disable"), &Physics2DServer::body_set_shape_disabled);
ClassDB::bind_method(D_METHOD("body_set_shape_as_one_way_collision", "body", "shape_idx", "enable"), &Physics2DServer::body_set_shape_as_one_way_collision); ClassDB::bind_method(D_METHOD("body_set_shape_as_one_way_collision", "body", "shape_idx", "enable", "margin"), &Physics2DServer::body_set_shape_as_one_way_collision);
ClassDB::bind_method(D_METHOD("body_attach_object_instance_id", "body", "id"), &Physics2DServer::body_attach_object_instance_id); ClassDB::bind_method(D_METHOD("body_attach_object_instance_id", "body", "id"), &Physics2DServer::body_attach_object_instance_id);
ClassDB::bind_method(D_METHOD("body_get_object_instance_id", "body"), &Physics2DServer::body_get_object_instance_id); ClassDB::bind_method(D_METHOD("body_get_object_instance_id", "body"), &Physics2DServer::body_get_object_instance_id);