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

doc: Sync classref with current source

This commit is contained in:
Rémi Verschelde 2019-04-15 14:49:41 +02:00
parent dab8f8c953
commit 09e94aa087
54 changed files with 853 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/classes/AnimatedSprite.xml
View File

@ -23,6 +23,8 @@
</return>
<argument index="0" name="anim" type="String" default="&quot;&quot;">
</argument>
<argument index="1" name="backwards" type="bool" default="false">
</argument>
<description>
Play the animation set in parameter. If no parameter is provided, the current animation is played. Property [code]backwards[/code] plays the animation in reverse if set to [code]true[/code].
</description>

15
doc/classes/AudioEffectInstance.xml Normal file
View File

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectInstance" inherits="Reference" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<constants>
</constants>
</class>

23
doc/classes/AudioEffectSpectrumAnalyzer.xml Normal file
View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectSpectrumAnalyzer" inherits="AudioEffect" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<members>
<member name="buffer_length" type="float" setter="set_buffer_length" getter="get_buffer_length">
</member>
<member name="fft_size" type="int" setter="set_fft_size" getter="get_fft_size" enum="AudioEffectSpectrumAnalyzer.FFT_Size">
</member>
<member name="tap_back_pos" type="float" setter="set_tap_back_pos" getter="get_tap_back_pos">
</member>
</members>
<constants>
</constants>
</class>

31
doc/classes/AudioEffectSpectrumAnalyzerInstance.xml Normal file
View File

@ -0,0 +1,31 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectSpectrumAnalyzerInstance" inherits="AudioEffectInstance" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_magnitude_for_frequency_range" qualifiers="const">
<return type="Vector2">
</return>
<argument index="0" name="from_hz" type="float">
</argument>
<argument index="1" name="to_hz" type="float">
</argument>
<argument index="2" name="mode" type="int" enum="AudioEffectSpectrumAnalyzerInstance.MagnitudeMode" default="1">
</argument>
<description>
</description>
</method>
</methods>
<constants>
<constant name="MAGNITUDE_AVERAGE" value="0" enum="MagnitudeMode">
</constant>
<constant name="MAGNITUDE_MAX" value="1" enum="MagnitudeMode">
</constant>
</constants>
</class>

12
doc/classes/AudioServer.xml
View File

@ -97,6 +97,18 @@
Returns the number of effects on the bus at [code]bus_idx[/code].
</description>
</method>
<method name="get_bus_effect_instance">
<return type="AudioEffectInstance">
</return>
<argument index="0" name="bus_idx" type="int">
</argument>
<argument index="1" name="effect_idx" type="int">
</argument>
<argument index="2" name="channel" type="int" default="0">
</argument>
<description>
</description>
</method>
<method name="get_bus_index" qualifiers="const">
<return type="int">
</return>

21
doc/classes/AudioStreamGenerator.xml Normal file
View File

@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamGenerator" inherits="AudioStream" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<members>
<member name="buffer_length" type="float" setter="set_buffer_length" getter="get_buffer_length">
</member>
<member name="mix_rate" type="float" setter="set_mix_rate" getter="get_mix_rate">
</member>
</members>
<constants>
</constants>
</class>

57
doc/classes/AudioStreamGeneratorPlayback.xml Normal file
View File

@ -0,0 +1,57 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamGeneratorPlayback" inherits="AudioStreamPlaybackResampled" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="can_push_buffer" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="amount" type="int">
</argument>
<description>
</description>
</method>
<method name="clear_buffer">
<return type="void">
</return>
<description>
</description>
</method>
<method name="get_frames_available" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_skips" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="push_buffer">
<return type="bool">
</return>
<argument index="0" name="frames" type="PoolVector2Array">
</argument>
<description>
</description>
</method>
<method name="push_frame">
<return type="bool">
</return>
<argument index="0" name="frame" type="Vector2">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>

15
doc/classes/AudioStreamPlaybackResampled.xml Normal file
View File

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamPlaybackResampled" inherits="AudioStreamPlayback" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<constants>
</constants>
</class>

