41 Commits

Author SHA1 Message Date
Hugo Locurcio
229d02c146 Document reading an exported property value's early on in GDScript exports 2025-11-04 18:19:06 +01:00
Hugo Locurcio
b3cbe5f777 Remove old Godot version references to simplify documentation
This follows the documentation writing guidelines, specifically
the "When to refer to a specific Godot version" section.

This also removes warning blocks for a known issue that was resolved in Godot 4.5.
2025-10-07 19:01:12 +02:00
Matthew
ff29de0d89 Merge pull request #9980 from HolonProduction/editable-clearup
Clearify behaviour of `@export` in combination with setters
2025-07-18 21:20:31 -04:00
Matthew
7e591554a2 Merge pull request #10823 from Calinou/gdscript-exports-tool-button-icon
Document `@export_tool_button` icon parameter in GDScript exports
2025-06-27 14:31:22 -04:00
A Thousand Ships
92cd36b50e Various grammar and spelling fixes 2025-06-23 16:37:26 +02:00
HolonProduction
b26724f1b4 Clearify behaviour of @export in combination with setters 2025-06-16 23:47:57 +02:00
Hugo Locurcio
8a6ad4c926 Replace uses of shorthand codeblock syntax to avoid issues with localization
Previously, many paragraphs in the documentation used `::` at the end of a line
as a replacement for a single colon (and `::` on the following line).
Due to this, the `::` was part of the extracted string for localization.
Weblate also showed a warning about the trailing `::`, as it's not
normally expected to be there.

This change requires translators to revalidate all modified strings.
However, considering many of those have broken code blocks due to translators
replacing `::` with `:`, it can be a good idea.

