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

58 commits

Author SHA1 Message Date
Rémi Verschelde
862994a8ef
doc: Update links to latest documentation after content reorganization 2021-10-06 13:48:48 +02:00
Max Hilbrunner
770bd61767
Merge pull request #53076 from zacryol/dict-typo-fix 
Fix typo with example variable name in Dictionary docs
 2021-09-30 20:19:05 +02:00
Haoyu Qiu
1e0fe9f817 Fix doc for Dictionary.erase 2021-09-30 01:18:47 +08:00
zacryol
9359bee75c Fix typo with example variable name in Dictionary docs, and fix error in C# example 2021-09-26 11:16:55 -06:00
Aaron Franke
d54f2ad7ca
Don't generate empty doc sections and reduce code duplication 2021-09-20 20:59:33 -05:00
George Marques
455e142d37
Allow comparing equality between builtin types and null 2021-09-17 12:33:52 -03:00
Rémi Verschelde
7adf4cc9b5
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.
 2021-07-30 15:29:52 +02:00
Paul Joannon
8455e901f3
class reference proofreading 2021-03-19 13:21:20 +01:00
Rémi Verschelde
4ca1e73ff9
doc: Sync classref with current source 
And move GLTF docs to its module folder.
 2021-03-18 16:37:43 +01:00
Rémi Verschelde
215d18814e
doc: Sync classref with current source 2021-01-04 14:33:44 +01:00
Marcel Admiraal
5b937d493f Rename empty() to is_empty() 2020-12-28 10:39:56 +00:00
Hugo Locurcio
5325de4e6b
Improve the Dictionary class documentation 
- Mention Lua-style syntax.
- Make the code samples self-contained.
- Mention caveat with `const` (also in Array).
- Clarify the description of `size()`.

This closes https://github.com/godotengine/godot-docs/issues/4272.
 2020-11-14 22:05:53 +01:00
Rémi Verschelde
64e893deac
doc: Sync classref to add operators after #43419 2020-11-10 15:00:50 +01:00
Rémi Verschelde
0f249f5c0a
Variant: Sync docs with new constructors, fixups after #43403 
Change DocData comparators for MethodDoc and ArgumentDoc to get a better
ordering of constructors.
 2020-11-09 23:39:53 +01:00
HaSa1002
8fb113bb4c Port code examples to C# (D) 
Includes:
 * Decal
 * Dictionary
 * Directory
 * DisplayServer
 * DTLSServer
 * DynamicFont
 * EditorImportPlugin
 * EditorPlugin
 * EditorScenePostImport
 * EditorScript
 * EditorSettings
 * EditorTranslationParserPlugin
 * Engine
 * Expression

Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
 2020-11-01 09:05:17 +01:00
Aaron Franke
439be614f4
Link to demos from within the class reference 2020-10-01 23:57:21 -04:00
Hugo Locurcio
c4903a603b
Add link titles for all links in the class reference 
This makes them display in a nicer way in the editor help.
(The title will display instead of the full URL.)
 2020-08-31 14:22:07 +02:00
Hugo Locurcio
7f01f68226
Document the in operator in String, Array and Dictionary classes 
This also clarifies the `in` operator behavior in Object.
 2020-06-12 19:22:35 +02:00
Hugo Locurcio
77b89263dd Mention ordering caveats for Dictionary.hash() 
See https://github.com/godotengine/godot/issues/27615.
 2020-06-10 09:33:43 +02:00
Hugo Locurcio
675fea1648
Document that Dictionary is always passed as reference 
See #38792.
 2020-05-16 23:52:40 +02:00
Marcel Admiraal
4d41535fa3 Correct the addition of a key and the duplication of a variable name 
in Dictionary class documentation.
 2020-04-19 09:52:54 +01:00
Hugo Locurcio
88da90f2bf
Improve the Dictionary class documentation 
This closes https://github.com/godotengine/godot-docs/issues/3376.
 2020-04-12 22:48:02 +02:00
