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

doc: Sync classref with current source

Browse source
This commit is contained in:
Rémi Verschelde 2019-08-29 15:33:52 +02:00
parent 46471a8d69
commit 65d61d0360
10 changed files with 109 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/classes/Control.xml
View file

@ -260,7 +260,7 @@
</description>
</method>
<method name="get_drag_data" qualifiers="virtual">
<return type="Object">
<return type="Variant">
</return>
<argument index="0" name="position" type="Vector2">
</argument>

95
doc/classes/JSONRPC.xml Normal file
View file

@ -0,0 +1,95 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="JSONRPC" inherits="Object" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="make_notification">
<return type="Dictionary">
</return>
<argument index="0" name="method" type="String">
</argument>
<argument index="1" name="params" type="Variant">
</argument>
<description>
</description>
</method>
<method name="make_request">
<return type="Dictionary">
</return>
<argument index="0" name="method" type="String">
</argument>
<argument index="1" name="params" type="Variant">
</argument>
<argument index="2" name="id" type="Variant">
</argument>
<description>
</description>
</method>
<method name="make_response">
<return type="Dictionary">
</return>
<argument index="0" name="result" type="Variant">
</argument>
<argument index="1" name="id" type="Variant">
</argument>
<description>
</description>
</method>
<method name="make_response_error" qualifiers="const">
<return type="Dictionary">
</return>
<argument index="0" name="code" type="int">
</argument>
<argument index="1" name="message" type="String">
</argument>
<argument index="2" name="id" type="Variant" default="null">
</argument>
<description>
</description>
</method>
<method name="process_action">
<return type="Variant">
</return>
<argument index="0" name="action" type="Variant">
</argument>
<argument index="1" name="recurse" type="bool" default="false">
</argument>
<description>
</description>
</method>
<method name="process_string">
<return type="String">
</return>
<argument index="0" name="action" type="String">
</argument>
<description>
</description>
</method>
<method name="set_scope">
<return type="void">
</return>
<argument index="0" name="scope" type="String">
</argument>
<argument index="1" name="target" type="Object">
</argument>
<description>
</description>
</method>
</methods>
<constants>
<constant name="ParseError" value="-32700" enum="ErrorCode">
</constant>
<constant name="InvalidRequest" value="-32600" enum="ErrorCode">
</constant>
<constant name="MethodNotFound" value="-32601" enum="ErrorCode">
</constant>
<constant name="InvalidParams" value="-32602" enum="ErrorCode">
</constant>
<constant name="InternalError" value="-32603" enum="ErrorCode">
</constant>
</constants>
</class>

2
doc/classes/ProjectSettings.xml
View file

@ -415,6 +415,8 @@
<member name="editor/active" type="bool" setter="" getter="" default="false">
Internal editor setting, don't touch.
</member>
<member name="editor/script_templates_search_path" type="String" setter="" getter="" default="&quot;res://script_templates&quot;">
</member>
<member name="editor/search_in_file_extensions" type="PoolStringArray" setter="" getter="" default="PoolStringArray( &quot;gd&quot;, &quot;shader&quot; )">
</member>
<member name="gui/common/default_scroll_deadzone" type="int" setter="" getter="" default="0">

2
doc/classes/SpriteBase3D.xml
View file

@ -46,6 +46,8 @@
<member name="axis" type="int" setter="set_axis" getter="get_axis" enum="Vector3.Axis" default="2">
The direction in which the front of the texture faces.
</member>
<member name="billboard" type="int" setter="set_billboard_mode" getter="get_billboard_mode" enum="SpatialMaterial.BillboardMode" default="0">
</member>
<member name="centered" type="bool" setter="set_centered" getter="is_centered" default="true">
If [code]true[/code], texture will be centered.
</member>

4
doc/classes/Vector2.xml
View file

@ -215,7 +215,7 @@
<method name="posmodv">
<return type="Vector2">
</return>
<argument index="0" name="mod" type="float">
<argument index="0" name="modv" type="Vector2">
</argument>
<description>
Returns a vector composed of the [code]fposmod[/code] of this vector's components and [code]modv[/code]'s components.
@ -310,7 +310,7 @@
</members>
<constants>
<constant name="AXIS_X" value="0">
Enumerated value for the X axis. Returned by [method max_axis] and [method min_axis].
Enumerated value for the X axis.
</constant>
<constant name="AXIS_Y" value="1">
Enumerated value for the Y axis.

6
doc/classes/Vector3.xml
View file

@ -214,7 +214,7 @@
<method name="posmodv">
<return type="Vector3">
</return>
<argument index="0" name="mod" type="float">
<argument index="0" name="modv" type="Vector3">
</argument>
<description>
Returns a vector composed of the [code]fposmod[/code] of this vector's components and [code]modv[/code]'s components.
@ -317,10 +317,10 @@
Enumerated value for the X axis. Returned by [method max_axis] and [method min_axis].
</constant>
<constant name="AXIS_Y" value="1">
Enumerated value for the Y axis.
Enumerated value for the Y axis. Returned by [method max_axis] and [method min_axis].
</constant>
<constant name="AXIS_Z" value="2">
Enumerated value for the Z axis.
Enumerated value for the Z axis. Returned by [method max_axis] and [method min_axis].
</constant>
<constant name="ZERO" value="Vector3( 0, 0, 0 )">
Zero vector.

2
modules/gdnative/doc_classes/NativeScript.xml
View file

@ -42,7 +42,7 @@
</description>
</method>
<method name="new" qualifiers="vararg">
<return type="Object">
<return type="Variant">
</return>
<description>
Constructs a new object of the base type with a script of this type already attached.

2
modules/gdnative/doc_classes/PluginScript.xml
View file

@ -8,7 +8,7 @@
</tutorials>
<methods>
<method name="new" qualifiers="vararg">
<return type="Object">
<return type="Variant">
</return>
<description>
Returns a new instance of the script.

2
modules/gdscript/doc_classes/@GDScript.xml
View file

@ -1119,7 +1119,7 @@
[codeblock]
stepify(100, 32) # Returns 96
stepify(3.14159, 0.01) # Returns 3.14
[/codeblock]
[/codeblock]
</description>
</method>
<method name="str" qualifiers="vararg">

2
modules/gdscript/doc_classes/GDScript.xml
View file

@ -19,7 +19,7 @@
</description>
</method>
<method name="new" qualifiers="vararg">
<return type="Object">
<return type="Variant">
</return>
<description>
Returns a new instance of the script.