6
doc/classes/AudioStreamPlayer.xml
View File

@ -19,6 +19,12 @@
Returns the position in the [AudioStream] in seconds.
</description>
</method>
<method name="get_stream_playback">
<return type="AudioStreamPlayback">
</return>
<description>
</description>
</method>
<method name="play">
<return type="void">
</return>

6
doc/classes/AudioStreamPlayer2D.xml
View File

@ -19,6 +19,12 @@
Returns the position in the [AudioStream].
</description>
</method>
<method name="get_stream_playback">
<return type="AudioStreamPlayback">
</return>
<description>
</description>
</method>
<method name="play">
<return type="void">
</return>

6
doc/classes/AudioStreamPlayer3D.xml
View File

@ -19,6 +19,12 @@
Returns the position in the [AudioStream].
</description>
</method>
<method name="get_stream_playback">
<return type="AudioStreamPlayback">
</return>
<description>
</description>
</method>
<method name="play">
<return type="void">
</return>

16
doc/classes/Basis.xml
View File

@ -76,6 +76,12 @@
This function considers a discretization of rotations into 24 points on unit sphere, lying along the vectors (x,y,z) with each component being either -1,0 or 1, and returns the index of the point best representing the orientation of the object. It is mainly used by the grid map editor. For further details, refer to Godot source code.
</description>
</method>
<method name="get_rotation_quat">
<return type="Quat">
</return>
<description>
</description>
</method>
<method name="get_scale">
<return type="Vector3">
</return>
@ -90,6 +96,16 @@
Return the inverse of the matrix.
</description>
</method>
<method name="is_equal_approx">
<return type="bool">
</return>
<argument index="0" name="b" type="Basis">
</argument>
<argument index="1" name="epsilon" type="float" default="0.00001">
</argument>
<description>
</description>
</method>
<method name="orthonormalized">
<return type="Basis">
</return>

2
doc/classes/CanvasItem.xml
View File

@ -575,7 +575,7 @@
<constant name="BLEND_MODE_DISABLED" value="5" enum="BlendMode">
Disable blending mode. Colors including alpha are written as is. Only applicable for render targets with a transparent background. No lighting will be applied.
</constant>
<constant name="NOTIFICATION_TRANSFORM_CHANGED" value="29">
<constant name="NOTIFICATION_TRANSFORM_CHANGED" value="2000">
Canvas item transform has changed. Notification is only received if enabled by [method set_notify_transform] or [method set_notify_local_transform].
</constant>
<constant name="NOTIFICATION_DRAW" value="30">

4
doc/classes/CanvasLayer.xml
View File

@ -25,6 +25,10 @@
<member name="custom_viewport" type="Node" setter="set_custom_viewport" getter="get_custom_viewport">
The custom [Viewport] node assigned to the [CanvasLayer]. If null, uses the default viewport instead.
</member>
<member name="follow_viewport_enable" type="bool" setter="set_follow_viewport" getter="is_following_viewport">
</member>
<member name="follow_viewport_scale" type="float" setter="set_follow_viewport_scale" getter="get_follow_viewport_scale">
</member>
<member name="layer" type="int" setter="set_layer" getter="get_layer">
Layer index for draw order. Lower values are drawn first. Default value: [code]1[/code].
</member>

131
doc/classes/EditorFeatureProfile.xml Normal file
View File

