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 2017-12-07 08:23:08 +01:00
parent 9ff17379c2
commit 7d440d04aa
12 changed files with 69 additions and 197 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/classes/@GlobalScope.xml
View file

@ -1277,7 +1277,7 @@
</constant>
<constant name="PROPERTY_USAGE_DEFAULT_INTL" value="71" enum="PropertyUsageFlags">
</constant>
<constant name="PROPERTY_USAGE_NOEDITOR" value="5" enum="PropertyUsageFlags">
<constant name="PROPERTY_USAGE_NOEDITOR" value="1048581" enum="PropertyUsageFlags">
</constant>
<constant name="METHOD_FLAG_NORMAL" value="1" enum="MethodFlags">
Flag for normal method

2
doc/classes/ARVRController.xml
View file

@ -66,7 +66,7 @@
</member>
<member name="rumble" type="float" setter="set_rumble" getter="get_rumble">
The degree to which the tracker rumbles. Ranges from [code]0.0[/code] to [code]1.0[/code] with precision [code].01[/code]. If changed, updates [member ARVRPositionalTracker.rumble] accordingly.
</member>
</member>
</members>
<signals>
<signal name="button_pressed">

91
doc/classes/AnimationPlayer.xml
View file

@ -74,6 +74,20 @@
Returns the name of [code]animation[/code] or empty string if not found.
</description>
</method>
<method name="get_anim_length" qualifiers="const">
<return type="float">
</return>
<description>
Get the length (in seconds) of the currently playing animation.
</description>
</method>
<method name="get_anim_position" qualifiers="const">
<return type="float">
</return>
<description>
Get the position (in seconds) of the currently playing animation.
</description>
</method>
<method name="get_animation" qualifiers="const">
<return type="Animation">
</return>
@ -90,13 +104,6 @@
Returns the list of stored animation names.
</description>
</method>
<method name="get_autoplay" qualifiers="const">
<return type="String">
</return>
<description>
Returns the name of the animation played when the scene loads.
</description>
</method>
<method name="get_blend_time" qualifiers="const">
<return type="float">
</return>
@ -115,27 +122,6 @@
Returns the name of the currently playing animation.
</description>
</method>
<method name="get_anim_length" qualifiers="const">
<return type="float">
</return>
<description>
Get the length (in seconds) of the currently playing animation.
</description>
</method>
<method name="get_anim_position" qualifiers="const">
<return type="float">
</return>
<description>
Get the position (in seconds) of the currently playing animation.
</description>
</method>
<method name="get_speed_scale" qualifiers="const">
<return type="float">
</return>
<description>
Get the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is [i]1[/i] (no scaling).
</description>
</method>
<method name="has_animation" qualifiers="const">
<return type="bool">
</return>
@ -145,13 +131,6 @@
Returns [code]true[/code] if the [code]AnimationPlayer[/code] stores an [Animation] with key [code]name[/code].
</description>
</method>
<method name="is_active" qualifiers="const">
<return type="bool">
</return>
<description>
Returns true if the player is active.
</description>
</method>
<method name="is_playing" qualifiers="const">
<return type="bool">
</return>
@ -225,24 +204,6 @@
Seek the animation to the [code]seconds[/code] point in time (in seconds). If 'update' is true, the animation updates too, otherwise it updates at process time.
</description>
</method>
<method name="set_active">
<return type="void">
</return>
<argument index="0" name="active" type="bool">
</argument>
<description>
Set the player as active (playing). If false, it will do nothing.
</description>
</method>
<method name="set_autoplay">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Set the name of the animation that will be automatically played when the scene is loaded.
</description>
</method>
<method name="set_blend_time">
<return type="void">
</return>
@ -265,15 +226,6 @@
Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to calling play().
</description>
</method>
<method name="set_speed_scale">
<return type="void">
</return>
<argument index="0" name="speed" type="float">
</argument>
<description>
Set a speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is [i]1[/i] (no scaling).
</description>
</method>
<method name="stop">
<return type="void">
</return>
@ -292,6 +244,12 @@
</method>
</methods>
<members>
<member name="active" type="bool" setter="set_active" getter="is_active">
If [code]true[/code] updates animations in response to process-related notifications. Default value: [code]true[/code].
</member>
<member name="autoplay" type="String" setter="set_autoplay" getter="get_autoplay">
The name of the animation to play when the scene loads. Default value: [code]""[/code].
</member>
<member name="playback_default_blend_time" type="float" setter="set_default_blend_time" getter="get_default_blend_time">
The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. Default value: [code]0[/code].
</member>
@ -301,18 +259,9 @@
<member name="root_node" type="NodePath" setter="set_root" getter="get_root">
The node from which node path references will travel. Default value: [code]".."[/code].
</member>
<member name="autoplay" type="String" setter="set_autoplay" getter="get_autoplay">
The name of the animation to play when the scene loads. Default value: [code]""[/code].
</member>
<member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale">
The speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default value: [code]1[/code].
</member>
<member name="active" type="bool" setter="set_active" getter="is_active">
If [code]true[/code] updates animations in response to process-related notifications. Default value: [code]true[/code].
</member>
<member name="current_anim" type="String" setter="set_current_anim" getter="get_current_anim">
The name of the current animation. If already playing, restarts the animation. Ensure [member active] is [code]true[/code] to simulate [method play]. Default value: [code]""[/code].
</member>
</members>
<signals>
<signal name="animation_changed">

