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 2020-02-29 14:22:57 +01:00
parent 1399747532
commit 16486a9055
7 changed files with 51 additions and 75 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
core/bind/core_bind.cpp
View file

@ -134,7 +134,7 @@ bool _ResourceLoader::exists(const String &p_path, const String &p_type_hint) {
void _ResourceLoader::_bind_methods() {
ClassDB::bind_method(D_METHOD("load_threaded_request", "path", "type_hint", "use_sub_threads"), &_ResourceLoader::load_threaded_request, DEFVAL(""), DEFVAL(false));
ClassDB::bind_method(D_METHOD("load_threaded_get_status", "path", "r_progress"), &_ResourceLoader::load_threaded_get_status, DEFVAL(Array()));
ClassDB::bind_method(D_METHOD("load_threaded_get_status", "path", "progress"), &_ResourceLoader::load_threaded_get_status, DEFVAL(Array()));
ClassDB::bind_method(D_METHOD("load_threaded_get", "path"), &_ResourceLoader::load_threaded_get);
ClassDB::bind_method(D_METHOD("load", "path", "type_hint", "no_cache"), &_ResourceLoader::load, DEFVAL(""), DEFVAL(false));

22
doc/classes/NavigationServer.xml
View file

@ -298,6 +298,17 @@
Sets the map up direction.
</description>
</method>
<method name="process">
<return type="void">
</return>
<argument index="0" name="delta_time" type="float">
</argument>
<description>
Process the collision avoidance agents.
The result of this process is needed by the physics server, so this must be called in the main thread.
Note: This function is not thread safe.
</description>
</method>
<method name="region_bake_navmesh" qualifiers="const">
<return type="void">
</return>
@ -358,17 +369,6 @@
Control activation of this server.
</description>
</method>
<method name="process">
<return type="void">
</return>
<argument index="0" name="delta_time" type="float">
</argument>
<description>
Process the collision avoidance agents.
The result of this process is needed by the physics server, so this must be called in the main thread.
Note: This function is not thread safe.
</description>
</method>
</methods>
<constants>
</constants>

55
doc/classes/ResourceInteractiveLoader.xml
View file

@ -1,55 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ResourceInteractiveLoader" inherits="Reference" version="4.0">
<brief_description>
Interactive [Resource] loader.
</brief_description>
<description>
Interactive [Resource] loader. This object is returned by [ResourceLoader] when performing an interactive load. It allows loading resources with high granularity, which makes it mainly useful for displaying loading bars or percentages.
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_resource">
<return type="Resource">
</return>
<description>
Returns the loaded resource if the load operation completed successfully, [code]null[/code] otherwise.
</description>
</method>
<method name="get_stage" qualifiers="const">
<return type="int">
</return>
<description>
Returns the load stage. The total amount of stages can be queried with [method get_stage_count].
</description>
</method>
<method name="get_stage_count" qualifiers="const">
<return type="int">
</return>
<description>
Returns the total amount of stages (calls to [method poll]) needed to completely load this resource.
</description>
</method>
<method name="poll">
<return type="int" enum="Error">
</return>
<description>
Polls the loading operation, i.e. loads a data chunk up to the next stage.
Returns [constant OK] if the poll is successful but the load operation has not finished yet (intermediate stage). This means [method poll] will have to be called again until the last stage is completed.
Returns [constant ERR_FILE_EOF] if the load operation has completed successfully. The loaded resource can be obtained by calling [method get_resource].
Returns another [enum Error] code if the poll has failed.
</description>
</method>
<method name="wait">
<return type="int" enum="Error">
</return>
<description>
Polls the loading operation successively until the resource is completely loaded or a [method poll] fails.
Returns [constant ERR_FILE_EOF] if the load operation has completed successfully. The loaded resource can be obtained by calling [method get_resource].
Returns another [enum Error] code if a poll has failed, aborting the operation.
</description>
</method>
</methods>
<constants>
</constants>
</class>

34
doc/classes/ResourceLoader.xml
View file

@ -68,16 +68,34 @@
Returns an empty resource if no ResourceFormatLoader could handle the file.
</description>
</method>
<method name="load_interactive">
<return type="ResourceInteractiveLoader">
<method name="load_threaded_get">
<return type="Resource">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
</description>
</method>
<method name="load_threaded_get_status">
<return type="int" enum="ResourceLoader.ThreadLoadStatus">
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="progress" type="Array" default="[ ]">
</argument>
<description>
</description>
</method>
<method name="load_threaded_request">
<return type="int" enum="Error">
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="type_hint" type="String" default="&quot;&quot;">
</argument>
<argument index="2" name="use_sub_threads" type="bool" default="false">
</argument>
<description>
Starts loading a resource interactively. The returned [ResourceInteractiveLoader] object allows to load with high granularity, calling its [method ResourceInteractiveLoader.poll] method successively to load chunks.
An optional [code]type_hint[/code] can be used to further specify the [Resource] type that should be handled by the [ResourceFormatLoader].
</description>
</method>
<method name="set_abort_on_missing_resources">
@ -91,5 +109,13 @@
</method>
</methods>
<constants>
<constant name="THREAD_LOAD_INVALID_RESOURCE" value="0" enum="ThreadLoadStatus">
</constant>
<constant name="THREAD_LOAD_IN_PROGRESS" value="1" enum="ThreadLoadStatus">
</constant>
<constant name="THREAD_LOAD_FAILED" value="2" enum="ThreadLoadStatus">
</constant>
<constant name="THREAD_LOAD_LOADED" value="3" enum="ThreadLoadStatus">
</constant>
</constants>
</class>

2
doc/classes/VisualShader.xml
View file

@ -183,6 +183,8 @@
<member name="code" type="String" setter="set_code" getter="get_code" override="true" default="&quot;shader_type spatial;void vertex() {// Output:0}void fragment() {// Output:0}void light() {// Output:0}&quot;" />
<member name="graph_offset" type="Vector2" setter="set_graph_offset" getter="get_graph_offset" default="Vector2( 0, 0 )">
</member>
<member name="version" type="String" setter="set_version" getter="get_version" default="&quot;&quot;">
</member>
</members>
<constants>
<constant name="TYPE_VERTEX" value="0" enum="Type">

9
doc/classes/VisualShaderNodeCompare.xml
View file

@ -25,13 +25,16 @@
<constant name="CTYPE_SCALAR" value="0" enum="ComparisonType">
A floating-point scalar.
</constant>
<constant name="CTYPE_VECTOR" value="1" enum="ComparisonType">
<constant name="CTYPE_SCALAR_INT" value="1" enum="ComparisonType">
An integer scalar.
</constant>
<constant name="CTYPE_VECTOR" value="2" enum="ComparisonType">
A 3D vector type.
</constant>
<constant name="CTYPE_BOOLEAN" value="2" enum="ComparisonType">
<constant name="CTYPE_BOOLEAN" value="3" enum="ComparisonType">
A boolean type.
</constant>
<constant name="CTYPE_TRANSFORM" value="3" enum="ComparisonType">
<constant name="CTYPE_TRANSFORM" value="4" enum="ComparisonType">
A transform ([code]mat4[/code]) type.
</constant>
<constant name="FUNC_EQUAL" value="0" enum="Function">

2
doc/classes/VisualShaderNodeIntFunc.xml
View file

@ -11,7 +11,7 @@
<methods>
</methods>
<members>
<member name="function" type="int" setter="set_function" getter="get_function" enum="VisualShaderNodeIntFunc.Function" default="0">
<member name="function" type="int" setter="set_function" getter="get_function" enum="VisualShaderNodeIntFunc.Function" default="3">
A function to be applied to the scalar. See [enum Function] for options.
</member>
</members>