@ -0,0 +1,131 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorFeatureProfile" inherits="Reference" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_feature_name">
<return type="String">
</return>
<argument index="0" name="feature" type="int" enum="EditorFeatureProfile.Feature">
</argument>
<description>
</description>
</method>
<method name="is_class_disabled" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="class_name" type="String">
</argument>
<description>
</description>
</method>
<method name="is_class_editor_disabled" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="class_name" type="String">
</argument>
<description>
</description>
</method>
<method name="is_class_property_disabled" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="class_name" type="String">
</argument>
<argument index="1" name="arg1" type="String">
</argument>
<description>
</description>
</method>
<method name="is_feature_disabled" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="feature" type="int" enum="EditorFeatureProfile.Feature">
</argument>
<description>
</description>
</method>
<method name="load_from_file">
<return type="int" enum="Error">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
</description>
</method>
<method name="save_to_file">
<return type="int" enum="Error">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
</description>
</method>
<method name="set_disable_class">
<return type="void">
</return>
<argument index="0" name="class_name" type="String">
</argument>
<argument index="1" name="disable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_disable_class_editor">
<return type="void">
</return>
<argument index="0" name="class_name" type="String">
</argument>
<argument index="1" name="disable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_disable_class_property">
<return type="void">
</return>
<argument index="0" name="class_name" type="String">
</argument>
<argument index="1" name="property" type="String">
</argument>
<argument index="2" name="arg2" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_disable_feature">
<return type="void">
</return>
<argument index="0" name="feature" type="int" enum="EditorFeatureProfile.Feature">
</argument>
<argument index="1" name="disable" type="bool">
</argument>
<description>
</description>
</method>
</methods>
<constants>
<constant name="FEATURE_3D" value="0" enum="Feature">
</constant>
<constant name="FEATURE_SCRIPT" value="1" enum="Feature">
</constant>
<constant name="FEATURE_ASSET_LIB" value="2" enum="Feature">
</constant>
<constant name="FEATURE_SCENE_TREE" value="3" enum="Feature">
</constant>
<constant name="FEATURE_IMPORT_DOCK" value="4" enum="Feature">
</constant>
<constant name="FEATURE_NODE_DOCK" value="5" enum="Feature">
</constant>
<constant name="FEATURE_FILESYSTEM_DOCK" value="6" enum="Feature">
</constant>
<constant name="FEATURE_MAX" value="7" enum="Feature">
</constant>
</constants>
</class>

6
doc/classes/EditorInterface.xml
View File

@ -48,6 +48,12 @@
Returns the editor [Viewport].
</description>
</method>
<method name="get_inspector" qualifiers="const">
<return type="EditorInspector">
</return>
<description>
</description>
</method>
<method name="get_open_scenes" qualifiers="const">
<return type="Array">
</return>

10
doc/classes/File.xml
View File

@ -227,7 +227,7 @@
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="flags" type="int">
<argument index="1" name="flags" type="int" enum="File.ModeFlags">
</argument>
<description>
Opens the file for writing or reading, depending on the flags.
@ -238,9 +238,9 @@
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="mode_flags" type="int">
<argument index="1" name="mode_flags" type="int" enum="File.ModeFlags">
</argument>
<argument index="2" name="compression_mode" type="int" default="0">
<argument index="2" name="compression_mode" type="int" enum="File.CompressionMode" default="0">
</argument>
<description>
Opens a compressed file for reading or writing. Use COMPRESSION_* constants to set [code]compression_mode[/code].
@ -251,7 +251,7 @@
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="mode_flags" type="int">
<argument index="1" name="mode_flags" type="int" enum="File.ModeFlags">
</argument>
<argument index="2" name="key" type="PoolByteArray">
</argument>
@ -264,7 +264,7 @@
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="mode_flags" type="int">
<argument index="1" name="mode_flags" type="int" enum="File.ModeFlags">
</argument>
<argument index="2" name="pass" type="String">
</argument>

24
doc/classes/MainLoop.xml
View File

