1
0
mirror of https://github.com/godotengine/godot.git synced 2025-11-04 12:00:25 +00:00
Commit Graph

170 Commits

Author SHA1 Message Date
kobewi
6640380bb6 Add multilevel notes to methods 2025-10-20 11:47:37 +02:00
Lukas Tenbrink
527f4e9e68 Update class reference contribution link. 2025-09-10 16:50:44 +02:00
kobewi
29a3f56701 Clarify _set/_get description 2025-06-21 22:58:54 +02:00
kobewi
b103f2d8c1 Add a note about _notification() being multilevel 2025-06-16 22:26:37 +02:00
kobewi
13f642d959 Replace XML codeblock spaces with tabs 2025-06-06 14:35:38 +02:00
Aaron Franke
c58483ad0b Document that memdelete() is the GDExtension C++ version of free() 2025-06-03 23:37:41 -07:00
Rindbee
5e2396e001 Add a flag to make the connection automatically emit the source object.
Mainly used to improve the connection dialog.

Not implemented in `emit_signalp()`, append the source object when a PackScene is instantiated.
2025-05-27 20:19:03 +08:00
Danil Alexeev
4f3b998b09 Documentation: Add tip to use more specific return type for _iter_get() 2025-05-02 18:20:08 +03:00
Juan
2f39d8ebef Add thread safety to Object signals
* It turns out the majority of this work was done already by AThousandShips as part of #89451. This allows to do lock-less emitting of signals.
* This means, that only the signal map needs to be protected, making the task simple and without risk of deadlocks, or affecting performance.
* Objects can choose to not protect signals for performance (as example Node uses thread guards for protection, so these signals are not thread safe).
2025-04-16 17:14:44 +02:00
Thaddeus Crews
9b3e445e47 Merge pull request #105073 from Mickeon/documentation-miscellaneous-oddities-part-4
Fix miscellaneous oddities around the class reference (part 4)
2025-04-11 09:51:11 -05:00
Micky
e935fb1ee2 Fix miscellaneous oddities around the class reference (part 4) 2025-04-10 17:56:58 +02:00
Thaddeus Crews
cf3f02c550 Merge pull request #94143 from Mickeon/documentation-object-connect-to-signal-too-long-didn't-read
Move and simplify Object's `connect` description slightly
2025-04-09 18:11:59 -05:00
Roan Lubbe
6b1869b76b Fix get_meta_list return type in description 2025-01-03 16:17:28 +11:00
Raul Santos
072ff85f82 [.NET] Use collection expressions in docs
As of C# 12 we can now use collection expressions to reduce some boilerplate when initializing collections.
2024-12-21 02:28:59 +01:00
Micky
d90f045d24 Update documentation's "Prints" comments after #47502 2024-11-30 16:14:11 +01:00
Thaddeus Crews
2a147f3ce1 Merge pull request #99091 from Mickeon/documentation-object-boolean-context-4.4
Add documentation note on Object's boolean context
2024-11-27 10:46:54 -06:00
Micky
eaebb3f864 Fix more miscellaneous oddities around the class reference 2024-11-12 17:44:45 +01:00
Thaddeus Crews
e66d9988a6 Merge pull request #95774 from Mickeon/documentation-miscellaneous-oddities
Fix miscellaneous oddities around the class reference
2024-11-12 09:27:47 -06:00
Micky
f789025d42 Add documentation note on Object's boolean context 2024-11-11 22:21:59 +01:00
Micky
5c5460b026 Fix many untagged true/false/null in the documentation 2024-11-10 11:26:39 +01:00
A Thousand Ships
203d3be200 [Core] Add way to check if a signal has any connections
Added to `Object` and `Signal`
2024-09-20 16:39:09 +02:00
Rémi Verschelde
330cb45c5a Merge pull request #96981 from ItzCog/patch-1
Change "deconstructor" to "destructor"
2024-09-20 16:06:31 +02:00
Dungeon Master
d33f4820cd Change "deconstructor" to "destructor" in NOTIFICATION_PREDELETE docs 2024-09-20 15:49:03 +02:00
Haoyu Qiu
c5d147b9b5 Allow configuring which translation domain Object.tr uses 2024-09-17 13:09:44 +08:00
Danil Alexeev
be5068d44b Core: Bind and document iterator API virtual methods 2024-08-27 21:57:22 +03:00
Jason Wodicka
97cf2c147e Fix C# code example for Object._get_property_list
There were two small errors in this code example that kept it from working when copied to a new node locally. These are the fixes I used locally to test the example.
2024-08-26 12:36:01 -07:00
Micky
b8f78b14be Fix miscellaneous oddities around the class reference 2024-08-18 23:18:44 +02:00
Sai Nane
15f6984675 Fix check in Object._ValidateProperty example
The GDScript version above makes the `number` property read only whenever
`is_number_editable` is false.