Zak Grumbles
469b7c948f Clarify Dictionary duplicate params godotengine#37162 
* Added additional clarification for the function of the 'deep'
parameter in the Dictionary's `duplicate` method.
 2020-04-02 10:02:02 -05:00
Rémi Verschelde
a2d3ba3372 doc: Sync classref with current source 
Fix wrong binding after #37111.
 2020-03-18 09:14:57 +01:00
Rémi Verschelde
788765709d DocData: Fix serialization of Variant default values 
Co-authored-by: Bojidar Marinov <bojidar.marinov.bg@gmail.com>
 2020-03-09 10:52:44 +01:00
Rémi Verschelde
048f4f8305 doc: Sync classref with apparent Variant return type changes 
Part of those seem bogus, methods like Array.back()/front()
should return a Variant and not void.
 2020-02-22 15:16:32 +01:00
clayjohn
57e27683ba Update docs to version 4.0 2020-01-31 17:15:41 -08: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
Michael Alexsander
c4745c96d7 Remove unnecessary extra spaces before comments in code examples. 2020-01-23 14:41:49 -03:00
Rémi Verschelde
ba177ccaec doc: Misc updates for AnimationNode* and others 
- Add some missing descriptions.
- Add links to tutorials for ARVR and AnimationTree.
- Style fixes.
- Engine changes:
  * Make `AnimationNodeTransition.input_<number>` properties internal
    so that they don't appear in the docs. They still appear in the
    inspector based on the actual number of inputs requested.
  * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D
    particles in `ParticlesMaterial`, and thus only relevant for
    `CPUParticles3D`.
 2020-01-23 12:37:33 +01:00
Feniks
6e24933115 Improve dictionary description 
I improved dictionary description to ad some real life examples and expand on it a little bit so person who never seen dictionary can understand it better seeing them for a first time here. 
I also added note about the way to compare dictionaries  as it can catch people of guard because common assumption is that it works the same as comparing Arrays when it does not.
 2020-01-20 20:36:59 +00:00
Hugo Locurcio
ecd572073c
Mention that Dictionary.hash() can be used for equality comparisons 
See #27615.
 2019-11-11 14:18:11 +01: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
Sean Heffernan
426bcc9941 Change "Return" to "Returns" where necessary in XML documentation 
In many of the XML files it had been noted that when the documentation
refers to a return value, both "Return" and "Returns" are used. This
has now been fixed to only say "Returns".

Fixes #28867
 2019-05-23 21:11:24 -07:00
lopho
5ce9bfcb4f Document dictionary erase return value 2019-05-04 21:10:18 +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
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
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
454b701e76 [DOCS] minor classref updates 2019-03-14 11:36:12 -07:00
Evgeny Savelyev
5594b08e90 added warnings about Dictionary element erasure while iterating over it 2019-02-10 23:28:22 +03:00
Rémi Verschelde
daa9092ed3 doc: Sync classref with current source 2018-11-20 09:34:45 +01:00
m
bf1867aaab Added Python-like .get() method to Dictionary in GDScript #20488 
Added .get() method to Dictionary class in GDScript to return the value if the key exists, or return Null if the key does not exist.
 2018-11-19 14:03:13 -05:00
Rémi Verschelde
f92b87e5f8 DocData: Fix return type listed as "var" instead of "Variant" 2018-08-31 22:41:14 +02:00
Rémi Verschelde
4ea3e4f551 doc: Sync classref with current source 2018-08-21 00:35:46 +02:00
Craigory V Coppola
0dd526e062 Docs update for several classes 
Namely: Dictionary, GraphEdit, Object, TileMap, Script, ScollBar,
ScrollContainer and SplitContainer
 2018-04-19 21:09:53 +02:00
Rémi Verschelde
cb7fe2c793 doc: Sync classref with current source 2018-04-10 10:12:42 +02:00
Rémi Verschelde
3fa77b3172 doc: Remove status from hardcoded version string 
It has no practical use case and just generates noise for each alpha, beta, etc.
 2018-02-27 13:40:49 +01:00