Commit Graph

1074 Commits

Author SHA1 Message Date
Neil Moore 6cdf6d3044 Update Image format enumeration documentation
Provides more information about each image format.

(cherry picked from commit 60f1f58158)
2018-04-29 14:22:40 +02:00
Pieter-Jan Briers 1e8ff7460a Fixes a typo in the VisualServer.canvas_item_add_set_transform docs.
(cherry picked from commit 09f79cde69)
2018-04-28 22:58:29 +02:00
Michael Alexsander Silva Dias ca00323e7f Minor fixes for the AnimationPlayer doc.
(cherry picked from commit 9c3698dee2)
2018-04-28 22:48:28 +02:00
Will Vincent d49fc76ab8 Remove incorrect & potentially confusing references to Euler
e is referred to as Euler’s number, so technically the MATH_EXP description in VisualScript doc was not incorrect, though could potentially lead to confusion.

e is different from Euler’s constant however, making the existing GDScript exp & VisualScriptMathConstant descriptions nvalid.

(cherry picked from commit b6b8c7b215)
2018-04-28 22:47:43 +02:00
Pedro J. Estébanez 02f767fe0d Add support for radio-looking items with icon
Letting users of `PopupMenu` use them. `OptionButton` was one of those interested and is updated in this commit.

Fixes #18063.

(cherry picked from commit b964a9e678)
2018-04-28 22:17:08 +02:00
Pedro J. Estébanez a525ea128d Add radio-button-looking entries to PopupMenu
They work exactly the same as current checkbox-decorated items, but in order to preserve compatibility, separate methods are used, like `add_radio_check_item()`. The other option would have been to add a new parameter at the end of `add_check_item()` and the like, but that would have forced callers to provide the defaults manually.

`is_item_checkable()`, `is_item_checked()` and `set_item_checked()` are used regardless the item is set to look as check box or radio button.

Keeping check in the name adds an additional clue about these facts.

Closes #13055.

(cherry picked from commit ab3b1d9f3e)
2018-04-28 22:16:25 +02:00
Poommetee Ketson 287f169f2a [Docs] fix typos
(cherry picked from commit a88ee7d920)
2018-04-28 20:00:42 +02:00
Poommetee Ketson 5485939233 [DOCS] minor ParticlesMaterial docs fix Linear -> Radial
(cherry picked from commit 7d18334ad2)
2018-04-28 17:46:34 +02:00
Michael Alexsander Silva Dias 29a02a78df Fixed small typo in the "InstancePlaceholder" doc.
(cherry picked from commit 712d6e724a)
2018-04-28 17:31:08 +02:00
Geoffrey 5d7b7f798a Made print_tree_pretty() function which displays scene tree graphically
(cherry picked from commit 8362ce4769)
2018-04-14 19:56:55 +02:00
Pedro J. Estébanez 46101928bd Enhance HTTPClient.query_string_from_dict()
(cherry picked from commit 8d8e9d54c8)
2018-04-12 21:20:10 +02:00
Hugo Locurcio 209acbaac7 Add documentation for the DynamicFont hinting property
(cherry picked from commit a0ddd6122c)
2018-03-28 22:56:29 +02:00
Hein-Pieter van Braam 6ab8fb04af Fix documentation indentation for apply_torqe_impulse 2018-03-03 15:19:40 +01:00
Max Hilbrunner 649cb70ddb [DOCS] Small fix to Area: Fix copy/paste errors
(cherry picked from commit fdd0f18959)
2018-03-03 11:00:41 +01:00
Max Hilbrunner 5bcc7f88b6 [DOCS] Small fix to PinJoint2D
(cherry picked from commit 0b65bac1a1)
2018-03-03 01:55:33 +01:00
Poommetee Ketson c4468aef5d s/Camear/Camera in docs
(cherry picked from commit b099a500eb)
2018-03-03 01:52:12 +01:00
Hein-Pieter van Braam 7e5a374825 Deprecate a typo for a new method introduced in 3.0.1 2018-02-27 17:53:46 +01:00
Rémi Verschelde 2c55064708 doc: Sync with current source 2018-02-27 13:57:29 +01:00
Rémi Verschelde 42e82b9377 doc: Update version string for 3.0.2 2018-02-27 13:57:10 +01:00
indicainkwell 115c0a7415 added docs on Control's drag and drop api
(cherry picked from commit 7154a96d3f)
2018-02-27 11:32:35 +01:00
Hein-Pieter van Braam 5f15642fde Update doc version strings to 3.0.1 2018-02-24 18:59:38 +01:00
Poommetee Ketson fe38b648b0 [DOCS] clarify that OS.get_user_data_dir needs project name
[ci skip]