2
doc/classes/ColorPickerButton.xml
View file

@ -22,7 +22,7 @@
<return type="PopupPanel">
</return>
<description>
Returns the control's [PopupPanel] which allows you to connect to Popup Signals. This allows you to handle events when the ColorPicker is shown or hidden.
Returns the control's [PopupPanel] which allows you to connect to Popup Signals. This allows you to handle events when the ColorPicker is shown or hidden.
</description>
</method>
</methods>

132
doc/classes/EditorFileDialog.xml
View file

@ -26,42 +26,6 @@
Removes all filters except for "All Files (*)".
</description>
</method>
<method name="get_access" qualifiers="const">
<return type="int" enum="EditorFileDialog.Access">
</return>
<description>
</description>
</method>
<method name="get_current_dir" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_current_file" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_current_path" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_display_mode" qualifiers="const">
<return type="int" enum="EditorFileDialog.DisplayMode">
</return>
<description>
</description>
</method>
<method name="get_mode" qualifiers="const">
<return type="int" enum="EditorFileDialog.Mode">
</return>
<description>
</description>
</method>
<method name="get_vbox">
<return type="VBoxContainer">
</return>
@ -76,93 +40,11 @@
Notify the [code]EditorFileDialog[/code] that its view of the data is no longer accurate. Updates the view contents on next view update.
</description>
</method>
<method name="is_overwrite_warning_disabled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_showing_hidden_files" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_access">
<return type="void">
</return>
<argument index="0" name="access" type="int" enum="EditorFileDialog.Access">
</argument>
<description>
</description>
</method>
<method name="set_current_dir">
<return type="void">
</return>
<argument index="0" name="dir" type="String">
</argument>
<description>
</description>
</method>
<method name="set_current_file">
<return type="void">
</return>
<argument index="0" name="file" type="String">
</argument>
<description>
</description>
</method>
<method name="set_current_path">
<return type="void">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
</description>
</method>
<method name="set_disable_overwrite_warning">
<return type="void">
</return>
<argument index="0" name="disable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_display_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="EditorFileDialog.DisplayMode">
</argument>
<description>
</description>
</method>
<method name="set_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="EditorFileDialog.Mode">
</argument>
<description>
</description>
</method>
<method name="set_show_hidden_files">
<return type="void">
</return>
<argument index="0" name="show" type="bool">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="access" type="int" enum="EditorFileDialog.Access" setter="set_access" getter="get_access">
<member name="access" type="int" setter="set_access" getter="get_access" enum="EditorFileDialog.Access">
The location from which the user may select a file, including [code]res://[/code], [code]user://[/code], and the local file system.
</member>
<member name="display_mode" type="int" enum="EditorFileDialog.DisplayMode" setter="set_display_mode" getter="get_display_mode">
The view format in which the [code]EditorFileDialog[/code] displays resources to the user.
</member>
<member name="mode" type="int" enum="EditorFileDialog.Mode" setter="set_mode" getter="get_mode">
The purpose of the [code]EditorFileDialog[/code]. Changes allowed behaviors.
</member>
<member name="current_dir" type="String" setter="set_current_dir" getter="get_current_dir">
The currently occupied directory.
</member>
@ -172,12 +54,18 @@
<member name="current_path" type="String" setter="set_current_path" getter="get_current_path">
The file system path in the address bar.
</member>
<member name="show_hidden_files" type="bool" setter="set_show_hidden_files" getter="is_showing_hidden_files">
If [code]true[/code] hidden files and directories will be visible in the [code]EditorFileDialog[/code].
</member>
<member name="disable_overwrite_warning" type="bool" setter="set_disable_overwrite_warning" getter="is_overwrite_warning_disabled">
If [code]true[/code] the [code]EditorFileDialog[/code] will not warn the user before overwriting files.
</member>
<member name="display_mode" type="int" setter="set_display_mode" getter="get_display_mode" enum="EditorFileDialog.DisplayMode">
The view format in which the [code]EditorFileDialog[/code] displays resources to the user.
</member>
<member name="mode" type="int" setter="set_mode" getter="get_mode" enum="EditorFileDialog.Mode">
The purpose of the [code]EditorFileDialog[/code]. Changes allowed behaviors.
</member>
<member name="show_hidden_files" type="bool" setter="set_show_hidden_files" getter="is_showing_hidden_files">
If [code]true[/code] hidden files and directories will be visible in the [code]EditorFileDialog[/code].
</member>
</members>
<signals>
<signal name="dir_selected">