@ -114,29 +114,29 @@
</method>
</methods>
<constants>
<constant name="NOTIFICATION_WM_MOUSE_ENTER" value="2">
<constant name="NOTIFICATION_WM_MOUSE_ENTER" value="1002">
</constant>
<constant name="NOTIFICATION_WM_MOUSE_EXIT" value="3">
<constant name="NOTIFICATION_WM_MOUSE_EXIT" value="1003">
</constant>
<constant name="NOTIFICATION_WM_FOCUS_IN" value="4">
<constant name="NOTIFICATION_WM_FOCUS_IN" value="1004">
</constant>
<constant name="NOTIFICATION_WM_FOCUS_OUT" value="5">
<constant name="NOTIFICATION_WM_FOCUS_OUT" value="1005">
</constant>
<constant name="NOTIFICATION_WM_QUIT_REQUEST" value="6">
<constant name="NOTIFICATION_WM_QUIT_REQUEST" value="1006">
</constant>
<constant name="NOTIFICATION_WM_GO_BACK_REQUEST" value="7">
<constant name="NOTIFICATION_WM_GO_BACK_REQUEST" value="1007">
</constant>
<constant name="NOTIFICATION_WM_UNFOCUS_REQUEST" value="8">
<constant name="NOTIFICATION_WM_UNFOCUS_REQUEST" value="1008">
</constant>
<constant name="NOTIFICATION_OS_MEMORY_WARNING" value="9">
<constant name="NOTIFICATION_OS_MEMORY_WARNING" value="1009">
</constant>
<constant name="NOTIFICATION_TRANSLATION_CHANGED" value="90">
<constant name="NOTIFICATION_TRANSLATION_CHANGED" value="1010">
</constant>
<constant name="NOTIFICATION_WM_ABOUT" value="91">
<constant name="NOTIFICATION_WM_ABOUT" value="1011">
</constant>
<constant name="NOTIFICATION_CRASH" value="92">
<constant name="NOTIFICATION_CRASH" value="1012">
</constant>
<constant name="NOTIFICATION_OS_IME_UPDATE" value="93">
<constant name="NOTIFICATION_OS_IME_UPDATE" value="1013">
</constant>
</constants>
</class>

18
doc/classes/MeshLibrary.xml
View File

@ -68,6 +68,14 @@
<description>
</description>
</method>
<method name="get_item_navmesh_transform" qualifiers="const">
<return type="Transform">
</return>
<argument index="0" name="id" type="int">
</argument>
<description>
</description>
</method>
<method name="get_item_preview" qualifiers="const">
<return type="Texture">
</return>
@ -132,6 +140,16 @@
<description>
</description>
</method>
<method name="set_item_navmesh_transform">
<return type="void">
</return>
<argument index="0" name="id" type="int">
</argument>
<argument index="1" name="navmesh" type="Transform">
</argument>
<description>
</description>
</method>
<method name="set_item_preview">
<return type="void">
</return>

28
doc/classes/Node.xml
View File

@ -886,15 +886,37 @@
<constant name="NOTIFICATION_PATH_CHANGED" value="23">
Notification received when the node's [NodePath] changed.
</constant>
<constant name="NOTIFICATION_TRANSLATION_CHANGED" value="24">
Notification received when translations may have changed. Can be triggered by the user changing the locale. Can be used to respond to language changes, for example to change the UI strings on the fly. Useful when working with the built-in translation support, like [method Object.tr].
</constant>
<constant name="NOTIFICATION_INTERNAL_PROCESS" value="25">
Notification received every frame when the internal process flag is set (see [method set_process_internal]).
</constant>
<constant name="NOTIFICATION_INTERNAL_PHYSICS_PROCESS" value="26">
Notification received every frame when the internal physics process flag is set (see [method set_physics_process_internal]).
</constant>
<constant name="NOTIFICATION_WM_MOUSE_ENTER" value="1002">
</constant>
<constant name="NOTIFICATION_WM_MOUSE_EXIT" value="1003">
</constant>
<constant name="NOTIFICATION_WM_FOCUS_IN" value="1004">
</constant>
<constant name="NOTIFICATION_WM_FOCUS_OUT" value="1005">
</constant>
<constant name="NOTIFICATION_WM_QUIT_REQUEST" value="1006">
</constant>
<constant name="NOTIFICATION_WM_GO_BACK_REQUEST" value="1007">
</constant>
<constant name="NOTIFICATION_WM_UNFOCUS_REQUEST" value="1008">
</constant>
<constant name="NOTIFICATION_OS_MEMORY_WARNING" value="1009">
</constant>
<constant name="NOTIFICATION_TRANSLATION_CHANGED" value="1010">
Notification received when translations may have changed. Can be triggered by the user changing the locale. Can be used to respond to language changes, for example to change the UI strings on the fly. Useful when working with the built-in translation support, like [method Object.tr].
</constant>
<constant name="NOTIFICATION_WM_ABOUT" value="1011">
</constant>
<constant name="NOTIFICATION_CRASH" value="1012">
</constant>
<constant name="NOTIFICATION_OS_IME_UPDATE" value="1013">
</constant>
<constant name="PAUSE_MODE_INHERIT" value="0" enum="PauseMode">
Inherits pause mode from the node's parent. For the root node, it is equivalent to PAUSE_MODE_STOP. Default.
</constant>

