Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-01-21 01:11:20 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

doc: Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde 2019-05-28 18:08:13 +02:00
parent b71254a861
commit 3a365c1fc0
16 changed files with 379 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/classes/@GlobalScope.xml
View File

@ -45,6 +45,8 @@
<member name="Marshalls" type="Reference" setter="" getter="">
[Marshalls] singleton
</member>
<member name="NavigationMeshGenerator" type="EditorNavigationMeshGenerator" setter="" getter="">
</member>
<member name="OS" type="OS" setter="" getter="">
[OS] singleton
</member>

14
doc/classes/Camera.xml
View File

@ -18,6 +18,13 @@
If this is the current Camera, remove it from being current. If [code]enable_next[/code] is [code]true[/code], request to make the next Camera current, if any.
</description>
</method>
<method name="get_camera_rid" qualifiers="const">
<return type="RID">
</return>
<description>
Returns the camera's RID from the [VisualServer].
</description>
</method>
<method name="get_camera_transform" qualifiers="const">
<return type="Transform">
</return>
@ -39,13 +46,6 @@
<description>
</description>
</method>
<method name="get_camera_rid" qualifiers="const">
<return type="RID">
</return>
<description>
Returns the camera's RID from the [VisualServer].
</description>
</method>
<method name="is_position_behind" qualifiers="const">
<return type="bool">
</return>

2
doc/classes/Color.xml
View File

@ -566,6 +566,8 @@
</constant>
<constant name="tomato" value="Color( 1, 0.39, 0.28, 1 )">
</constant>
<constant name="transparent" value="Color( 1, 1, 1, 0 )">
</constant>
<constant name="turquoise" value="Color( 0.25, 0.88, 0.82, 1 )">
</constant>
<constant name="violet" value="Color( 0.93, 0.51, 0.93, 1 )">

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

@ -0,0 +1,31 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorNavigationMeshGenerator" inherits="Object" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="bake">
<return type="void">
</return>
<argument index="0" name="nav_mesh" type="NavigationMesh">
</argument>
<argument index="1" name="root_node" type="Node">
</argument>
<description>
</description>
</method>
<method name="clear">
<return type="void">
</return>
<argument index="0" name="nav_mesh" type="NavigationMesh">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>

28
doc/classes/NavigationMesh.xml
View File

@ -29,6 +29,14 @@
<description>
</description>
</method>
<method name="get_collision_mask_bit" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="bit" type="int">
</argument>
<description>
</description>
</method>
<method name="get_polygon">
<return type="PoolIntArray">
</return>
@ -49,6 +57,16 @@
<description>
</description>
</method>
<method name="set_collision_mask_bit">
<return type="void">
</return>
<argument index="0" name="bit" type="int">
</argument>
<argument index="1" name="value" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_vertices">
<return type="void">
</return>
@ -85,6 +103,10 @@
</member>
<member name="filter/low_hanging_obstacles" type="bool" setter="set_filter_low_hanging_obstacles" getter="get_filter_low_hanging_obstacles">
</member>
<member name="geometry/collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask">
</member>
<member name="geometry/parsed_geometry_type" type="int" setter="set_parsed_geometry_type" getter="get_parsed_geometry_type">
</member>
<member name="polygon/verts_per_poly" type="float" setter="set_verts_per_poly" getter="get_verts_per_poly">
</member>
<member name="region/merge_size" type="float" setter="set_region_merge_size" getter="get_region_merge_size">
@ -101,5 +123,11 @@
</constant>
<constant name="SAMPLE_PARTITION_LAYERS" value="2">
</constant>
<constant name="PARSED_GEOMETRY_MESH_INSTANCES" value="0">
</constant>
<constant name="PARSED_GEOMETRY_STATIC_COLLIDERS" value="1">
</constant>
<constant name="PARSED_GEOMETRY_BOTH" value="2">
</constant>
</constants>
</class>

24
doc/classes/OS.xml
View File

