asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
30916 commits 1 branch 0 tags 2.2 GiB
Commit graph

71 commits

Author SHA1 Message Date
Rémi Verschelde
f0b37b1519
doc: Point URLs to 3.4 version of the online docs 2021-08-12 17:08:10 +02:00
Rémi Verschelde
f5836b40d4
doc: Use self-closing tags for return and argument 
For the time being we don't support writing a description for those, preferring
having all details in the method's description.

Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.

(cherry picked from commit 7adf4cc9b5)
 2021-08-03 10:20:19 +02:00
Nick Huelin
8b09112d5f
Edit "quit()" method description in SceneTree 
Updated the `SceneTree.quit()` method to include a note that on iOS this method won't work as apps are expected to be closed via the Home button, not programmatically.

(cherry picked from commit c63af17a31)
 2021-06-07 12:14:30 +02:00
Hugo Locurcio
1f0e570216
Document that SceneTree.call_group() is deferred 
(cherry picked from commit 7516ff3805)
 2021-04-30 12:15:24 +02:00
Rémi Verschelde
c3272997cd
doc: Update classref headers with 3.4 version 2021-04-26 13:15:29 +02:00
Rémi Verschelde
015973df04
doc: Make all tutorial links point to 3.3 branch of docs 2021-03-26 10:43:43 +01:00
Paul Joannon
596169d7df
class reference proofreading 
(cherry picked from commit 8455e901f3)
 2021-03-26 09:49:07 +01:00
Rémi Verschelde
1aba997d75
doc: Sync classref with 3.3 version bump 2021-03-23 13:40:34 +01:00
Ryan Roden-Corrent
c31bb02a3e
Clarify that create_timer does not require cleanup. 
This is how I would expect it to work, but the docs didn't clarify, so I
had to check the source just to make sure I wasn't responsible for
freeing the timer:

d39f6386ce/scene/main/scene_tree.cpp (L473)
(cherry picked from commit 6e7e4f82ec)
 2021-01-26 17:00:16 +01:00
kobewi
9150d35699
Mention that change_scene is deferred 
(cherry picked from commit 86aa9b1233)
 2020-12-29 16:02:02 +01:00
Hugo Locurcio
9c234abdc9
Document the argument count limit in SceneTree.call_group() 
This limitation should be lifted in 4.0 thanks to the new method
binding system, but it's still present in 3.2.x.
 2020-12-15 00:53:40 +01:00
Phischermen
776faa5c92
Clarify that SceneTree::quit() does not immediately end the application. 
(cherry picked from commit 371d12a2f0)
 2020-11-19 17:15:27 +01:00
Rémi Verschelde
4287af5148
doc: Make docs.godotengine.org links point to 3.2 branch 2020-10-19 16:10:01 +02:00
Rémi Verschelde
4cee1cda5e
Merge pull request #35589 from akien-mga/doc-drop-category-property 
doc: Drop unused 'category' property from header
 2020-01-26 16:34:13 +01:00
Rémi Verschelde
09ced94dd4 doc: Do not expose Variant::NIL as a type in the class reference 
Fix signals Variant arguments incorrectly listed as Nil.

Fixes #12520.
 2020-01-26 16:08:11 +01:00
Rémi Verschelde
2d20fc39aa doc: Drop unused 'category' property from header 
We already removed it from the online docs with #35132.

Currently it can only be "Built-In Types" (Variant types) or "Core"
(everything else), which is of limited use.

We might also want to consider dropping it from `ClassDB` altogether
in Godot 4.0.
 2020-01-26 16:02:39 +01:00
Hugo Locurcio
cc626acf45
Add a shorthand for setting the exit code using SceneTree::quit() 
This reduces the amount of code required to exit a process with a
non-zero exit code. This pattern is also found in most other
programming languages.
 2020-01-03 11:41:46 +01:00
Rémi Verschelde
4eff13d768 doc: Markup fixes for enums and constants 2019-12-06 23:09:20 +01:00
merumelu
3de002db30 Doc: Add return values for SceneTree::reload_current_scene 2019-11-12 16:43:31 +01:00
Rémi Verschelde
067c259ef1 doc: Sync classref with current source 2019-11-11 17:25:05 +01:00
Tomasz Chabora
5d618b0570 Clarify how to handle go back button on mobile 2019-11-09 00:15:50 +01:00
Yeongho Kim
d4a55fb639 Print errors when tab indent found in [codeblock] 2019-10-01 23:39:45 +09:00
bruvzg
db6d4352ea
[macOS] Add methods to modify global and dock menus. Add ability to open multiple editor/project manager instances, recent/favourite project list to project manager dock menu and opened scene list to editor dock menu. 2019-08-26 16:45:49 +03:00
Rémi Verschelde
a78373ddc2 doc: Remove null default values that can't be determined 
Applying #30187.
 2019-06-30 13:58:07 +02:00
