Skip to content

Commit 42ac7c8

Browse files
authored
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
1 parent f167d48 commit 42ac7c8

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

tutorials/scripting/gdscript/gdscript_exports.rst

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -99,19 +99,19 @@ annotation.
9999
Strings as paths
100100
----------------
101101

102-
String as a path to a file.
102+
String as a path to a file. See :ref:`@export_file <class_@GDScript_annotation_@export_file>`.
103103

104104
::
105105

106106
@export_file var f
107107

108-
String as a path to a directory.
108+
String as a path to a directory. See :ref:`@export_dir <class_@GDScript_annotation_@export_dir>`.
109109

110110
::
111111

112112
@export_dir var f
113113

114-
String as a path to a file, custom filter provided as hint.
114+
String as a path to a file, custom filter provided as hint. See again :ref:`@export_file <class_@GDScript_annotation_@export_file>`.
115115

116116
::
117117

@@ -120,20 +120,20 @@ String as a path to a file, custom filter provided as hint.
120120
Using paths in the global filesystem is also possible,
121121
but only in scripts in tool mode.
122122

123-
String as a path to a PNG file in the global filesystem.
123+
String as a path to a PNG file in the global filesystem. See :ref:`@export_global_file <class_@GDScript_annotation_@export_global_file>`.
124124

125125
::
126126

127127
@export_global_file("*.png") var tool_image
128128

129-
String as a path to a directory in the global filesystem.
129+
String as a path to a directory in the global filesystem. See :ref:`@export_global_dir <class_@GDScript_annotation_@export_global_dir>`.
130130

131131
::
132132

133133
@export_global_dir var tool_dir
134134

135135
The multiline annotation tells the editor to show a large input
136-
field for editing over multiple lines.
136+
field for editing over multiple lines. See :ref:`@export_multiline <class_@GDScript_annotation_@export_multiline>`.
137137

138138
::
139139

@@ -142,6 +142,8 @@ field for editing over multiple lines.
142142
Limiting editor input ranges
143143
----------------------------
144144

145+
See :ref:`@export_range <class_@GDScript_annotation_@export_range>` for all of the following.
146+
145147
Allow integer values from 0 to 20.
146148

147149
::
@@ -222,7 +224,7 @@ Floats with easing hint
222224
-----------------------
223225

224226
Display a visual representation of the ``ease()`` function
225-
when editing.
227+
when editing. See :ref:`@export_exp_easing <class_@GDScript_annotation_@export_exp_easing>`.
226228

227229
::
228230

@@ -237,7 +239,7 @@ Regular color given as red-green-blue-alpha value.
237239

238240
@export var col: Color
239241

240-
Color given as red-green-blue value (alpha will always be 1).
242+
Color given as red-green-blue value (alpha will always be 1). See :ref:`@export_color_no_alpha <class_@GDScript_annotation_@export_color_no_alpha>`.
241243

242244
::
243245

@@ -303,6 +305,8 @@ in conjunction with a :ref:`script in "tool" mode <doc_gdscript_tool_mode>`.
303305
Exporting bit flags
304306
-------------------
305307

308+
See :ref:`@export_flags <class_@GDScript_annotation_@export_flags>`.
309+
306310
Integers used as bit flags can store multiple ``true``/``false`` (boolean)
307311
values in one property. By using the ``@export_flags`` annotation, they
308312
can be set from the editor::
@@ -341,6 +345,8 @@ If in doubt, use boolean variables instead.
341345
Exporting enums
342346
---------------
343347

348+
See :ref:`@export_enum <class_@GDScript_annotation_@export_enum>`.
349+
344350
Properties can be exported with a type hint referencing an enum to limit their values
345351
to the values of the enumeration. The editor will create a widget in the Inspector, enumerating
346352
the following as "Thing 1", "Thing 2", "Another Thing". The value will be stored as an integer.
@@ -435,6 +441,8 @@ Other export variants can also be used when exporting arrays:
435441
``@export_storage``
436442
-------------------
437443

444+
See :ref:`@export_storage <class_@GDScript_annotation_@export_storage>`.
445+
438446
By default, exporting a property has two effects:
439447

440448
1. makes the property stored in the scene/resource file (:ref:`PROPERTY_USAGE_STORAGE <class_@GlobalScope_constant_PROPERTY_USAGE_STORAGE>`);

0 commit comments

Comments
 (0)