godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/CollisionObject2D.xml

243 lines
7.3 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Remove revision.module_config from version string It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}", limits unnecessary diffs.
2017-11-15 17:37:54 +00:00
<class name="CollisionObject2D" inherits="Node2D" category="Core" version="3.0-alpha">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
[DOCS] Update CollisionObject/CollisionObject2D class ref
2017-09-24 02:47:13 +00:00
Base node for 2D collision objects.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</brief_description>
<description>
makerst: Fix rst-ization of members and escaping of [Class]s Fixes #11517.
2017-10-21 10:33:50 +00:00
CollisionObject2D is the base class for 2D physics objects. It can hold any number of 2D collision [Shape2D]s. Each shape must be assigned to a [i]shape owner[/i]. The CollisionObject2D can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the [code]shape_owner_*[/code] methods.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="_input_event" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="viewport" type="Object">
</argument>
<argument index="1" name="event" type="InputEvent">
</argument>
<argument index="2" name="shape_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="create_shape_owner">
<return type="int">
</return>
<argument index="0" name="owner" type="Object">
</argument>
<description>
[DOCS] Update CollisionObject/CollisionObject2D class ref
2017-09-24 02:47:13 +00:00
Creates a new shape owner for the given object. Returns [code]owner_id[/code] of the new owner for future reference.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_rid" qualifiers="const">
<return type="RID">
</return>
<description>
[DOCS] Update CollisionObject/CollisionObject2D class ref
2017-09-24 02:47:13 +00:00
Returns the object's [RID].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_shape_owners">
<return type="Array">
</return>
<description>
[DOCS] Update CollisionObject/CollisionObject2D class ref
2017-09-24 02:47:13 +00:00
Returns an [Array] of [code]owner_id[/code] identifiers. You can use these ids in other methods that take [code]owner_id[/code] as an argument.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="is_pickable" qualifiers="const">
<return type="bool">
</return>
<description>
Return whether this object is pickable.
</description>
</method>
<method name="is_shape_owner_disabled" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="owner_id" type="int">
</argument>
<description>
[DOCS] Update CollisionObject/CollisionObject2D class ref
2017-09-24 02:47:13 +00:00
If [code]true[/code] the shape owner and its shapes are disabled.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="is_shape_owner_one_way_collision_enabled" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="owner_id" type="int">
</argument>
<description>
</description>
</method>
<method name="remove_shape_owner">
<return type="void">
</return>
<argument index="0" name="owner_id" type="int">
</argument>
<description>
[DOCS] Update CollisionObject/CollisionObject2D class ref
2017-09-24 02:47:13 +00:00
Removes the given shape owner.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="set_pickable">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Set whether this object is pickable. A pickable object can detect the mouse pointer enter/leave it and, if the mouse is inside it, report input events.
</description>
</method>
<method name="shape_find_owner" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="shape_index" type="int">
</argument>
<description>
[DOCS] Update CollisionObject/CollisionObject2D class ref
2017-09-24 02:47:13 +00:00
Returns the [code]owner_id[/code] of the given shape.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="shape_owner_add_shape">
<return type="void">
</return>
<argument index="0" name="owner_id" type="int">
</argument>
<argument index="1" name="shape" type="Shape2D">
</argument>
<description>
[DOCS] Update CollisionObject/CollisionObject2D class ref
2017-09-24 02:47:13 +00:00
Adds a [Shape2D] to the shape owner.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="shape_owner_clear_shapes">
<return type="void">
</return>
<argument index="0" name="owner_id" type="int">
</argument>
<description>
[DOCS] Update CollisionObject/CollisionObject2D class ref
2017-09-24 02:47:13 +00:00
Removes all shapes from the shape owner.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="shape_owner_get_owner" qualifiers="const">
<return type="Object">
</return>
<argument index="0" name="owner_id" type="int">
</argument>
<description>
[DOCS] Update CollisionObject/CollisionObject2D class ref
2017-09-24 02:47:13 +00:00
Returns the parent object of the given shape owner.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="shape_owner_get_shape" qualifiers="const">
<return type="Shape2D">
</return>
<argument index="0" name="owner_id" type="int">
</argument>
<argument index="1" name="shape_id" type="int">
</argument>
<description>
[DOCS] Update CollisionObject/CollisionObject2D class ref
2017-09-24 02:47:13 +00:00
Returns the [Shape2D] with the given id from the given shape owner.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="shape_owner_get_shape_count" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="owner_id" type="int">
</argument>
<description>
[DOCS] Update CollisionObject/CollisionObject2D class ref
2017-09-24 02:47:13 +00:00
Returns the number of shapes the given shape owner contains.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="shape_owner_get_shape_index" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="owner_id" type="int">
</argument>
<argument index="1" name="shape_id" type="int">
</argument>
<description>
</description>
</method>
<method name="shape_owner_get_transform" qualifiers="const">
<return type="Transform2D">
</return>
<argument index="0" name="owner_id" type="int">
</argument>
<description>
[DOCS] Update CollisionObject/CollisionObject2D class ref
2017-09-24 02:47:13 +00:00
Returns the shape owner's [Transform2D].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="shape_owner_remove_shape">
<return type="void">
</return>
<argument index="0" name="owner_id" type="int">
</argument>
<argument index="1" name="shape_id" type="int">
</argument>
<description>
[DOCS] Update CollisionObject/CollisionObject2D class ref
2017-09-24 02:47:13 +00:00
Removes a shape from the given shape owner.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="shape_owner_set_disabled">
<return type="void">
</return>
<argument index="0" name="owner_id" type="int">
</argument>
<argument index="1" name="disabled" type="bool">
</argument>
<description>
[DOCS] Update CollisionObject/CollisionObject2D class ref
2017-09-24 02:47:13 +00:00
If [code]true[/code] disables the given shape owner.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="shape_owner_set_one_way_collision">
<return type="void">
</return>
<argument index="0" name="owner_id" type="int">
</argument>
<argument index="1" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="shape_owner_set_transform">
<return type="void">
</return>
<argument index="0" name="owner_id" type="int">
</argument>
<argument index="1" name="transform" type="Transform2D">
</argument>
<description>
[DOCS] Update CollisionObject/CollisionObject2D class ref
2017-09-24 02:47:13 +00:00
Sets the [Transform2D] of the given shape owner.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<members>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="input_pickable" type="bool" setter="set_pickable" getter="is_pickable">
[DOCS] Update CollisionObject/CollisionObject2D class ref
2017-09-24 02:47:13 +00:00
If [code]true[/code] this object is pickable. A pickable object can detect the mouse pointer entering/leaving, and if the mouse is inside it, report input events.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
</members>
<signals>
<signal name="input_event">
<argument index="0" name="viewport" type="Object">
</argument>
<argument index="1" name="event" type="Object">
</argument>
<argument index="2" name="shape_idx" type="int">
</argument>
<description>
[DOCS] Update CollisionObject/CollisionObject2D class ref
2017-09-24 02:47:13 +00:00
Emitted when an input event occurs and [code]input_pickable[/code] is [code]true[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</signal>
<signal name="mouse_entered">
<description>
[DOCS] Update CollisionObject/CollisionObject2D class ref
2017-09-24 02:47:13 +00:00
Emitted when the mouse pointer enters any of this object's shapes.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</signal>
<signal name="mouse_exited">
<description>
[DOCS] Update CollisionObject/CollisionObject2D class ref
2017-09-24 02:47:13 +00:00
Emitted when the mouse pointer exits all this object's shapes.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</signal>
</signals>
<constants>
</constants>
</class>