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-10-26 16:40:31 +02:00
parent cbfb944a7b
commit aa0fa6b14f
8 changed files with 91 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
doc/classes/CanvasItem.xml
View file

@ -22,6 +22,28 @@
Called (if exists) to draw the canvas item.
</description>
</method>
<method name="draw_arc">
<return type="void">
</return>
<argument index="0" name="center" type="Vector2">
</argument>
<argument index="1" name="radius" type="float">
</argument>
<argument index="2" name="start_angle" type="float">
</argument>
<argument index="3" name="end_angle" type="float">
</argument>
<argument index="4" name="point_count" type="int">
</argument>
<argument index="5" name="color" type="Color">
</argument>
<argument index="6" name="width" type="float" default="1.0">
</argument>
<argument index="7" name="antialiased" type="bool" default="false">
</argument>
<description>
</description>
</method>
<method name="draw_char">
<return type="float">
</return>

22
doc/classes/EditorSpinSlider.xml Normal file
View file

@ -0,0 +1,22 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorSpinSlider" inherits="Range" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="flat" type="bool" setter="set_flat" getter="is_flat" default="false">
</member>
<member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" override="true" enum="Control.FocusMode" default="2" />
<member name="label" type="String" setter="set_label" getter="get_label" default="&quot;&quot;">
</member>
<member name="read_only" type="bool" setter="set_read_only" getter="is_read_only" default="false">
</member>
</members>
<constants>
</constants>
</class>

2
doc/classes/OS.xml
View file

@ -217,7 +217,7 @@
Returns the path to the current engine executable.
</description>
</method>
<method name="get_granted_permissions">
<method name="get_granted_permissions" qualifiers="const">
<return type="PoolStringArray">
</return>
<description>

30
doc/classes/RichTextLabel.xml
View file

@ -133,6 +133,18 @@
Adds an [code][align][/code] tag based on the given [code]align[/code] value. See [enum Align] for possible values.
</description>
</method>
<method name="push_bold">
<return type="void">
</return>
<description>
</description>
</method>
<method name="push_bold_italics">
<return type="void">
</return>
<description>
</description>
</method>
<method name="push_cell">
<return type="void">
</return>
@ -167,6 +179,12 @@
Adds an [code][indent][/code] tag to the tag stack. Multiplies "level" by current tab_size to determine new margin length.
</description>
</method>
<method name="push_italics">
<return type="void">
</return>
<description>
</description>
</method>
<method name="push_list">
<return type="void">
</return>
@ -185,6 +203,18 @@
Adds a [code][meta][/code] tag to the tag stack. Similar to the BBCode [code][url=something]{text}[/url][/code], but supports non-[String] metadata types.
</description>
</method>
<method name="push_mono">
<return type="void">
</return>
<description>
</description>
</method>
<method name="push_normal">
<return type="void">
</return>
<description>
</description>
</method>
<method name="push_strikethrough">
<return type="void">
</return>

2
doc/classes/TextEdit.xml
View file

@ -530,7 +530,7 @@
</constant>
</constants>
<theme_items>
<theme_item name="background_color" type="Color" default="Color( 0, 0, 0, 1 )">
<theme_item name="background_color" type="Color" default="Color( 0, 0, 0, 0 )">
Sets the background [Color] of this [TextEdit]. [member syntax_highlighting] has to be enabled.
</theme_item>
<theme_item name="bookmark_color" type="Color" default="Color( 0.08, 0.49, 0.98, 1 )">

2
doc/classes/VideoPlayer.xml
View file

@ -16,7 +16,7 @@
Returns the video stream's name.
</description>
</method>
<method name="get_video_texture">
<method name="get_video_texture" qualifiers="const">
<return type="Texture">
</return>
<description>

6
doc/classes/VisualShaderNodeCubeMap.xml
View file

@ -12,10 +12,16 @@
<member name="cube_map" type="CubeMap" setter="set_cube_map" getter="get_cube_map">
</member>
<member name="default_input_values" type="Array" setter="_set_default_input_values" getter="_get_default_input_values" override="true" default="[ ]" />
<member name="source" type="int" setter="set_source" getter="get_source" enum="VisualShaderNodeCubeMap.Source" default="0">
</member>
<member name="texture_type" type="int" setter="set_texture_type" getter="get_texture_type" enum="VisualShaderNodeCubeMap.TextureType" default="0">
</member>
</members>
<constants>
<constant name="SOURCE_TEXTURE" value="0" enum="Source">
</constant>
<constant name="SOURCE_PORT" value="1" enum="Source">
</constant>
<constant name="TYPE_DATA" value="0" enum="TextureType">
</constant>
<constant name="TYPE_COLOR" value="1" enum="TextureType">

8
modules/gridmap/doc_classes/GridMap.xml
View file

@ -217,6 +217,14 @@
Deprecated, use [member mesh_library] instead.
</member>
</members>
<signals>
<signal name="cell_size_changed">
<argument index="0" name="cell_size" type="Vector3">
</argument>
<description>
</description>
</signal>
</signals>
<constants>
<constant name="INVALID_CELL_ITEM" value="-1">
Invalid cell item that can be used in [method set_cell_item] to clear cells (or represent an empty cell in [method get_cell_item]).