e86a64a2a5
Add optional 'default' argument to get_meta()
...
(cherry picked from commit 3eb7fc4bfd
2022-04-13 11:43:49 +02:00
3fe37f9635
update _init() description
...
Specify details regarding required parameters.
(cherry picked from commit 21fc3cbe81
2022-03-22 10:29:25 +01:00
b087538119
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-03-16 23:01:02 +01:00
12841d536f
DOCS: Object.set() does nothing on type mismatch
...
(cherry picked from commit bb7d003881
2022-02-11 09:50:06 +01:00
b1153f8829
Fix broken links in Class Reference
2021-12-10 21:07:21 +08:00
de365200bb
Clarify get_indexed in relation to Nodes
...
(cherry picked from commit 4ea6709558
2021-11-25 22:48:20 +01:00
3ac2999f22
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 17:22:47 +01:00
14c366ddd7
Bump version to 3.5-beta
2021-11-05 16:10:17 +01:00
3872986f1f
Document `Object.get_class()/is_class()` ignores `class_name` declaration
...
(cherry picked from commit a15847e5ca
2021-09-21 17:14:58 +02:00
f0b37b1519
doc: Point URLs to 3.4 version of the online docs
2021-08-12 17:08:10 +02:00
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
c3272997cd
doc: Update classref headers with 3.4 version
2021-04-26 13:15:29 +02:00
1c9203ad68
Object: Make deleted object access raise errors, not warnings
...
Clarify doc about not decaying to `null` for `free` and `queue_free`.
Part of #45639 .
2021-04-20 11:37:39 +02:00
015973df04
doc: Make all tutorial links point to 3.3 branch of docs
2021-03-26 10:43:43 +01:00
596169d7df
class reference proofreading
...
(cherry picked from commit 8455e901f3
2021-03-26 09:49:07 +01:00
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
48d5080e6a
Link to advanced exports tutorial in the Object class documentation
2021-03-05 22:44:41 +01:00
898327b312
Document known bug with `Object.new()` and workaround
2021-02-07 16:15:24 +01:00
4287af5148
doc: Make docs.godotengine.org links point to 3.2 branch
2020-10-19 16:10:01 +02:00
738f6ea221
Document how to remove metadata from an Object
...
This closes https://github.com/godotengine/godot-docs/issues/4010 .
(cherry picked from commit cba4d73b71
2020-09-14 14:24:14 +02:00
b717a61903
Improve the Object, Reference and Resource class documentations
...
(cherry picked from commit 4275e6aad5
2020-07-28 00:48:33 +02:00
e41ab634c6
Mention C# gotchas in Object's dynamic call/set/connect methods
...
This closes #34015 .
(cherry picked from commit 878f03d8e3
2020-07-15 12:48:18 +02:00
5a1f94ba47
Document the `in` operator in String, Array and Dictionary classes
...
This also clarifies the `in` operator behavior in Object.
(cherry picked from commit 7f01f68226
2020-06-15 14:34:34 +02:00
ccf5703568
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.
2020-05-16 12:32:41 -04:00
82bee3f993
Added has_signal method for Object
...
(cherry picked from commit 258d91f883
2020-03-25 09:36:41 +01: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
f7eb426e2e
Allow overriding how scripted objects are converted to strings
...
solves #26796
- ADD `String to_string()` method to Object which can be overriden by `String _to_string()` in scripts
- ADD `String to_string(r_valid)` method to ScriptInstance to allow langauges to control how scripted objects are converted to strings
- IMPLEMENT to_string for GDScriptInstance, VisualScriptInstance, and NativeScriptInstance
- ADD Documentation about `Object.to_string` and `Object._to_string`
- Changed `Variant::operator String` to use `obj->to_string()`
2019-05-03 15:06:05 -07:00
c991379b81
doc: Sync classref with current source
2019-04-30 14:23:59 +02:00
ab4705a807
Merge pull request #28125 from KoBeWi/code_true_code
...
Consistently wrap booleans in [code]
2019-04-22 11:59:16 +02:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
b0846f60c9
Consistently wrap booleans in [code]
2019-04-17 17:13:00 +02:00
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
2e39e38c10
doc: Sync classref with current source
...
Fix various code formatting issues and argument names.
2018-12-27 11:10:18 +01:00
a98baad18f
Docs: Add mention to Object constructors in scripting languages
...
Fixes godotengine/godot-docs#1968 .
2018-12-13 20:23:36 +01:00
kobewi
zacryol
Hugo Locurcio
Max Hilbrunner
Haoyu Qiu
Rémi Verschelde
Paul Joannon
Remi Rampin
PouleyKetchoupp
Michael Alexsander
rainlizard
Chris Bradfield
Benjamin Navarro
Bojidar Marinov
Randall Fulton
Nathan Lovato
Leonard Meagher
Davide Cristini