(cherry picked from commit 2c22c9dcfb)
2018-02-24 18:33:43 +01:00
Rémi Verschelde 46b594054c doc: Sync classref with current source 2018-02-22 19:02:37 +01:00
luz.paz 751806b5c7 Fix typos with codespell
Found via `codespell -q 3 --skip="./thirdparty,./editor/translations" -I ../godot-word-whitelist.txt`
Whitelist consists of:
```
ang
doubleclick
lod
nd
que
te
unselect
```

(cherry picked from commit 612ab4bbc6)
2018-02-22 12:17:06 +01:00
BastiaanOlij be6323d848 Added documentation for VehicleBody
(cherry picked from commit 234b86e6b2)
2018-02-22 12:03:10 +01:00
Hein-Pieter van Braam 99efa7ce62 Revert "Fix wrong return type of xform functions"
As this will change bindings API this will have to wait for 3.1

This reverts commit 187c40d64d.
2018-02-21 23:47:04 +01:00
Benjamin Stammen 7a20495a80 Direct to InputEventJoypadButton for using buttons
(cherry picked from commit 6af7dafd6c)
2018-02-19 22:37:09 +01:00
Michael Alexsander Silva Dias 237cf72f89 Made modifications to the RigidBody(2D) descriptions.
(cherry picked from commit 50e6b3c005)
2018-02-19 22:28:47 +01:00
Anish 5c2b2ca95b Documentation tool does not add escapes to code and codeblocks
Instead of adding the escapes to all * and _ the tool now excludes
the characters inside [code] and [codeblock].

Resolves: #15156
(cherry picked from commit 84e8c49f5d)
2018-02-19 22:28:03 +01:00
Michael Alexsander Silva Dias 9fb843db06 Added "allow_reselect" property to ItemList and enabled it for the method/help lists.
(cherry picked from commit 4dbf6ac1b8)
2018-02-19 22:21:14 +01:00
George Marques a39930c5b9 Add a function to remove controls from containers
Closes #5968

(cherry picked from commit da69a06253)
2018-02-19 22:18:22 +01:00
George Marques d54ac732ae Expose priority and order for custom import plugins
(cherry picked from commit c68948fdfa)
2018-02-19 22:16:13 +01:00
Andrew Silver 47b49200b0 Fixed KinematicBody move_and_slide documentation naming
(cherry picked from commit da81d9f843)
2018-02-19 22:13:46 +01:00
Michael Alexsander Silva Dias a0e9d751a3 Fixed wrong example in JSONParseResult.
(cherry picked from commit 24e87f97c6)
2018-02-19 22:13:45 +01:00
Max Hilbrunner 2515d42a14 [DOCS] parse_json: Objects do not keep key order
Document JSON not guaranteeing key order.

(cherry picked from commit 82b8f1729d)
2018-02-19 22:13:44 +01:00
Michael Alexsander Silva Dias 248fea2a79 Small fixes for the Control description in the docs.
(cherry picked from commit 5e0821e867)
2018-02-04 20:10:45 +01:00
Profesor Tartelett bd02969263 Errata fix on Image get_format() description
The description of this function seems to be duplicated from the preceding description.

(cherry picked from commit 9d735ffacb)
2018-02-04 20:07:19 +01:00
George Marques acf01c955f Expose a few GraphEdit methods to script languages
(cherry picked from commit b80bc73a17)
2018-02-04 20:05:47 +01:00
George Marques 0a75a38db4 Add interface for plugins to enable/disable other plugins
(cherry picked from commit 87be0bc110)
2018-02-04 20:05:12 +01:00
Chaosus 780a7a281b Viewport doc improvements
(cherry picked from commit ffcbb0c358)
2018-02-04 20:02:38 +01:00
Marlon Henry Schweigert 5481ece976 Display set_nodelay to GDScript
Pass enabled arg

Rename set_nodelay to set_no_delay

Add description to the method

Change description

(cherry picked from commit 87adf9cfba)
2018-02-04 20:02:04 +01:00
Poommetee Ketson 187c40d64d Fix wrong return type of xform functions
(cherry picked from commit ebe2337515)
2018-01-30 20:55:41 +01:00
volzhs a62d8de062 Update ProjectSettings description to correct usage
Fix #16078
2018-01-26 17:17:53 +09:00
Rémi Verschelde f2e3825616 doc: Fix references to online tutorials after godotengine/godot-docs#1015 2018-01-25 09:03:59 +01:00
Rémi Verschelde d516aab8fa doc: Sync with current source
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018
and fix the version tag in all files (not really stable yet, but it makes no sense
to hardcode rc3 at this stage).
2018-01-25 08:50:56 +01:00
Rémi Verschelde 4808dfb06b doc: Sync with current source 2018-01-24 21:58:39 +01:00
Chaosus 70bba4e62d Fix bug in color doc 2018-01-24 23:39:36 +03:00
PetePete1984 f4d67433e7 More precise description for is_visible_in_tree 2018-01-22 16:22:17 +01:00
Todd Ross b57dcf446e clarify OS.execute usage, add examples 2018-01-20 18:36:00 -06:00
Anutrix 6d4c6449f4 Added description to dedent in String.xml 2018-01-19 15:57:38 +05:30
Poommetee Ketson d7e07fb25a
Merge pull request #15857 from YeldhamDev/find_last_doc
[DOCS] Fixed incorrect information inside String's "find_last" method

