godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #4459 from CombustibleLemonade/master 

Documentation for WeakRef
This commit is contained in:
Rémi Verschelde 2016-04-27 19:41:04 +02:00
parent 87aa128228 e301ca3544
commit 49e560bfb6
1 changed files with 53 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
doc/base/classes.xml
View File

@ -2900,6 +2900,12 @@
</method>
</methods>
<signals>
<signal name="animation_started">
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</signal>
<signal name="animation_changed">
<argument index="0" name="old_name" type="String">
</argument>
@ -13895,6 +13901,12 @@ Returns an empty String "" at the end of the list.
<description>
</description>
</method>
<method name="get_connection" qualifiers="const">
<return type="StreamPeer">
</return>
<description>
</description>
</method>
<method name="request">
<return type="int">
</return>
@ -19126,6 +19138,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Set the mesh of the item.
</description>
</method>
<method name="set_item_navmesh">
<argument index="0" name="id" type="int">
</argument>
<argument index="1" name="navmesh" type="NavigationMesh">
</argument>
<description>
</description>
</method>
<method name="set_item_shape">
<argument index="0" name="id" type="int">
</argument>
@ -19152,6 +19172,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the mesh of the item.
</description>
</method>
<method name="get_item_navmesh" qualifiers="const">
<return type="NavigationMesh">
</return>
<argument index="0" name="id" type="int">
</argument>
<description>
</description>
</method>
<method name="get_item_shape" qualifiers="const">
<return type="Shape">
</return>
@ -36094,6 +36122,22 @@ This method controls whether the position between two cached points is interpola
<description>
</description>
</method>
<method name="add_triangle_fan">
<argument index="0" name="vertexes" type="Vector3Array">
</argument>
<argument index="1" name="uvs" type="Vector2Array" default="[Vector2Array]">
</argument>
<argument index="2" name="colors" type="ColorArray" default="ColorArray([ColorArray])">
</argument>
<argument index="3" name="uv2s" type="Vector2Array" default="[Vector2Array]">
</argument>
<argument index="4" name="normals" type="Vector3Array" default="Vector3Array()">
</argument>
<argument index="5" name="tangents" type="Array" default="Array()">
</argument>
<description>
</description>
</method>
<method name="set_material">
<argument index="0" name="material" type="Material">
</argument>
@ -37336,6 +37380,12 @@ This method controls whether the position between two cached points is interpola
<description>
</description>
</method>
<method name="get_stylebox_types" qualifiers="const">
<return type="StringArray">
</return>
<description>
</description>
</method>
<method name="set_font">
<argument index="0" name="name" type="String">
</argument>
@ -43248,14 +43298,17 @@ This method controls whether the position between two cached points is interpola
</class>
<class name="WeakRef" inherits="Reference" category="Core">
<brief_description>
Holds an [Object], but does not contribute to the reference count if the object is a reference.
</brief_description>
<description>
A weakref can hold a [Reference], without contributing to the reference counter. A weakref can be created from an [Object] using [method @GDScript.weakref]. If this object is not a reference, weakref still works, however, it does not have any effect on the object. Weakrefs are useful in cases where multiple classes have variables that refer to eachother. Without weakrefs, using these classes could lead to memory leaks, since both references keep eachother from being released. Making part of the variables a weakref can prevent this cyclic dependency, and allows the references to be released.
</description>
<methods>
<method name="get_ref" qualifiers="const">
<return type="Object">
</return>
<description>
Returns the [Object] this weakref is referring to.
</description>
</method>
</methods>