@ -97,6 +97,8 @@
</argument>
<argument index="3" name="output" type="Array" default="[ ]">
</argument>
<argument index="4" name="read_stderr" type="bool" default="false">
</argument>
<description>
Execute the file at the given path with the arguments passed as an array of strings. Platform path resolution will take place. The resolved file must exist and be executable.
The arguments are used in the given order and separated by a space, so [code]OS.execute('ping', ['-w', '3', 'godotengine.org'], false)[/code] will resolve to [code]ping -w 3 godotengine.org[/code] in the system's shell.
@ -701,17 +703,6 @@
The same image is used for window caption, taskbar/dock and window selection dialog. Image is scaled as needed.
</description>
</method>
<method name="set_native_icon">
<return type="void">
</return>
<argument index="0" name="filename" type="String">
</argument>
<description>
Sets the game's icon using a multi-size platform-specific icon file ([code]*.ico[/code] on Windows and [code]*.icns[/code] on macOS).
Appropriate size sub-icons are used for window caption, taskbar/dock and window selection dialog.
Note: This method is only implemented on macOS and Windows.
</description>
</method>
<method name="set_ime_active">
<return type="void">
</return>
@ -730,6 +721,17 @@
Sets position of IME suggestion list popup (in window coordinates).
</description>
</method>
<method name="set_native_icon">
<return type="void">
</return>
<argument index="0" name="filename" type="String">
</argument>
<description>
Sets the game's icon using a multi-size platform-specific icon file ([code]*.ico[/code] on Windows and [code]*.icns[/code] on macOS).
Appropriate size sub-icons are used for window caption, taskbar/dock and window selection dialog.
Note: This method is only implemented on macOS and Windows.
</description>
</method>
<method name="set_thread_name">
<return type="int" enum="Error">
</return>

4
doc/classes/ProjectSettings.xml
View File

@ -180,6 +180,8 @@
<member name="application/config/icon" type="String" setter="" getter="">
Icon used for the project, set when project loads. Exporters will also use this icon when possible.
</member>
<member name="application/config/macos_native_icon" type="String" setter="" getter="">
</member>
<member name="application/config/name" type="String" setter="" getter="">
The project's name. It is used both by the Project Manager and by exporters. The project name can be translated by translating its value in localization files.
</member>
@ -189,6 +191,8 @@
<member name="application/config/use_custom_user_dir" type="bool" setter="" getter="">
If [code]true[/code], the project will save user data to its own user directory (see [member application/config/custom_user_dir_name]). This setting is only effective on desktop platforms. A name must be set in the [member application/config/custom_user_dir_name] setting for this to take effect. If [code]false[/code], the project will save user data to [code](OS user data directory)/Godot/app_userdata/(project name)[/code].
</member>
<member name="application/config/windows_native_icon" type="String" setter="" getter="">
</member>
<member name="application/run/disable_stderr" type="bool" setter="" getter="">
If [code]true[/code], disables printing to standard error in an exported build.
</member>

6
doc/classes/SceneTree.xml
View File

@ -359,6 +359,12 @@
Emitted whenever a node is removed from the SceneTree.
</description>
</signal>
<signal name="node_renamed">
<argument index="0" name="node" type="Node">
</argument>
<description>
</description>
</signal>
<signal name="physics_frame">
<description>
Emitted immediately before [method Node._physics_process] is called on every node in the SceneTree.

6
doc/classes/SpatialMaterial.xml
View File

@ -120,6 +120,8 @@
<member name="flags_use_point_size" type="bool" setter="set_flag" getter="get_flag">
If [code]true[/code], render point size can be changed. Note: this is only effective for objects whose geometry is point-based rather than triangle-based. See also [member params_point_size].
</member>
<member name="flags_use_shadow_to_opacity" type="bool" setter="set_flag" getter="get_flag">
</member>
<member name="flags_vertex_lighting" type="bool" setter="set_flag" getter="get_flag">
If [code]true[/code], lighting is calculated per vertex rather than per pixel. This may increase performance on low-end devices. Default value: [code]false[/code].
</member>
@ -390,7 +392,9 @@
</constant>
<constant name="FLAG_ENSURE_CORRECT_NORMALS" value="16" enum="Flags">
</constant>
<constant name="FLAG_MAX" value="18" enum="Flags">
<constant name="FLAG_USE_SHADOW_TO_OPACITY" value="18" enum="Flags">
</constant>
<constant name="FLAG_MAX" value="19" enum="Flags">
</constant>
<constant name="DIFFUSE_BURLEY" value="0" enum="DiffuseMode">
Default diffuse scattering algorithm.

18
doc/classes/SurfaceTool.xml
View File

@ -169,6 +169,12 @@
Returns a constructed [ArrayMesh] from current information passed in. If an existing [ArrayMesh] is passed in as an argument, will add an extra surface to the existing [ArrayMesh].
</description>
</method>
<method name="commit_to_arrays">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="create_from">
<return type="void">
</return>
@ -180,6 +186,18 @@
Creates a vertex array from an existing [Mesh].
</description>
</method>
<method name="create_from_blend_shape">
<return type="void">
</return>
<argument index="0" name="existing" type="Mesh">
</argument>
<argument index="1" name="surface" type="int">
</argument>
<argument index="2" name="blend_shape" type="String">
</argument>
<description>
</description>
</method>
<method name="deindex">
<return type="void">
</return>

6
doc/classes/Tree.xml
View File

@ -271,6 +271,12 @@
Emitted when a cell with the [code]CELL_MODE_CUSTOM[/code] is clicked to be edited.
</description>
</signal>
<signal name="empty_rmb">
<argument index="0" name="position" type="Vector2">
</argument>
<description>
</description>
</signal>
<signal name="empty_tree_rmb_selected">
<argument index="0" name="position" type="Vector2">
</argument>

