De-headline the Inherits and Category fields

Also escape _ and * characters in e.g. "TYPE_*" description content.
This commit is contained in:
Rémi Verschelde
2016-02-08 18:31:35 +01:00
parent ca6cb54cdb
commit 2f06d055e3
361 changed files with 764 additions and 2530 deletions
+3 -7
View File
@@ -3,11 +3,7 @@
@GDScript
=========
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Built-in GDScript functions.
@@ -423,13 +419,13 @@ Returns a reference to the specified function
- :ref:`Object<class_object>` **convert** **(** Variant what, :ref:`int<class_int>` type **)**
Convert from a type to another in the best way possible. The "type" parameter uses the enum TYPE_* in :ref:`@Global Scope<class_@global scope>`.
Convert from a type to another in the best way possible. The "type" parameter uses the enum TYPE\_\* in :ref:`@Global Scope<class_@global scope>`.
.. _class_@GDScript_typeof:
- :ref:`int<class_int>` **typeof** **(** Variant what **)**
Returns the internal type of the given Variant object, using the TYPE_* enum in :ref:`@Global Scope<class_@global scope>`.
Returns the internal type of the given Variant object, using the TYPE\_\* enum in :ref:`@Global Scope<class_@global scope>`.
.. _class_@GDScript_str:
+2 -6
View File
@@ -3,11 +3,7 @@
@Global Scope
=============
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Global scope constants and variables.
@@ -434,7 +430,7 @@ Numeric Constants
- **PROPERTY_HINT_KEY_ACCEL** = **7**
- **PROPERTY_HINT_FLAGS** = **8** --- Property hint for a bitmask description, for bits 0,1,2,3 and 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers.
- **PROPERTY_HINT_ALL_FLAGS** = **9** --- Property hint for a bitmask description that covers all 32 bits. Valid only for integers.
- **PROPERTY_HINT_FILE** = **10** --- String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "*.doc".
- **PROPERTY_HINT_FILE** = **10** --- String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "\*.doc".
- **PROPERTY_HINT_DIR** = **11** --- String property is a directory (so pop up a file dialog when edited).
- **PROPERTY_HINT_GLOBAL_FILE** = **12**
- **PROPERTY_HINT_GLOBAL_DIR** = **13**
+3 -7
View File
@@ -3,11 +3,7 @@
AABB
====
Category: Built-In Types
------------------------
Brief Description
-----------------
**Category:** Built-In Types
Axis-Aligned Bounding Box.
@@ -107,7 +103,7 @@ Return the normalized longest axis of the :ref:`AABB<class_aabb>`.
- :ref:`int<class_int>` **get_longest_axis_index** **(** **)**
Return the index of the longest axis of the :ref:`AABB<class_aabb>` (according to :ref:`Vector3<class_vector3>`::AXIS* enum).
Return the index of the longest axis of the :ref:`AABB<class_aabb>` (according to :ref:`Vector3<class_vector3>`::AXIS\* enum).
.. _class_AABB_get_longest_axis_size:
@@ -125,7 +121,7 @@ Return the normalized shortest axis of the :ref:`AABB<class_aabb>`.
- :ref:`int<class_int>` **get_shortest_axis_index** **(** **)**
Return the index of the shortest axis of the :ref:`AABB<class_aabb>` (according to :ref:`Vector3<class_vector3>`::AXIS* enum).
Return the index of the shortest axis of the :ref:`AABB<class_aabb>` (according to :ref:`Vector3<class_vector3>`::AXIS\* enum).
.. _class_AABB_get_shortest_axis_size:
+2 -7
View File
@@ -3,14 +3,9 @@
AcceptDialog
============
Inherits: :ref:`WindowDialog<class_windowdialog>`
-------------------------------------------------
**Inherits:** :ref:`WindowDialog<class_windowdialog>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Base dialog for user notification.
+2 -7
View File
@@ -3,14 +3,9 @@
AnimatedSprite
==============
Inherits: :ref:`Node2D<class_node2d>`
-------------------------------------
**Inherits:** :ref:`Node2D<class_node2d>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Sprite node that can use multiple textures for animation.
+2 -7
View File
@@ -3,14 +3,9 @@
AnimatedSprite3D
================
Inherits: :ref:`SpriteBase3D<class_spritebase3d>`
-------------------------------------------------
**Inherits:** :ref:`SpriteBase3D<class_spritebase3d>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+5 -10
View File
@@ -3,14 +3,9 @@
Animation
=========
Inherits: :ref:`Resource<class_resource>`
-----------------------------------------
**Inherits:** :ref:`Resource<class_resource>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Contains data used to animate everything in the engine.
@@ -115,7 +110,7 @@ Member Function Description
- :ref:`int<class_int>` **add_track** **(** :ref:`int<class_int>` type, :ref:`int<class_int>` at_pos=-1 **)**
Add a track to the Animation. The track type must be specified as any of the values in te TYPE_* enumeration.
Add a track to the Animation. The track type must be specified as any of the values in te TYPE\_\* enumeration.
.. _class_Animation_remove_track:
@@ -233,13 +228,13 @@ Find the key index by time in a given track. Optionally, only find it if the exa
- void **track_set_interpolation_type** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` interpolation **)**
Set the interpolation type of a given track, from the INTERPOLATION_* enum.
Set the interpolation type of a given track, from the INTERPOLATION\_\* enum.
.. _class_Animation_track_get_interpolation_type:
- :ref:`int<class_int>` **track_get_interpolation_type** **(** :ref:`int<class_int>` idx **)** const
Return the interpolation type of a given track, from the INTERPOLATION_* enum.
Return the interpolation type of a given track, from the INTERPOLATION\_\* enum.
.. _class_Animation_transform_track_interpolate:
+3 -8
View File
@@ -3,14 +3,9 @@
AnimationPlayer
===============
Inherits: :ref:`Node<class_node>`
---------------------------------
**Inherits:** :ref:`Node<class_node>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Container and player of :ref:`Animation<class_animation>` resources.
@@ -299,7 +294,7 @@ The animation player creates caches for faster access to the nodes it will anima
- void **set_animation_process_mode** **(** :ref:`int<class_int>` mode **)**
Set the mode in which the animation player processes. By default, it processes on idle time (framerate dependent), but using fixed time works well for animating static collision bodies in 2D and 3D. See enum ANIMATION_PROCESS_*.
Set the mode in which the animation player processes. By default, it processes on idle time (framerate dependent), but using fixed time works well for animating static collision bodies in 2D and 3D. See enum ANIMATION_PROCESS\_\*.
.. _class_AnimationPlayer_get_animation_process_mode:
+3 -8
View File
@@ -3,14 +3,9 @@
AnimationTreePlayer
===================
Inherits: :ref:`Node<class_node>`
---------------------------------
**Inherits:** :ref:`Node<class_node>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Animation Player that uses a node graph for the blending.
@@ -189,7 +184,7 @@ Rename a node in the graph.
- :ref:`int<class_int>` **node_get_type** **(** :ref:`String<class_string>` id **)** const
Get the node type, will return from NODE_* enum.
Get the node type, will return from NODE\_\* enum.
.. _class_AnimationTreePlayer_node_get_input_count:
+2 -7
View File
@@ -3,14 +3,9 @@
Area
====
Inherits: :ref:`CollisionObject<class_collisionobject>`
-------------------------------------------------------
**Inherits:** :ref:`CollisionObject<class_collisionobject>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
Area2D
======
Inherits: :ref:`CollisionObject2D<class_collisionobject2d>`
-----------------------------------------------------------
**Inherits:** :ref:`CollisionObject2D<class_collisionobject2d>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
General purpose area detection and influence for 2D physics.
+1 -5
View File
@@ -3,11 +3,7 @@
Array
=====
Category: Built-In Types
------------------------
Brief Description
-----------------
**Category:** Built-In Types
Generic array datatype.
+2 -7
View File
@@ -3,14 +3,9 @@
AtlasTexture
============
Inherits: :ref:`Texture<class_texture>`
---------------------------------------
**Inherits:** :ref:`Texture<class_texture>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+10 -15
View File
@@ -3,14 +3,9 @@
AudioServer
===========
Inherits: :ref:`Object<class_object>`
-------------------------------------
**Inherits:** :ref:`Object<class_object>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Server interface for low level audio access.
@@ -143,7 +138,7 @@ Member Function Description
- :ref:`RID<class_rid>` **sample_create** **(** :ref:`int<class_int>` format, :ref:`bool<class_bool>` stereo, :ref:`int<class_int>` length **)**
Create an audio sample, return a :ref:`RID<class_rid>` referencing it. The sample will be created with a given format (from the SAMPLE_FORMAT_* enum), a total length (in samples, not bytes), in either stereo or mono.
Create an audio sample, return a :ref:`RID<class_rid>` referencing it. The sample will be created with a given format (from the SAMPLE_FORMAT\_\* enum), a total length (in samples, not bytes), in either stereo or mono.
Even if a stereo sample consists of a left sample and a right sample, it still counts as one sample for length purposes.
@@ -163,7 +158,7 @@ Return the description of an audio sample. Mainly used for organization.
- :ref:`int<class_int>` **sample_get_format** **(** :ref:`RID<class_rid>` sample **)** const
Return the format of the audio sample, in the form of the SAMPLE_FORMAT_* enum.
Return the format of the audio sample, in the form of the SAMPLE_FORMAT\_\* enum.
.. _class_AudioServer_sample_is_stereo:
@@ -223,13 +218,13 @@ Return the mix rate of the given sample.
- void **sample_set_loop_format** **(** :ref:`RID<class_rid>` sample, :ref:`int<class_int>` loop_format **)**
Set the loop format for a sample from the SAMPLE_LOOP_* enum. As a warning, Ping Pong loops may not be available on some hardware-mixing platforms.
Set the loop format for a sample from the SAMPLE_LOOP\_\* enum. As a warning, Ping Pong loops may not be available on some hardware-mixing platforms.
.. _class_AudioServer_sample_get_loop_format:
- :ref:`int<class_int>` **sample_get_loop_format** **(** :ref:`RID<class_rid>` sample **)** const
Return the loop format for a sample, as a value from the SAMPLE_LOOP_* enum.
Return the loop format for a sample, as a value from the SAMPLE_LOOP\_\* enum.
.. _class_AudioServer_sample_set_loop_begin:
@@ -283,7 +278,7 @@ Change the pan of a currently playing voice and, optionally, the depth and heigh
- void **voice_set_filter** **(** :ref:`RID<class_rid>` voice, :ref:`int<class_int>` type, :ref:`float<class_float>` cutoff, :ref:`float<class_float>` resonance, :ref:`float<class_float>` gain=0 **)**
Set a resonant filter post processing for the voice. Filter type is a value from the FILTER_* enum.
Set a resonant filter post processing for the voice. Filter type is a value from the FILTER\_\* enum.
.. _class_AudioServer_voice_set_chorus:
@@ -295,7 +290,7 @@ Set chorus send post processing for the voice (from 0 to 1).
- void **voice_set_reverb** **(** :ref:`RID<class_rid>` voice, :ref:`int<class_int>` room, :ref:`float<class_float>` reverb **)**
Set the reverb send post processing for the voice (from 0 to 1) and the reverb type, from the REVERB_* enum.
Set the reverb send post processing for the voice (from 0 to 1) and the reverb type, from the REVERB\_\* enum.
.. _class_AudioServer_voice_set_mix_rate:
@@ -337,7 +332,7 @@ Return the current pan depth for a given voice (-1 to +1 range).
- :ref:`int<class_int>` **voice_get_filter_type** **(** :ref:`RID<class_rid>` voice **)** const
Return the current selected filter type for a given voice, from the FILTER_* enum.
Return the current selected filter type for a given voice, from the FILTER\_\* enum.
.. _class_AudioServer_voice_get_filter_cutoff:
@@ -361,7 +356,7 @@ Return the current chorus send for a given voice (0 to 1).
- :ref:`int<class_int>` **voice_get_reverb_type** **(** :ref:`RID<class_rid>` voice **)** const
Return the current reverb type for a given voice from the REVERB_* enum.
Return the current reverb type for a given voice from the REVERB\_\* enum.
.. _class_AudioServer_voice_get_reverb:
+2 -7
View File
@@ -3,14 +3,9 @@
AudioServerSW
=============
Inherits: :ref:`AudioServer<class_audioserver>`
-----------------------------------------------
**Inherits:** :ref:`AudioServer<class_audioserver>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Software implementation of :ref:`AudioServer<class_audioserver>`.
+2 -7
View File
@@ -3,14 +3,9 @@
AudioStream
===========
Inherits: :ref:`Resource<class_resource>`
-----------------------------------------
**Inherits:** :ref:`Resource<class_resource>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Base class for audio streams.
+2 -7
View File
@@ -3,14 +3,9 @@
AudioStreamMPC
==============
Inherits: :ref:`AudioStream<class_audiostream>`
-----------------------------------------------
**Inherits:** :ref:`AudioStream<class_audiostream>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
MusePack audio stream driver.
+2 -7
View File
@@ -3,14 +3,9 @@
AudioStreamOGGVorbis
====================
Inherits: :ref:`AudioStream<class_audiostream>`
-----------------------------------------------
**Inherits:** :ref:`AudioStream<class_audiostream>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
OGG Vorbis audio stream driver.
+2 -7
View File
@@ -3,14 +3,9 @@
AudioStreamOpus
===============
Inherits: :ref:`AudioStream<class_audiostream>`
-----------------------------------------------
**Inherits:** :ref:`AudioStream<class_audiostream>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Opus Codec audio stream driver.
+2 -7
View File
@@ -3,14 +3,9 @@
AudioStreamPlayback
===================
Inherits: :ref:`Reference<class_reference>`
-------------------------------------------
**Inherits:** :ref:`Reference<class_reference>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
AudioStreamSpeex
================
Inherits: :ref:`AudioStream<class_audiostream>`
-----------------------------------------------
**Inherits:** :ref:`AudioStream<class_audiostream>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Speex audio stream driver.
+2 -7
View File
@@ -3,14 +3,9 @@
BackBufferCopy
==============
Inherits: :ref:`Node2D<class_node2d>`
-------------------------------------
**Inherits:** :ref:`Node2D<class_node2d>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
BakedLight
==========
Inherits: :ref:`Resource<class_resource>`
-----------------------------------------
**Inherits:** :ref:`Resource<class_resource>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
BakedLightInstance
==================
Inherits: :ref:`VisualInstance<class_visualinstance>`
-----------------------------------------------------
**Inherits:** :ref:`VisualInstance<class_visualinstance>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
BakedLightSampler
=================
Inherits: :ref:`VisualInstance<class_visualinstance>`
-----------------------------------------------------
**Inherits:** :ref:`VisualInstance<class_visualinstance>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+3 -8
View File
@@ -3,14 +3,9 @@
BaseButton
==========
Inherits: :ref:`Control<class_control>`
---------------------------------------
**Inherits:** :ref:`Control<class_control>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Provides a base class for different kinds of buttons.
@@ -130,6 +125,6 @@ Return the state of the click_on_press property (see :ref:`set_click_on_press<Ba
- :ref:`int<class_int>` **get_draw_mode** **(** **)** const
Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overiding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW_* enum.
Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overiding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW\_\* enum.
+2 -7
View File
@@ -3,14 +3,9 @@
BitMap
======
Inherits: :ref:`Resource<class_resource>`
-----------------------------------------
**Inherits:** :ref:`Resource<class_resource>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
BoneAttachment
==============
Inherits: :ref:`Spatial<class_spatial>`
---------------------------------------
**Inherits:** :ref:`Spatial<class_spatial>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+1 -5
View File
@@ -3,11 +3,7 @@
bool
====
Category: Built-In Types
------------------------
Brief Description
-----------------
**Category:** Built-In Types
Boolean built-in type
+2 -7
View File
@@ -3,14 +3,9 @@
BoxContainer
============
Inherits: :ref:`Container<class_container>`
-------------------------------------------
**Inherits:** :ref:`Container<class_container>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Base class for Box containers.
+2 -7
View File
@@ -3,14 +3,9 @@
BoxShape
========
Inherits: :ref:`Shape<class_shape>`
-----------------------------------
**Inherits:** :ref:`Shape<class_shape>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Box shape resource.
+2 -7
View File
@@ -3,14 +3,9 @@
Button
======
Inherits: :ref:`BaseButton<class_basebutton>`
---------------------------------------------
**Inherits:** :ref:`BaseButton<class_basebutton>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Standard themed Button.
+2 -7
View File
@@ -3,14 +3,9 @@
ButtonArray
===========
Inherits: :ref:`Control<class_control>`
---------------------------------------
**Inherits:** :ref:`Control<class_control>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Array of Buttons.
+2 -7
View File
@@ -3,14 +3,9 @@
ButtonGroup
===========
Inherits: :ref:`BoxContainer<class_boxcontainer>`
-------------------------------------------------
**Inherits:** :ref:`BoxContainer<class_boxcontainer>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Group of Buttons.
+2 -7
View File
@@ -3,14 +3,9 @@
Camera
======
Inherits: :ref:`Spatial<class_spatial>`
---------------------------------------
**Inherits:** :ref:`Spatial<class_spatial>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Camera node, displays from a point of view.
+3 -8
View File
@@ -3,14 +3,9 @@
Camera2D
========
Inherits: :ref:`Node2D<class_node2d>`
-------------------------------------
**Inherits:** :ref:`Node2D<class_node2d>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Camera node for 2D scenes.
@@ -187,7 +182,7 @@ Return the scrolling limit in pixels.
- void **set_drag_margin** **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` drag_margin **)**
Set the margins needed to drag the camera (relative to the screen size). Margin uses the MARGIN_* enum. Drag margins of 0,0,0,0 will keep the camera at the center of the screen, while drag margins of 1,1,1,1 will only move when the camera is at the edges.
Set the margins needed to drag the camera (relative to the screen size). Margin uses the MARGIN\_\* enum. Drag margins of 0,0,0,0 will keep the camera at the center of the screen, while drag margins of 1,1,1,1 will only move when the camera is at the edges.
.. _class_Camera2D_get_drag_margin:
+5 -10
View File
@@ -3,14 +3,9 @@
CanvasItem
==========
Inherits: :ref:`Node<class_node>`
---------------------------------
**Inherits:** :ref:`Node<class_node>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Base class of anything 2D.
@@ -152,7 +147,7 @@ Description
Base class of anything 2D. Canvas items are laid out in a tree and children inherit and extend the transform of their parent. CanvasItem is extended by :ref:`Control<class_control>`, for anything GUI related, and by :ref:`Node2D<class_node2d>` for anything 2D engine related.
Any CanvasItem can draw. For this, the "update" function must be called, then NOTIFICATION_DRAW will be received on idle time to request redraw. Because of this, canvas items don't need to be redraw on every frame, improving the performance significan'tly. Several functions for drawing on the CanvasItem are provided (see draw_* functions). They can only be used inside the notification, signal or _draw() overrided function, though.
Any CanvasItem can draw. For this, the "update" function must be called, then NOTIFICATION_DRAW will be received on idle time to request redraw. Because of this, canvas items don't need to be redraw on every frame, improving the performance significan'tly. Several functions for drawing on the CanvasItem are provided (see draw\_\* functions). They can only be used inside the notification, signal or _draw() overrided function, though.
Canvas items are draw in tree order. By default, children are on top of their parents so a root CanvasItem will be drawn behind everything (this can be changed per item though).
@@ -251,13 +246,13 @@ Return if set as toplevel. See :ref:`set_as_toplevel<CanvasItem_set_as_toplevel>
- void **set_blend_mode** **(** :ref:`int<class_int>` blend_mode **)**
Set the blending mode from enum BLEND_MODE_*.
Set the blending mode from enum BLEND_MODE\_\*.
.. _class_CanvasItem_get_blend_mode:
- :ref:`int<class_int>` **get_blend_mode** **(** **)** const
Return the current blending mode from enum BLEND_MODE_*.
Return the current blending mode from enum BLEND_MODE\_\*.
.. _class_CanvasItem_set_light_mask:
+2 -7
View File
@@ -3,14 +3,9 @@
CanvasItemMaterial
==================
Inherits: :ref:`Resource<class_resource>`
-----------------------------------------
**Inherits:** :ref:`Resource<class_resource>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
CanvasItemShader
================
Inherits: :ref:`Shader<class_shader>`
-------------------------------------
**Inherits:** :ref:`Shader<class_shader>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
CanvasItemShaderGraph
=====================
Inherits: :ref:`ShaderGraph<class_shadergraph>`
-----------------------------------------------
**Inherits:** :ref:`ShaderGraph<class_shadergraph>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
CanvasLayer
===========
Inherits: :ref:`Node<class_node>`
---------------------------------
**Inherits:** :ref:`Node<class_node>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Canvas Item layer.
+2 -7
View File
@@ -3,14 +3,9 @@
CanvasModulate
==============
Inherits: :ref:`Node2D<class_node2d>`
-------------------------------------
**Inherits:** :ref:`Node2D<class_node2d>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
CapsuleShape
============
Inherits: :ref:`Shape<class_shape>`
-----------------------------------
**Inherits:** :ref:`Shape<class_shape>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Capsule shape resource.
+2 -7
View File
@@ -3,14 +3,9 @@
CapsuleShape2D
==============
Inherits: :ref:`Shape2D<class_shape2d>`
---------------------------------------
**Inherits:** :ref:`Shape2D<class_shape2d>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Capsule 2D shape resource for physics.
+2 -7
View File
@@ -3,14 +3,9 @@
CenterContainer
===============
Inherits: :ref:`Container<class_container>`
-------------------------------------------
**Inherits:** :ref:`Container<class_container>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Keeps children controls centered.
+2 -7
View File
@@ -3,14 +3,9 @@
CheckBox
========
Inherits: :ref:`Button<class_button>`
-------------------------------------
**Inherits:** :ref:`Button<class_button>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
CheckButton
===========
Inherits: :ref:`Button<class_button>`
-------------------------------------
**Inherits:** :ref:`Button<class_button>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Checkable button.
+2 -7
View File
@@ -3,14 +3,9 @@
CircleShape2D
=============
Inherits: :ref:`Shape2D<class_shape2d>`
---------------------------------------
**Inherits:** :ref:`Shape2D<class_shape2d>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Circular Shape for 2D Physics.
+2 -7
View File
@@ -3,14 +3,9 @@
CollisionObject
===============
Inherits: :ref:`Spatial<class_spatial>`
---------------------------------------
**Inherits:** :ref:`Spatial<class_spatial>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
CollisionObject2D
=================
Inherits: :ref:`Node2D<class_node2d>`
-------------------------------------
**Inherits:** :ref:`Node2D<class_node2d>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Base node for 2D collisionables.
+2 -7
View File
@@ -3,14 +3,9 @@
CollisionPolygon
================
Inherits: :ref:`Spatial<class_spatial>`
---------------------------------------
**Inherits:** :ref:`Spatial<class_spatial>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
CollisionPolygon2D
==================
Inherits: :ref:`Node2D<class_node2d>`
-------------------------------------
**Inherits:** :ref:`Node2D<class_node2d>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Editor-only class for easy editing of collision polygons.
+2 -7
View File
@@ -3,14 +3,9 @@
CollisionShape
==============
Inherits: :ref:`Spatial<class_spatial>`
---------------------------------------
**Inherits:** :ref:`Spatial<class_spatial>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
CollisionShape2D
================
Inherits: :ref:`Node2D<class_node2d>`
-------------------------------------
**Inherits:** :ref:`Node2D<class_node2d>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Editor-only class for easy editing of shapes.
+1 -5
View File
@@ -3,11 +3,7 @@
Color
=====
Category: Built-In Types
------------------------
Brief Description
-----------------
**Category:** Built-In Types
Color in RGBA format.
+1 -5
View File
@@ -3,11 +3,7 @@
ColorArray
==========
Category: Built-In Types
------------------------
Brief Description
-----------------
**Category:** Built-In Types
Array of Colors
+2 -7
View File
@@ -3,14 +3,9 @@
ColorPicker
===========
Inherits: :ref:`BoxContainer<class_boxcontainer>`
-------------------------------------------------
**Inherits:** :ref:`BoxContainer<class_boxcontainer>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Color picker control.
+2 -7
View File
@@ -3,14 +3,9 @@
ColorPickerButton
=================
Inherits: :ref:`Button<class_button>`
-------------------------------------
**Inherits:** :ref:`Button<class_button>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
ColorRamp
=========
Inherits: :ref:`Resource<class_resource>`
-----------------------------------------
**Inherits:** :ref:`Resource<class_resource>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
ConcavePolygonShape
===================
Inherits: :ref:`Shape<class_shape>`
-----------------------------------
**Inherits:** :ref:`Shape<class_shape>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Concave polygon shape.
+2 -7
View File
@@ -3,14 +3,9 @@
ConcavePolygonShape2D
=====================
Inherits: :ref:`Shape2D<class_shape2d>`
---------------------------------------
**Inherits:** :ref:`Shape2D<class_shape2d>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Concave polygon 2D shape resource for physics.
+2 -7
View File
@@ -3,14 +3,9 @@
ConeTwistJoint
==============
Inherits: :ref:`Joint<class_joint>`
-----------------------------------
**Inherits:** :ref:`Joint<class_joint>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
ConfigFile
==========
Inherits: :ref:`Reference<class_reference>`
-------------------------------------------
**Inherits:** :ref:`Reference<class_reference>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
ConfirmationDialog
==================
Inherits: :ref:`AcceptDialog<class_acceptdialog>`
-------------------------------------------------
**Inherits:** :ref:`AcceptDialog<class_acceptdialog>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Dialog for confirmation of actions.
+2 -7
View File
@@ -3,14 +3,9 @@
Container
=========
Inherits: :ref:`Control<class_control>`
---------------------------------------
**Inherits:** :ref:`Control<class_control>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Base node for containers.
+5 -10
View File
@@ -3,14 +3,9 @@
Control
=======
Inherits: :ref:`CanvasItem<class_canvasitem>`
---------------------------------------------
**Inherits:** :ref:`CanvasItem<class_canvasitem>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Control is the base node for all the GUI components.
@@ -233,7 +228,7 @@ Only one control can hold the keyboard focus (receiving keyboard events), for th
It is sometimes desired for a control to ignore mouse/pointer events. This is often the case when placing other controls on top of a button, in such cases. Calling :ref:`set_ignore_mouse<Control_set_ignore_mouse>` enables this function.
Finally, controls are skinned according to a :ref:`Theme<class_theme>`. Setting a :ref:`Theme<class_theme>` on a control will propagate all the skinning down the tree. Optionally, skinning can be overrided per each control by calling the add_*_override functions, or from the editor.
Finally, controls are skinned according to a :ref:`Theme<class_theme>`. Setting a :ref:`Theme<class_theme>` on a control will propagate all the skinning down the tree. Optionally, skinning can be overrided per each control by calling the add\_\*_override functions, or from the editor.
Member Function Description
---------------------------
@@ -568,13 +563,13 @@ Return the tooltip, which will appear when the cursor is resting over this contr
- void **set_default_cursor_shape** **(** :ref:`int<class_int>` shape **)**
Set the default cursor shape for this control. See enum CURSOR_* for the list of shapes.
Set the default cursor shape for this control. See enum CURSOR\_\* for the list of shapes.
.. _class_Control_get_default_cursor_shape:
- :ref:`int<class_int>` **get_default_cursor_shape** **(** **)** const
Return the default cursor shape for this control. See enum CURSOR_* for the list of shapes.
Return the default cursor shape for this control. See enum CURSOR\_\* for the list of shapes.
.. _class_Control_get_cursor_shape:
+2 -7
View File
@@ -3,14 +3,9 @@
ConvexPolygonShape
==================
Inherits: :ref:`Shape<class_shape>`
-----------------------------------
**Inherits:** :ref:`Shape<class_shape>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Convex Polygon Shape.
+2 -7
View File
@@ -3,14 +3,9 @@
ConvexPolygonShape2D
====================
Inherits: :ref:`Shape2D<class_shape2d>`
---------------------------------------
**Inherits:** :ref:`Shape2D<class_shape2d>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Convex Polygon Shape for 2D physics.
+2 -7
View File
@@ -3,14 +3,9 @@
CubeMap
=======
Inherits: :ref:`Resource<class_resource>`
-----------------------------------------
**Inherits:** :ref:`Resource<class_resource>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
Curve2D
=======
Inherits: :ref:`Resource<class_resource>`
-----------------------------------------
**Inherits:** :ref:`Resource<class_resource>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Describes a Bezier curve in 2D space.
+2 -7
View File
@@ -3,14 +3,9 @@
Curve3D
=======
Inherits: :ref:`Resource<class_resource>`
-----------------------------------------
**Inherits:** :ref:`Resource<class_resource>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Describes a Bezier curve in 3D space.
+2 -7
View File
@@ -3,14 +3,9 @@
DampedSpringJoint2D
===================
Inherits: :ref:`Joint2D<class_joint2d>`
---------------------------------------
**Inherits:** :ref:`Joint2D<class_joint2d>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Damped spring constraint for 2D physics.
+1 -5
View File
@@ -3,11 +3,7 @@
Dictionary
==========
Category: Built-In Types
------------------------
Brief Description
-----------------
**Category:** Built-In Types
Dictionary type.
+2 -7
View File
@@ -3,14 +3,9 @@
DirectionalLight
================
Inherits: :ref:`Light<class_light>`
-----------------------------------
**Inherits:** :ref:`Light<class_light>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Directional Light, such as the Sun or the Moon.
+2 -7
View File
@@ -3,14 +3,9 @@
Directory
=========
Inherits: :ref:`Reference<class_reference>`
-------------------------------------------
**Inherits:** :ref:`Reference<class_reference>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
EditorFileDialog
================
Inherits: :ref:`ConfirmationDialog<class_confirmationdialog>`
-------------------------------------------------------------
**Inherits:** :ref:`ConfirmationDialog<class_confirmationdialog>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
EditorImportPlugin
==================
Inherits: :ref:`Reference<class_reference>`
-------------------------------------------
**Inherits:** :ref:`Reference<class_reference>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
EditorPlugin
============
Inherits: :ref:`Node<class_node>`
---------------------------------
**Inherits:** :ref:`Node<class_node>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
EditorScenePostImport
=====================
Inherits: :ref:`Reference<class_reference>`
-------------------------------------------
**Inherits:** :ref:`Reference<class_reference>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
EditorScript
============
Inherits: :ref:`Reference<class_reference>`
-------------------------------------------
**Inherits:** :ref:`Reference<class_reference>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
Environment
===========
Inherits: :ref:`Resource<class_resource>`
-----------------------------------------
**Inherits:** :ref:`Resource<class_resource>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
EventPlayer
===========
Inherits: :ref:`Node<class_node>`
---------------------------------
**Inherits:** :ref:`Node<class_node>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Class for event stream playback.
+2 -7
View File
@@ -3,14 +3,9 @@
EventStream
===========
Inherits: :ref:`Resource<class_resource>`
-----------------------------------------
**Inherits:** :ref:`Resource<class_resource>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Base class for all event-based stream drivers.
+2 -7
View File
@@ -3,14 +3,9 @@
EventStreamChibi
================
Inherits: :ref:`EventStream<class_eventstream>`
-----------------------------------------------
**Inherits:** :ref:`EventStream<class_eventstream>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Driver for MOD playback.
+2 -7
View File
@@ -3,14 +3,9 @@
File
====
Inherits: :ref:`Reference<class_reference>`
-------------------------------------------
**Inherits:** :ref:`Reference<class_reference>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+5 -10
View File
@@ -3,14 +3,9 @@
FileDialog
==========
Inherits: :ref:`ConfirmationDialog<class_confirmationdialog>`
-------------------------------------------------------------
**Inherits:** :ref:`ConfirmationDialog<class_confirmationdialog>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Dialog for selecting files or directories in the filesystem.
@@ -87,7 +82,7 @@ Clear all the added filters in the dialog.
- void **add_filter** **(** :ref:`String<class_string>` filter **)**
Add a custom filter. Filter format is: "mask ; description", example (C++): dialog->add_filter("*.png ; PNG Images");
Add a custom filter. Filter format is: "mask ; description", example (C++): dialog->add_filter("\*.png ; PNG Images");
.. _class_FileDialog_get_current_dir:
@@ -123,13 +118,13 @@ Get the current selected path (directory and file) of the file dialog (empty if
- void **set_mode** **(** :ref:`int<class_int>` mode **)**
Set the file dialog mode from the MODE_* enum.
Set the file dialog mode from the MODE\_\* enum.
.. _class_FileDialog_get_mode:
- :ref:`int<class_int>` **get_mode** **(** **)** const
Get the file dialog mode from the MODE_* enum.
Get the file dialog mode from the MODE\_\* enum.
.. _class_FileDialog_get_vbox:
+6 -11
View File
@@ -3,14 +3,9 @@
FixedMaterial
=============
Inherits: :ref:`Material<class_material>`
-----------------------------------------
**Inherits:** :ref:`Material<class_material>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Simple Material with a fixed parameter set.
@@ -84,13 +79,13 @@ Member Function Description
- void **set_parameter** **(** :ref:`int<class_int>` param, var value **)**
Set a parameter, parameters are defined in the PARAM_* enum. The type of each parameter may change, so it's best to check the enum.
Set a parameter, parameters are defined in the PARAM\_\* enum. The type of each parameter may change, so it's best to check the enum.
.. _class_FixedMaterial_get_parameter:
- void **get_parameter** **(** :ref:`int<class_int>` param **)** const
Return a parameter, parameters are defined in the PARAM_* enum. The type of each parameter may change, so it's best to check the enum.
Return a parameter, parameters are defined in the PARAM\_\* enum. The type of each parameter may change, so it's best to check the enum.
.. _class_FixedMaterial_set_texture:
@@ -108,13 +103,13 @@ Return a texture. Textures change parameters per texel and are mapped to the mod
- void **set_texcoord_mode** **(** :ref:`int<class_int>` param, :ref:`int<class_int>` mode **)**
Set the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object.
Set the texture coordinate mode. Each texture param (from the PARAM\_\* enum) has one. It defines how the textures are mapped to the object.
.. _class_FixedMaterial_get_texcoord_mode:
- :ref:`int<class_int>` **get_texcoord_mode** **(** :ref:`int<class_int>` param **)** const
Return the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object.
Return the texture coordinate mode. Each texture param (from the PARAM\_\* enum) has one. It defines how the textures are mapped to the object.
.. _class_FixedMaterial_set_fixed_flag:
+1 -5
View File
@@ -3,11 +3,7 @@
float
=====
Category: Built-In Types
------------------------
Brief Description
-----------------
**Category:** Built-In Types
+2 -7
View File
@@ -3,14 +3,9 @@
Font
====
Inherits: :ref:`Resource<class_resource>`
-----------------------------------------
**Inherits:** :ref:`Resource<class_resource>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Internationalized font and text drawing support.
+2 -7
View File
@@ -3,14 +3,9 @@
FuncRef
=======
Inherits: :ref:`Reference<class_reference>`
-------------------------------------------
**Inherits:** :ref:`Reference<class_reference>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
GDFunctionState
===============
Inherits: :ref:`Reference<class_reference>`
-------------------------------------------
**Inherits:** :ref:`Reference<class_reference>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
GDNativeClass
=============
Inherits: :ref:`Reference<class_reference>`
-------------------------------------------
**Inherits:** :ref:`Reference<class_reference>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
GDScript
========
Inherits: :ref:`Script<class_script>`
-------------------------------------
**Inherits:** :ref:`Script<class_script>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
Generic6DOFJoint
================
Inherits: :ref:`Joint<class_joint>`
-----------------------------------
**Inherits:** :ref:`Joint<class_joint>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
Geometry
========
Inherits: :ref:`Object<class_object>`
-------------------------------------
**Inherits:** :ref:`Object<class_object>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
+2 -7
View File
@@ -3,14 +3,9 @@
GeometryInstance
================
Inherits: :ref:`VisualInstance<class_visualinstance>`
-----------------------------------------------------
**Inherits:** :ref:`VisualInstance<class_visualinstance>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Base node for geometry based visual instances.
+2 -7
View File
@@ -3,14 +3,9 @@
Globals
=======
Inherits: :ref:`Object<class_object>`
-------------------------------------
**Inherits:** :ref:`Object<class_object>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
Contains global variables accessible from everywhere.
+2 -7
View File
@@ -3,14 +3,9 @@
GraphEdit
=========
Inherits: :ref:`Control<class_control>`
---------------------------------------
**Inherits:** :ref:`Control<class_control>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
GraphEdit is an area capable of showing various GraphNodes. It manages connection events between them.
+2 -7
View File
@@ -3,14 +3,9 @@
GraphNode
=========
Inherits: :ref:`Container<class_container>`
-------------------------------------------
**Inherits:** :ref:`Container<class_container>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core
A GraphNode is a container with several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types.
+2 -7
View File
@@ -3,14 +3,9 @@
GridContainer
=============
Inherits: :ref:`Container<class_container>`
-------------------------------------------
**Inherits:** :ref:`Container<class_container>`
Category: Core
--------------
Brief Description
-----------------
**Category:** Core

Some files were not shown because too many files have changed in this diff Show More