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

doc: Sync with current source

Browse source
This commit is contained in:
Rémi Verschelde 2018-01-13 11:43:30 +01:00
parent e28cdc4654
commit c01575b312
7 changed files with 13 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/classes/ARVRServer.xml
View file

@ -99,21 +99,21 @@
</members> </members>
<signals> <signals>
<signal name="interface_added"> <signal name="interface_added">
<argument index="0" name="name" type="String"> <argument index="0" name="interface_name" type="String">
</argument> </argument>
<description> <description>
Signal send when a new interface has been added. Signal send when a new interface has been added.
</description> </description>
</signal> </signal>
<signal name="interface_removed"> <signal name="interface_removed">
<argument index="0" name="name" type="String"> <argument index="0" name="interface_name" type="String">
</argument> </argument>
<description> <description>
Signal send when an interface is removed. Signal send when an interface is removed.
</description> </description>
</signal> </signal>
<signal name="tracker_added"> <signal name="tracker_added">
<argument index="0" name="name" type="String"> <argument index="0" name="tracker_name" type="String">
</argument> </argument>
<argument index="1" name="type" type="int"> <argument index="1" name="type" type="int">
</argument> </argument>
@ -124,7 +124,7 @@
</description> </description>
</signal> </signal>
<signal name="tracker_removed"> <signal name="tracker_removed">
<argument index="0" name="name" type="String"> <argument index="0" name="tracker_name" type="String">
</argument> </argument>
<argument index="1" name="type" type="int"> <argument index="1" name="type" type="int">
</argument> </argument>

4
doc/classes/AnimationPlayer.xml
View file

@ -247,14 +247,14 @@
</description> </description>
</signal> </signal>
<signal name="animation_finished"> <signal name="animation_finished">
<argument index="0" name="name" type="String"> <argument index="0" name="anim_name" type="String">
</argument> </argument>
<description> <description>
Notifies when an animation finished playing. Notifies when an animation finished playing.
</description> </description>
</signal> </signal>
<signal name="animation_started"> <signal name="animation_started">
<argument index="0" name="name" type="String"> <argument index="0" name="anim_name" type="String">
</argument> </argument>
<description> <description>
Notifies when an animation starts playing. Notifies when an animation starts playing.

2
doc/classes/Engine.xml
View file

@ -77,7 +77,7 @@
<member name="iterations_per_second" type="int" setter="set_iterations_per_second" getter="get_iterations_per_second"> <member name="iterations_per_second" type="int" setter="set_iterations_per_second" getter="get_iterations_per_second">
The number of fixed iterations per second (for fixed process and physics). The number of fixed iterations per second (for fixed process and physics).
</member> </member>
<member name="target_fps" type="float" setter="set_target_fps" getter="get_target_fps"> <member name="target_fps" type="int" setter="set_target_fps" getter="get_target_fps">
The desired frames per second. If the hardware cannot keep up, this setting may not be respected. Defaults to 0, which indicates no limit. The desired frames per second. If the hardware cannot keep up, this setting may not be respected. Defaults to 0, which indicates no limit.
</member> </member>
<member name="time_scale" type="float" setter="set_time_scale" getter="get_time_scale"> <member name="time_scale" type="float" setter="set_time_scale" getter="get_time_scale">

10
doc/classes/Node.xml
View file

@ -744,16 +744,16 @@
Emitted when the node enters the tree. Emitted when the node enters the tree.
</description> </description>
</signal> </signal>
<signal name="tree_exiting">
<description>
Emitted when the node is still active but about to exit the tree. This is the right place for de-initialization.
</description>
</signal>
<signal name="tree_exited"> <signal name="tree_exited">
<description> <description>
Emitted after the node exits the tree and is no longer active. Emitted after the node exits the tree and is no longer active.
</description> </description>
</signal> </signal>
<signal name="tree_exiting">
<description>
Emitted when the node is still active but about to exit the tree. This is the right place for de-initialization.
</description>
</signal>
</signals> </signals>
<constants> <constants>
<constant name="NOTIFICATION_ENTER_TREE" value="10"> <constant name="NOTIFICATION_ENTER_TREE" value="10">

2
doc/classes/ProximityGroup.xml
View file

@ -32,7 +32,7 @@
</members> </members>
<signals> <signals>
<signal name="broadcast"> <signal name="broadcast">
<argument index="0" name="name" type="String"> <argument index="0" name="group_name" type="String">
</argument> </argument>
<argument index="1" name="parameters" type="Array"> <argument index="1" name="parameters" type="Array">
</argument> </argument>

1
doc/classes/Tree.xml
View file

@ -223,7 +223,6 @@
</member> </member>
<member name="allow_rmb_select" type="bool" setter="set_allow_rmb_select" getter="get_allow_rmb_select"> <member name="allow_rmb_select" type="bool" setter="set_allow_rmb_select" getter="get_allow_rmb_select">
If [code]true[/code] a right mouse button click can select items. If [code]true[/code] a right mouse button click can select items.
</member> </member>
<member name="columns" type="int" setter="set_columns" getter="get_columns"> <member name="columns" type="int" setter="set_columns" getter="get_columns">
The amount of columns. The amount of columns.

1
doc/classes/World.xml
View file

@ -24,7 +24,6 @@
</member> </member>
<member name="scenario" type="RID" setter="" getter="get_scenario"> <member name="scenario" type="RID" setter="" getter="get_scenario">
The World's visual scenario. The World's visual scenario.
</member> </member>
<member name="space" type="RID" setter="" getter="get_space"> <member name="space" type="RID" setter="" getter="get_space">
The World's physics space. The World's physics space.