Commit Graph

268 Commits

Author SHA1 Message Date
Rémi Verschelde 22d1385caf classref: Directory and ConfigFile 2016-05-12 08:41:43 +02:00
Rémi Verschelde 2fbf4f563b classref: Sync with current source 2016-05-12 08:31:53 +02:00
Paulb23 997476777a Updated caret blink method documentation 2016-05-11 17:55:59 +01:00
Rémi Verschelde bc31be9812 Sync classes.xml with current sources
Also fix a typo in the binding of Control::set_drag_forwarding.
2016-05-09 22:20:35 +02:00
Daniel J. Ramirez cb0be4adaa Documented @GlobalScope singletons and some keys 2016-05-05 14:04:42 -05:00
Daniel J. Ramirez ed7c0a6caf Partial documentation for OS methods 2016-05-05 12:46:31 -05:00
Daniel J. Ramirez f558b4003b Documented LinkButton 2016-05-05 11:23:25 -05:00
CowThing f6ae5e41de Input Documentation
Input Documentation
2016-05-03 14:44:58 -04:00
Rémi Verschelde 5b039245b9 Sync class reference 2016-05-03 19:35:01 +02:00
Daniel J. Ramirez 3ca1d0f1d5 Documented bool methods 2016-05-02 13:32:29 -05:00
Rémi Verschelde 1d9c4c559b Merge pull request #4529 from djrm/classref-float
Documented float
2016-05-02 20:14:28 +02:00
Daniel J. Ramirez 520e6f5b09 Documented float 2016-05-02 13:11:14 -05:00
Daniel J. Ramirez 4453284388 Documented int methods 2016-05-02 12:44:30 -05:00
CowThing abf5f8c586 Finished AnimationPlayer Documentation
Finished AnimationPlayer Documentation
2016-05-02 12:16:59 -04:00
CowThing bf13410626 Finished Timer Documentation
Finished Timer Documentation
2016-05-02 11:10:31 -04:00
CowThing 957c265f11 Documented YSort (#4515)
Documented YSort
2016-05-01 23:55:24 +02:00
Daniel J. Ramirez c2bdb3727b Documented ColorRamp 2016-05-01 13:34:25 -05:00
Daniel J. Ramirez 3cd58fe0ba Partial documentation for Particles2D 2016-05-01 12:36:45 -05:00
Bojidar Marinov 5cdf4a6379 Document Popup, PopupDialog, PopupMenu, and PopupPanel 2016-05-01 17:52:42 +03:00
Rémi Verschelde 18c09acf9f classref: Run doctool and merge BitmapFont
BitmapFont was split from the Font class, so the relevant method
descriptions were readded manually.
2016-04-29 18:28:07 +02:00
Geequlim a518792d89 Add more documentations for this classes:
* BoxContainer
* CenterContainer
* ScrollContainer
* SplitContainer
* Vector2
* StringArray
* FileDiloags
2016-04-29 22:27:16 +08:00
Rémi Verschelde a0dce1e66f Merge pull request #4482 from Geequlim/master
Add more documentations and fix AcceptDialog::add_cancel
2016-04-29 10:43:50 +02:00
Geequlim 5c61e17c10 Add more documentations and fix AcceptDialog::add_cancel 2016-04-29 16:34:07 +08:00
Rémi Verschelde c97cc362e3 Merge pull request #4387 from JoshuaGrams/rigidbody2d-torque
Hooked up RigidBody2D torque methods
2016-04-29 10:29:12 +02:00
Geequlim 4de3f8944e Fill in the blank in the Array, CenterContainer and Dictionary class reference (#4476) 2016-04-29 07:32:13 +02:00
Daniel J. Ramirez faf21b81e8 Documentation for Canvas Modulate, ColorPicker, ColorPickerButton 2016-04-29 07:27:18 +02:00
Rémi Verschelde 0485c9eaba Merge pull request #4451 from JoshuaGrams/anim-tree-filter
Anim tree: add filters on Animation nodes
2016-04-28 20:48:38 +02:00
Daniel Ramirez 9f29b4b26a Partial documentation for Polygon2D and Raycast2D (#4467) 2016-04-28 10:14:55 +02:00
Rémi Verschelde 3a4ec88b37 Classref: Document Button and ButtonArray
Also bind relevant constants and define some object types and better
argument names for the docs.
2016-04-28 00:10:17 +02:00
Rémi Verschelde e9a5471ee1 Merge pull request #4461 from djrm/classref-edit
Added GridContainer documentation
2016-04-27 23:49:52 +02:00
Daniel J. Ramirez a5b4c1d64f GridContainer, CheckBox documentation, descriptions for Vector2 and CenterContainer.set_use_top_left 2016-04-27 16:09:48 -05:00
Jan Heemstra e301ca3544 fixed some mistakes in WeakRef documentation 2016-04-27 17:27:01 +02:00
Jan Heemstra edff81c214 Documented WeakRef and member functions 2016-04-27 16:10:10 +02:00
Jan Heemstra f2a73816c2 Sync classes reference template with current code base 2016-04-27 15:19:12 +02:00
Julian Murgia - StraToN 87aa128228 Documented Node2D 2016-04-26 23:19:45 +02:00
Josh Grams a7b4127481 RigidBody2D (add_force, set_inertia): new methods. 2016-04-26 08:15:15 -04:00
Josh Grams bd95e18ae4 AnimationTree: add filters to Animation nodes. 2016-04-26 06:49:06 -04:00
Julian Murgia 81e405545b Edited classes.xml : GraphEdit finished (#4450) 2016-04-26 12:48:47 +02:00
Josh Grams f7d31cec38 RigidBody2D: add and bind get_inertia() method.
You can't set this value very well, since it's automatically computed
from the mass and the collision shapes. But since the values are higher
than many people might suspect, so being able to read it helps estimate
the amount of torque you might need to apply.
2016-04-20 20:49:37 -04:00
Josh Grams dbabe4c07c RigidBody2D: add and bind get/set_applied_torque. 2016-04-20 19:49:35 -04:00
Alexander Holland a379ed56ea string ends_with 2016-04-17 23:49:21 +02:00
Rémi Verschelde d454e64f42 Sync docs with source 2016-04-07 21:27:29 +02:00
Josh Grams ef08fed277 doc/base/classes.xml: String.match, Node.find_node
Clarify wildcard behavior.
2016-03-27 08:21:14 -04:00
Kyle Luce 674c6f2f2d Add function to convert Date time from a dictionary to Epoch
- Also changed get_time_from_unix_time to get_date_time_from_unix_time to be
  consistent.

Ticket:
https://github.com/godotengine/godot/issues/4038
2016-03-16 23:13:39 -07:00
Kyle Luce feef563f3f Fixes the month consistency issue in enums and get_date etc
- Also updated the docs to reflect this.
- Added some vim temp files to gitignore
- Changed NaCL to be consistent with the other OS_Unix::get_date implementation
   (added 1 to month to map to 1-12)

Ticket:
https://github.com/godotengine/godot/issues/4025
2016-03-13 15:27:39 -07:00
Bojidar Marinov 0e8a8d2cb1 Add option to keep margins when changing anchors, closes #3979
Amend: Fixed an issue for non-tool builds
Amend2: Same, just fixed doing nothing at some times
2016-03-09 21:14:17 +02:00
Rémi Verschelde 32bb7a04a2 Merge pull request #3833 from AlexHolly/feature-file-md5
expose md5 for file(s) to gdscript
2016-03-08 19:32:33 +01:00
hondres 1b806ef54e doc: fix joystick left/right trigger axis description (index 6/7 instead of 4/5) 2016-03-06 13:40:37 +01:00
Martin Chuckeles ff7c89ebaf Add more verbose build-in functions descriptions
Add descriptions for some global constants
2016-03-06 10:34:07 +01:00
Martin Chuckeles cd1184d56c Write GDScript documentation 2016-03-05 15:06:31 +01:00
Stabington 6b7ec5de69 set_time_scale docs
This is correct?
2016-03-03 10:07:10 +01:00
Rémi Verschelde 002ff3cc9a Revert "Merge pull request #3814 from est31/iterators_for_for"
This reverts commit adf5056889, reversing
changes made to ee2bc87c0e.
2016-03-01 18:09:48 +01:00
Rémi Verschelde a12c63ef9e Quick fixes to tween documentation formatting
Maybe the reST parser should be improved instead though ;)
2016-03-01 08:37:35 +01:00
Juan Linietsky 640443be6a Merge pull request #3864 from leezh/editorplugin_extras
Adds EditorPlugin::remove_control_from_bottom_panel()
2016-02-28 23:11:37 -03:00
est31 f81153eb69 Add xrange builtin function
Also update classes.xml in order to document xrange
2016-02-28 22:47:48 +01:00
Zher Huei Lee 3546403af2 Updated the docs for EditorPlugin
One thing to note is that visibilty of the bottom panel items are automatically
managed by the buttons along the bottom.
2016-02-28 20:09:15 +00:00
Bojidar Marinov 49e1cc6fa9 Document Tween class 2016-02-28 22:04:01 +02:00
Juan Linietsky 6fc1c3a4d1 Completed the support for plugins! It is not possible to add plugins.
Not all APIs are provided yet, please request whathever you are missing.
Some example plugins are provided in demos/plugins. Just copy them to a folder in your project named addons/ and then enable them from the project settings.
Have fun!
2016-02-27 23:12:27 -03:00
Alexander Holland d093f558ab expose md5 for file(s) to gdscript 2016-02-25 19:25:29 +01:00
David 00d3c657de applied some typo fixes. see godotengine/godot-docs#18 2016-02-24 01:53:44 -06:00
Josh Grams d2ac38679d doc (NodePath): Rewrite description and all methods. 2016-02-22 17:59:18 -05:00
Josh Grams 47a2213580 docs: RigidBody2D._integrate_forces: Explain in more detail. 2016-02-20 21:18:24 -05:00
Alexander Holland d809987827 update doc on HTTPClient headers case-sensitivity 2016-02-20 00:37:43 +01:00
Rémi Verschelde 0dce4f7eb2 Remove broken [image] usage in classref 2016-02-19 18:39:16 +01:00
Rémi Verschelde 16b0cf8bcb Merge pull request #3754 from akien-mga/pr-subtract
Rename KEY_KP_SUBSTRACT to KEY_KP_SUBTRACT
2016-02-17 23:33:13 +01:00
Rémi Verschelde 130f8fa193 Rename KEY_KP_SUBSTRACT to KEY_KP_SUBTRACT
The former name was incorrect in English, though for us latin lovers it's an understandable mistake.
Second part of and closes #3626.
2016-02-17 23:01:27 +01:00
Rémi Verschelde 9e4532d689 Implement support for [codeblock] tag in help
It allows to define a multiline space-indented code block that will be properly parsed by the reST converter for the online docs.
The in-editor help understand the [codeblock] tag as it supposedly understand [code] already (i.e. it just seems to discard it, though the code was supposed to switch it to a monospace font, but that's likely another issue.
2016-02-17 21:17:08 +01:00
Rémi Verschelde 281236280e Fix NavigationPolygon references in _bind_method
Also sync the doc accordingly
2016-02-17 18:46:31 +01:00
Josh Grams a0cffd625b doc: explain DampedSpringJoint2D parameters. 2016-02-17 10:25:55 -05:00
Rémi Verschelde 747c1709aa Merge pull request #3710 from AlexHolly/doc-directory
some doc for directory
2016-02-16 07:47:44 +01:00
Rémi Verschelde 5439937899 Bind method is_cell_transposed 2016-02-15 23:30:52 +01:00
Rémi Verschelde 76ff31b3ff Fix some broken method references
+ sync template with source
2016-02-15 23:22:55 +01:00
Alexander Holland e65838f2d0 some doc for directory 2016-02-14 20:31:55 +01:00
Rémi Verschelde 391a882218 Merge pull request #3699 from Hinsbart/doc_os_getname
Doc: add list of possible return values to OS.get_name() description
2016-02-13 14:32:50 +01:00
hondres 080b5e4f63 doc: add list of possible return values to OS.get_name() description 2016-02-13 15:24:01 +01:00
hondres a415996f79 "Sync classes reference template with current code base" 2016-02-13 03:16:24 +01:00
Alexander Holland 260380be45 Doc HTTPClient.get_response_headers_as_dictionary() 2016-02-12 22:39:23 +01:00
Rémi Verschelde f5433dc60d Merge pull request #3627 from lordadamson/master
renamed function get_video_texutre to get_video_texture
2016-02-08 11:21:58 +01:00
Adham Zahran 6be6d02daf renamed function get_video_texutre to get_video_texture 2016-02-08 12:11:26 +02:00
Rémi Verschelde 9998927cfd Merge pull request #3625 from lordadamson/master
'radian' to 'radians' :D
2016-02-07 20:21:54 +01:00
Adham Zahran 485e772d37 just a small type 2016-02-07 21:17:13 +02:00
Rémi Verschelde 938772ac9f Merge pull request #3624 from lordadamson/master
fixing typos all over the place
2016-02-07 20:15:26 +01:00
Adham Zahran 8161392eb6 fixing typos all over the place 2016-02-07 21:10:52 +02:00
Rémi Verschelde 6faa1b9288 Merge pull request #3619 from lordadamson/master
description for Input.is_mouse_button_pressed()
2016-02-07 19:22:18 +01:00
Adham Zahran 9d8b798d44 description for Input.is_mouse_button_pressed() 2016-02-07 19:48:23 +02:00
Rémi Verschelde 0f11b322b3 Improve parsing of [method ...] tags
Also improve some code display.
2016-02-07 18:30:18 +01:00
Rémi Verschelde 1af65aff44 Fix badly formatted tags in XML
Also add parsing of [code] tags in RST converter
2016-02-07 17:19:12 +01:00
Rémi Verschelde c512dbfe5a Sync classes ref with code 2016-02-07 11:18:38 +01:00
Johan Manuel a634fc7a4a Added get_cellv() method to TileMap 2016-02-06 13:48:41 +01:00
Ovnuniarchos 51dfd4a4b5 Variables SpatialSoundServer and SS pointed to SpatialSound2DServer. 2016-01-30 10:36:58 +01:00
Rémi Verschelde ac3aa29c24 Sync API reference with current code 2016-01-26 00:19:47 +01:00
hondres de809f3ed9 replace InputEvent references with GlobalScope in joystick doc 2016-01-23 15:34:27 +01:00
Ovnuniarchos 8ed13c4df4 set_signed_data now works correctly on pcm8 samples. 2016-01-21 14:40:58 +01:00
Ovnuniarchos 37ee43fd5a Documented AudioServserSW, EventPlayer and EventStream*. Corrections on AudioServer and Sample. 2016-01-21 01:17:17 +01:00
volzhs 4563a5909a add documentation for OS::set_keep_screen_on 2016-01-16 20:59:44 +09:00
hondres c632c13c66 Add some joystick functions to input. Enables manipulation of mappings at runtime 2016-01-08 00:40:41 +01:00
Ovnuniarchos 57ffdbc24c PhysicsBody2D and descendants documented. 2015-12-28 21:53:05 +01:00
Rémi Verschelde d4993b74fc Add missing argument names in GDScript bindings
All classes were reviewed apart from VisualServer for which no argument name is documented at all.
While doing this review, I found quite a few bugs that were fixed either in earlier commits or this one (mostly documentation bugs though, i.e. some arguments were listed at the wrong place).
2015-12-28 02:13:05 +01:00
Rémi Verschelde d1caf2f037 Remove bogus argument in body_get_node 2015-12-28 01:32:12 +01:00
Rémi Verschelde 46eebac3ae Remove bogus argument in sample_get_description
Copy-paste mistake from the setter most likely.
2015-12-28 01:18:37 +01:00
Rémi Verschelde e66f4a4021 Sync doc with current source 2015-12-27 23:06:13 +01:00
Ovnuniarchos 69a65e5a69 New area space override modes documented. Also, PhysicsBody2D, Area2D, and CollisionObject2D. 2015-12-22 15:48:41 +01:00
Juan Linietsky ff936c6b2e Merge pull request #2868 from akien-mga/pr-fix-can-move-to
Fix can_move_to and rename it for more clarity
2015-12-08 17:09:47 -03:00
Juan Linietsky afb895f197 Merge pull request #2993 from leezh/nrex-v0.1
updated the RegEx library nrex to v0.1
2015-12-08 17:00:27 -03:00
Franklin Sobrinho 3c4b0236cb Add constructor for Image built-in type 2015-12-06 09:12:14 -03:00
Zher Huei Lee d957749179 updated nrex documentation 2015-12-04 22:19:53 +00:00
Bojidar Marinov 12f2c1378a Edit documentation for AABB and Rect2.
Docs for AABB were already present, but had a few mistakes.
2015-11-29 15:56:40 +02:00
Bojidar Marinov c81c671131 Run -doctool on existing documentation
Also, s/vecor/vector/
2015-11-29 15:38:47 +02:00
est31 323938cc28 Document byte conversion methods for Strings 2015-11-24 05:46:00 +01:00
Rémi Verschelde a961347d8c Fix return type of Matrix32 member vars
Thanks to @bojidar-bg for localising the issue.
2015-11-23 19:08:54 +01:00
Bojidar Marinov 4359a90cca Document Vector3 and Vector3Array. Fix documentation of Vector2 and Vector2Array. 2015-11-23 14:18:13 +02:00
Bojidar Marinov ca750fb7bc Update doc with -doctool. 2015-11-23 13:57:57 +02:00
Rémi Verschelde e57dfe2663 Update doc for can_teleport_to 2015-11-22 14:21:04 +01:00
Rémi Verschelde 0c8dda80ff Update Vector2.angle() description 2015-11-20 18:47:18 +01:00
Rémi Verschelde 497efa720c Sync doc template with code 2015-11-20 18:39:23 +01:00
Ovnuniarchos 8c0c46c2ae Inserted explanation about the behaviour of CollsionPolygon2D.set_polygon. 2015-11-20 18:24:28 +01:00
Ovnuniarchos 68a0f713b8 Differences between ConvexPolygon2D and ConcavePolygon2D? 2015-11-20 18:09:31 +01:00
Ovnuniarchos 1155ac884c ConvexPolygonShape2D.set_point_cloud documented to do nothing. 2015-11-20 18:09:31 +01:00
Ovnuniarchos 73a80e5509 Added definition of bias solver. 2015-11-20 18:09:31 +01:00
Juan Linietsky 232b1a3fef Merge pull request #2822 from kurikaesu/master
HTTPClient docs & request functionality + fixes
2015-11-19 09:18:09 -03:00
Aren Villanueva 5c7e9e7e63 Fixes the make_doc.sh, <, > and & signs in descriptions that cause the parser to break.
Documentation for HTTPClient.
Added a query_string_from_dict method to HTTPClient to create a x-www-form-urlencoded valid query string for GET and POST messages.
String now has http_escape() and http_unescape() methods to help facilitate the above query_string_from_dict method.
2015-11-19 22:01:42 +11:00
Ovnuniarchos 07110c3a14 Changed capabilities list. 2015-11-19 11:18:22 +01:00
Rémi Verschelde 3fcfdfec0a Merge pull request #2645 from Ovnuniarchos/DocCurvePathPFollow
Documented classes Curve*, Path*, and PathFollow*
2015-11-07 13:15:47 +01:00
Ovnuniarchos 8abdb43aab Documented classes Curve*, Path*, and PathFollow* 2015-11-07 13:09:00 +01:00
Ovnuniarchos 3b2899bc42 Regex class documented. For some reason, parameter descriptors don\'t appear. 2015-11-03 04:39:42 +01:00
Rémi Verschelde b2f9acb8c9 Merge pull request #2680 from Brickcaster/onceagain
Added a few notes to classes.xml
2015-11-02 07:38:06 +01:00
Brickcaster e0e4bcc6a6 Added description to classes/ScrollContainer
Added description to help understand how to utilize the ScrollContainer
node.
2015-11-01 20:58:07 -05:00
Brickcaster 18964798b7 classes/color - Documenting a trick with set_modulate
I wanted to document a trick using class color to highlight a sprite.
2015-11-01 20:58:06 -05:00
Brickcaster 44057ed4ae Updated classes/matrix32
The 3 members of a matrix 32 are Vector2, not float.  Updated
documentation to reflect this.
2015-10-25 19:29:44 -04:00
George Marques baa59c0670 Add missing reference documentation for Array class 2015-10-20 14:31:30 -02:00
George Marques eefc2bf5f7 Syncing classes.xml with current binary 2015-10-20 14:26:37 -02:00
Julian Murgia - StraToN 2975064c4d GraphEdit and GraphNode documentation 2015-10-16 17:56:03 +02:00
George Marques 6e87314d83
Add support for Opus audio format 2015-10-02 14:25:38 -03:00
Rémi Verschelde 7c1a79089a Update documentation for all Sample* classes 2015-09-26 23:58:12 +02:00
Juan Linietsky 6f0df4e80c Merge pull request #2534 from eska014/unpress-hidden-buttons
Fix BaseButtons remaining pressed when hiding while pressed down
2015-09-26 00:53:38 -03:00
eska 6ee2a84e8a Clarify `BaseButton::is_pressed()` documentation 2015-09-26 05:48:51 +02:00
Rémi Verschelde 4abc7f5740 Update documentation for TileSet and Timer 2015-09-25 20:45:00 +02:00
Rémi Verschelde c69ea708fa Sync classes reference template with current code base 2015-09-25 17:54:24 +02:00
Juan Linietsky 52eebdc001 Merge pull request #2449 from leezh/label-valign-fix
reworked Label class
2015-09-25 11:29:49 -03:00
Rémi Verschelde d55274b5b0 Document TileMap class 2015-09-23 23:05:47 +02:00
Bojidar Marinov f41ed99df2 Update descriptions for Vector2 and Vector2Array 2015-09-23 17:41:02 +03:00
Bojidar Marinov 6adb5ed440 Regenerate docs 2015-09-23 17:34:07 +03:00
Zher Huei Lee b33c288525 updated Label documentation 2015-09-08 10:41:58 +01:00
Ovnuniarchos d1a260c966 A bunch of spell checks, and rewordings. Also, some simple documentation. 2015-07-26 20:09:47 +02:00
Ovnuniarchos 43053e3a71 Added a proper name and an explanation to arg4 on CanvasItem.draw_texture_rect*. 2015-07-20 20:07:25 +02:00
ShadowKyogre 631cb10e86 Add some documentation for RayCast2D about is_colliding and get_collider quirks 2015-06-24 13:24:42 -07:00
krzycho d65455185a - added GDscript bidings for UndoRedo class mechanizm
- registered UndoRedo
2015-06-21 22:23:09 +02:00
Juan Linietsky e323cc0505 -Rename unexisting by nonexistant, closes #1940
-Added function to retrieve list of actions fron InputMap
2015-05-18 10:20:54 -03:00
Juan Linietsky af06843982 -new collision layer & mask system for 2D, for more flexible collision masking 2015-05-03 16:47:21 -03:00
Simon Wenner 8156db1623 updated outdated or missing Plane class documentation 2015-04-20 23:31:53 +02:00