Commit graph

1879 commits

Author SHA1 Message Date
Tomasz Chabora
b71a339160 Clarify docs for _ready and request_ready 2019-06-28 19:18:43 +02:00
Hugo Locurcio
f7f6115f76
Proofread and improve the whole class reference
- Document a few more properties and methods
- Add more information to many classes
- Fix lots of typos and gramar mistakes
- Use [code] tags for parameters consistently
- Use [b] and [i] tags consistently
- Put "Warning:" and "Note:" on their own line to be more visible,
  and make them always bold
- Tweak formatting in code examples to be more readable
- Use double quotes consistently
- Add more links to third-party technologies
2019-06-27 22:30:19 +02:00
Rémi Verschelde
f35fd681ac
Merge pull request #30114 from Chaosus/vs_context_menu
Shows menu when dragging connection on empty space in visual shader
2019-06-27 15:14:54 +02:00
Rémi Verschelde
528c4722d6 doc: Don't use GlobalScope scope in hyperlinks, it's automatically inferred 2019-06-27 14:43:37 +02:00
Rémi Verschelde
bc82781f7d doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks 2019-06-27 13:49:36 +02:00
Rémi Verschelde
1bf448dd87 Properly expose all Error constants to scripting languages 2019-06-27 12:48:26 +02:00
Rémi Verschelde
71d53637b5 doc: Fix scoped hyperlinks to same-class enums/methods
The class name does not need to be specified when it is the current class.
2019-06-27 11:44:37 +02:00
Rémi Verschelde
86ed7a9884 doc: Complete and harmonize all _MAX constant descriptions 2019-06-27 11:10:53 +02:00
Chaosus
0aec3c3113 Shows menu when dragging connection on empty space in visual shader graph 2019-06-27 10:48:18 +03:00
Rémi Verschelde
755b589384
Merge pull request #30096 from akien-mga/doc-misc-updates
doc: Proofread and complete various nodes
2019-06-27 08:12:34 +02:00
Rémi Verschelde
d8c9646118
Merge pull request #30105 from Xrayez/bind-pip-geometry
Bind is_point_in_polygon in Geometry singleton
2019-06-27 01:03:51 +02:00
Rémi Verschelde
caf8e20f2a
Merge pull request #30078 from Zylann/document_vs_cull_ray
Document VisualServer.instances_cull_ray
2019-06-26 23:28:56 +02:00
Andrii Doroshenko (Xrayez)
6f2233d13a Bind is_point_in_polygon in Geometry singleton 2019-06-27 00:20:22 +03:00
Rémi Verschelde
867dda1124 doc: Proofread and complete various nodes
All 100% completed: MainLoop, Node, Object, Path, Performance,
Reference, Resource, SceneState, SceneTree, UndoRedo.

Also fixed some en_GB occurrences as the reference spelling is en_US.
2019-06-26 23:05:51 +02:00
Rémi Verschelde
43a6969470
Merge pull request #25863 from AlexHolly/undo-redo-version-signal
UndoRedo add version changed signal
2019-06-26 22:56:51 +02:00
Marc Gilleron
cb5233ee12 Document VisualServer.instances_cull_ray 2019-06-26 19:53:22 +01:00
Rémi Verschelde
2c96942df9
Merge pull request #30088 from akien-mga/node-get_node_and_resource
Node: Fix logic of has/get_node_and_resource and document it
2019-06-26 16:48:21 +02:00
Alexander Holland
8f23f4b44e UndoRedo add version changed signal
added some functions to manage undo buttons
2019-06-26 16:32:34 +02:00
Rémi Verschelde
261bdfa14d doc: Sync classref with current source 2019-06-26 16:03:04 +02:00
Rémi Verschelde
6e9272eea8 Node: Fix logic of has/get_node_and_resource and document it
Also document NodePath.
2019-06-26 15:46:32 +02:00
Rémi Verschelde
a9cff880d6 doc: Document EncodedObjectAsID, expose its property 2019-06-26 10:50:45 +02:00
Rémi Verschelde
615ffb3507 doctool: Fix writing theme_item descriptions
We already had support for parsing and saving theme_item descriptions
in DocData, and displaying it in the editor, but doctool would drop the
changes as it was not writing them back to the XML.

Part of #29868.
2019-06-25 13:08:15 +02:00
Rémi Verschelde
230eb262e2
Merge pull request #30030 from zaksnet/document-margincontainer
Document MarginContainer node
2019-06-25 12:20:49 +02:00
austinried
9eeead4be3
Remove references to mouse stuff from OS
There is nothing in `OS` about mouse grabbing or mouse cursors, that's in `Input`, so I'm cleaning up those references.
2019-06-24 19:28:49 -07:00
Rémi Verschelde
8c483886d2
Merge pull request #30016 from randall-fulton/docs/object-set-deferred
Add docstring for Object.set_deferred
2019-06-24 22:09:15 +02:00
Rémi Verschelde
f34c8015cb Area2D: Fix argument type of body_* signals
Those signals receive either a PhysicsBody2D or a TileMap object,
and what the emitting method checks internally is only that the
object is a Node. In theory any Node could go through these signals
if they talk directly to the PhysicsServer2D.

