godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-03 18:11:19 +03:00
Code Issues Packages Projects Releases Wiki Activity

Proofread and improve the whole class reference

Browse Source 
- 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
This commit is contained in:
Hugo Locurcio
2019-06-22 01:04:47 +02:00
parent 538c8eec15
commit f7f6115f76
330 changed files with 2585 additions and 2474 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
doc/classes/FileDialog.xml
View File

@@ -15,7 +15,7 @@
<argument index="0" name="filter" type="String">
</argument>
<description>
Add a custom filter. Example: [code]add_filter("*.png ; PNG Images")[/code]
Adds [code]filter[/code] as a custom filter; [code]filter[/code] should be of the form [code]"filename.extension ; Description"[/code]. For example, [code]"*.png ; PNG Images"[/code].
</description>
</method>
<method name="clear_filters">
@@ -68,10 +68,10 @@
The currently selected file path of the file dialog.
</member>
<member name="filters" type="PoolStringArray" setter="set_filters" getter="get_filters">
Set file type filters. This example shows only .png and .gd files [code]set_filters(PoolStringArray(["*.png ; PNG Images","*.gd ; GD Script"]))[/code].
The available file type filters. For example, this shows only [code].png[/code] and [code].gd[/code] files: [code]set_filters(PoolStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"]))[/code].
</member>
<member name="mode" type="int" setter="set_mode" getter="get_mode" enum="FileDialog.Mode">
Set dialog to open or save mode, changes selection behavior. See enum [code]Mode[/code] constants.
The dialog's open or save mode, which affects the selection behavior. See enum [code]Mode[/code] constants.
</member>
<member name="mode_overrides_title" type="bool" setter="set_mode_overrides_title" getter="is_mode_overriding_title">
If [code]true[/code], changing the [code]Mode[/code] property will set the window title accordingly (e.g. setting mode to [constant MODE_OPEN_FILE] will change the window title to "Open a File").
@@ -85,48 +85,48 @@
<argument index="0" name="dir" type="String">
</argument>
<description>
Event emitted when the user selects a directory.
Emitted when the user selects a directory.
</description>
</signal>
<signal name="file_selected">
<argument index="0" name="path" type="String">
</argument>
<description>
Event emitted when the user selects a file (double clicks it or presses the OK button).
Emitted when the user selects a file by double-clicking it or pressing the [b]OK[/b] button.
</description>
</signal>
<signal name="files_selected">
<argument index="0" name="paths" type="PoolStringArray">
</argument>
<description>
Event emitted when the user selects multiple files.
Emitted when the user selects multiple files.
</description>
</signal>
</signals>
<constants>
<constant name="MODE_OPEN_FILE" value="0" enum="Mode">
The dialog allows the selection of one, and only one file.
The dialog allows selecting one, and only one file.
</constant>
<constant name="MODE_OPEN_FILES" value="1" enum="Mode">
The dialog allows the selection of multiple files.
The dialog allows selecting multiple files.
</constant>
<constant name="MODE_OPEN_DIR" value="2" enum="Mode">
The dialog functions as a folder selector, disallowing the selection of any file.
The dialog only allows selecting a directory, disallowing the selection of any file.
</constant>
<constant name="MODE_OPEN_ANY" value="3" enum="Mode">
The dialog allows the selection of a file or a directory.
The dialog allows selecting one file or directory.
</constant>
<constant name="MODE_SAVE_FILE" value="4" enum="Mode">
The dialog will warn when a file exists.
</constant>
<constant name="ACCESS_RESOURCES" value="0" enum="Access">
The dialog allows the selection of file and directory.
The dialog only allows accessing files under the [Resource] path ([code]res://[/code]).
</constant>
<constant name="ACCESS_USERDATA" value="1" enum="Access">
The dialog allows access files under [Resource] path(res://) .
The dialog only allows accessing files under user data path ([code]user://[/code]).
</constant>
<constant name="ACCESS_FILESYSTEM" value="2" enum="Access">
The dialog allows access files in whole file system.
The dialog allows accessing files on the whole file system.
</constant>
</constants>
<theme_items>