Commit Graph

244 Commits

Author SHA1 Message Date
Jakob Sinclair 3d810a207c Add and polish up documentation for Image methods
Written new documentation for undocumented methods. The already
documented methods seemed to follow a very old style and changed them to
fit the new guidelines for documentation.

Signed-off-by: Jakob Sinclair <sinclair.jakob@mailbox.org>
2017-10-26 20:07:05 +02:00
Henrique Campos 1063ddfeb5 Added description for camera2D missing members
Also fixed typo in AudioEffectFilter.
[ci skip]
2017-10-26 09:08:52 +02:00
Rémi Verschelde d135008acf Merge pull request #12405 from Jerome67000/clean_getnodetype
Removes Script::get_node_type()

[ci skip]
2017-10-26 08:49:38 +02:00
Jason Anderson 8aecdaa6f0 Added descriptions to RichTextLabel 2017-10-25 13:15:39 -05:00
Jerome67000 2609cc9ef4 Removes Script::get_node_type()
used before GDScript, with squirrel apparently
2017-10-25 20:11:30 +02:00
Chris Bradfield c9e6168db0 Merge pull request #12375 from NathanWarden/cubemap_docs
[DOCS] CubeMap
2017-10-25 08:54:15 -07:00
Nathan Warden e0b2a74a14 [DOCS] CubeMap 2017-10-24 21:46:37 -05:00
Rémi Verschelde 552ed07cfd classref: Sync with current source
[ci skip]
2017-10-24 19:22:43 +02:00
volzhs d15af2c290 Fix example code for EditorImportPlugin 2017-10-25 01:12:43 +09:00
Rémi Verschelde 5b53cd1fc4 Merge pull request #12330 from Jerome67000/docs_basebutton
[DOCS] BaseButton

[ci skip]
2017-10-23 23:13:25 +02:00
Rémi Verschelde abea816e54 Revert "Rename Schlick GGX to GGX." 2017-10-23 07:42:36 +02:00
Chris Bradfield 774023a38e Merge pull request #12336 from mhilbrunner/docs-globalscope
[DOCS] @GlobalScope
2017-10-22 18:03:20 -07:00
Chris Bradfield 4bb02a1b68 Merge pull request #12318 from mhilbrunner/docs-remotetransform
[DOCS] RemoteTransform & RemoteTransform2D
2017-10-22 17:29:57 -07:00
mhilbrunner 0b7619fd9c [DOCS] RemoteTransform & RemoteTransform2D 2017-10-23 02:18:57 +02:00
mhilbrunner 24bcf6d17a [DOCS] @GlobalScope 2017-10-23 01:46:46 +02:00
Chris Bradfield d49f23fd1b Merge pull request #12331 from mhilbrunner/docs-editorscript
[DOCS] EditorScript: Small formatting fixes
2017-10-22 16:31:27 -07:00
Chris Bradfield 7d36409f42 Merge pull request #12306 from Grosskopf/various-docs
[DOCS] added several small docs
2017-10-22 15:58:56 -07:00
Chris Bradfield 99493e2243 Merge pull request #12305 from Grosskopf/arvr-docs
[DOCS] added some arvr docs
2017-10-22 15:57:03 -07:00
Grosskopf aaa4142a37 added some arvr docs 2017-10-23 00:43:13 +02:00
Grosskopf 03e2508e45 Added various docs, mostly mathematical basics 2017-10-23 00:39:34 +02:00
mhilbrunner 649b25e037 [DOCS] EditorScript: Small formatting fixes 2017-10-23 00:35:10 +02:00
Chris Bradfield 0564f96ab4 Merge pull request #12328 from mhilbrunner/docs-string
[DOCS] String
2017-10-22 15:23:04 -07:00
Jerome67000 b0ac316dc9 [DOCS] BaseButton 2017-10-23 00:17:02 +02:00
mhilbrunner 0608f2fca3 [DOCS] String 2017-10-23 00:11:09 +02:00
Chris Bradfield ecdf49ec61 Merge pull request #12315 from Jerome67000/docs_parallax
[DOCS] ParallaxBackground and ParallaxLayer
2017-10-22 15:09:40 -07:00
Jerome67000 a5c3696b3b [DOCS] ParallaxBackground and ParallaxLayer 2017-10-22 23:10:39 +02:00
Rémi Verschelde fc09e14366 classref: Sync with current source
Also fix hyperlink references to same class as per the guidelines.
[ci skip]
2017-10-22 12:56:17 +02:00
Nathan Lovato 14b1741cbf Merge pull request #12150 from Grosskopf/2D-joints-docs
[DOCS] 2D joints docs
2017-10-22 12:07:40 +02:00
Henrique Campos bc667aeada Added description to Audio Filter Effects
Also doccumented Filter member variables and methods.
[ci skip]
2017-10-22 11:57:25 +02:00
Stephen Ednave 8f382879cf Added descriptions to some members of Camera2D 2017-10-22 11:56:44 +02:00
Rémi Verschelde add60f840a Merge pull request #12273 from willnationsdev/tabcontainer-doc-edit
[DOCS] Updated the TabContainer docs for depth and readability