2
doc/classes/ProjectSettings.xml
View File

@ -215,6 +215,8 @@
<member name="audio/channel_disable_time" type="float" setter="" getter="">
Audio buses will disable automatically when sound goes below a given DB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing.
</member>
<member name="audio/default_bus_layout" type="String" setter="" getter="">
</member>
<member name="audio/driver" type="String" setter="" getter="">
</member>
<member name="audio/enable_audio_input" type="bool" setter="" getter="">

2
doc/classes/ResourceSaver.xml
View File

@ -27,7 +27,7 @@
</argument>
<argument index="1" name="resource" type="Resource">
</argument>
<argument index="2" name="flags" type="int" default="0">
<argument index="2" name="flags" type="int" enum="ResourceSaver.SaverFlags" default="0">
</argument>
<description>
Saves a resource to disk.

2
doc/classes/Spatial.xml
View File

@ -329,7 +329,7 @@
</signal>
</signals>
<constants>
<constant name="NOTIFICATION_TRANSFORM_CHANGED" value="29">
<constant name="NOTIFICATION_TRANSFORM_CHANGED" value="2000">
Spatial nodes receives this notification when their global transform changes. This means that either the current or a parent node changed its transform.
In order for [code]NOTIFICATION_TRANSFORM_CHANGED[/code] to work, users first need to ask for it, with [method set_notify_transform].
</constant>

2
doc/classes/String.xml
View File

@ -437,7 +437,7 @@
</return>
<description>
Returns [code]true[/code] if this string is free from characters that aren't allowed in file names, those being:
[code]: / \ ? * " | % < >[/code]
[code]: / \ ? * " | % &lt; &gt;[/code]
</description>
</method>
<method name="is_valid_float">

6
doc/classes/StyleBoxFlat.xml
View File

@ -148,12 +148,12 @@
<member name="shadow_color" type="Color" setter="set_shadow_color" getter="get_shadow_color">
The color of the shadow. (This has no effect when shadow_size &lt; 1)
</member>
<member name="shadow_size" type="int" setter="set_shadow_size" getter="get_shadow_size">
The shadow size in pixels.
</member>
<member name="shadow_offset" type="Vector2" setter="set_shadow_offset" getter="get_shadow_offset">
The shadow offset in pixels. Adjusts the position of the shadow relatively to the stylebox.
</member>
<member name="shadow_size" type="int" setter="set_shadow_size" getter="get_shadow_size">
The shadow size in pixels.
</member>
</members>
<constants>
</constants>

12
doc/classes/TextureRect.xml
View File

@ -16,18 +16,18 @@
<member name="expand" type="bool" setter="set_expand" getter="has_expand">
If [code]true[/code], the texture scales to fit its bounding rectangle. Default value: [code]false[/code].
</member>
<member name="stretch_mode" type="int" setter="set_stretch_mode" getter="get_stretch_mode" enum="TextureRect.StretchMode">
Controls the texture's behavior when resizing the node's bounding rectangle. See [enum StretchMode].
</member>
<member name="texture" type="Texture" setter="set_texture" getter="get_texture">
The node's [Texture] resource.
</member>
<member name="flip_h" type="bool" setter="set_flip_h" getter="is_flipped_h">
If [code]true[/code], texture is flipped horizontally. Default value: [code]false[/code].
</member>
<member name="flip_v" type="bool" setter="set_flip_v" getter="is_flipped_v">
If [code]true[/code], texture is flipped vertically. Default value: [code]false[/code].
</member>
<member name="stretch_mode" type="int" setter="set_stretch_mode" getter="get_stretch_mode" enum="TextureRect.StretchMode">
Controls the texture's behavior when resizing the node's bounding rectangle. See [enum StretchMode].
</member>
<member name="texture" type="Texture" setter="set_texture" getter="get_texture">
The node's [Texture] resource.
</member>
</members>
<constants>
<constant name="STRETCH_SCALE_ON_EXPAND" value="0" enum="StretchMode">