Also updated docs.

Fixes #27076.

Might need further (compat breaking) improvement as this API is a
bit confusing, cf. #24739.
2019-06-24 21:40:31 +02:00
Randall Fulton
6843ad87a4 Add docstring for Object.set_deferred 2019-06-24 12:57:14 -05:00
Zak
9f582a7c3e Document MarginContainer Node 2019-06-24 16:39:35 +03:00
Rémi Verschelde
5e21310343 doc: Sync classref with current source 2019-06-24 10:39:59 +02:00
Hugo Locurcio
03335e5250
Improve the Engine.get_version_info() documentation
This documents some keys that were missing and improves formatting.
2019-06-21 15:15:55 +02:00
Rémi Verschelde
1e833cadbc
Merge pull request #29935 from Faless/net/get_if_multicast_pr
Multicast, more network interfaces info
2019-06-21 10:21:01 +02:00
Fabio Alessandrelli
e5e3f86648 Multicast support in NetSocket/PacketPeerUDP 2019-06-21 00:14:42 +02:00
Fabio Alessandrelli
b574e476ec Implement IP.get_local_interfaces.
Allow getting interfaces names and assigned names.

On UWP this is not supported, and the function will return one interface
for each local address (with interface name the local address itself).
2019-06-21 00:14:42 +02:00
Zak
5d0040e340 Document ReferenceRect Node
Added missing documentation for ReferenceRect Node
2019-06-20 17:35:08 +03:00
Rémi Verschelde
8591691b9b
Merge pull request #24249 from zorbathut/zorbathut/animimmediate
Implement AnimationPlayer call modes as per #23498.
2019-06-20 13:04:34 +02:00
Rémi Verschelde
922a4f5413
Merge pull request #29901 from BastiaanOlij/fix_cameraserver_const
Made constants fully upper case in camera server
2019-06-19 20:20:47 +02:00
Rémi Verschelde
43a9b8c76c
Merge pull request #27237 from Chaosus/astar_2d
Added 2D functions to AStar
2019-06-19 15:07:59 +02:00
Rémi Verschelde
d7af08aa95
Merge pull request #27389 from YeldhamDev/acceptdiag_label_wrap
Add option to enable autowrapping for label inside 'AcceptDialog'
2019-06-19 14:46:32 +02:00
Bastiaan Olij
4ebedb5f11 Made constants fully upper case in camera server 2019-06-19 22:24:54 +10:00
Rémi Verschelde
2b52cd3e5c
Merge pull request #28648 from KoBeWi/substr-1
Make second parameter of substr optional
2019-06-19 12:43:46 +02:00
Rémi Verschelde
bb0aeb4874
Merge pull request #28659 from KoBeWi/rainbow_mode
Add HSV mode to color picker
2019-06-19 12:41:51 +02:00
Rémi Verschelde
c39bf80a08
Merge pull request #29851 from akien-mga/doc-resource
doc: Improve docs for Resource* classes
2019-06-19 00:10:56 +02:00
Rémi Verschelde
3345c03122
Merge pull request #29870 from Anutrix/docup1
Added description to is_pixel_opaque() in Sprite.xml
2019-06-18 20:56:38 +02:00
Rémi Verschelde
0764451dc5 doc: Improve docs for Resource* classes
Also move module-specific classes to their own module's `doc_classes`
folder.
2019-06-18 20:07:26 +02:00
Rémi Verschelde
d6176db271 Unexpose subclasses of ResourceFormatLoader and -Saver
ResourceFormatLoader and ResourceFormatSaver are meant to be overridden
to add support for different formats in ResourceLoader and ResourceSaver.
Those should be exposed as they can be overridden in plugins.

On the other hand, all predefined subclasses of those two base classes
are only meant to register support for new file and resource types, but
should not and cannot be used directly from script, so they should not
be exposed.

Also unexposed ResourceImporterOGGVorbis (and thus its base class
ResourceImporter) which are editor-only.
2019-06-18 17:56:23 +02:00
unknown
44a20a0f61 Added description to is_pixel_opaque() in Sprite.xml 2019-06-18 20:57:42 +05:30
Rémi Verschelde
054ac5c8f5 doc: Sync classref with current source
Fix a few bugs.
2019-06-18 15:07:31 +02:00
Rémi Verschelde
08ebeee0e1
Merge pull request #29840 from Anutrix/master
Added description in TranslationServer and OpenSimplexNoise
2019-06-18 15:01:42 +02:00
Rémi Verschelde
8b83e6d580
Merge pull request #29676 from zaksnet/ItemList-Imrovements
Document ItemList control
2019-06-18 15:01:11 +02:00
Zak
49df253627 Document ItemList control 2019-06-18 08:36:32 +03:00