```gdscript
func _validate_property(property: Dictionary):
	if property.name == "number" and not is_number_editable:
		property.usage |= PROPERTY_USAGE_READ_ONLY
```

The C# version is similar, but omits the negation, so the Number property is
made read only whenever `is_number_editable` is true.

This adds the negation to the C# example, making it match the GDScript
example.
2024-08-09 19:08:27 +00:00
Micky
824d4ee855 Move and simplify Object's connect description 2024-07-09 21:21:21 +02:00
A Thousand Ships
6ab303cd76 [Doc] Clarify the session-specific nature of RID and ObjectID 2024-06-18 20:19:21 +02:00
MewPurPur
409202d574 Add notes in Object about TranslationServer methods 2024-05-04 02:58:12 +03:00
Radiant
75bca7d112 Remove experimental flag. 2024-04-18 19:37:05 +03:00
Radiant
e263b11cdd Implement remove_user_signal()
Co-authored-by: Timothe Bonhoure <tbonhoure@ymail.Com>
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2024-04-18 11:22:59 +03:00
kkoang
3286e191f3 doc: Use Signal.emit instead of emit_signal in Object examples 2024-04-09 10:35:15 +02:00
kobewi
83789426cc Improve some notification and translation docs 2024-03-24 15:14:02 +01:00
A Thousand Ships
59bcc2888c Add methods to get argument count of methods
Added to:
* `Callable`s
* `Object`s
* `ClassDB`
* `Script(Instance)`s
2024-03-10 11:02:43 +01:00
A Thousand Ships
2f1f8ee39b [Docs][C#] Use PropertyName constants in more places 2024-03-07 13:03:03 +01:00
A Thousand Ships
1cc5b0aa0d [Doc] Clarify some details about deferred calls 2024-02-28 17:04:47 +01:00
Rémi Verschelde
3ce9ae71fc Merge pull request #84906 from /fix-some-defvals 2024-02-23 11:29:22 +01:00
Raul Santos
5ba92e5a57 Fix some DEFVALs to use the right type
- Use `StringName()` in DEFVAL for StringNames.
- Use `Variant()` in DEFVAL for Variants.
2024-02-23 01:50:18 +01:00
kobewi
5473c7e222 Fix implementation of property_can_revert() in PropertyListHelper 2024-02-22 15:05:19 +01:00
Michael Alexsander
7b42c24550 Make auto translation inheritable 2024-02-15 16:51:19 -03:00
RedMser
5911a12db1 Update class reference to include some keywords
More should be added in future PRs, wherever there is demand.
2024-02-09 18:13:23 +01:00
EterDelta
fee70558f8 Expose NOTIFICATION_EXTENSION_RELOADED to ClassDB 2024-02-02 14:57:00 -05:00
Rémi Verschelde
964de297e4 Merge pull request #85450 from KoBeWi/advanced_properties_for_every_Object
Improve documentation for dynamic properties
2024-01-29 13:16:12 +01:00
kobewi
7d0d405e22 Improve documentation for dynamic properties 2024-01-18 02:01:06 +01:00
Gwen
e40b23c619 Correct C# syntax in _validate_property example for the Object class 2023-12-30 19:13:58 +01:00
Rémi Verschelde
d99285db6a Merge pull request #83609 from k0T0z/fix-csharp-syntax-error-in-web-doc
Fix Object class C# syntax error
2023-10-20 15:10:38 +02:00
CopyTIME
458cb99966 Change return type of "_Set" method in csharp code example
Add "return false" to GDScript code example of _Set method
2023-10-19 18:52:11 +08:00
Saif Kandil
74efbde7df Fix Object class C# syntax error
Signed-off-by: Saif Kandil <74428638+k0T0z@users.noreply.github.com>
2023-10-19 13:43:54 +03:00