Commit Graph

142 Commits

Author SHA1 Message Date
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
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
Yuri Sizov cc0eebd9d8 Validate `code` tags for class and member references
This commit also adds means to manually disable warnings
in `code` tags where it's a false positive with the new
`skip-lint` attribute.

Warnings are now enabled on CI to prevent future errors.
2023-10-03 15:48:31 +02:00
Rémi Verschelde 8dfd9d39a6
Merge pull request #81093 from mateuseap/docs/objectClassReference
Improve `Object.get_property_list()` method description
2023-08-29 12:48:19 +02:00
Mateus Elias 6020e34757 Improve Object.get_property_list() method description 2023-08-29 07:11:11 -03:00
kobewi 67db4693eb Expose _validate_property() for scripting 2023-08-28 15:18:48 +02:00
Yuri Sizov 4b208fec74 Merge pull request #80884 from timothyqiu/typo-fixes
Fix various typos in classref
2023-08-25 14:58:47 +02:00
Haoyu Qiu d026b37abd Fix various typos in classref 2023-08-22 18:05:50 +08:00
kobewi 90160eff80 Fix _set example 2023-08-12 12:46:46 +02:00
Rémi Verschelde 81064cc239
Doctool: Remove version attribute from XML header
We don't use that info for anything, and it generates unnecessary diffs
every time we bump the minor version (and CI failures if we forget to
sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 10:08:21 +02:00
Rémi Verschelde 346f1ab86b
Bump version to 4.2-dev
Keep on waitin'
2023-07-05 22:07:03 +02:00
L4Vo5 2747dd35e7 clarify the meaning of "deferred" 2023-06-18 00:46:58 -03:00
Yuri Sizov 5edcf4f3c7
Merge pull request #77614 from mhilbrunner/class_ref_documentation_object_set_meta
Docs: Update Object's class reference regarding meta data
2023-05-29 17:06:32 +02:00
Devin cdc2e6d872 Updated Object's class reference documentation for set_meta to indicate metadata's name must be a valid identifier 2023-05-29 16:09:16 +02:00
Dipal Zambare 41ac5a406e Fix typo in CS notification example of the Object class 2023-05-25 10:09:12 +02:00
Juan Linietsky 98c655ec8d Refactor Node Processing
* Node processing works on the concept of process groups.
* A node group can be inherited, run on main thread, or a sub-thread.
* Groups can be ordered.
* Process priority is now present for physics.

This is the first steps towards implementing https://github.com/godotengine/godot-proposals/issues/6424.
No threading or thread guards exist yet in most of the scene code other than Node. That will have to be added later.
2023-05-09 19:17:51 +02:00
Juan Linietsky 1c93606e47 Add ValidatedCall to MethodBind
* This should optimize GDScript function calling _enormously_.
* It also should simplify the GDScript VM considerably.

NOTE: GDExtension calling performance has most likely been affected until going via ptrcall is fixed.
2023-04-30 20:01:26 +02:00
Paweł 4431cdd154 Remove double thes from documentation 2023-04-17 21:45:30 +02:00
Rémi Verschelde 1c1524a651
Bump version to 4.1-dev
Can't stop, won't stop, they said, huh?
2023-03-01 01:44:37 +01:00
Haoyu Qiu cc384a8228 Add missing period for sentences in classref 2023-02-12 11:39:14 +08:00
Yuri Sizov 03ae8caea8 Fix incorrect description for `Signal::get_connections` 2023-02-03 17:28:17 +01:00
Raul Santos 7eb8325180
Fix C# examples in documentation
- Fix documentation after C# renames.
- Add missing `partial` in C# class declarations.
- Change `delta` parameter type to `double` in C#.
- Ensure parameters match base declaration.
- Use `$` string interpolation in C#.
- Fix invalid or outdated C# code.
- Changed some examples to follow our style guide more closely.
2023-01-31 19:04:07 +01:00
Raul Santos 92e4b4e888
Update C# signal documentation and remove bind array
- Updates C# signal documentation and code examples to the new API in 4.0
- Replace all `nameof` usages with the exposed `StringName`
2023-01-23 16:45:37 +01:00
Rémi Verschelde 5b1df48c6c
Convert en_GB spelling to en_US with codespell 2023-01-23 11:02:20 +01:00
Yuri Sizov 4c1f11944e Update all outdated online documentation links 2023-01-14 19:38:00 +03:00
Rémi Verschelde 346efd29e0
Fix typos with codespell 2022-12-15 12:24:08 +01:00
Yuri Sizov a9961b378a Add missing public property_*_revert getters 2022-11-29 23:07:40 +03:00
Raul Santos e27f127a74
Fix C# documentation for Godot.Object
- Add and fix a few C# examples
- Add tips about avoiding allocating StringNames
2022-11-24 04:09:14 +01:00
Micky bee1b52e30 Overhaul Object's Documentation 2022-11-23 18:13:18 +01:00
Rémi Verschelde f7c611ab71
Style: Misc docs and comment style and language fixes
- Removed empty paragraphs in XML.
- Consistently use bold style for "Example:", on a new line.
- Fix usage of `[code]` when hyperlinks could be used (`[member]`, `[constant]`).
- Fix invalid usage of backticks for inline code in BBCode.
- Fix some American/British English spelling inconsistencies.
- Other minor fixes spotted along the way, including typo fixes with codespell.
- Don't specify `@GlobalScope` for `enum` and `constant`.
2022-11-02 19:01:18 +01:00