[ci skip]
2018-01-19 10:22:21 +07:00
Michael Alexsander Silva Dias d8f6acee4b [DOCS] Fixed incorrect information inside String's "find_last" method. 2018-01-19 00:10:33 -02:00
Rémi Verschelde 9f479f096c Fix typos in code and docs with codespell
Using v1.11.0 from https://github.com/lucasdemarchi/codespell
2018-01-18 22:01:42 +01:00
Rémi Verschelde f2a26fba96
Merge pull request #15845 from Anutrix/master
Added description to get_collision_mask_bit and set_collision_mask_bit in RayCast2D.xml
2018-01-18 19:13:23 +01:00
Abhas Kumar Sinha 1a1303a948 Update MultiMeshInstance and WorldEnvironment documentation
With some edits by @akien-mga.
2018-01-18 19:11:33 +01:00
Anutrix 0ec8f4c06b Added description to get_collision_mask_bit and set_collision_mask_bit in RayCast2D.xml 2018-01-18 23:14:31 +05:30
Chaosus fc5cc57d82 few doc fixes 2018-01-17 13:28:59 +03:00
Rémi Verschelde 6c46787749 doc: Replace some more "val" with "value" + sync 2018-01-17 10:43:23 +01:00
Chaosus 0c9312c6b8 Fixes for parameter names of builtin functions in visual scripts/core 2018-01-16 19:49:45 +03:00
Michael Alexsander Silva Dias 0dce89c862 [DOCS] Description for the JavaScript singleton in @GlobalScope. 2018-01-15 21:15:04 -02:00
Juan Linietsky 03475ba197 Filled tutorial field in most relevent classes.
Added tutorial display in doc.
2018-01-15 18:41:13 -03:00
Bojidar Marinov f2355949c4
Fix an issue with the animation editor not seeking to the target time properly.
Fixes #15646.
2018-01-14 12:28:57 +02:00
Rémi Verschelde c01575b312 doc: Sync with current source 2018-01-13 11:43:49 +01:00
Rémi Verschelde e28cdc4654 doc: Update version string in XML 2018-01-13 11:43:42 +01:00
letheed 524ee14054 Small fix for Control bindings 2018-01-13 09:40:42 +01:00
Grosskopf a9b18041fc Added some explanations that should make it easier to use the AnimationTreePlayer 2018-01-12 19:26:03 +01:00
Juan Linietsky a26e6c8215 Renamed tree_exited to tree_exiting. tree_exited is now used for actual out of tree notification.
Updated doc accordingly.
2018-01-12 08:29:24 -03:00
Rémi Verschelde baef1e71c7 Fix malformed doc after #15611 2018-01-12 09:03:11 +01:00
Bojidar Marinov ad79c70300
Update docs
[ci skip]
2018-01-12 00:58:22 +02:00
Juan Linietsky e633a04c42 Update documentation to clarify that list of overlaps is not updated immediately. 2018-01-11 11:19:12 -03:00
Rémi Verschelde 415d128249
Merge pull request #15530 from akien-mga/signal-args
Fix signal arguments shadowing member variables
2018-01-10 10:38:28 +01:00
Rémi Verschelde 7251c5b582 Improve Control and Label documentation about mouse filtering
Fixes #9657.
2018-01-09 17:40:19 +01:00
Rémi Verschelde 52165fa12d Fix bindings of EditorSettings.set_initial_value
Also ran doctool.
2018-01-09 16:52:46 +01:00
Rémi Verschelde 4b6bef6524 Fix signal arguments shadowing member variables
Fixes #10212.
2018-01-09 16:51:19 +01:00
Todd Ross 6e932c3108 obsolete UndoRedo max_steps; no users identified 2018-01-08 10:57:07 -06:00
Rémi Verschelde efe27c6ed2
Merge pull request #15491 from volzhs/doc-kinematicbody
Fix KinematicBody documentation about move_and_slide
2018-01-08 17:09:06 +01:00
volzhs e04a9cdf6e Fix KinematicBody documentation about move_and_slide 2018-01-09 01:05:28 +09:00
Jerome67000 feef8615d2 Add standardised color names to doc 2018-01-08 11:55:49 +01:00
Rémi Verschelde b5b2ca8143
Merge pull request #15423 from agmcleod/master
Documentation interpolation functions - Indicate what "t" means in interpolation docs
2018-01-07 14:27:28 +01:00
Rémi Verschelde 29e68aa40e doc: Sync classref with current source 2018-01-07 01:37:45 +01:00
Aaron McLeod b04610b5e7 Indicate what "t" means in interpolation docs 2018-01-06 18:28:21 -05:00
Jerome67000 b5885c43eb Fix crash when using Image.resize() without calling Image.create() first 2018-01-06 13:20:45 +01:00
Rémi Verschelde 1f382ba434
Merge pull request #15333 from PJB3005/18-01-04-control-mouse-filter-docs
Document Control.mouse_filter and its constants.
2018-01-04 19:51:41 +01:00
PJB3005 305ab94431 Document Control.mouse_filter and its constants. 2018-01-04 18:20:19 +01:00
Rémi Verschelde 913777b773
Merge pull request #14914 from fodinabor/fix13254
Enum members now also link to the corresponding class in the webdocs
2018-01-04 15:00:06 +01:00
Rémi Verschelde 914f51031c doc: Sync classref with current source 2018-01-04 01:48:24 +01:00
Rémi Verschelde f9f6f250e6
Merge pull request #15191 from Jerome67000/z_renaming
renames "z" Node2D property to "z_index"
2018-01-04 00:41:45 +01:00
Rémi Verschelde 8d03cafd7c doc: Sync classref with current source 2018-01-03 13:45:03 +01:00
Jerome67000 42ae3525a3 #15078 renamed "z" -> "z_index" property in Node2D 2018-01-03 13:02:26 +01:00
Rémi Verschelde 4be31e37b0
Merge pull request #15157 from Noshyaar/prdocs
[DOCS] Minor docs fix
2018-01-03 12:17:06 +01:00
Rémi Verschelde 6322b0bbb7
Merge pull request #12814 from guilhermefelipecgs/add_hardware_custom_cursor
Custom hardware-accelerated mouse cursor
2018-01-03 08:35:59 +01:00
Juan Linietsky 14772d2213
Merge pull request #15083 from tagcup/spatial_rot_fix
Restore the behavior of Spatial rotations recently changed in c1153f5.
2018-01-02 15:02:19 -03:00
Andrew Silver 0c57394d6e Updated timer docs 2017-12-31 20:13:25 +01:00
Poommetee Ketson 7753b8ba0f
Minor docs fix 2017-12-31 03:19:52 +07:00
Noshyaar ef2ab0de82
Merge pull request #15006 from CyanBlob/master
Update TileMap doc descriptions for update_bitmask_area/region