2
doc/classes/FileDialog.xml
View file

@ -160,6 +160,8 @@
</theme_item>
<theme_item name="folder" type="Texture">
</theme_item>
<theme_item name="parent_folder" type="Texture">
</theme_item>
<theme_item name="reload" type="Texture">
</theme_item>
</theme_items>

4
doc/classes/JSON.xml
View file

@ -25,6 +25,10 @@
</return>
<argument index="0" name="value" type="Variant">
</argument>
<argument index="1" name="indent" type="String" default="&quot;&quot;">
</argument>
<argument index="2" name="sort_keys" type="bool" default="false">
</argument>
<description>
Converts a Variant var to JSON text and returns the result. Useful for serializing data to store or send over the network.
</description>

2
doc/classes/LinkButton.xml
View file

@ -30,6 +30,8 @@
</constant>
</constants>
<theme_items>
<theme_item name="focus" type="StyleBox">
</theme_item>
<theme_item name="font" type="Font">
</theme_item>
<theme_item name="font_color" type="Color">

19
doc/classes/ProxyTexture.xml Normal file
View file

@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ProxyTexture" inherits="Texture" category="Core" version="3.0-beta">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<members>
<member name="base" type="Texture" setter="set_base" getter="get_base">
</member>
</members>
<constants>
</constants>
</class>

2
doc/classes/RayCast.xml
View file

@ -139,6 +139,8 @@
<member name="enabled" type="bool" setter="set_enabled" getter="is_enabled">
If [code]true[/code], collisions will be reported. Default value: [code]false[/code].
</member>
<member name="exclude_parent" type="bool" setter="set_exclude_parent_body" getter="get_exclude_parent_body">
</member>
</members>
<constants>
</constants>

6
doc/classes/SpatialMaterial.xml
View file

@ -79,6 +79,8 @@
</member>
<member name="emission_texture" type="Texture" setter="set_texture" getter="get_texture">
</member>
<member name="flags_albedo_tex_force_srgb" type="bool" setter="set_flag" getter="get_flag">
</member>
<member name="flags_fixed_size" type="bool" setter="set_flag" getter="get_flag">
</member>
<member name="flags_no_depth_test" type="bool" setter="set_flag" getter="get_flag">
@ -307,7 +309,9 @@
</constant>
<constant name="FLAG_TRIPLANAR_USE_WORLD" value="9" enum="Flags">
</constant>
<constant name="FLAG_MAX" value="12" enum="Flags">
<constant name="FLAG_ALBEDO_TEXTURE_FORCE_SRGB" value="12" enum="Flags">
</constant>
<constant name="FLAG_MAX" value="13" enum="Flags">
</constant>
<constant name="DIFFUSE_BURLEY" value="0" enum="DiffuseMode">
</constant>

2
doc/classes/TextEdit.xml
View file

@ -470,6 +470,8 @@
</theme_item>
<theme_item name="number_color" type="Color">
</theme_item>
<theme_item name="read_only" type="StyleBox">
</theme_item>
<theme_item name="selection_color" type="Color">
</theme_item>
<theme_item name="symbol_color" type="Color">