6
doc/classes/VehicleWheel.xml
View File

@ -9,6 +9,12 @@
<tutorials>
</tutorials>
<methods>
<method name="get_rpm" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_skidinfo" qualifiers="const">
<return type="float">
</return>

2
doc/classes/VisualServer.xml
View File

@ -3597,7 +3597,7 @@
get_viewport().set_attach_to_screen_rect(Rect2())
$Viewport.set_attach_to_screen_rect(Rect2(0, 0, 600, 600))
[/codeblock]
Using this can result in significant optimization, especially on lower-end devices. However, it comes at the cost of having to manage your viewports manually. For a further optimization see, [method set_render_direct_to_screen].
Using this can result in significant optimization, especially on lower-end devices. However, it comes at the cost of having to manage your viewports manually. For a further optimization see, [method viewport_set_render_direct_to_screen].
</description>
</method>
<method name="viewport_create">

22
doc/classes/VisualShader.xml
View File

@ -53,6 +53,22 @@
<description>
</description>
</method>
<method name="connect_nodes_forced">
<return type="void">
</return>
<argument index="0" name="type" type="int" enum="VisualShader.Type">
</argument>
<argument index="1" name="from_node" type="int">
</argument>
<argument index="2" name="from_port" type="int">
</argument>
<argument index="3" name="to_node" type="int">
</argument>
<argument index="4" name="to_port" type="int">
</argument>
<description>
</description>
</method>
<method name="disconnect_nodes">
<return type="void">
</return>
@ -129,6 +145,12 @@
<description>
</description>
</method>
<method name="rebuild">
<return type="void">
</return>
<description>
</description>
</method>
<method name="remove_node">
<return type="void">
</return>

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

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeExpression" inherits="VisualShaderNodeGroupBase" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="build">
<return type="void">
</return>
<description>
</description>
</method>
</methods>
<members>
<member name="expression" type="String" setter="set_expression" getter="get_expression">
</member>
</members>
<constants>
</constants>
</class>

205
doc/classes/VisualShaderNodeGroupBase.xml Normal file
View File

@ -0,0 +1,205 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeGroupBase" inherits="VisualShaderNode" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_input_port">
<return type="void">
</return>
<argument index="0" name="id" type="int">
</argument>
<argument index="1" name="type" type="int">
</argument>
<argument index="2" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="add_output_port">
<return type="void">
</return>
<argument index="0" name="id" type="int">
</argument>
<argument index="1" name="type" type="int">
</argument>
<argument index="2" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="clear_input_ports">
<return type="void">
</return>
<description>
</description>
</method>
<method name="clear_output_ports">
<return type="void">
</return>
<description>
</description>
</method>
<method name="get_control">
<return type="Control">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="get_free_input_port_id" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_free_output_port_id" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_input_port_count" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_inputs" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_output_port_count" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_outputs" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_size" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="has_input_port" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="id" type="int">
</argument>
<description>
</description>
</method>
<method name="has_output_port" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="id" type="int">
</argument>
<description>
</description>
</method>
<method name="remove_input_port">
<return type="void">
</return>
<argument index="0" name="id" type="int">
</argument>
<description>
</description>
</method>
<method name="remove_output_port">
<return type="void">
</return>
<argument index="0" name="id" type="int">
</argument>
<description>
</description>
</method>
<method name="set_control">
<return type="void">
</return>
<argument index="0" name="control" type="Control">
</argument>
<argument index="1" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="set_input_port_name">
<return type="void">
</return>
<argument index="0" name="arg0" type="int">
</argument>
<argument index="1" name="arg1" type="String">
</argument>
<description>
</description>
</method>
<method name="set_input_port_type">
<return type="void">
</return>
<argument index="0" name="arg0" type="int">
</argument>
<argument index="1" name="arg1" type="int">
</argument>
<description>
</description>
</method>
<method name="set_inputs">
<return type="void">
</return>
<argument index="0" name="inputs" type="String">
</argument>
<description>
</description>
</method>
<method name="set_output_port_name">
<return type="void">
</return>
<argument index="0" name="arg0" type="int">
</argument>
<argument index="1" name="arg1" type="String">
</argument>
<description>
</description>
</method>
<method name="set_output_port_type">
<return type="void">
</return>
<argument index="0" name="arg0" type="int">
</argument>
<argument index="1" name="arg1" type="int">
</argument>
<description>
</description>
</method>
<method name="set_outputs">
<return type="void">
</return>
<argument index="0" name="outputs" type="String">
</argument>
<description>
</description>
</method>
<method name="set_size">
<return type="void">
</return>
<argument index="0" name="size" type="Vector2">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>