This also adds documentation writing guidelines for code blocks and admonitions.
This commit does not modify existing admonitions in any way (as this would
lead to a much larger diff, and require more localizable text to be revalidated
by translators).
2025-05-30 02:02:30 +02:00
lena
f31a4ac23f docs: Add a note about the effect of @export. (#10560)
Add information on @export and RPC.
2025-04-11 10:42:19 -04:00
starsJuly
2f4ad61ef6 Update the @export_custom example in gdscript_exports.rst
Co-authored-by: tetrapod <145553014+tetrapod00@users.noreply.github.com>
2025-04-11 11:01:50 +08:00
starsJuly
ab6e73822a Fix @export_custom hint format in gdscript_exports.rst 2025-04-10 21:23:44 +08:00
Hugo Locurcio
949cf045f0 Document @export_tool_button icon parameter in GDScript exports 2025-04-01 01:41:40 +02:00
Billy Guzik
42ac7c8431 Update gdscript_exports.rst (#9327)
* Update gdscript_exports.rst

Added hyperlinks for each export type that lead to annotation documentation further explaining each export type, as requested in issue#9281
2025-01-25 11:32:33 -05:00
52SW
e05cebecdb Document GDScript @export_tool_button (#10338)
* Add @export_tool_button to the documention
2024-11-29 15:18:08 -05:00
tetrapod00
09156f2ee9 Add UPDATE comments to perishable information 2024-11-17 13:50:42 -08:00
notPelf
00221436f4 Add info about layer mask exporting to physics_introduction.rst (#10242)
* Update physics_introduction.rst

The docs page for raycasting provides a link to the physics introduction page for how to set a collision mask on a raycast created in code. The physics introduction page does not mention export annotations for exporting a collision mask. This pull request adds a brief bit about exporting layer masks, and links to the export annotation docs.

---------

Co-authored-by: tetrapod <145553014+tetrapod00@users.noreply.github.com>
2024-11-17 11:30:23 +01:00
Hugo Locurcio
4c3020b775 Document @export_custom and additional range hints in GDScript exports
This also adds a hint suffix example to C# exports.

Co-authored-by: Shawn Hardern <126725649+ShawnHardern@users.noreply.github.com>
2024-11-11 17:22:44 +01:00
Kleidon
198625efea Fix "or_greater"/"or_less" code example
The code example demonstrating the usage of the "or_greater" and "or_less" hints for the export_range annotation does not declare a variable after the annotation, which is inconsistent with the previous three code examples in the section.
Also, giving the export_range a step of 1 does not create a slider for the property in the editor, like the text suggests, but it instead creates a spin box. The step should be changed to a float so the property can appear as a slider.
2024-10-11 18:56:18 -06:00
Sai Nane
f10b322c27 Fix description of typed resource exports
`AnimationNode`'s inherited classes are `Resource`, `RefCounted`, and `Object`.

I assume it meant to say "derived classes", or something along the lines of
"and all classes which inherit it".
2024-08-06 14:49:08 +00:00
Abel Toy
bd7bc61e9e Document new feature allowing @exported Arrays to set property hints for their elements (#9061)
* Document export variations for arrays

* Update tutorials/scripting/gdscript/gdscript_exports.rst

Co-authored-by: Raul Santos <raulsntos@gmail.com>

---------

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
Co-authored-by: Raul Santos <raulsntos@gmail.com>
2024-03-25 17:34:38 +01:00
Danil Alexeev
88ec4c294b GDScript: Document @export_storage annotation 2024-03-01 22:28:32 +03:00
Yuri Sizov
cd92be066d Update references to private class methods across the docs 2023-11-10 16:06:36 +01:00
Yuri Sizov
ac728e8dd2 Update the state of C#/.NET support as of 4.2 2023-10-03 18:03:52 +02:00
CactiChameleon9
cf5222b129 Fix mention of Godot3's or_lesser for export_range 2023-07-08 06:34:20 +01:00
huulong
e7fbd0e136 Fix gdscript_exports @export_node_path example by adding quotes around class names to pass strings 2023-02-08 20:24:28 +01:00
Danil Alexeev
aa271f3aab Clarify @export_enum docs (#6704) 2023-02-04 23:13:33 +03:00
J.M. de Jong
6485c97491 link to appropriate Object._get() and Object._set() sections 2023-01-15 11:12:30 +01:00
Hana
74804eb8e9 update gdscript export docs 2022-12-29 22:20:33 +01:00
Hugo Locurcio
01cc64412c Document node property exports now being possible in GDScript 2022-12-08 14:32:39 +01:00
atn
eb60c8968c small correction
Removed an additional notify in the function's name
2022-10-20 09:27:51 +02:00
Max Hilbrunner
99d3d0be12 Renames / fixes for Godot 4 2022-10-17 00:35:07 +02:00
Hugo Locurcio
696f746dff Fix nested typed arrays being claimed as supported in GDScript reference 2022-09-04 19:41:53 +02:00
Vladislav Vorobev
3dd5afca78 Fix missing code blocks in GDScript exports (#5998) 2022-07-28 23:08:51 +02:00
Hugo Locurcio
b54e6e4ec8 Update syntax for GDScript 2.0 in GDScript exports 2022-04-10 01:55:11 +02:00
Micky
1d6c90a434 Change remaining "export" to "@export"
This PR changes the "export"s in the Array section of the GDScript Exports documentation to the "@export" annotation to be in line with 4.0.

Also slightly touches up the wording when referring to default null assignment and Packed*Arrays.
2022-02-27 14:30:15 +01:00
SnailRhymer
5d43929a09 Add navigation annotations to gdscript export docs
Under 'exporting bit flags', add 2D and 3D navigation annotations to the bit flag annotation examples.
2022-01-27 15:50:20 +00:00
Rémi Verschelde
f39354b7f8 GDScript: Remove reference to @export_exp_range
Cf. #52800.
2021-09-17 23:00:38 +02:00
Aaron Franke
4060179184 Remove trailing space characters (#5251) 2021-09-13 14:52:39 +02:00
skyace65
f8fffccde0 Add C# Export Page 2021-09-07 08:38:17 -04:00
skyace65
baa8f38032 minor clarification about export node_path 2021-08-03 19:35:30 -04:00
George Marques
ec48a04a85 Update export docs to use annotations 2020-10-10 21:44:07 -06:00
Nathan Lovato
4272395ab7 Move scripting section to tutorials/
Closes #4113
2020-10-07 14:05:48 -06:00