[ci skip]
2017-12-28 06:52:37 +07:00
tagcup e9896b17a9 Restore the behavior of Spatial rotations recently changed in c1153f5.
That change was borne out of a confusion regarding the meaning of "local" in #14569.

Affine transformations in Spatial simply correspond to affine operations of its Transform. Such operations take place in a coordinate system that is defined by the parent Spatial. When there is no parent, they correspond to operations in the global coordinate system.
This coordinate system, which is relative to the parent, has been referred to as the local coordinate system in the docs so far, but this sloppy language has apparently confused some users, making them think that the local coordinate system refers to the one whose axes are "painted" on the Spatial node itself.

To avoid such conceptual conflations and misunderstandings in the future, the parent-relative local system is now referred to as "parent-local", and the object-relative local system is called "object-local" in the docs.

This commit adds the functionality "requested" in #14569, not by changing how rotate/scale/translate works, but by adding new rotate_object_local, scale_object_local and translate_object_local functions. Also, for completeness, there is now global_scale.

This commit also updates another part of the docs regarding the rotation property of Spatial, which also leads to confusion among some users.
2017-12-27 16:40:49 -05:00
Andrew Thomas 9ac312f17a Update TileMap doc descriptions for update_bitmask_area/region 2017-12-27 14:16:05 -06:00
Noshyaar 07d0f2e72b
Merge pull request #15046 from YeldhamDev/optionbutton_changes
Added "get_popup" method for OptionButton
2017-12-27 10:22:22 +07:00
Noshyaar 198bb5309d
Merge pull request #15049 from YeldhamDev/get_popup_const
Made MenuButton and ColorPickerButton's "get_popup" methods return constant
2017-12-27 10:20:56 +07:00
homer666 cef20a134e [DOCS] PhysicsDirectSpaceState enhancements 2017-12-27 07:41:50 +11:00