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

classref: sync with 2.0 branch

Browse Source
This commit is contained in:
Rémi Verschelde
2016-04-29 18:14:24 +02:00
parent 22a5819acc
commit 496226cec5
12 changed files with 131 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
classes/class_acceptdialog.rst
View File

@@ -82,10 +82,16 @@ Return true if the dialog will be hidden when accepted (default true).
- :ref:`Button<class_button>` **add_button** **(** :ref:`String<class_string>` text, :ref:`bool<class_bool>` right=false, :ref:`String<class_string>` action="" **)**
Add custom button to the dialog and return the created button.
The button titled with *text* and the *action* will be passed to :ref:`custom_action<class_custom_action>` signal when it is pressed.
.. _class_AcceptDialog_add_cancel:
- :ref:`Button<class_button>` **add_cancel** **(** :ref:`String<class_string>` name **)**
Add custom cancel button to the dialog and return the created button.
.. _class_AcceptDialog_register_text_enter:
- :ref:`LineEdit<class_lineedit>` **register_text_enter** **(** :ref:`Object<class_object>` line_edit **)**

14
classes/class_basebutton.rst
View File

@@ -56,10 +56,10 @@ Signals
Numeric Constants
-----------------
- **DRAW_NORMAL** = **0**
- **DRAW_PRESSED** = **1**
- **DRAW_HOVER** = **2**
- **DRAW_DISABLED** = **3**
- **DRAW_NORMAL** = **0** --- The normal state (i.e. not pressed, not hovered, not toggled and enabled) of buttons.
- **DRAW_PRESSED** = **1** --- The state of buttons are pressed.
- **DRAW_HOVER** = **2** --- The state of buttons are hovered.
- **DRAW_DISABLED** = **3** --- The state of buttons are disabled.
Description
-----------
@@ -73,10 +73,14 @@ Member Function Description
- void **_pressed** **(** **)** virtual
Called when button is pressed.
.. _class_BaseButton__toggled:
- void **_toggled** **(** :ref:`bool<class_bool>` pressed **)** virtual
Called when button is toggled (only if toggle_mode is active).
.. _class_BaseButton_set_pressed:
- void **set_pressed** **(** :ref:`bool<class_bool>` pressed **)**
@@ -93,6 +97,8 @@ If toggle_mode is active, return whether the button is toggled. If toggle_mode i
- :ref:`bool<class_bool>` **is_hovered** **(** **)** const
Return true if mouse entered the button before it exit.
.. _class_BaseButton_set_toggle_mode:
- void **set_toggle_mode** **(** :ref:`bool<class_bool>` enabled **)**

14
classes/class_boxcontainer.rst
View File

@@ -31,9 +31,9 @@ Member Functions
Numeric Constants
-----------------
- **ALIGN_BEGIN** = **0**
- **ALIGN_CENTER** = **1**
- **ALIGN_END** = **2**
- **ALIGN_BEGIN** = **0** --- Align children with beginning of the container.
- **ALIGN_CENTER** = **1** --- Align children with center of the container.
- **ALIGN_END** = **2** --- Align children with end of the container.
Description
-----------
@@ -47,12 +47,20 @@ Member Function Description
- void **add_spacer** **(** :ref:`bool<class_bool>` begin **)**
Add a control to the box as a spacer.
If *begin* is true the spacer control will be inserted in front of other children.
.. _class_BoxContainer_get_alignment:
- :ref:`int<class_int>` **get_alignment** **(** **)** const
Return the alignment of children in the container.
.. _class_BoxContainer_set_alignment:
- void **set_alignment** **(** :ref:`int<class_int>` alignment **)**
Set the alignment of children in the container(Must be one of ALIGN_BEGIN, ALIGN_CENTER or ALIGN_END).

2
classes/class_color.rst
View File

@@ -69,6 +69,8 @@ Member Function Description
- :ref:`Color<class_color>` **blend** **(** :ref:`Color<class_color>` over **)**
Return a new color blended with anothor one.
.. _class_Color_contrasted:
- :ref:`Color<class_color>` **contrasted** **(** **)**