[ci skip]
2017-10-22 10:38:23 +02:00
Will Nations 5b10422fba updated the TabContainer docs for depth and readability. 2017-10-22 00:07:33 -05:00
Ferenc Arn cb0bf1edea Rename Schlick GGX to GGX.
Schlick's approximation and GGX are orthogonal concepts.

Furthermore, it's usage so far has been inconsistent: we don't even use it with anisotropic SchlickGGX, and Burley (Disney) diffuse does use it while its name doesn't indicate it.

The use of Schlick's approximation in Burley and GGX is an implementation detail and doesn't need to be reflected to the namig.
2017-10-21 19:35:54 -04:00
Pedro J. Estébanez 7b12ae39f2 Rename RayCasts collision_layer to collision_mask
The point is that `RayCast`s are checked against objects' `collision_layer`(s), but they themselves are considered no to _belong_ to any layer. Therefore, the correct name for their property is `collision_mask`, rather than `collision_layer`.

Only renaming is needed since the behavior was already the right one, only that it wasn't matching what users would expect from the name and description of the property.

Fixes #7589, where it's also discussed.
2017-10-21 22:17:47 +02:00
Grosskopf 7a6246a0bd Added the 2D Joint docs 2017-10-21 17:55:45 +02:00
Rémi Verschelde b302084395 makerst: Fix rst-ization of members and escaping of [Class]s
Fixes #11517.
2017-10-21 12:33:52 +02:00
Rémi Verschelde 8652c1d5b1 classref: Sync with current source 2017-10-21 12:04:36 +02:00
Nathan Lovato 5cbab0e001 Merge pull request #12221 from Jerome67000/docs_input
[DOCS] InputEvent*
2017-10-21 12:02:18 +02:00
Jerome67000 0a89b0f767 [DOCS] InputEvent* 2017-10-21 10:04:43 +02:00
Chris Bradfield d4eecce962 [DOCS] Updates and clarifications to RigidBody2D 2017-10-20 22:48:23 -07:00
Jakob Sinclair 1870c2fdcf Fix ambiguous documentation for RigidBody2D
Fixes #12225 and the possesive form of the word body. Also uses simpler terms now
when describing when the linear velocity gets updated.

Signed-off-by: Jakob Sinclair <sinclair.jakob@mailbox.org>
2017-10-20 22:40:02 +02:00
Julian Murgia cba35c5ec9 Merge pull request #12199 from Fallayn/patch-1
[DOCS] EditorScript
2017-10-20 21:24:07 +02:00
Poommetee Ketson 0e9f81a40b Merge pull request #12054 from Fallayn/docs-editorinterface
[DOCS] EditorInterface

[ci skip]
2017-10-20 22:42:39 +07:00
Fallayn 800904a374 [DOCS] EditorScript 2017-10-18 20:20:27 +02:00
Fallayn 7f2d36bf84 [DOCS] EditorInterface 2017-10-17 17:13:27 +02:00
Rémi Verschelde 0d0cb01f33 Merge pull request #12126 from cbscribe/kcc_vsdocs2
[DOCS] Various VisualScript* nodes