2
doc/classes/Thread.xml
View File

@ -34,7 +34,7 @@
</argument>
<argument index="2" name="userdata" type="Variant" default="null">
</argument>
<argument index="3" name="priority" type="int" default="1">
<argument index="3" name="priority" type="int" enum="Thread.Priority" default="1">
</argument>
<description>
Starts a new [Thread] that runs "method" on object "instance" with "userdata" passed as an argument. The "priority" of the [Thread] can be changed by passing a PRIORITY_* enum.

2
doc/classes/TileMap.xml
View File

@ -171,7 +171,7 @@
# Write your custom logic here.
# To call the default method:
.set_cell(x, y, tile, flip_x, flip_y, transpose, autotile_coord)
[/codeblock]
[/codeblock]
</description>
</method>
<method name="set_cellv">

4
doc/classes/Transform.xml
View File

@ -172,9 +172,9 @@
</constant>
<constant name="FLIP_X" value="Transform( -1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
</constant>
<constant name="FLIP_Y" value="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
<constant name="FLIP_Y" value="Transform( 1, 0, 0, 0, -1, 0, 0, 0, 1, 0, 0, 0 )">
</constant>
<constant name="FLIP_Z" value="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
<constant name="FLIP_Z" value="Transform( 1, 0, 0, 0, 1, 0, 0, 0, -1, 0, 0, 0 )">
</constant>
</constants>
</class>

19
doc/classes/VisualShaderNodeBooleanConstant.xml Normal file
View File

@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeBooleanConstant" inherits="VisualShaderNode" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<members>
<member name="constant" type="bool" setter="set_constant" getter="get_constant">
</member>
</members>
<constants>
</constants>
</class>

15
doc/classes/VisualShaderNodeBooleanUniform.xml Normal file
View File

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeBooleanUniform" inherits="VisualShaderNodeUniform" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<constants>
</constants>
</class>

23
doc/classes/VisualShaderNodeColorFunc.xml Normal file
View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeColorFunc" inherits="VisualShaderNode" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<members>
<member name="function" type="int" setter="set_function" getter="get_function" enum="VisualShaderNodeColorFunc.Function">
</member>
</members>
<constants>
<constant name="FUNC_GRAYSCALE" value="0" enum="Function">
</constant>
<constant name="FUNC_SEPIA" value="1" enum="Function">
</constant>
</constants>
</class>

15
doc/classes/VisualShaderNodeDeterminant.xml Normal file
View File

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeDeterminant" inherits="VisualShaderNode" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<constants>
</constants>
</class>

15
doc/classes/VisualShaderNodeFaceForward.xml Normal file
View File

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeFaceForward" inherits="VisualShaderNode" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<constants>
</constants>
</class>

15
doc/classes/VisualShaderNodeIf.xml Normal file
View File

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeIf" inherits="VisualShaderNode" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<constants>
</constants>
</class>

15
doc/classes/VisualShaderNodeOuterProduct.xml Normal file
View File

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeOuterProduct" inherits="VisualShaderNode" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<constants>
</constants>
</class>

15
doc/classes/VisualShaderNodeScalarClamp.xml Normal file
View File

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeScalarClamp" inherits="VisualShaderNode" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<constants>
</constants>
</class>

25
doc/classes/VisualShaderNodeScalarDerivativeFunc.xml Normal file
View File