6
classes/class_dictionary.rst
View File

@@ -25,6 +25,8 @@ Member Functions
+------------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has<class_Dictionary_has>` **(** var value **)** |
+------------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_all<class_Dictionary_has_all>` **(** :ref:`Array<class_array>` values **)** |
+------------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`hash<class_Dictionary_hash>` **(** **)** |
+------------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`keys<class_Dictionary_keys>` **(** **)** |
@@ -68,6 +70,10 @@ Erase a dictionary key/value pair by key.
Return true if the dictionary has a given key.
.. _class_Dictionary_has_all:
- :ref:`bool<class_bool>` **has_all** **(** :ref:`Array<class_array>` values **)**
.. _class_Dictionary_hash:
- :ref:`int<class_int>` **hash** **(** **)**

14
classes/class_filedialog.rst
View File

@@ -66,9 +66,9 @@ Numeric Constants
- **MODE_OPEN_FILES** = **1** --- The dialog allows the selection of multiple files.
- **MODE_OPEN_DIR** = **2** --- The dialog functions as a folder selector, disallowing the selection of any file.
- **MODE_SAVE_FILE** = **3** --- The dialog will warn when a file exists.
- **ACCESS_RESOURCES** = **0**
- **ACCESS_USERDATA** = **1**
- **ACCESS_FILESYSTEM** = **2**
- **ACCESS_RESOURCES** = **0** --- The dialog allows the selection of file and directory.
- **ACCESS_USERDATA** = **1** --- The dialog allows ascess files under :ref:`Resource<class_resource>` path(res://) .
- **ACCESS_FILESYSTEM** = **2** --- The dialog allows ascess files in whole file system.
Description
-----------
@@ -140,18 +140,26 @@ Get the file dialog mode from the MODE\_\* enum.
- void **set_access** **(** :ref:`int<class_int>` access **)**
Set the file access permission of the dialog(Must be one of :ref:`ACCESS_RESOURCES<class_access_resources>`, :ref:`ACCESS_USERDATA<class_access_userdata>` or :ref:`ACCESS_FILESYSTEM<class_access_filesystem>`).
.. _class_FileDialog_get_access:
- :ref:`int<class_int>` **get_access** **(** **)** const
Return the file access permission of the dialog.
.. _class_FileDialog_set_show_hidden_files:
- void **set_show_hidden_files** **(** :ref:`bool<class_bool>` show **)**
Set the dialog should show hidden files.
.. _class_FileDialog_is_showing_hidden_files:
- :ref:`bool<class_bool>` **is_showing_hidden_files** **(** **)** const
Return true if the diaog allows show hidden files.
.. _class_FileDialog_invalidate:
- void **invalidate** **(** **)**

2
classes/class_gdfunctionstate.rst
View File

@@ -35,4 +35,6 @@ Member Function Description
- :ref:`bool<class_bool>` **is_valid** **(** **)** const
Should put children to the top left corner instead of center of the container.

16
classes/class_scrollcontainer.rst
View File

@@ -48,32 +48,48 @@ Member Function Description
- void **set_enable_h_scroll** **(** :ref:`bool<class_bool>` enable **)**
Set allows horizontal scrool.
.. _class_ScrollContainer_is_h_scroll_enabled:
- :ref:`bool<class_bool>` **is_h_scroll_enabled** **(** **)** const
Return true if horizontal scrool is allowed.
.. _class_ScrollContainer_set_enable_v_scroll:
- void **set_enable_v_scroll** **(** :ref:`bool<class_bool>` enable **)**
Set allows vertical scrool.
.. _class_ScrollContainer_is_v_scroll_enabled:
- :ref:`bool<class_bool>` **is_v_scroll_enabled** **(** **)** const
Return true if vertical scrool is allowed.
.. _class_ScrollContainer_set_h_scroll:
- void **set_h_scroll** **(** :ref:`int<class_int>` val **)**
Set horizontal scroll value.
.. _class_ScrollContainer_get_h_scroll:
- :ref:`int<class_int>` **get_h_scroll** **(** **)** const
Return current horizontal scroll value.
.. _class_ScrollContainer_set_v_scroll:
- void **set_v_scroll** **(** :ref:`int<class_int>` val **)**
Set vertical scroll value.
.. _class_ScrollContainer_get_v_scroll:
- :ref:`int<class_int>` **get_v_scroll** **(** **)** const
Return current vertical scroll value.

12
classes/class_splitcontainer.rst
View File

@@ -42,9 +42,9 @@ Signals
Numeric Constants
-----------------
- **DRAGGER_VISIBLE** = **0**
- **DRAGGER_HIDDEN** = **1**
- **DRAGGER_HIDDEN_COLLAPSED** = **2**
- **DRAGGER_VISIBLE** = **0** --- The split dragger is visible.
- **DRAGGER_HIDDEN** = **1** --- The split dragger is invisible.
- **DRAGGER_HIDDEN_COLLAPSED** = **2** --- The split dragger is invisible and collapsed.
Description
-----------
@@ -76,14 +76,18 @@ Set if the split must be collapsed.
- :ref:`bool<class_bool>` **is_collapsed** **(** **)** const
Return if the split is collapsed.
Return true if the split is collapsed.
.. _class_SplitContainer_set_dragger_visibility:
- void **set_dragger_visibility** **(** :ref:`int<class_int>` mode **)**
Set visibility of the split dragger(*mode* must be one of :ref:`DRAGGER_VISIBLE<class_dragger_visible>`, :ref:`DRAGGER_HIDDEN<class_dragger_hidden>` or :ref:`DRAGGER_HIDDEN_COLLAPSED<class_dragger_hidden_collapsed>`).
.. _class_SplitContainer_get_dragger_visibility:
- :ref:`int<class_int>` **get_dragger_visibility** **(** **)** const
Return visibility of the split dragger(One of :ref:`DRAGGER_VISIBLE<class_dragger_visible>`, :ref:`DRAGGER_HIDDEN<class_dragger_hidden>` or :ref:`DRAGGER_HIDDEN_COLLAPSED<class_dragger_hidden_collapsed>`).

102
classes/class_streamplayer.rst
View File

@@ -18,55 +18,55 @@ Base class for audio stream playback.
Member Functions
----------------
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_stream<class_StreamPlayer_set_stream>` **(** Stream stream **)** |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| Stream | :ref:`get_stream<class_StreamPlayer_get_stream>` **(** **)** const |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`play<class_StreamPlayer_play>` **(** :ref:`float<class_float>` offset=0 **)** |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`stop<class_StreamPlayer_stop>` **(** **)** |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_playing<class_StreamPlayer_is_playing>` **(** **)** const |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_paused<class_StreamPlayer_set_paused>` **(** :ref:`bool<class_bool>` paused **)** |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_paused<class_StreamPlayer_is_paused>` **(** **)** const |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_loop<class_StreamPlayer_set_loop>` **(** :ref:`bool<class_bool>` enabled **)** |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_loop<class_StreamPlayer_has_loop>` **(** **)** const |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_volume<class_StreamPlayer_set_volume>` **(** :ref:`float<class_float>` volume **)** |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_volume<class_StreamPlayer_get_volume>` **(** **)** const |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_volume_db<class_StreamPlayer_set_volume_db>` **(** :ref:`float<class_float>` db **)** |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_volume_db<class_StreamPlayer_get_volume_db>` **(** **)** const |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_buffering_msec<class_StreamPlayer_set_buffering_msec>` **(** :ref:`int<class_int>` msec **)** |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_buffering_msec<class_StreamPlayer_get_buffering_msec>` **(** **)** const |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_loop_restart_time<class_StreamPlayer_set_loop_restart_time>` **(** :ref:`float<class_float>` secs **)** |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_loop_restart_time<class_StreamPlayer_get_loop_restart_time>` **(** **)** const |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_stream_name<class_StreamPlayer_get_stream_name>` **(** **)** const |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_loop_count<class_StreamPlayer_get_loop_count>` **(** **)** const |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_pos<class_StreamPlayer_get_pos>` **(** **)** const |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`seek_pos<class_StreamPlayer_seek_pos>` **(** :ref:`float<class_float>` time **)** |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_autoplay<class_StreamPlayer_set_autoplay>` **(** :ref:`bool<class_bool>` enabled **)** |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_autoplay<class_StreamPlayer_has_autoplay>` **(** **)** const |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_length<class_StreamPlayer_get_length>` **(** **)** const |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_stream<class_StreamPlayer_set_stream>` **(** :ref:`AudioStream<class_audiostream>` stream **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`AudioStream<class_audiostream>` | :ref:`get_stream<class_StreamPlayer_get_stream>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`play<class_StreamPlayer_play>` **(** :ref:`float<class_float>` offset=0 **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`stop<class_StreamPlayer_stop>` **(** **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_playing<class_StreamPlayer_is_playing>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_paused<class_StreamPlayer_set_paused>` **(** :ref:`bool<class_bool>` paused **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_paused<class_StreamPlayer_is_paused>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_loop<class_StreamPlayer_set_loop>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_loop<class_StreamPlayer_has_loop>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_volume<class_StreamPlayer_set_volume>` **(** :ref:`float<class_float>` volume **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_volume<class_StreamPlayer_get_volume>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_volume_db<class_StreamPlayer_set_volume_db>` **(** :ref:`float<class_float>` db **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_volume_db<class_StreamPlayer_get_volume_db>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_buffering_msec<class_StreamPlayer_set_buffering_msec>` **(** :ref:`int<class_int>` msec **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_buffering_msec<class_StreamPlayer_get_buffering_msec>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_loop_restart_time<class_StreamPlayer_set_loop_restart_time>` **(** :ref:`float<class_float>` secs **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_loop_restart_time<class_StreamPlayer_get_loop_restart_time>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_stream_name<class_StreamPlayer_get_stream_name>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_loop_count<class_StreamPlayer_get_loop_count>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_pos<class_StreamPlayer_get_pos>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`seek_pos<class_StreamPlayer_seek_pos>` **(** :ref:`float<class_float>` time **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_autoplay<class_StreamPlayer_set_autoplay>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_autoplay<class_StreamPlayer_has_autoplay>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_length<class_StreamPlayer_get_length>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -83,13 +83,13 @@ Member Function Description
.. _class_StreamPlayer_set_stream:
- void **set_stream** **(** Stream stream **)**
- void **set_stream** **(** :ref:`AudioStream<class_audiostream>` stream **)**
Set the :ref:`EventStream<class_eventstream>` this player will play.
.. _class_StreamPlayer_get_stream:
- Stream **get_stream** **(** **)** const
- :ref:`AudioStream<class_audiostream>` **get_stream** **(** **)** const
Return the currently assigned stream.

6
classes/class_stringarray.rst
View File

@@ -40,10 +40,14 @@ Member Function Description
- void **push_back** **(** :ref:`String<class_string>` string **)**
Append a string element at end of the array.
.. _class_StringArray_resize:
- void **resize** **(** :ref:`int<class_int>` idx **)**
Reset the size of the array.
.. _class_StringArray_set:
- void **set** **(** :ref:`int<class_int>` idx, :ref:`String<class_string>` string **)**
@@ -52,6 +56,8 @@ Member Function Description
- :ref:`int<class_int>` **size** **(** **)**
Return the size of the array.
.. _class_StringArray_StringArray:
- :ref:`StringArray<class_stringarray>` **StringArray** **(** :ref:`Array<class_array>` from **)**

2
classes/class_vector2.rst
View File

@@ -128,6 +128,8 @@ Remove the fractional part of x and y.
- :ref:`Vector2<class_vector2>` **floorf** **(** **)**
Remove the fractional part of x and y.
.. _class_Vector2_get_aspect:
- :ref:`float<class_float>` **get_aspect** **(** **)**