[ci skip]
2017-10-15 23:04:32 +02:00
Chris Bradfield 6160591d2c Merge pull request #12124 from Kaukamieli/Particles2D
[DOCS] documented and edited Particles2D
2017-10-15 14:01:26 -07:00
Kaukamieli 6de19415a6 [DOCS] documented and edited Particles2D 2017-10-15 23:57:12 +03:00
Chris Bradfield ec0ade0dde [DOCS] Various VisualScript* nodes 2017-10-15 11:50:45 -07:00
Nathan Lovato 64827d2040 Merge pull request #12116 from cbscribe/kcc_vsdocs
[DOCS] Update 12 VisualScript* nodes
2017-10-15 19:46:57 +02:00
Chris Bradfield 6172f09703 [DOCS] Update 12 VisualScript* nodes 2017-10-15 08:59:38 -07:00
Rémi Verschelde 3266ebbf4f Merge pull request #12088 from Grosskopf/physics-server-docs
Added documentation for 3D Joints, the 2D Pin Joint, and the Physicsservers, also minor Bugfix
2017-10-15 10:12:53 +02:00
Grosskopf f8c7d32987 Added documentation for 3D Joints, the 2D Pin Joint, and the Physicsservers, also a minor bugfix in the 3D Pinjoint. 2017-10-14 22:17:26 +02:00
Saracen d030e6ee75 Expose 'request_frame_drawn_callback' to script. 2017-10-14 16:32:27 +01:00
Andreas Haas 4c716f3623
[DOCS] Fix a few typos. 2017-10-14 12:45:49 +02:00
Olli Markkanen 9876bad05c [DOCS] Improve docs for is_action_just_pressed and is_action_just_released (#12081) 2017-10-14 11:30:41 +02:00
Rémi Verschelde 00a12104df Merge pull request #12078 from Nallebeorn/documentation
[DOCS] Small edits to ConfigFile docs.

[ci skip]
2017-10-14 10:05:35 +02:00
BastiaanOlij cc37d43f86 Redoing the ARVR GDNative interface as module and tighter implementation 2017-10-14 09:10:18 +11:00
Benjamin Larsson 6820f785a0 Small edits to ConfigFile docs. 2017-10-13 23:05:07 +02:00
Chris Bradfield 4585239a4b Merge pull request #12004 from diowonderland/docs-touchscreenbutton
[DOCS] TouchScreenButton
2017-10-13 09:03:52 -07:00
Chris Bradfield 7009ffa255 Merge pull request #12055 from brunosxs/tabcontainer
[DOCS] TabContainer class descriptions
2017-10-13 09:02:47 -07:00
Dio a931f905f5 [DOCS] TouchScreenButton 2017-10-13 16:10:10 +02:00
Karroffel 916ee427ff removed GDNativeClass doc from GDNative module 2017-10-13 15:02:54 +02:00
BastiaanOlij 41e70d4192 Move GDNative docs into gdnative folder 2017-10-13 21:54:57 +11:00
brunosxs 42f576f424 [DOCS] TabContainer class descriptions 2017-10-12 22:06:32 -03:00
Chris Bradfield 8bdb04c839 Merge pull request #12005 from diowonderland/docs-bitmapfont
[DOCS] BitmapFont
2017-10-12 17:56:35 -07:00
Chris Bradfield bddeaabfdc Merge pull request #12007 from diowonderland/docs-dynamicfontdata
[DOCS] DynamicFontData
2017-10-12 17:55:34 -07:00
Dio 5ec3da0a8b [DOCS] BitmapFont 2017-10-12 21:10:12 +02:00
Rémi Verschelde f956f2979e Merge pull request #12006 from diowonderland/docs-dynamicfont
[DOCS] DynamicFont

[ci skip]
2017-10-12 19:43:53 +02:00
Dio a425a986eb [DOCS] DynamicFontData 2017-10-12 16:40:29 +02:00
Dio f43e49b1c0 [DOCS] DynamicFont 2017-10-12 16:37:45 +02:00
Rémi Verschelde b1f2c31a36 doc: Sync classref with current source
Ensure that s/fixed_process/physics_process/ is handled properly.
[ci skip]
2017-10-11 23:55:04 +02:00
Chris Bradfield da47f58b24 Merge pull request #11999 from Grosskopf/AudioServerAndStream-docs
[DOCS] Updated AudioStream docs and added AudioServer docs
2017-10-10 19:09:41 -07:00
Grosskopf 3ac7cc9e57 updated AudioStream docs and added AudioServer docs 2017-10-11 00:51:59 +02:00
Chris Bradfield 51b41dcdbb Merge pull request #11945 from saltares/docs-os
[DOCS] - Completes the docs for the OS class
2017-10-10 12:56:39 -07:00
David Saltares ee513aba44 [DOCS] - Completes the docs for the OS class 2017-10-10 20:51:58 +01:00
Chris Bradfield 0bf58c0525 Merge pull request #11942 from saltares/docs-engine
[DOCS] - Complete Engine docs
2017-10-10 12:43:25 -07:00
David Saltares 23a2e2a2a9 [DOCS] - Complete Engine docs 2017-10-10 20:41:01 +01:00
Andreas Haas 1d8a546a07 Merge pull request #11919 from Toizi/array_sort_ref
Array::sort/invert now return reference to Array
2017-10-10 20:31:48 +02:00
Chris Bradfield f240cfe5a9 Merge pull request #11921 from mhilbrunner/docs-tree-treeitem
[DOCS] Document Tree & TreeItem
2017-10-09 13:53:30 -07:00
mhilbrunner b776330cb7 [DOCS] Document Tree 2017-10-09 22:44:27 +02:00
Marius Guggenmos 2f173a67ab Array::sort, sort_custom and invert now return reference to Array to allow chaining of operations 2017-10-09 16:36:09 +02:00
Chris Bradfield bf0b328197 Added VisualScript* descriptions
[ci skip]
2017-10-09 12:57:21 +02:00
Jérôme GULLY 9e93f5b478 [DOCS] Review and improve 17 classes (#11890) 2017-10-09 12:49:12 +02:00
Unknown 17011f5d12 Added documenation for Line2D
[ci skip]
2017-10-09 11:45:41 +02:00
Chris Bradfield e4dc1f93d2 Merge pull request #11943 from Nallebeorn/documentation_2
[DOCS] Add documentation for Performance
2017-10-08 23:34:37 -07:00
Nathan Lovato c022a32e63 Merge pull request #11820 from cbscribe/kcc_particles_doc
[DOCS] Update ParticlesMaterial, Particles, Particles2D class ref
2017-10-09 08:08:53 +02:00
authenticate 6d2abb4877 A minor documentation typo fix. 2017-10-08 22:59:07 -04:00
Chris Bradfield c95ba4d7a7 Merge pull request #11938 from brunosxs/docs
[DOCS] File Class method description
2017-10-08 14:07:09 -07:00
brunosxs 22436f6bf1 [DOCS] File Class method description 2017-10-08 17:04:00 -03:00
Benjamin Larsson fc839f9fe8 Fix a typo in KinematicBody and KinematicBody2D. 2017-10-08 18:39:24 +02:00
Benjamin Larsson be8d343f2c Add documentation for Performance. 2017-10-08 18:31:56 +02:00
Chris Bradfield 0fb22b1d24 Merge pull request #11920 from mhilbrunner/docs-camera
[DOCS] Camera documentation
2017-10-07 16:38:13 -07:00
Poommetee Ketson 7d50c5de86 Merge pull request #11902 from GDquest/texture-button-progress
[DOCS] Write TextureButton, review and fill missing entries in TextureProgress

[ci skip]
2017-10-08 06:37:38 +07:00
Poommetee Ketson a645c38084 Merge pull request #11918 from Nallebeorn/documentation
[DOCS] Write missing method and member descriptions of KinematicBody2D

[ci skip]
2017-10-08 06:36:33 +07:00
Chris Bradfield da94eab3ea Merge pull request #11914 from diowonderland/docs-backbuffercopy
[DOCS] BackBufferCopy: Document members
2017-10-07 16:35:14 -07:00
Chris Bradfield 96a5aeeea6 Merge pull request #11917 from brunosxs/docs
[DOCS] Add descriptions to members of Camera2D
2017-10-07 16:34:03 -07:00
Benjamin Larsson acf81338aa Minor fixes to KinematicBody and KinematicBody2D 2017-10-07 22:57:31 +02:00
brunosxs a5e5c0855d [DOCS] Add descriptions to members of Camera2D 2017-10-07 17:54:25 -03:00
Benjamin Larsson 9b15bf26f6 Edit move_and_slide, it does a bit more than I first thought. 2017-10-07 22:40:18 +02:00