@ -0,0 +1,25 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeScalarDerivativeFunc" inherits="VisualShaderNode" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<members>
<member name="function" type="int" setter="set_function" getter="get_function" enum="VisualShaderNodeScalarDerivativeFunc.Function">
</member>
</members>
<constants>
<constant name="FUNC_SUM" value="0" enum="Function">
</constant>
<constant name="FUNC_X" value="1" enum="Function">
</constant>
<constant name="FUNC_Y" value="2" enum="Function">
</constant>
</constants>
</class>

22
doc/classes/VisualShaderNodeScalarFunc.xml
View File

@ -55,5 +55,27 @@
</constant>
<constant name="FUNC_NEGATE" value="19" enum="Function">
</constant>
<constant name="FUNC_ACOSH" value="20" enum="Function">
</constant>
<constant name="FUNC_ASINH" value="21" enum="Function">
</constant>
<constant name="FUNC_ATANH" value="22" enum="Function">
</constant>
<constant name="FUNC_DEGREES" value="23" enum="Function">
</constant>
<constant name="FUNC_EXP2" value="24" enum="Function">
</constant>
<constant name="FUNC_INVERSE_SQRT" value="25" enum="Function">
</constant>
<constant name="FUNC_LOG2" value="26" enum="Function">
</constant>
<constant name="FUNC_RADIANS" value="27" enum="Function">
</constant>
<constant name="FUNC_RECIPROCAL" value="28" enum="Function">
</constant>
<constant name="FUNC_ROUNDEVEN" value="29" enum="Function">
</constant>
<constant name="FUNC_TRUNC" value="30" enum="Function">
</constant>
</constants>
</class>

2
doc/classes/VisualShaderNodeScalarOp.xml
View File

@ -33,5 +33,7 @@
</constant>
<constant name="OP_ATAN2" value="8" enum="Operator">
</constant>
<constant name="OP_STEP" value="9" enum="Operator">
</constant>
</constants>
</class>

15
doc/classes/VisualShaderNodeScalarSmoothStep.xml Normal file
View File

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeScalarSmoothStep" inherits="VisualShaderNode" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<constants>
</constants>
</class>

15
doc/classes/VisualShaderNodeSwitch.xml Normal file
View File

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeSwitch" inherits="VisualShaderNode" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<constants>
</constants>
</class>

23
doc/classes/VisualShaderNodeTransformFunc.xml Normal file
View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeTransformFunc" inherits="VisualShaderNode" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<members>
<member name="function" type="int" setter="set_function" getter="get_function" enum="VisualShaderNodeTransformFunc.Function">
</member>
</members>
<constants>
<constant name="FUNC_INVERSE" value="0" enum="Function">
</constant>
<constant name="FUNC_TRANSPOSE" value="1" enum="Function">
</constant>
</constants>
</class>

4
doc/classes/VisualShaderNodeTransformMult.xml
View File

@ -19,5 +19,9 @@
</constant>
<constant name="OP_BxA" value="1" enum="Operator">
</constant>
<constant name="OP_AxB_COMP" value="2" enum="Operator">
</constant>
<constant name="OP_BxA_COMP" value="3" enum="Operator">
</constant>
</constants>
</class>

15
doc/classes/VisualShaderNodeVectorClamp.xml Normal file
View File

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeVectorClamp" inherits="VisualShaderNode" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<constants>
</constants>
</class>

25
doc/classes/VisualShaderNodeVectorDerivativeFunc.xml Normal file
View File

@ -0,0 +1,25 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeVectorDerivativeFunc" inherits="VisualShaderNode" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<members>
<member name="function" type="int" setter="set_function" getter="get_function" enum="VisualShaderNodeVectorDerivativeFunc.Function">
</member>
</members>
<constants>
<constant name="FUNC_SUM" value="0" enum="Function">
</constant>
<constant name="FUNC_X" value="1" enum="Function">
</constant>
<constant name="FUNC_Y" value="2" enum="Function">
</constant>
</constants>
</class>

15
doc/classes/VisualShaderNodeVectorDistance.xml Normal file
View File

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeVectorDistance" inherits="VisualShaderNode" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<constants>
</constants>
</class>

56
doc/classes/VisualShaderNodeVectorFunc.xml
View File