Rémi Verschelde
b9aa13e591 doc: Remove hardcoded default values from descriptions 
They are now generated automatically by doctool.
 2019-06-30 13:58:07 +02:00
Rémi Verschelde
c6cea6e9b3 doc: Add default values to all properties 
Thanks to @bojidar-bg's impressive work in #29380.
 2019-06-30 13:58:07 +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
528c4722d6 doc: Don't use GlobalScope scope in hyperlinks, it's automatically inferred 2019-06-27 14:43:37 +02: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
3a365c1fc0 doc: Sync classref with current source 2019-05-28 18:08:13 +02:00
Rémi Verschelde
ab4705a807
Merge pull request #28125 from KoBeWi/code_true_code 
Consistently wrap booleans in [code]
 2019-04-22 11:59:16 +02:00
Rémi Verschelde
6af69f851a doc: Drop unused <demos> tag 2019-04-19 11:03:46 +02:00
Tomasz Chabora
b0846f60c9 Consistently wrap booleans in [code] 2019-04-17 17:13:00 +02:00
Rémi Verschelde
70a009833b
Merge pull request #27561 from KoBeWi/get_frame_doc 
Document SceneTree.get_frame() and persistent in add_to_group()
 2019-04-09 12:10:48 +02:00
Rémi Verschelde
63d3a42f82
Merge pull request #27465 from neikeq/road-to-lang-agnostic-docs-is-going-to-be-tough 
EditorHelp: Improve enum ref resolving and add constant ref support
 2019-04-05 15:19:21 +02:00
Rémi Verschelde
39c868171e doc: Bump version to 3.2 2019-04-01 12:33:56 +02:00
Tomasz Chabora
1e9128238e Document SceneTree.get_frame() and persistent in add_to_group 2019-03-31 21:17:50 +02:00
Ignacio Etcheverry
d80bc5cbba ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] 
Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
 2019-03-29 23:47:35 +01:00
Chris Bradfield
08c3a2241d [DOCS] Minor classref updates. 2019-02-24 20:30:26 -08:00
Rémi Verschelde
ee6f1fa3f8 doc: Fix references to setters and misc formatting 2018-12-29 00:17:09 +01:00
Rémi Verschelde
6cdcde7114 doc: Add missing commas after "If true/false" 2018-12-20 13:47:12 +01:00
Rémi Verschelde
5f8af252e8 doc: Use HTTPS for docs.godotengine.org and point to latest branch 
Fixes #23509.
 2018-11-05 08:46:27 +01:00
florian
353af122b8 Add Behaviour of SceneTree pausing to the doc 2018-10-03 15:29:25 +02:00
Fabio Alessandrelli
d6b31daec6 Rename slave keyword to puppet 
The slave keyword will still be available as deprecated in 3.1 but will
be dropped from future releases.
 2018-09-15 00:06:03 +02:00
luz.paz
08bde5b2de Misc. typos 
Found via `codespell -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po"`
 2018-09-12 21:39:17 -04:00
Kelly Thomas
1dc8e7c05f Improve ClassDB information for some some signal parameters 2018-09-01 18:05:51 +08:00
Poommetee Ketson
5ed0861e81 [DOCS] SceneTree stretching constants 2018-08-07 10:17:55 +07:00
robojumper
98b59cf2a3 Add support for tutorial links to makerst.py 
Also change the <tutorials> structure to make use of individual <link> tags
 2018-06-12 17:40:24 +02:00
Fabio Alessandrelli
348725dfe0 Add option to disable automatic multiplayer poll 
Automatic poll from SceneTree is enabled by default.
This allows for polling (and thus RPCs/RSETs) manually in other loops
(e.g. physics, thread, specific step) and for proper mutex protecion
when accessing the multiplayer API from threads (e.g. for sending larger
files in chunks).
 2018-06-03 18:58:04 +02:00
Michael Alexsander Silva Dias
e10687a520 Fixed GroupCallFlags links in the SceneTree's doc. 2018-05-27 01:22:34 -03:00