Forráskód Böngészése

Sync classref with current source

Rémi Verschelde 7 éve
szülő
commit
97d7e0224c

+ 1 - 1
classes/class_canvasitem.rst

@@ -418,7 +418,7 @@ Returns ``true`` if global transform notifications are communicated to children.
 
 - :ref:`bool<class_bool>` **is_visible_in_tree** **(** **)** const
 
-Returns ``true`` if the node is in the :ref:`SceneTree<class_scenetree>` and is visible on-screen.
+Returns ``true`` if the node is present in the :ref:`SceneTree<class_scenetree>`, its :ref:`visible<class_CanvasItem_visible>` property is ``true`` and its inherited visibility is also ``true``.
 
 .. _class_CanvasItem_make_canvas_position_local:
 

+ 1 - 3
classes/class_color.rst

@@ -276,8 +276,6 @@ Returns the color's 32-bit integer in ARGB format (each byte represents a compon
     var c = Color(1, .5, .2)
     print(str(c.to_32())) # prints 4294934323
 
-
-
-*This is same as :ref:`to_ARGB32<class_Color_to_ARGB32>` but may be changed later to support RGBA format instead*.
+*This is same as :ref:`to_argb32<class_Color_to_argb32>` but may be changed later to support RGBA format instead*.
 
 

+ 18 - 1
classes/class_os.rst

@@ -351,7 +351,24 @@ At the end of the file is a statistic of all used Resource Types.
 
 - :ref:`int<class_int>` **execute** **(** :ref:`String<class_string>` path, :ref:`PoolStringArray<class_poolstringarray>` arguments, :ref:`bool<class_bool>` blocking, :ref:`Array<class_array>` output=[  ] **)**
 
-Execute the binary file in given path, optionally blocking until it returns. A process ID is returned.
+Execute the file at the given path, optionally blocking until it returns.
+
+Platform path resolution will take place.  The resolved file must exist and be executable.
+
+Returns a process id.
+
+For example:
+
+::
+
+    var output = []
+    var pid = OS.execute('ls', [], true, output)
+
+If you wish to access a shell built-in or perform a composite command, a platform specific shell can be invoked.  For example:
+
+::
+
+    var pid = OS.execute('CMD.exe', ['/C', 'cd %TEMP% && dir'], true, output)
 
 .. _class_OS_find_scancode_from_string:
 

+ 1 - 1
classes/class_projectsettings.rst

@@ -54,7 +54,7 @@ Member Functions
 Description
 -----------
 
-Contains global variables accessible from everywhere. Use the normal :ref:`Object<class_object>` API, such as "ProjectSettings.get(variable)", "ProjectSettings.set(variable,value)" or "ProjectSettings.has(variable)" to access them. Variables stored in project.godot are also loaded into ProjectSettings, making this object very useful for reading custom game configuration options.
+Contains global variables accessible from everywhere. Use "ProjectSettings.get_setting(variable)", "ProjectSettings.set_setting(variable,value)" or "ProjectSettings.has_setting(variable)" to access them. Variables stored in project.godot are also loaded into ProjectSettings, making this object very useful for reading custom game configuration options.
 
 Member Function Description
 ---------------------------

+ 1 - 1
classes/class_rigidbody.rst

@@ -202,7 +202,7 @@ Called during physics processing, allowing you to read and safely modify the sim
 
 - void **apply_impulse** **(** :ref:`Vector3<class_vector3>` position, :ref:`Vector3<class_vector3>` impulse **)**
 
-Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the offset from the body origin are in global coordinates.
+Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the position are in global coordinates, and the position is relative to the object's origin.
 
 .. _class_RigidBody_get_colliding_bodies:
 

+ 3 - 1
classes/class_string.rst

@@ -387,6 +387,8 @@ Performs a case-sensitive comparison to another string. Returns ``-1`` if less t
 
 - :ref:`String<class_string>` **dedent** **(** **)**
 
+Removes indentation from string.
+
 .. _class_String_empty:
 
 - :ref:`bool<class_bool>` **empty** **(** **)**
@@ -415,7 +417,7 @@ Finds the first occurrence of a substring. Returns the starting position of the
 
 - :ref:`int<class_int>` **find_last** **(** :ref:`String<class_string>` what **)**
 
-Finds the last occurrence of a substring. Returns the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed.
+Finds the last occurrence of a substring. Returns the starting position of the substring or -1 if not found.
 
 .. _class_String_findn:
 

+ 3 - 3
classes/class_tween.rst

@@ -70,19 +70,19 @@ Signals
 
 .. _class_Tween_tween_completed:
 
-- **tween_completed** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key **)**
+- **tween_completed** **(** :ref:`Object<class_object>` object, :ref:`NodePath<class_nodepath>` key **)**
 
 This signal is emitted when a tween ends.
 
 .. _class_Tween_tween_started:
 
-- **tween_started** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key **)**
+- **tween_started** **(** :ref:`Object<class_object>` object, :ref:`NodePath<class_nodepath>` key **)**
 
 This signal is emitted when a tween starts.
 
 .. _class_Tween_tween_step:
 
-- **tween_step** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key, :ref:`float<class_float>` elapsed, :ref:`Object<class_object>` value **)**
+- **tween_step** **(** :ref:`Object<class_object>` object, :ref:`NodePath<class_nodepath>` key, :ref:`float<class_float>` elapsed, :ref:`Object<class_object>` value **)**
 
 This signal is emitted each step of the tweening.
 

+ 3 - 3
classes/class_visualserver.rst

@@ -168,7 +168,7 @@ Member Functions
 +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | void                                       | :ref:`force_sync<class_VisualServer_force_sync>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| void                                       | :ref:`free<class_VisualServer_free>` **(** :ref:`RID<class_rid>` rid **)**                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+| void                                       | :ref:`free_rid<class_VisualServer_free_rid>` **(** :ref:`RID<class_rid>` rid **)**                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | :ref:`int<class_int>`                      | :ref:`get_render_info<class_VisualServer_get_render_info>` **(** :ref:`int<class_int>` info **)**                                                                                                                                                                                                                                                                                                                                                                                                                        |
 +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -1108,9 +1108,9 @@ Draws a frame. Same as :ref:`draw<class_VisualServer_draw>`.
 
 Syncronizes threads.
 
-.. _class_VisualServer_free:
+.. _class_VisualServer_free_rid:
 
-- void **free** **(** :ref:`RID<class_rid>` rid **)**
+- void **free_rid** **(** :ref:`RID<class_rid>` rid **)**
 
 Tries to free an object in the VisualServer.