b68dd2e189
Add an XML schema for documentation
...
This makes it easier to spot syntax errors when editing the
class reference. The schema is referenced locally so validation
can still work offline.
Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-15 00:03:31 +01:00
bb7d003881
DOCS: Object.set() does nothing on type mismatch
2022-02-02 11:24:47 +01:00
66fae485ea
Add a note that the script property is part of the object class
2022-01-09 10:26:16 -05:00
f10cc3d7f6
Add a link to the notifications tutorial page in the object class reference
2021-12-22 21:37:54 -05:00
4ea6709558
Clarify get_indexed in relation to Nodes
2021-11-22 13:21:45 +01:00
6c1bd4d227
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 13:02:21 +01:00
862994a8ef
doc: Update links to latest documentation after content reorganization
2021-10-06 13:48:48 +02:00
9d4c84e154
Merge pull request #52587 from zacryol/call_example_change
...
Change example used for StringName call methods
2021-09-13 02:57:21 +02:00
a15847e5ca
Document `Object.get_class()/is_class()` ignores `class_name` declaration
2021-09-13 02:17:24 +02:00
b587c77cb2
Change example used for StringName call methods
...
Co-authored-by: Raul Santos <raulsntos@gmail.com>
2021-09-11 19:11:57 -06:00
4fae7ae9dc
Correct null and boolean values being capitalised by the str command
2021-08-26 17:11:34 +10:00
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
1147fa5c19
Make Object "meta" functions take StringName.
...
The various get_meta, set_meta, has_meta, get_meta_list, remove_meta
functions now uses StringName, allowing further optimizations via the
SNAME macro when used from C++ (this PR does not change the various
usage though).
2021-07-22 22:52:30 +02:00
0ff4095b36
Better format arguments in variant parser
2021-06-18 00:06:40 -03:00
04688b92ff
Rename Reference to RefCounted
2021-06-11 18:48:42 +02:00
8455e901f3
class reference proofreading
2021-03-19 13:21:20 +01:00
0d1d719178
doc: Sync classref with current source
...
And fix various bogus bindings following previous PRs.
2021-02-19 14:39:14 +01:00
e2a80a4be3
Merge pull request #43245 from HaSa1002/docs-object
...
Docs: Object: Use new signal syntax and port to C#
2021-02-08 12:53:44 +01:00
215d18814e
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
790f788833
Docs: Object: Use new signal syntax and port to C#
...
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
Co-authored-by: Ignacio Etcheverry <ignalfonsore@gmail.com>
2021-01-04 12:10:12 +01:00
cba4d73b71
Document how to remove metadata from an Object
...
This closes https://github.com/godotengine/godot-docs/issues/4010 .
2020-09-14 14:01:13 +02:00
ee03e39da7
doc: Sync classref with current source
2020-08-31 11:25:11 +02:00
ce3461dc88
Update GDScriptTranslationParserPlugin to use GDSriptParser instead of RegEx.
2020-08-19 03:10:51 +02:00
0ef758eaee
Updated Translation architecture to have TranslationPO, did some commit fixes and updated class Reference.
2020-08-19 03:01:53 +02:00
4275e6aad5
Improve the Object, Reference and Resource class documentations
2020-07-27 10:03:46 +02:00
878f03d8e3
Mention C# gotchas in Object's dynamic call/set/connect methods
...
This closes #34015 .
2020-07-14 17:07:10 +02:00
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
55bad66447
Update description of Object.free() method
...
Clarify that variables pointing to an object don't become `null` when that object is freed, it just makes them invalid.
(cherry picked from commit ccf5703568
2020-05-18 09:11:22 +02:00
eaaee63b62
doc: Update classref with node renames
...
A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:23:02 +02:00
258d91f883
Added has_signal method for Object
2020-03-23 11:27:17 +01:00
fea37cfb52
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00
213a85521d
doc: Sync classref with current source
...
Handle removal of Pool*Array types and other recent changes.
2020-02-18 14:02:02 +01:00
57e27683ba
Update docs to version 4.0
2020-01-31 17:15:41 -08:00
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
c4745c96d7
Remove unnecessary extra spaces before comments in code examples.
2020-01-23 14:41:49 -03:00
0a965300e7
doc: Document what happens to old script with Object.set_script()
2020-01-06 13:57:35 +01:00
6e79d683fa
Document the return value of `Object.get()` with a nonexistent property
2020-01-04 20:16:10 +01:00
4d727f1ee6
Allows to doc vararg method return type as void
2020-01-02 21:37:26 +08:00
bc234ce0ae
[Docs] Description updates for Node2D & Object
2019-12-26 10:24:29 -08:00
b81f9f777f
Better description of the binds parameter of connect
...
Now states how binds are handled if they are used together with parameters passed to emit_signal
2019-11-21 09:15:58 +01:00
7123fab771
Add FuncRef.call_funcv
...
Closes #31143
2019-08-08 11:58:57 +03:00
b9aa13e591
doc: Remove hardcoded default values from descriptions
...
They are now generated automatically by doctool.
2019-06-30 13:58:07 +02:00
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
528c4722d6
doc: Don't use `GlobalScope` scope in hyperlinks, it's automatically inferred
2019-06-27 14:43:37 +02:00
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
a9cff880d6
doc: Document EncodedObjectAsID, expose its property
2019-06-26 10:50:45 +02:00
6843ad87a4
Add docstring for Object.set_deferred
2019-06-24 12:57:14 -05:00
21a0dad58a
Improve the documentation of the Object class
...
I edited the main description to remove parentheses and split long sentences.
Closes #29382
Closes #29384
2019-06-03 19:10:59 +09:00
86f6d08923
doc: Sync classref with current source
2019-05-21 13:27:03 +02:00
defd960276
Merge pull request #27886 from LeonardMeagher2/obj_to_string
...
Allow overriding how scripted objects are converted to strings
2019-05-20 22:37:01 +02:00
Hugo Locurcio
Max Hilbrunner
skyace65
kobewi
Rémi Verschelde
Max Hilbrunner
zacryol
Balloonpopper
Fabio Alessandrelli
Michael Alexsander Silva Dias
Pedro J. Estébanez
Paul Joannon
Rémi Verschelde
HaSa1002
SkyJJ
Remi Rampin
PouleyKetchoupp
clayjohn
rainlizard
Haoyu Qiu
Chris Bradfield
Benjamin Navarro
Bojidar Marinov
Randall Fulton
Nathan Lovato