@ -27,5 +27,61 @@
</constant>
<constant name="FUNC_HSV2RGB" value="5" enum="Function">
</constant>
<constant name="FUNC_ABS" value="6" enum="Function">
</constant>
<constant name="FUNC_ACOS" value="7" enum="Function">
</constant>
<constant name="FUNC_ACOSH" value="8" enum="Function">
</constant>
<constant name="FUNC_ASIN" value="9" enum="Function">
</constant>
<constant name="FUNC_ASINH" value="10" enum="Function">
</constant>
<constant name="FUNC_ATAN" value="11" enum="Function">
</constant>
<constant name="FUNC_ATANH" value="12" enum="Function">
</constant>
<constant name="FUNC_CEIL" value="13" enum="Function">
</constant>
<constant name="FUNC_COS" value="14" enum="Function">
</constant>
<constant name="FUNC_COSH" value="15" enum="Function">
</constant>
<constant name="FUNC_DEGREES" value="16" enum="Function">
</constant>
<constant name="FUNC_EXP" value="17" enum="Function">
</constant>
<constant name="FUNC_EXP2" value="18" enum="Function">
</constant>
<constant name="FUNC_FLOOR" value="19" enum="Function">
</constant>
<constant name="FUNC_FRAC" value="20" enum="Function">
</constant>
<constant name="FUNC_INVERSE_SQRT" value="21" enum="Function">
</constant>
<constant name="FUNC_LOG" value="22" enum="Function">
</constant>
<constant name="FUNC_LOG2" value="23" enum="Function">
</constant>
<constant name="FUNC_RADIANS" value="24" enum="Function">
</constant>
<constant name="FUNC_ROUND" value="25" enum="Function">
</constant>
<constant name="FUNC_ROUNDEVEN" value="26" enum="Function">
</constant>
<constant name="FUNC_SIGN" value="27" enum="Function">
</constant>
<constant name="FUNC_SIN" value="28" enum="Function">
</constant>
<constant name="FUNC_SINH" value="29" enum="Function">
</constant>
<constant name="FUNC_SQRT" value="30" enum="Function">
</constant>
<constant name="FUNC_TAN" value="31" enum="Function">
</constant>
<constant name="FUNC_TANH" value="32" enum="Function">
</constant>
<constant name="FUNC_TRUNC" value="33" enum="Function">
</constant>
</constants>
</class>

6
doc/classes/VisualShaderNodeVectorOp.xml
View File

@ -33,5 +33,11 @@
</constant>
<constant name="OP_CROSS" value="8" enum="Operator">
</constant>
<constant name="OP_ATAN2" value="9" enum="Operator">
</constant>
<constant name="OP_REFLECT" value="10" enum="Operator">
</constant>
<constant name="OP_STEP" value="11" enum="Operator">
</constant>
</constants>
</class>

15
doc/classes/VisualShaderNodeVectorRefract.xml Normal file
View File

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeVectorRefract" inherits="VisualShaderNode" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<constants>
</constants>
</class>

15
doc/classes/VisualShaderNodeVectorScalarSmoothStep.xml Normal file
View File

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeVectorScalarSmoothStep" inherits="VisualShaderNode" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<constants>
</constants>
</class>

15
doc/classes/VisualShaderNodeVectorScalarStep.xml Normal file
View File

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeVectorScalarStep" inherits="VisualShaderNode" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<constants>
</constants>
</class>

15
doc/classes/VisualShaderNodeVectorSmoothStep.xml Normal file
View File

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeVectorSmoothStep" inherits="VisualShaderNode" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<constants>
</constants>
</class>

8
modules/opensimplex/doc_classes/OpenSimplexNoise.xml
View File

@ -37,6 +37,14 @@
Generate a noise image with the requested [code]width[/code] and [code]height[/code], based on the current noise parameters.
</description>
</method>
<method name="get_noise_1d">
<return type="float">
</return>
<argument index="0" name="x" type="float">
</argument>
<description>
</description>
</method>
<method name="get_noise_2d">
<return type="float">
</return>