diff --git a/classes/class_@global scope.rst b/classes/class_@global scope.rst index 39d85a7b6..ef1cd68ce 100644 --- a/classes/class_@global scope.rst +++ b/classes/class_@global scope.rst @@ -17,27 +17,87 @@ Global scope constants and variables. Member Variables ---------------- + .. _class_@Global Scope_ARVRServer: + - :ref:`ARVRServer` **ARVRServer** - :ref:`ARVRServer` singleton + + .. _class_@Global Scope_AudioServer: + - :ref:`AudioServer` **AudioServer** - :ref:`AudioServer` singleton + + .. _class_@Global Scope_ClassDB: + - :ref:`ClassDB` **ClassDB** - :ref:`ClassDB` singleton + + .. _class_@Global Scope_Engine: + - :ref:`Engine` **Engine** - :ref:`Engine` singleton + + .. _class_@Global Scope_Geometry: + - :ref:`Geometry` **Geometry** - :ref:`Geometry` singleton + + .. _class_@Global Scope_GodotSharp: + - :ref:`GodotSharp` **GodotSharp** + + .. _class_@Global Scope_IP: + - :ref:`IP` **IP** - :ref:`IP` singleton + + .. _class_@Global Scope_Input: + - :ref:`Input` **Input** - :ref:`Input` singleton + + .. _class_@Global Scope_InputMap: + - :ref:`InputMap` **InputMap** - :ref:`InputMap` singleton + + .. _class_@Global Scope_JSON: + - :ref:`JSON` **JSON** + + .. _class_@Global Scope_Marshalls: + - :ref:`Reference` **Marshalls** - :ref:`Marshalls` singleton + + .. _class_@Global Scope_OS: + - :ref:`OS` **OS** - :ref:`OS` singleton + + .. _class_@Global Scope_Performance: + - :ref:`Performance` **Performance** - :ref:`Performance` singleton + + .. _class_@Global Scope_Physics2DServer: + - :ref:`Physics2DServer` **Physics2DServer** - :ref:`Physics2DServer` singleton + + .. _class_@Global Scope_PhysicsServer: + - :ref:`PhysicsServer` **PhysicsServer** - :ref:`PhysicsServer` singleton + + .. _class_@Global Scope_ProjectSettings: + - :ref:`ProjectSettings` **ProjectSettings** - :ref:`ProjectSettings` singleton + + .. _class_@Global Scope_ResourceLoader: + - :ref:`ResourceLoader` **ResourceLoader** - :ref:`ResourceLoader` singleton + + .. _class_@Global Scope_ResourceSaver: + - :ref:`ResourceSaver` **ResourceSaver** - :ref:`ResourceSaver` singleton + + .. _class_@Global Scope_TranslationServer: + - :ref:`TranslationServer` **TranslationServer** - :ref:`TranslationServer` singleton + + .. _class_@Global Scope_VisualServer: + - :ref:`VisualServer` **VisualServer** - :ref:`VisualServer` singleton + Numeric Constants ----------------- diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 50d5ca9e3..8d497a5e9 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -44,10 +44,14 @@ Member Functions Signals ------- +.. _class_AcceptDialog_confirmed: + - **confirmed** **(** **)** Emitted when the dialog is accepted. +.. _class_AcceptDialog_custom_action: + - **custom_action** **(** :ref:`String` action **)** Emitted when a custom button is pressed. See :ref:`add_button`. @@ -56,9 +60,15 @@ Emitted when a custom button is pressed. See :ref:`add_button` **dialog_hide_on_ok** - If ``true`` the dialog is hidden when accepted. Default value: ``true``. + + .. _class_AcceptDialog_dialog_text: + - :ref:`String` **dialog_text** - The text displayed by this dialog. + Description ----------- diff --git a/classes/class_animatedsprite.rst b/classes/class_animatedsprite.rst index 104c97557..98baf7d46 100644 --- a/classes/class_animatedsprite.rst +++ b/classes/class_animatedsprite.rst @@ -58,26 +58,54 @@ Member Functions Signals ------- +.. _class_AnimatedSprite_animation_finished: + - **animation_finished** **(** **)** Emitted when the animation is finished (when it plays the last frame). If the animation is looping, this signal is emitted every time the last frame is drawn. +.. _class_AnimatedSprite_frame_changed: + - **frame_changed** **(** **)** -Emitted when member frame changed. +Emitted when :ref:`frame` changed. Member Variables ---------------- + .. _class_AnimatedSprite_animation: + - :ref:`String` **animation** - The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset. + + .. _class_AnimatedSprite_centered: + - :ref:`bool` **centered** - If ``true`` texture will be centered. Default value: ``true``. + + .. _class_AnimatedSprite_flip_h: + - :ref:`bool` **flip_h** - If ``true`` texture is flipped horizontally. Default value: ``false``. + + .. _class_AnimatedSprite_flip_v: + - :ref:`bool` **flip_v** - If ``true`` texture is flipped vertically. Default value: ``false``. + + .. _class_AnimatedSprite_frame: + - :ref:`int` **frame** - The displayed animation frame's index. + + .. _class_AnimatedSprite_frames: + - :ref:`SpriteFrames` **frames** - The :ref:`SpriteFrames` resource containing the animation(s). + + .. _class_AnimatedSprite_offset: + - :ref:`Vector2` **offset** - The texture's drawing offset. -- :ref:`bool` **playing** - If ``true`` the member animation is currently playing. + + .. _class_AnimatedSprite_playing: + +- :ref:`bool` **playing** - If ``true`` the :ref:`animation` is currently playing. + Description ----------- diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index 1b09ed865..a235c1eb6 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -42,18 +42,32 @@ Member Functions Signals ------- +.. _class_AnimatedSprite3D_frame_changed: + - **frame_changed** **(** **)** -Emitted when member frame changed. +Emitted when :ref:`frame` changed. Member Variables ---------------- + .. _class_AnimatedSprite3D_animation: + - :ref:`String` **animation** - The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset. + + .. _class_AnimatedSprite3D_frame: + - :ref:`int` **frame** - The displayed animation frame's index. + + .. _class_AnimatedSprite3D_frames: + - :ref:`SpriteFrames` **frames** - The :ref:`SpriteFrames` resource containing the animation(s). -- :ref:`bool` **playing** - If ``true`` the member animation is currently playing. + + .. _class_AnimatedSprite3D_playing: + +- :ref:`bool` **playing** - If ``true`` the :ref:`animation` is currently playing. + Description ----------- diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index d89ed1063..265447cdf 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -100,14 +100,20 @@ Member Functions Signals ------- +.. _class_AnimationPlayer_animation_changed: + - **animation_changed** **(** :ref:`String` old_name, :ref:`String` new_name **)** If the currently being played animation changes, this signal will notify of such change. +.. _class_AnimationPlayer_animation_finished: + - **animation_finished** **(** :ref:`String` name **)** Notifies when an animation finished playing. +.. _class_AnimationPlayer_animation_started: + - **animation_started** **(** :ref:`String` name **)** Notifies when an animation starts playing. @@ -116,10 +122,19 @@ Notifies when an animation starts playing. Member Variables ---------------- + .. _class_AnimationPlayer_playback_default_blend_time: + - :ref:`float` **playback_default_blend_time** + + .. _class_AnimationPlayer_playback_process_mode: + - :ref:`int` **playback_process_mode** + + .. _class_AnimationPlayer_root_node: + - :ref:`NodePath` **root_node** + Numeric Constants ----------------- diff --git a/classes/class_animationtreeplayer.rst b/classes/class_animationtreeplayer.rst index c4ee304a9..8b02cebb1 100644 --- a/classes/class_animationtreeplayer.rst +++ b/classes/class_animationtreeplayer.rst @@ -152,8 +152,11 @@ Member Functions Member Variables ---------------- + .. _class_AnimationTreePlayer_playback_process_mode: + - :ref:`int` **playback_process_mode** + Numeric Constants ----------------- diff --git a/classes/class_area.rst b/classes/class_area.rst index 02f9ad82c..9f111ef61 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -112,34 +112,50 @@ Member Functions Signals ------- +.. _class_Area_area_entered: + - **area_entered** **(** :ref:`Object` area **)** Emitted when another area enters. +.. _class_Area_area_exited: + - **area_exited** **(** :ref:`Object` area **)** Emitted when another area exits. +.. _class_Area_area_shape_entered: + - **area_shape_entered** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** Emitted when another area enters, reporting which areas overlapped. +.. _class_Area_area_shape_exited: + - **area_shape_exited** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** Emitted when another area exits, reporting which areas were overlapping. +.. _class_Area_body_entered: + - **body_entered** **(** :ref:`Object` body **)** Emitted when a :ref:`PhysicsBody` object enters. +.. _class_Area_body_exited: + - **body_exited** **(** :ref:`Object` body **)** Emitted when a :ref:`PhysicsBody2D` object exits. +.. _class_Area_body_shape_entered: + - **body_shape_entered** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** Emitted when a :ref:`PhysicsBody2D` object enters, reporting which shapes overlapped. +.. _class_Area_body_shape_exited: + - **body_shape_exited** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** Emitted when a :ref:`PhysicsBody2D` object exits, reporting which shapes were overlapping. @@ -148,25 +164,79 @@ Emitted when a :ref:`PhysicsBody2D` object exits, reporting Member Variables ---------------- + .. _class_Area_angular_damp: + - :ref:`float` **angular_damp** - The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping). + + .. _class_Area_audio_bus_name: + - :ref:`String` **audio_bus_name** - The name of the area's audio bus. + + .. _class_Area_audio_bus_override: + - :ref:`bool` **audio_bus_override** - If ``true`` the area's audio bus overrides the default audio bus. Default value: ``false``. + + .. _class_Area_collision_layer: + - :ref:`int` **collision_layer** - The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also ``collision_mask``. + + .. _class_Area_collision_mask: + - :ref:`int` **collision_mask** - The physics layers this area scans to determine collision detection. + + .. _class_Area_gravity: + - :ref:`float` **gravity** - The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction. + + .. _class_Area_gravity_distance_scale: + - :ref:`float` **gravity_distance_scale** - The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. + + .. _class_Area_gravity_point: + - :ref:`bool` **gravity_point** - If ``true`` gravity is calculated from a point (set via ``gravity_vec``). Also see ``space_override``. Default value: ``false``. + + .. _class_Area_gravity_vec: + - :ref:`Vector3` **gravity_vec** - The area's gravity vector (not normalized). If gravity is a point (see :ref:`is_gravity_a_point`), this will be the point of attraction. + + .. _class_Area_linear_damp: + - :ref:`float` **linear_damp** - The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping). + + .. _class_Area_monitorable: + - :ref:`bool` **monitorable** - If ``true`` other monitoring areas can detect this area. Default value: ``true``. + + .. _class_Area_monitoring: + - :ref:`bool` **monitoring** - If ``true`` the area detects bodies or areas entering and exiting it. Default value: ``true``. + + .. _class_Area_priority: + - :ref:`float` **priority** - The area's priority. Higher priority areas are processed first. Default value: 0. + + .. _class_Area_reverb_bus_amount: + - :ref:`float` **reverb_bus_amount** + + .. _class_Area_reverb_bus_enable: + - :ref:`bool` **reverb_bus_enable** + + .. _class_Area_reverb_bus_name: + - :ref:`String` **reverb_bus_name** + + .. _class_Area_reverb_bus_uniformity: + - :ref:`float` **reverb_bus_uniformity** + + .. _class_Area_space_override: + - :ref:`int` **space_override** - Override mode for gravity and damping calculations within this area. See the SPACE_OVERRIDE\_\* constants for values. + Numeric Constants ----------------- diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index da1d35101..b4b28e4bc 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -96,34 +96,50 @@ Member Functions Signals ------- +.. _class_Area2D_area_entered: + - **area_entered** **(** :ref:`Object` area **)** Emitted when another area enters. +.. _class_Area2D_area_exited: + - **area_exited** **(** :ref:`Object` area **)** Emitted when another area exits. +.. _class_Area2D_area_shape_entered: + - **area_shape_entered** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** Emitted when another area enters, reporting which shapes overlapped. +.. _class_Area2D_area_shape_exited: + - **area_shape_exited** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** Emitted when another area exits, reporting which shapes were overlapping. +.. _class_Area2D_body_entered: + - **body_entered** **(** :ref:`Object` body **)** Emitted when a :ref:`PhysicsBody2D` object enters. +.. _class_Area2D_body_exited: + - **body_exited** **(** :ref:`Object` body **)** Emitted when a :ref:`PhysicsBody2D` object exits. +.. _class_Area2D_body_shape_entered: + - **body_shape_entered** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** Emitted when a :ref:`PhysicsBody2D` object enters, reporting which shapes overlapped. +.. _class_Area2D_body_shape_exited: + - **body_shape_exited** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** Emitted when a :ref:`PhysicsBody2D` object exits, reporting which shapes were overlapping. @@ -132,21 +148,63 @@ Emitted when a :ref:`PhysicsBody2D` object exits, reporting Member Variables ---------------- + .. _class_Area2D_angular_damp: + - :ref:`float` **angular_damp** - The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping). + + .. _class_Area2D_audio_bus_name: + - :ref:`String` **audio_bus_name** - The name of the area's audio bus. + + .. _class_Area2D_audio_bus_override: + - :ref:`bool` **audio_bus_override** - If ``true`` the area's audio bus overrides the default audio bus. Default value: ``false``. + + .. _class_Area2D_collision_layer: + - :ref:`int` **collision_layer** - The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also ``collision_mask``. + + .. _class_Area2D_collision_mask: + - :ref:`int` **collision_mask** - The physics layers this area scans to determine collision detection. + + .. _class_Area2D_gravity: + - :ref:`float` **gravity** - The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction. + + .. _class_Area2D_gravity_distance_scale: + - :ref:`float` **gravity_distance_scale** - The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. + + .. _class_Area2D_gravity_point: + - :ref:`bool` **gravity_point** - If ``true`` gravity is calculated from a point (set via ``gravity_vec``). Also see ``space_override``. Default value: ``false``. + + .. _class_Area2D_gravity_vec: + - :ref:`Vector2` **gravity_vec** - The area's gravity vector (not normalized). If gravity is a point (see :ref:`is_gravity_a_point`), this will be the point of attraction. + + .. _class_Area2D_linear_damp: + - :ref:`float` **linear_damp** - The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping). + + .. _class_Area2D_monitorable: + - :ref:`bool` **monitorable** - If ``true`` other monitoring areas can detect this area. Default value: ``true``. + + .. _class_Area2D_monitoring: + - :ref:`bool` **monitoring** - If ``true`` the area detects bodies or areas entering and exiting it. Default value: ``true``. + + .. _class_Area2D_priority: + - :ref:`float` **priority** - The area's priority. Higher priority areas are processed first. Default value: 0. + + .. _class_Area2D_space_override: + - :ref:`int` **space_override** - Override mode for gravity and damping calculations within this area. See the SPACE_OVERRIDE\_\* constants for values. + Numeric Constants ----------------- diff --git a/classes/class_arvranchor.rst b/classes/class_arvranchor.rst index 6421264b8..dc3651083 100644 --- a/classes/class_arvranchor.rst +++ b/classes/class_arvranchor.rst @@ -36,8 +36,11 @@ Member Functions Member Variables ---------------- + .. _class_ARVRAnchor_anchor_id: + - :ref:`int` **anchor_id** + Description ----------- diff --git a/classes/class_arvrcontroller.rst b/classes/class_arvrcontroller.rst index 9e2bd99fc..75f6a7f90 100644 --- a/classes/class_arvrcontroller.rst +++ b/classes/class_arvrcontroller.rst @@ -40,10 +40,14 @@ Member Functions Signals ------- +.. _class_ARVRController_button_pressed: + - **button_pressed** **(** :ref:`int` button **)** When a button on this controller is pressed, this signal is given. +.. _class_ARVRController_button_release: + - **button_release** **(** :ref:`int` button **)** When a button on this controller is released, this signal is given. @@ -52,8 +56,11 @@ When a button on this controller is released, this signal is given. Member Variables ---------------- + .. _class_ARVRController_controller_id: + - :ref:`int` **controller_id** + Description ----------- diff --git a/classes/class_arvrinterface.rst b/classes/class_arvrinterface.rst index 943a70ad9..4da9f9d15 100644 --- a/classes/class_arvrinterface.rst +++ b/classes/class_arvrinterface.rst @@ -52,10 +52,19 @@ Member Functions Member Variables ---------------- + .. _class_ARVRInterface_ar_is_anchor_detection_enabled: + - :ref:`bool` **ar_is_anchor_detection_enabled** - On an AR interface, is our anchor detection enabled? + + .. _class_ARVRInterface_interface_is_initialized: + - :ref:`bool` **interface_is_initialized** - Has this interface been initialized? + + .. _class_ARVRInterface_interface_is_primary: + - :ref:`bool` **interface_is_primary** - Is this our primary interface? + Numeric Constants ----------------- diff --git a/classes/class_arvrorigin.rst b/classes/class_arvrorigin.rst index b651cb2a7..e3ea54692 100644 --- a/classes/class_arvrorigin.rst +++ b/classes/class_arvrorigin.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_ARVROrigin_world_scale: + - :ref:`float` **world_scale** + Description ----------- diff --git a/classes/class_arvrserver.rst b/classes/class_arvrserver.rst index 9eee4f91c..024e2e136 100644 --- a/classes/class_arvrserver.rst +++ b/classes/class_arvrserver.rst @@ -48,18 +48,26 @@ Member Functions Signals ------- +.. _class_ARVRServer_interface_added: + - **interface_added** **(** :ref:`String` name **)** Signal send when a new interface has been added. +.. _class_ARVRServer_interface_removed: + - **interface_removed** **(** :ref:`String` name **)** Signal send when an interface is removed. +.. _class_ARVRServer_tracker_added: + - **tracker_added** **(** :ref:`String` name, :ref:`int` type, :ref:`int` id **)** Signal send when a new tracker has been added. If you don't use a fixed number of controllers or if you're using ARVRAnchors for an AR solution it is important to react to this signal and add the appropriate ARVRController or ARVRAnchor node related to this new tracker. +.. _class_ARVRServer_tracker_removed: + - **tracker_removed** **(** :ref:`String` name, :ref:`int` type, :ref:`int` id **)** Signal send when a tracker is removed, you should remove any ARVRController or ARVRAnchor points if applicable. This is not mandatory, the nodes simply become inactive and will be made active again when a new tracker becomes available (i.e. a new controller is switched on that takes the place of the previous one). @@ -68,8 +76,11 @@ Signal send when a tracker is removed, you should remove any ARVRController or A Member Variables ---------------- + .. _class_ARVRServer_world_scale: + - :ref:`float` **world_scale** + Numeric Constants ----------------- diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index c6b37c126..a0001c008 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -36,10 +36,19 @@ Member Functions Member Variables ---------------- + .. _class_AtlasTexture_atlas: + - :ref:`Texture` **atlas** - The texture that contains the atlas. Can be any :ref:`Texture` subtype. + + .. _class_AtlasTexture_margin: + - :ref:`Rect2` **margin** - The margin around the region. The :ref:`Rect2`'s 'size' parameter ('w' and 'h' in the editor) resizes the texture so it fits within the margin. + + .. _class_AtlasTexture_region: + - :ref:`Rect2` **region** - The AtlasTexture's used region. + Description ----------- diff --git a/classes/class_audioeffectamplify.rst b/classes/class_audioeffectamplify.rst index fac95df46..5e521e3a3 100644 --- a/classes/class_audioeffectamplify.rst +++ b/classes/class_audioeffectamplify.rst @@ -30,8 +30,11 @@ Member Functions Member Variables ---------------- + .. _class_AudioEffectAmplify_volume_db: + - :ref:`float` **volume_db** - Amount of amplification. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24. Default value: ``0``. + Description ----------- diff --git a/classes/class_audioeffectchorus.rst b/classes/class_audioeffectchorus.rst index 3f567177b..37b1be792 100644 --- a/classes/class_audioeffectchorus.rst +++ b/classes/class_audioeffectchorus.rst @@ -60,34 +60,115 @@ Member Functions Member Variables ---------------- + .. _class_AudioEffectChorus_dry: + - :ref:`float` **dry** - The effect's raw signal. + + .. _class_AudioEffectChorus_voice/1/cutoff_hz: + - :ref:`float` **voice/1/cutoff_hz** - The voice's cutoff frequency. + + .. _class_AudioEffectChorus_voice/1/delay_ms: + - :ref:`float` **voice/1/delay_ms** - The voice's signal delay. + + .. _class_AudioEffectChorus_voice/1/depth_ms: + - :ref:`float` **voice/1/depth_ms** - The voice filter's depth. + + .. _class_AudioEffectChorus_voice/1/level_db: + - :ref:`float` **voice/1/level_db** - The voice's volume. + + .. _class_AudioEffectChorus_voice/1/pan: + - :ref:`float` **voice/1/pan** - The voice's pan level. + + .. _class_AudioEffectChorus_voice/1/rate_hz: + - :ref:`float` **voice/1/rate_hz** - The voice's filter rate. + + .. _class_AudioEffectChorus_voice/2/cutoff_hz: + - :ref:`float` **voice/2/cutoff_hz** - The voice's cutoff frequency. + + .. _class_AudioEffectChorus_voice/2/delay_ms: + - :ref:`float` **voice/2/delay_ms** - The voice's signal delay. + + .. _class_AudioEffectChorus_voice/2/depth_ms: + - :ref:`float` **voice/2/depth_ms** - The voice filter's depth. + + .. _class_AudioEffectChorus_voice/2/level_db: + - :ref:`float` **voice/2/level_db** - The voice's volume. + + .. _class_AudioEffectChorus_voice/2/pan: + - :ref:`float` **voice/2/pan** - The voice's pan level. + + .. _class_AudioEffectChorus_voice/2/rate_hz: + - :ref:`float` **voice/2/rate_hz** - The voice's filter rate. + + .. _class_AudioEffectChorus_voice/3/cutoff_hz: + - :ref:`float` **voice/3/cutoff_hz** - The voice's cutoff frequency. + + .. _class_AudioEffectChorus_voice/3/delay_ms: + - :ref:`float` **voice/3/delay_ms** - The voice's signal delay. + + .. _class_AudioEffectChorus_voice/3/depth_ms: + - :ref:`float` **voice/3/depth_ms** - The voice filter's depth. + + .. _class_AudioEffectChorus_voice/3/level_db: + - :ref:`float` **voice/3/level_db** - The voice's volume. + + .. _class_AudioEffectChorus_voice/3/pan: + - :ref:`float` **voice/3/pan** - The voice's pan level. + + .. _class_AudioEffectChorus_voice/3/rate_hz: + - :ref:`float` **voice/3/rate_hz** - The voice's filter rate. + + .. _class_AudioEffectChorus_voice/4/cutoff_hz: + - :ref:`float` **voice/4/cutoff_hz** - The voice's cutoff frequency. + + .. _class_AudioEffectChorus_voice/4/delay_ms: + - :ref:`float` **voice/4/delay_ms** - The voice's signal delay. + + .. _class_AudioEffectChorus_voice/4/depth_ms: + - :ref:`float` **voice/4/depth_ms** - The voice filter's depth. + + .. _class_AudioEffectChorus_voice/4/level_db: + - :ref:`float` **voice/4/level_db** - The voice's volume. + + .. _class_AudioEffectChorus_voice/4/pan: + - :ref:`float` **voice/4/pan** - The voice's pan level. + + .. _class_AudioEffectChorus_voice/4/rate_hz: + - :ref:`float` **voice/4/rate_hz** - The voice's filter rate. + + .. _class_AudioEffectChorus_voice_count: + - :ref:`int` **voice_count** - The amount of voices in the effect. + + .. _class_AudioEffectChorus_wet: + - :ref:`float` **wet** - The effect's processed signal. + Description ----------- diff --git a/classes/class_audioeffectcompressor.rst b/classes/class_audioeffectcompressor.rst index df306d6c4..561bbe7a2 100644 --- a/classes/class_audioeffectcompressor.rst +++ b/classes/class_audioeffectcompressor.rst @@ -54,14 +54,35 @@ Member Functions Member Variables ---------------- + .. _class_AudioEffectCompressor_attack_us: + - :ref:`float` **attack_us** - Compressor's reaction time when the signal exceeds the threshold. Value can range from 20 to 2000. Default value: ``20ms``. + + .. _class_AudioEffectCompressor_gain: + - :ref:`float` **gain** - Gain applied to the output signal. + + .. _class_AudioEffectCompressor_mix: + - :ref:`float` **mix** - Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet). Default value: ``1``. + + .. _class_AudioEffectCompressor_ratio: + - :ref:`float` **ratio** - Amount of compression applied to the audio once it passes the threshold level. The higher the ratio the more the loud parts of the audio will be compressed. Value can range from 1 to 48. Default value: ``4``. + + .. _class_AudioEffectCompressor_release_ms: + - :ref:`float` **release_ms** - Compressor's delay time to stop reducing the signal after the signal level falls below the threshold. Value can range from 20 to 2000. Default value: ``250ms``. + + .. _class_AudioEffectCompressor_sidechain: + - :ref:`String` **sidechain** - Reduce the sound level using another audio bus for threshold detection. + + .. _class_AudioEffectCompressor_threshold: + - :ref:`float` **threshold** - The level above which compression is applied to the audio. Value can range from -60 to 0. Default value: ``0``. + Description ----------- diff --git a/classes/class_audioeffectdelay.rst b/classes/class_audioeffectdelay.rst index 94319ec84..71f71fb09 100644 --- a/classes/class_audioeffectdelay.rst +++ b/classes/class_audioeffectdelay.rst @@ -78,20 +78,59 @@ Member Functions Member Variables ---------------- + .. _class_AudioEffectDelay_dry: + - :ref:`float` **dry** - Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1. Default value: ``1``. + + .. _class_AudioEffectDelay_feedback/active: + - :ref:`bool` **feedback/active** - If ``true`` feedback is enabled. Default value: ``false``. + + .. _class_AudioEffectDelay_feedback/delay_ms: + - :ref:`float` **feedback/delay_ms** - Feedback delay time in milliseconds. Default value: ``340``. + + .. _class_AudioEffectDelay_feedback/level_db: + - :ref:`float` **feedback/level_db** - Sound level for ``tap1``. Default value: ``-6 dB``. + + .. _class_AudioEffectDelay_feedback/lowpass: + - :ref:`float` **feedback/lowpass** - Low-pass filter for feedback. Frequencies below the Low Cut value are filtered out of the source signal. Default value: ``16000``. + + .. _class_AudioEffectDelay_tap1/active: + - :ref:`bool` **tap1/active** - If ``true``, ``tap1`` will be enabled. Default value: ``true``. + + .. _class_AudioEffectDelay_tap1/delay_ms: + - :ref:`float` **tap1/delay_ms** - **Tap1** delay time in milliseconds. Default value: ``250ms``. + + .. _class_AudioEffectDelay_tap1/level_db: + - :ref:`float` **tap1/level_db** - Sound level for ``tap1``. Default value: ``-6 dB``. + + .. _class_AudioEffectDelay_tap1/pan: + - :ref:`float` **tap1/pan** - Pan position for ``tap1``. Value can range from -1 (fully left) to 1 (fully right). Default value: ``0.2``. + + .. _class_AudioEffectDelay_tap2/active: + - :ref:`bool` **tap2/active** - If ``true``, ``tap2`` will be enabled. Default value: ``true``. + + .. _class_AudioEffectDelay_tap2/delay_ms: + - :ref:`float` **tap2/delay_ms** - **Tap2** delay time in milliseconds. Default value: ``500ms``. + + .. _class_AudioEffectDelay_tap2/level_db: + - :ref:`float` **tap2/level_db** - Sound level for ``tap2``. Default value: ``-12 dB``. + + .. _class_AudioEffectDelay_tap2/pan: + - :ref:`float` **tap2/pan** - Pan position for ``tap2``. Value can range from -1 (fully left) to 1 (fully right). Default value: ``-0.4``. + Description ----------- diff --git a/classes/class_audioeffectdistortion.rst b/classes/class_audioeffectdistortion.rst index 7cc0871db..a87ea934e 100644 --- a/classes/class_audioeffectdistortion.rst +++ b/classes/class_audioeffectdistortion.rst @@ -46,12 +46,27 @@ Member Functions Member Variables ---------------- + .. _class_AudioEffectDistortion_drive: + - :ref:`float` **drive** - Distortion power. Value can range from 0 to 1. Default value: ``0``. + + .. _class_AudioEffectDistortion_keep_hf_hz: + - :ref:`float` **keep_hf_hz** - High-pass filter. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000. Default value: ``16000``. + + .. _class_AudioEffectDistortion_mode: + - :ref:`int` **mode** - Distortion type. Default value: ``MODE_CLIP``. + + .. _class_AudioEffectDistortion_post_gain: + - :ref:`float` **post_gain** - Increases or decreases the volume after the effect. Value can range from -80 to 24. Default value: ``0``. + + .. _class_AudioEffectDistortion_pre_gain: + - :ref:`float` **pre_gain** - Increases or decreases the volume before the effect. Value can range from -60 to 60. Default value: ``0``. + Numeric Constants ----------------- diff --git a/classes/class_audioeffectfilter.rst b/classes/class_audioeffectfilter.rst index 4da3fd238..c4f96fe6a 100644 --- a/classes/class_audioeffectfilter.rst +++ b/classes/class_audioeffectfilter.rst @@ -42,11 +42,23 @@ Member Functions Member Variables ---------------- + .. _class_AudioEffectFilter_cutoff_hz: + - :ref:`float` **cutoff_hz** + + .. _class_AudioEffectFilter_dB: + - :ref:`int` **dB** + + .. _class_AudioEffectFilter_gain: + - :ref:`float` **gain** + + .. _class_AudioEffectFilter_resonance: + - :ref:`float` **resonance** + Numeric Constants ----------------- diff --git a/classes/class_audioeffectlimiter.rst b/classes/class_audioeffectlimiter.rst index 2576499ab..b44d7b928 100644 --- a/classes/class_audioeffectlimiter.rst +++ b/classes/class_audioeffectlimiter.rst @@ -40,11 +40,23 @@ Member Functions Member Variables ---------------- + .. _class_AudioEffectLimiter_ceiling_db: + - :ref:`float` **ceiling_db** - The waveform's maximum allowed value. Value can range from -20 to -0.1. Default value: ``-0.1dB``. + + .. _class_AudioEffectLimiter_soft_clip_db: + - :ref:`float` **soft_clip_db** - Applies a gain to the limited waves. Value can range from 0 to 6. Default value: ``2dB``. + + .. _class_AudioEffectLimiter_soft_clip_ratio: + - :ref:`float` **soft_clip_ratio** + + .. _class_AudioEffectLimiter_threshold_db: + - :ref:`float` **threshold_db** - Threshold from which the limiter begins to be active. Value can range from -30 to 0. Default value: ``0dB``. + Description ----------- diff --git a/classes/class_audioeffectpanner.rst b/classes/class_audioeffectpanner.rst index 654941d20..a1ff1997e 100644 --- a/classes/class_audioeffectpanner.rst +++ b/classes/class_audioeffectpanner.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_AudioEffectPanner_pan: + - :ref:`float` **pan** - Pan position. Value can range from -1 (fully left) to 1 (fully right). + Description ----------- diff --git a/classes/class_audioeffectphaser.rst b/classes/class_audioeffectphaser.rst index f2cda75d4..4d1f3e137 100644 --- a/classes/class_audioeffectphaser.rst +++ b/classes/class_audioeffectphaser.rst @@ -46,12 +46,27 @@ Member Functions Member Variables ---------------- + .. _class_AudioEffectPhaser_depth: + - :ref:`float` **depth** - Governs how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from 0.1 to 4. Default value: ``1``. + + .. _class_AudioEffectPhaser_feedback: + - :ref:`float` **feedback** - Output percent of modified sound. Value can range from 0.1 to 0.9. Default value: ``0.7``. + + .. _class_AudioEffectPhaser_range_max_hz: + - :ref:`float` **range_max_hz** - Determines the maximum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: ``1600hz``. + + .. _class_AudioEffectPhaser_range_min_hz: + - :ref:`float` **range_min_hz** - Determines the minimum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: ``440hz``. + + .. _class_AudioEffectPhaser_rate_hz: + - :ref:`float` **rate_hz** - Adjusts the rate at which the effect sweeps up and down across the frequency range. + Description ----------- diff --git a/classes/class_audioeffectpitchshift.rst b/classes/class_audioeffectpitchshift.rst index bdeab205b..1d4f32d56 100644 --- a/classes/class_audioeffectpitchshift.rst +++ b/classes/class_audioeffectpitchshift.rst @@ -30,8 +30,11 @@ Member Functions Member Variables ---------------- + .. _class_AudioEffectPitchShift_pitch_scale: + - :ref:`float` **pitch_scale** - Pitch value. Can range from 0 (-1 octave) to 16 (+16 octaves). + Description ----------- diff --git a/classes/class_audioeffectreverb.rst b/classes/class_audioeffectreverb.rst index ba381ae2f..01d74d76c 100644 --- a/classes/class_audioeffectreverb.rst +++ b/classes/class_audioeffectreverb.rst @@ -58,15 +58,39 @@ Member Functions Member Variables ---------------- + .. _class_AudioEffectReverb_damping: + - :ref:`float` **damping** - Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1. Default value: ``1``. + + .. _class_AudioEffectReverb_dry: + - :ref:`float` **dry** - Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1. Default value: ``1``. + + .. _class_AudioEffectReverb_hipass: + - :ref:`float` **hipass** - High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1. Default value: ``0``. + + .. _class_AudioEffectReverb_predelay_feedback: + - :ref:`float` **predelay_feedback** - Output percent of predelay. Value can range from 0 to 1. Default value: ``1``. + + .. _class_AudioEffectReverb_predelay_msec: + - :ref:`float` **predelay_msec** - Time between the original signal and the early reflections of the reverb signal. Default value: ``150ms``. + + .. _class_AudioEffectReverb_room_size: + - :ref:`float` **room_size** - Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1. Default value: ``0.8``. + + .. _class_AudioEffectReverb_spread: + - :ref:`float` **spread** - Defines how reflective the imaginary room's walls are. Value can range from 0 to 1. Default value: ``1``. + + .. _class_AudioEffectReverb_wet: + - :ref:`float` **wet** - Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1. Default value: ``0.5``. + Description ----------- diff --git a/classes/class_audioeffectstereoenhance.rst b/classes/class_audioeffectstereoenhance.rst index ffdb1054f..ca13372c2 100644 --- a/classes/class_audioeffectstereoenhance.rst +++ b/classes/class_audioeffectstereoenhance.rst @@ -36,10 +36,19 @@ Member Functions Member Variables ---------------- + .. _class_AudioEffectStereoEnhance_pan_pullout: + - :ref:`float` **pan_pullout** + + .. _class_AudioEffectStereoEnhance_surround: + - :ref:`float` **surround** + + .. _class_AudioEffectStereoEnhance_time_pullout_ms: + - :ref:`float` **time_pullout_ms** + Member Function Description --------------------------- diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index 957921779..93836e51f 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -90,6 +90,8 @@ Member Functions Signals ------- +.. _class_AudioServer_bus_layout_changed: + - **bus_layout_changed** **(** **)** Emitted when the :ref:`AudioBusLayout` changes. diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index 00dd278b4..304a23c31 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -36,10 +36,19 @@ Member Functions Member Variables ---------------- + .. _class_AudioStreamOGGVorbis_data: + - :ref:`PoolByteArray` **data** - Raw audio data. + + .. _class_AudioStreamOGGVorbis_loop: + - :ref:`bool` **loop** - If ``true``, audio will loop continuously. Default value: ``false``. + + .. _class_AudioStreamOGGVorbis_loop_offset: + - :ref:`float` **loop_offset** - If loop is ``true``, loop starts from this position, in seconds. + Description ----------- diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index 874582021..cca6643c3 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -54,6 +54,8 @@ Member Functions Signals ------- +.. _class_AudioStreamPlayer_finished: + - **finished** **(** **)** Emitted when the audio stops playing. @@ -62,13 +64,31 @@ Emitted when the audio stops playing. Member Variables ---------------- + .. _class_AudioStreamPlayer_autoplay: + - :ref:`bool` **autoplay** - If ``true`` audio plays when added to scene tree. Default value: ``false``. + + .. _class_AudioStreamPlayer_bus: + - :ref:`String` **bus** - Bus on which this audio is playing. + + .. _class_AudioStreamPlayer_mix_target: + - :ref:`int` **mix_target** - If the audio configuration has more than two speakers, this sets the target channels. See ``MIX_TARGET\_\*`` constants. + + .. _class_AudioStreamPlayer_playing: + - :ref:`bool` **playing** - If ``true`` audio is playing. + + .. _class_AudioStreamPlayer_stream: + - :ref:`AudioStream` **stream** - The :ref:`AudioStream` object to be played. + + .. _class_AudioStreamPlayer_volume_db: + - :ref:`float` **volume_db** - Volume of sound, in dB. + Numeric Constants ----------------- diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index cc0bac737..78058a29c 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -62,6 +62,8 @@ Member Functions Signals ------- +.. _class_AudioStreamPlayer2D_finished: + - **finished** **(** **)** Emitted when the audio stops playing. @@ -70,15 +72,39 @@ Emitted when the audio stops playing. Member Variables ---------------- + .. _class_AudioStreamPlayer2D_area_mask: + - :ref:`int` **area_mask** - Areas in which this sound plays. + + .. _class_AudioStreamPlayer2D_attenuation: + - :ref:`float` **attenuation** - Dampens audio over distance with this as an exponent. + + .. _class_AudioStreamPlayer2D_autoplay: + - :ref:`bool` **autoplay** - If ``true`` audio plays when added to scene tree. Default value: ``false``. + + .. _class_AudioStreamPlayer2D_bus: + - :ref:`String` **bus** - Bus on which this audio is playing. + + .. _class_AudioStreamPlayer2D_max_distance: + - :ref:`float` **max_distance** - Maximum distance from which audio is still hearable. + + .. _class_AudioStreamPlayer2D_playing: + - :ref:`bool` **playing** - If ``true`` audio is playing. + + .. _class_AudioStreamPlayer2D_stream: + - :ref:`AudioStream` **stream** - The :ref:`AudioStream` object to be played. + + .. _class_AudioStreamPlayer2D_volume_db: + - :ref:`float` **volume_db** - Base volume without dampening. + Description ----------- diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index d222e4566..2feef0c67 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -98,6 +98,8 @@ Member Functions Signals ------- +.. _class_AudioStreamPlayer3D_finished: + - **finished** **(** **)** Fires when the audio stops playing. @@ -106,24 +108,75 @@ Fires when the audio stops playing. Member Variables ---------------- + .. _class_AudioStreamPlayer3D_area_mask: + - :ref:`int` **area_mask** - Areas in which this sound plays. + + .. _class_AudioStreamPlayer3D_attenuation_filter_cutoff_hz: + - :ref:`float` **attenuation_filter_cutoff_hz** - Dampens audio above this frequency, in Hz. + + .. _class_AudioStreamPlayer3D_attenuation_filter_db: + - :ref:`float` **attenuation_filter_db** - Amount how much the filter affects the loudness, in dB. + + .. _class_AudioStreamPlayer3D_attenuation_model: + - :ref:`int` **attenuation_model** - Decides if audio should get quieter with distance linearly, quadratically or logarithmically. + + .. _class_AudioStreamPlayer3D_autoplay: + - :ref:`bool` **autoplay** - If ``true`` audio plays when added to scene tree. Default value: ``false``. + + .. _class_AudioStreamPlayer3D_bus: + - :ref:`String` **bus** - Bus on which this audio is playing. + + .. _class_AudioStreamPlayer3D_doppler_tracking: + - :ref:`int` **doppler_tracking** - Decides in which step the Doppler effect should be calculated. + + .. _class_AudioStreamPlayer3D_emission_angle_degrees: + - :ref:`float` **emission_angle_degrees** - The angle in which the audio reaches cameras undampened. + + .. _class_AudioStreamPlayer3D_emission_angle_enabled: + - :ref:`bool` **emission_angle_enabled** - If ``true`` the audio should be dampened according to the direction of the sound. + + .. _class_AudioStreamPlayer3D_emission_angle_filter_attenuation_db: + - :ref:`float` **emission_angle_filter_attenuation_db** - dampens audio if camera is outside of 'emission_angle_degrees' and 'emission_angle_enabled' is set by this factor, in dB. + + .. _class_AudioStreamPlayer3D_max_db: + - :ref:`float` **max_db** - Sets the absolute maximum of the soundlevel, in dB. + + .. _class_AudioStreamPlayer3D_max_distance: + - :ref:`float` **max_distance** - Sets the distance from which the 'out_of_range_mode' takes effect. Has no effect if set to 0. + + .. _class_AudioStreamPlayer3D_out_of_range_mode: + - :ref:`int` **out_of_range_mode** - Decides if audio should pause when source is outside of 'max_distance' range. + + .. _class_AudioStreamPlayer3D_playing: + - :ref:`bool` **playing** - If ``true``, audio is playing. + + .. _class_AudioStreamPlayer3D_stream: + - :ref:`AudioStream` **stream** - The :ref:`AudioStream` object to be played. + + .. _class_AudioStreamPlayer3D_unit_db: + - :ref:`float` **unit_db** - Base sound level unaffected by dampening, in dB. + + .. _class_AudioStreamPlayer3D_unit_size: + - :ref:`float` **unit_size** - Factor for the attenuation effect. + Numeric Constants ----------------- diff --git a/classes/class_audiostreamrandompitch.rst b/classes/class_audiostreamrandompitch.rst index e75305e08..754c1a0cd 100644 --- a/classes/class_audiostreamrandompitch.rst +++ b/classes/class_audiostreamrandompitch.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_AudioStreamRandomPitch_audio_stream: + - :ref:`AudioStream` **audio_stream** - The current :ref:`AudioStream`. + + .. _class_AudioStreamRandomPitch_random_pitch: + - :ref:`float` **random_pitch** - The intensity of random pitch variation. + Description ----------- diff --git a/classes/class_audiostreamsample.rst b/classes/class_audiostreamsample.rst index 26e621a8b..023d1b4cd 100644 --- a/classes/class_audiostreamsample.rst +++ b/classes/class_audiostreamsample.rst @@ -52,14 +52,35 @@ Member Functions Member Variables ---------------- + .. _class_AudioStreamSample_data: + - :ref:`PoolByteArray` **data** - Raw audio data. + + .. _class_AudioStreamSample_format: + - :ref:`int` **format** - Audio format. See FORMAT\_\* constants for values. + + .. _class_AudioStreamSample_loop_begin: + - :ref:`int` **loop_begin** - Loop start in bytes. + + .. _class_AudioStreamSample_loop_end: + - :ref:`int` **loop_end** - Loop end in bytes. + + .. _class_AudioStreamSample_loop_mode: + - :ref:`int` **loop_mode** - Loop mode. See LOOP\_\* constants for values. + + .. _class_AudioStreamSample_mix_rate: + - :ref:`int` **mix_rate** - The sample rate for mixing this audio. + + .. _class_AudioStreamSample_stereo: + - :ref:`bool` **stereo** - If ``true``, audio is stereo. Default value: ``false``. + Numeric Constants ----------------- diff --git a/classes/class_backbuffercopy.rst b/classes/class_backbuffercopy.rst index 718f36cd9..4ce8886fa 100644 --- a/classes/class_backbuffercopy.rst +++ b/classes/class_backbuffercopy.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_BackBufferCopy_copy_mode: + - :ref:`int` **copy_mode** - Buffer mode. See ``COPY_MODE\_\*`` constants. + + .. _class_BackBufferCopy_rect: + - :ref:`Rect2` **rect** - The area covered by the BackBufferCopy. Only used if ``copy_mode`` is ``COPY_MODE_RECT``. + Numeric Constants ----------------- diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index e549e6035..8aac58831 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -62,18 +62,26 @@ Member Functions Signals ------- +.. _class_BaseButton_button_down: + - **button_down** **(** **)** Emitted when the button starts being held down. +.. _class_BaseButton_button_up: + - **button_up** **(** **)** Emitted when the button stops being held down. +.. _class_BaseButton_pressed: + - **pressed** **(** **)** This signal is emitted every time the button is toggled or pressed (i.e. activated, so on ``button_down`` if "Click on press" is active and on ``button_up`` otherwise). +.. _class_BaseButton_toggled: + - **toggled** **(** :ref:`bool` pressed **)** This signal is emitted when the button was just toggled between pressed and normal states (only if toggle_mode is active). The new state is contained in the *pressed* argument. @@ -82,14 +90,35 @@ This signal is emitted when the button was just toggled between pressed and norm Member Variables ---------------- + .. _class_BaseButton_action_mode: + - :ref:`int` **action_mode** + + .. _class_BaseButton_disabled: + - :ref:`bool` **disabled** + + .. _class_BaseButton_enabled_focus_mode: + - :ref:`int` **enabled_focus_mode** + + .. _class_BaseButton_group: + - :ref:`ButtonGroup` **group** + + .. _class_BaseButton_pressed: + - :ref:`bool` **pressed** + + .. _class_BaseButton_shortcut: + - :ref:`ShortCut` **shortcut** + + .. _class_BaseButton_toggle_mode: + - :ref:`bool` **toggle_mode** + Numeric Constants ----------------- diff --git a/classes/class_basis.rst b/classes/class_basis.rst index 05151fb3c..c13bc1223 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -58,10 +58,19 @@ Member Functions Member Variables ---------------- + .. _class_Basis_x: + - :ref:`Vector3` **x** + + .. _class_Basis_y: + - :ref:`Vector3` **y** + + .. _class_Basis_z: + - :ref:`Vector3` **z** + Description ----------- diff --git a/classes/class_bitmap.rst b/classes/class_bitmap.rst index 2e2cbcfa1..2fe1dd749 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -38,12 +38,15 @@ Member Functions Member Variables ---------------- + .. _class_BitMap_data: + - :ref:`Dictionary` **data** - Returns a :ref:`Dictionary` with two keys : ``data`` : :ref:`PoolByteArray` with ``true``/``false`` ``BitMap`` data. ``size`` : The ``Bitmap``'s size. + Description ----------- diff --git a/classes/class_bitmapfont.rst b/classes/class_bitmapfont.rst index 526e4fa95..07dad619d 100644 --- a/classes/class_bitmapfont.rst +++ b/classes/class_bitmapfont.rst @@ -52,14 +52,35 @@ Member Functions Member Variables ---------------- + .. _class_BitmapFont_ascent: + - :ref:`float` **ascent** - Ascent (number of pixels above the baseline). + + .. _class_BitmapFont_chars: + - :ref:`PoolIntArray` **chars** - The characters in the BitmapFont. + + .. _class_BitmapFont_distance_field: + - :ref:`bool` **distance_field** - If ``true`` distance field hint is enabled. + + .. _class_BitmapFont_fallback: + - :ref:`BitmapFont` **fallback** - The fallback font. + + .. _class_BitmapFont_height: + - :ref:`float` **height** - Total font height (ascent plus descent) in pixels. + + .. _class_BitmapFont_kernings: + - :ref:`PoolIntArray` **kernings** - The font's kernings as :ref:`PoolIntArray`. + + .. _class_BitmapFont_textures: + - :ref:`Array` **textures** - The font's :ref:`Texture`\ s. + Description ----------- diff --git a/classes/class_boxcontainer.rst b/classes/class_boxcontainer.rst index f43fef730..fae210003 100644 --- a/classes/class_boxcontainer.rst +++ b/classes/class_boxcontainer.rst @@ -32,8 +32,11 @@ Member Functions Member Variables ---------------- + .. _class_BoxContainer_alignment: + - :ref:`int` **alignment** - The alignment of the container's children (must be one of ALIGN_BEGIN, ALIGN_CENTER, or ALIGN_END). + Numeric Constants ----------------- diff --git a/classes/class_boxshape.rst b/classes/class_boxshape.rst index 361f32c60..e39612715 100644 --- a/classes/class_boxshape.rst +++ b/classes/class_boxshape.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_BoxShape_extents: + - :ref:`Vector3` **extents** - The shape's half extents. + Description ----------- diff --git a/classes/class_button.rst b/classes/class_button.rst index 33de2a083..cdfad8c08 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -46,12 +46,27 @@ Member Functions Member Variables ---------------- + .. _class_Button_align: + - :ref:`int` **align** - Text alignment policy for the button's text, use one of the ALIGN\_\* constants. + + .. _class_Button_clip_text: + - :ref:`bool` **clip_text** - When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. This property is disabled by default. + + .. _class_Button_flat: + - :ref:`bool` **flat** - Flat buttons don't display decoration. + + .. _class_Button_icon: + - :ref:`Texture` **icon** - Button's icon, if text is present the icon will be placed before the text. + + .. _class_Button_text: + - :ref:`String` **text** - The button's text that will be displayed inside the button's area. + Numeric Constants ----------------- diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index 6b539fc1d..aa58cade1 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -108,28 +108,91 @@ Member Functions Member Variables ---------------- + .. _class_Camera2D_anchor_mode: + - :ref:`int` **anchor_mode** - The Camera2D's anchor point. See ``ANCHOR_MODE\_\*`` constants. + + .. _class_Camera2D_current: + - :ref:`bool` **current** - If ``true`` this camera is the active camera for the current scene. Only one camera can be current, so setting a different camera ``current`` will disable this one. + + .. _class_Camera2D_drag_margin_bottom: + - :ref:`float` **drag_margin_bottom** - Bottom margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. + + .. _class_Camera2D_drag_margin_h_enabled: + - :ref:`bool` **drag_margin_h_enabled** + + .. _class_Camera2D_drag_margin_left: + - :ref:`float` **drag_margin_left** - Left margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. + + .. _class_Camera2D_drag_margin_right: + - :ref:`float` **drag_margin_right** - Right margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. + + .. _class_Camera2D_drag_margin_top: + - :ref:`float` **drag_margin_top** - Top margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. + + .. _class_Camera2D_drag_margin_v_enabled: + - :ref:`bool` **drag_margin_v_enabled** + + .. _class_Camera2D_editor_draw_drag_margin: + - :ref:`bool` **editor_draw_drag_margin** + + .. _class_Camera2D_editor_draw_limits: + - :ref:`bool` **editor_draw_limits** + + .. _class_Camera2D_editor_draw_screen: + - :ref:`bool` **editor_draw_screen** + + .. _class_Camera2D_limit_bottom: + - :ref:`int` **limit_bottom** - Bottom scroll limit in pixels. The camera stops moving when reaching this value. + + .. _class_Camera2D_limit_left: + - :ref:`int` **limit_left** - Left scroll limit in pixels. The camera stops moving when reaching this value. + + .. _class_Camera2D_limit_right: + - :ref:`int` **limit_right** - Right scroll limit in pixels. The camera stops moving when reaching this value. + + .. _class_Camera2D_limit_smoothed: + - :ref:`bool` **limit_smoothed** + + .. _class_Camera2D_limit_top: + - :ref:`int` **limit_top** - Top scroll limit in pixels. The camera stops moving when reaching this value. + + .. _class_Camera2D_offset: + - :ref:`Vector2` **offset** - The camera's offset, useful for looking around or camera shake animations. + + .. _class_Camera2D_rotating: + - :ref:`bool` **rotating** + + .. _class_Camera2D_smoothing_enabled: + - :ref:`bool` **smoothing_enabled** + + .. _class_Camera2D_smoothing_speed: + - :ref:`float` **smoothing_speed** + + .. _class_Camera2D_zoom: + - :ref:`Vector2` **zoom** - The camera's zoom relative to the viewport. Values larger than ``Vector2(1, 1)`` zoom out and smaller values zoom in. For an example, use ``Vector2(0.5, 0.5)`` for a 2x zoom in, and ``Vector2(4, 4)`` for a 4x zoom out. + Numeric Constants ----------------- diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 152cb76fa..a9f5f9b88 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -146,18 +146,26 @@ Member Functions Signals ------- +.. _class_CanvasItem_draw: + - **draw** **(** **)** Emitted when the CanvasItem must redraw. This can only be connected realtime, as deferred will not allow drawing. +.. _class_CanvasItem_hide: + - **hide** **(** **)** Emitted when becoming hidden. +.. _class_CanvasItem_item_rect_changed: + - **item_rect_changed** **(** **)** Emitted when the item rect has changed. +.. _class_CanvasItem_visibility_changed: + - **visibility_changed** **(** **)** Emitted when the visibility (hidden/visible) changes. @@ -166,15 +174,39 @@ Emitted when the visibility (hidden/visible) changes. Member Variables ---------------- + .. _class_CanvasItem_light_mask: + - :ref:`int` **light_mask** + + .. _class_CanvasItem_material: + - :ref:`Material` **material** + + .. _class_CanvasItem_modulate: + - :ref:`Color` **modulate** + + .. _class_CanvasItem_self_modulate: + - :ref:`Color` **self_modulate** + + .. _class_CanvasItem_show_behind_parent: + - :ref:`bool` **show_behind_parent** + + .. _class_CanvasItem_show_on_top: + - :ref:`bool` **show_on_top** + + .. _class_CanvasItem_use_parent_material: + - :ref:`bool` **use_parent_material** + + .. _class_CanvasItem_visible: + - :ref:`bool` **visible** + Numeric Constants ----------------- diff --git a/classes/class_canvasitemmaterial.rst b/classes/class_canvasitemmaterial.rst index a3415f7f3..fefa4bc81 100644 --- a/classes/class_canvasitemmaterial.rst +++ b/classes/class_canvasitemmaterial.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_CanvasItemMaterial_blend_mode: + - :ref:`int` **blend_mode** + + .. _class_CanvasItemMaterial_light_mode: + - :ref:`int` **light_mode** + Numeric Constants ----------------- diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index 4fba0b713..c7ed53850 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -56,11 +56,23 @@ Member Functions Member Variables ---------------- + .. _class_CanvasLayer_layer: + - :ref:`int` **layer** - Layer index for draw order. Lower values are drawn first. Default value: ``1``. + + .. _class_CanvasLayer_offset: + - :ref:`Vector2` **offset** - The layer's base offset. + + .. _class_CanvasLayer_rotation: + - :ref:`float` **rotation** - The layer's rotation in degrees. + + .. _class_CanvasLayer_scale: + - :ref:`Vector2` **scale** - The layer's scale. + Description ----------- diff --git a/classes/class_canvasmodulate.rst b/classes/class_canvasmodulate.rst index b60924732..cb71e6e80 100644 --- a/classes/class_canvasmodulate.rst +++ b/classes/class_canvasmodulate.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_CanvasModulate_color: + - :ref:`Color` **color** - The tint color to apply. + Description ----------- diff --git a/classes/class_capsulemesh.rst b/classes/class_capsulemesh.rst index e2a321588..11119becc 100644 --- a/classes/class_capsulemesh.rst +++ b/classes/class_capsulemesh.rst @@ -40,11 +40,23 @@ Member Functions Member Variables ---------------- + .. _class_CapsuleMesh_mid_height: + - :ref:`float` **mid_height** - Height of the capsule mesh from the center point. Defaults to 1.0. + + .. _class_CapsuleMesh_radial_segments: + - :ref:`int` **radial_segments** - Number of radial segments on the capsule mesh. Defaults to 64. + + .. _class_CapsuleMesh_radius: + - :ref:`float` **radius** - Radius of the capsule mesh. Defaults to 1.0. + + .. _class_CapsuleMesh_rings: + - :ref:`int` **rings** - Number of rings along the height of the capsule. Defaults to 8. + Description ----------- diff --git a/classes/class_capsuleshape.rst b/classes/class_capsuleshape.rst index ec3768f63..3f6b1913b 100644 --- a/classes/class_capsuleshape.rst +++ b/classes/class_capsuleshape.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_CapsuleShape_height: + - :ref:`float` **height** - The capsule's height. + + .. _class_CapsuleShape_radius: + - :ref:`float` **radius** - The capsule's radius. + Description ----------- diff --git a/classes/class_capsuleshape2d.rst b/classes/class_capsuleshape2d.rst index 9b028d8c4..235e01c3b 100644 --- a/classes/class_capsuleshape2d.rst +++ b/classes/class_capsuleshape2d.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_CapsuleShape2D_height: + - :ref:`float` **height** - The capsule's height. + + .. _class_CapsuleShape2D_radius: + - :ref:`float` **radius** - The capsules's radius. + Description ----------- diff --git a/classes/class_centercontainer.rst b/classes/class_centercontainer.rst index 88909f849..2826a9bfe 100644 --- a/classes/class_centercontainer.rst +++ b/classes/class_centercontainer.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_CenterContainer_use_top_left: + - :ref:`bool` **use_top_left** + Description ----------- diff --git a/classes/class_circleshape2d.rst b/classes/class_circleshape2d.rst index 69870c0c7..1dbf904dd 100644 --- a/classes/class_circleshape2d.rst +++ b/classes/class_circleshape2d.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_CircleShape2D_radius: + - :ref:`float` **radius** - The circle's radius. + Description ----------- diff --git a/classes/class_collisionobject.rst b/classes/class_collisionobject.rst index 7701feaaa..aeac08c34 100644 --- a/classes/class_collisionobject.rst +++ b/classes/class_collisionobject.rst @@ -68,12 +68,18 @@ Member Functions Signals ------- +.. _class_CollisionObject_input_event: + - **input_event** **(** :ref:`Object` camera, :ref:`Object` event, :ref:`Vector3` click_position, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** +.. _class_CollisionObject_mouse_entered: + - **mouse_entered** **(** **)** Emitted when the mouse pointer enters any of this object's shapes. +.. _class_CollisionObject_mouse_exited: + - **mouse_exited** **(** **)** Emitted when the mouse pointer exits all this object's shapes. @@ -82,9 +88,15 @@ Emitted when the mouse pointer exits all this object's shapes. Member Variables ---------------- + .. _class_CollisionObject_input_capture_on_drag: + - :ref:`bool` **input_capture_on_drag** + + .. _class_CollisionObject_input_ray_pickable: + - :ref:`bool` **input_ray_pickable** + Description ----------- diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index 5ae7c1be2..4a86dcd58 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -68,14 +68,20 @@ Member Functions Signals ------- +.. _class_CollisionObject2D_input_event: + - **input_event** **(** :ref:`Object` viewport, :ref:`Object` event, :ref:`int` shape_idx **)** Emitted when an input event occurs and ``input_pickable`` is ``true``. +.. _class_CollisionObject2D_mouse_entered: + - **mouse_entered** **(** **)** Emitted when the mouse pointer enters any of this object's shapes. +.. _class_CollisionObject2D_mouse_exited: + - **mouse_exited** **(** **)** Emitted when the mouse pointer exits all this object's shapes. @@ -84,8 +90,11 @@ Emitted when the mouse pointer exits all this object's shapes. Member Variables ---------------- + .. _class_CollisionObject2D_input_pickable: + - :ref:`bool` **input_pickable** - If ``true`` this object is pickable. A pickable object can detect the mouse pointer entering/leaving, and if the mouse is inside it, report input events. + Description ----------- diff --git a/classes/class_collisionpolygon.rst b/classes/class_collisionpolygon.rst index 68d4315fa..5600b7bf6 100644 --- a/classes/class_collisionpolygon.rst +++ b/classes/class_collisionpolygon.rst @@ -36,10 +36,19 @@ Member Functions Member Variables ---------------- + .. _class_CollisionPolygon_depth: + - :ref:`float` **depth** - Length that the resulting collision extends in either direction perpendicular to its polygon. + + .. _class_CollisionPolygon_disabled: + - :ref:`bool` **disabled** - If true, no collision will be produced. + + .. _class_CollisionPolygon_polygon: + - :ref:`PoolVector2Array` **polygon** - Array of vertices which define the polygon. + Description ----------- diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index afd3cf3ec..a8db5e1cd 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -40,11 +40,23 @@ Member Functions Member Variables ---------------- + .. _class_CollisionPolygon2D_build_mode: + - :ref:`int` **build_mode** - Collision build mode. Use one of the ``BUILD\_\*`` constants. Default value: ``BUILD_SOLIDS``. + + .. _class_CollisionPolygon2D_disabled: + - :ref:`bool` **disabled** - If ``true`` no collisions will be detected. + + .. _class_CollisionPolygon2D_one_way_collision: + - :ref:`bool` **one_way_collision** - If ``true`` only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects. + + .. _class_CollisionPolygon2D_polygon: + - :ref:`PoolVector2Array` **polygon** - The polygon's list of vertices. The final point will be connected to the first. + Numeric Constants ----------------- diff --git a/classes/class_collisionshape.rst b/classes/class_collisionshape.rst index 8dddb5cca..7617d0368 100644 --- a/classes/class_collisionshape.rst +++ b/classes/class_collisionshape.rst @@ -36,9 +36,15 @@ Member Functions Member Variables ---------------- + .. _class_CollisionShape_disabled: + - :ref:`bool` **disabled** - A disabled collision shape has no effect in the world. + + .. _class_CollisionShape_shape: + - :ref:`Shape` **shape** - The actual shape owned by this collision shape. + Description ----------- diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index 314a81aab..b166f7a02 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -36,10 +36,19 @@ Member Functions Member Variables ---------------- + .. _class_CollisionShape2D_disabled: + - :ref:`bool` **disabled** - A disabled collision shape has no effect in the world. + + .. _class_CollisionShape2D_one_way_collision: + - :ref:`bool` **one_way_collision** - Sets whether this collision shape should only detect collision on one side (top or bottom). + + .. _class_CollisionShape2D_shape: + - :ref:`Shape2D` **shape** - The actual shape owned by this collision shape. + Description ----------- diff --git a/classes/class_color.rst b/classes/class_color.rst index af4e108cc..0f69050d6 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -46,18 +46,51 @@ Member Functions Member Variables ---------------- + .. _class_Color_a: + - :ref:`float` **a** - Alpha (0 to 1) + + .. _class_Color_a8: + - :ref:`int` **a8** - Alpha (0 to 255) + + .. _class_Color_b: + - :ref:`float` **b** - Blue (0 to 1) + + .. _class_Color_b8: + - :ref:`int` **b8** - Blue (0 to 255) + + .. _class_Color_g: + - :ref:`float` **g** - Green (0 to 1) + + .. _class_Color_g8: + - :ref:`int` **g8** - Green (0 to 255) + + .. _class_Color_h: + - :ref:`float` **h** - Hue (0 to 1) + + .. _class_Color_r: + - :ref:`float` **r** - Red (0 to 1) + + .. _class_Color_r8: + - :ref:`int` **r8** - Red (0 to 255) + + .. _class_Color_s: + - :ref:`float` **s** - Saturation (0 to 1) + + .. _class_Color_v: + - :ref:`float` **v** - Value (0 to 1) + Description ----------- diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index a79dde8af..0f71962c3 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -38,6 +38,8 @@ Member Functions Signals ------- +.. _class_ColorPicker_color_changed: + - **color_changed** **(** :ref:`Color` color **)** Emitted when the color is changed. diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index babffd9bb..01a971009 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -34,6 +34,8 @@ Member Functions Signals ------- +.. _class_ColorPickerButton_color_changed: + - **color_changed** **(** :ref:`Color` color **)** Emitted when the color is changed. @@ -42,9 +44,15 @@ Emitted when the color is changed. Member Variables ---------------- + .. _class_ColorPickerButton_color: + - :ref:`Color` **color** + + .. _class_ColorPickerButton_edit_alpha: + - :ref:`bool` **edit_alpha** + Description ----------- diff --git a/classes/class_colorrect.rst b/classes/class_colorrect.rst index 8ee5386f7..1a6eec857 100644 --- a/classes/class_colorrect.rst +++ b/classes/class_colorrect.rst @@ -28,12 +28,15 @@ Member Functions Member Variables ---------------- + .. _class_ColorRect_color: + - :ref:`Color` **color** - The color to fill the ``ColorRect``. :: $ColorRect.color = Color(1, 0, 0, 1) # Set ColorRect node's color to red + Description ----------- diff --git a/classes/class_concavepolygonshape2d.rst b/classes/class_concavepolygonshape2d.rst index f192e95e4..260c2cf81 100644 --- a/classes/class_concavepolygonshape2d.rst +++ b/classes/class_concavepolygonshape2d.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_ConcavePolygonShape2D_segments: + - :ref:`PoolVector2Array` **segments** + Description ----------- diff --git a/classes/class_conetwistjoint.rst b/classes/class_conetwistjoint.rst index b4958b268..f81bc28a6 100644 --- a/classes/class_conetwistjoint.rst +++ b/classes/class_conetwistjoint.rst @@ -28,11 +28,22 @@ Member Functions Member Variables ---------------- + .. _class_ConeTwistJoint_bias: + - :ref:`float` **bias** - The speed with which the swing or twist will take place. The higher, the faster. + + .. _class_ConeTwistJoint_relaxation: + - :ref:`float` **relaxation** - Defines, how fast the swing- and twist-speed-difference on both sides gets synced. + + .. _class_ConeTwistJoint_softness: + - :ref:`float` **softness** - The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint. + + .. _class_ConeTwistJoint_swing_span: + - :ref:`float` **swing_span** - Swing is rotation from side to side, around the axis perpendicular to the twist axis. The swing span defines, how much rotation will not get corrected allong the swing axis. @@ -40,10 +51,14 @@ The swing span defines, how much rotation will not get corrected allong the swin Could be defined as looseness in the :ref:`ConeTwistJoint`. If below 0.05, this behaviour is locked. Default value: ``PI/4``. + + .. _class_ConeTwistJoint_twist_span: + - :ref:`float` **twist_span** - Twist is the rotation around the twist axis, this value defined how far the joint can twist. Twist is locked if below 0.05. + Numeric Constants ----------------- diff --git a/classes/class_container.rst b/classes/class_container.rst index 318b0aa0d..f4b336b9b 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -30,6 +30,8 @@ Member Functions Signals ------- +.. _class_Container_sort_children: + - **sort_children** **(** **)** Emitted when sorting the children is needed. diff --git a/classes/class_control.rst b/classes/class_control.rst index 4fbabc765..2eeaf20b3 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -222,91 +222,190 @@ Member Functions Signals ------- +.. _class_Control_focus_entered: + - **focus_entered** **(** **)** Emitted when the node gains keyboard focus. +.. _class_Control_focus_exited: + - **focus_exited** **(** **)** Emitted when the node loses keyboard focus. +.. _class_Control_gui_input: + - **gui_input** **(** :ref:`Object` ev **)** Emitted when the node receives an :ref:`InputEvent`. +.. _class_Control_minimum_size_changed: + - **minimum_size_changed** **(** **)** Emitted when the node's minimum size changes. +.. _class_Control_modal_closed: + - **modal_closed** **(** **)** Emitted when a modal ``Control`` is closed. See :ref:`show_modal`. +.. _class_Control_mouse_entered: + - **mouse_entered** **(** **)** Emitted when the mouse enters the control's ``Rect`` area. +.. _class_Control_mouse_exited: + - **mouse_exited** **(** **)** Emitted when the mouse leaves the control's ``Rect`` area. +.. _class_Control_resized: + - **resized** **(** **)** Emitted when the control changes size. +.. _class_Control_size_flags_changed: + - **size_flags_changed** **(** **)** -Emitted when one of the size flags changes. See member size_flags_horizontal and member size_flags_vertical. +Emitted when one of the size flags changes. See :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. Member Variables ---------------- + .. _class_Control_anchor_bottom: + - :ref:`float` **anchor_bottom** - Anchors the bottom edge of the node to the origin, the center, or the end of its parent container. It changes how the bottom margin updates when the node moves or changes size. Use one of the ``ANCHOR\_\*`` constants. Default value: ``ANCHOR_BEGIN``. + + .. _class_Control_anchor_left: + - :ref:`float` **anchor_left** - Anchors the left edge of the node to the origin, the center or the end of its parent container. It changes how the left margin updates when the node moves or changes size. Use one of the ``ANCHOR\_\*`` constants. Default value: ``ANCHOR_BEGIN``. + + .. _class_Control_anchor_right: + - :ref:`float` **anchor_right** - Anchors the right edge of the node to the origin, the center or the end of its parent container. It changes how the right margin updates when the node moves or changes size. Use one of the ``ANCHOR\_\*`` constants. Default value: ``ANCHOR_BEGIN``. + + .. _class_Control_anchor_top: + - :ref:`float` **anchor_top** - Anchors the top edge of the node to the origin, the center or the end of its parent container. It changes how the top margin updates when the node moves or changes size. Use one of the ``ANCHOR\_\*`` constants. Default value: ``ANCHOR_BEGIN``. + + .. _class_Control_focus_neighbour_bottom: + - :ref:`NodePath` **focus_neighbour_bottom** - Tells Godot which node it should give keyboard focus to if the user presses Tab, the down arrow on the keyboard, or down on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. If the user presses Tab, Godot will give focus to the closest node to the right first, then to the bottom. If the user presses Shift+Tab, Godot will look to the left of the node, then above it. + + .. _class_Control_focus_neighbour_left: + - :ref:`NodePath` **focus_neighbour_left** - Tells Godot which node it should give keyboard focus to if the user presses Shift+Tab, the left arrow on the keyboard or left on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the left of this one. + + .. _class_Control_focus_neighbour_right: + - :ref:`NodePath` **focus_neighbour_right** - Tells Godot which node it should give keyboard focus to if the user presses Tab, the right arrow on the keyboard or right on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. + + .. _class_Control_focus_neighbour_top: + - :ref:`NodePath` **focus_neighbour_top** - Tells Godot which node it should give keyboard focus to if the user presses Shift+Tab, the top arrow on the keyboard or top on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. + + .. _class_Control_grow_horizontal: + - :ref:`int` **grow_horizontal** + + .. _class_Control_grow_vertical: + - :ref:`int` **grow_vertical** + + .. _class_Control_hint_tooltip: + - :ref:`String` **hint_tooltip** - Changes the tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments. -- :ref:`float` **margin_bottom** - Distance between the node's bottom edge and its parent container, based on member anchor_bottom. + + .. _class_Control_margin_bottom: + +- :ref:`float` **margin_bottom** - Distance between the node's bottom edge and its parent container, based on :ref:`anchor_bottom`. Margins are often controlled by one or multiple parent :ref:`Container` nodes. Margins update automatically when you move or resize the node. -- :ref:`float` **margin_left** - Distance between the node's left edge and its parent container, based on member anchor_left. -- :ref:`float` **margin_right** - Distance between the node's right edge and its parent container, based on member anchor_right. -- :ref:`float` **margin_top** - Distance between the node's top edge and its parent container, based on member anchor_top. + + .. _class_Control_margin_left: + +- :ref:`float` **margin_left** - Distance between the node's left edge and its parent container, based on :ref:`anchor_left`. + + .. _class_Control_margin_right: + +- :ref:`float` **margin_right** - Distance between the node's right edge and its parent container, based on :ref:`anchor_right`. + + .. _class_Control_margin_top: + +- :ref:`float` **margin_top** - Distance between the node's top edge and its parent container, based on :ref:`anchor_top`. + + .. _class_Control_mouse_filter: + - :ref:`int` **mouse_filter** + + .. _class_Control_rect_clip_content: + - :ref:`bool` **rect_clip_content** + + .. _class_Control_rect_min_size: + - :ref:`Vector2` **rect_min_size** - The minimum size of the node's bounding rectangle. If you set it to a value greater than (0, 0), the node's bounding rectangle will always have at least this size, even if its content is smaller. If it's set to (0, 0), the node sizes automatically to fit its content, be it a texture or child nodes. -- :ref:`Vector2` **rect_pivot_offset** - By default, the node's pivot is its top-left corner. When you change its member rect_scale, it will scale around this pivot. Set this property to member rect_size / 2 to center the pivot in the node's rectangle. -- :ref:`Vector2` **rect_position** - The node's position, relative to its parent. It corresponds to the rectangle's top-left corner. The property is not affected by member rect_pivot_offset. -- :ref:`float` **rect_rotation** - The node's rotation around its pivot, in degrees. See member rect_pivot_offset to change the pivot's position. -- :ref:`Vector2` **rect_scale** - The node's scale, relative to its member rect_size. Change this property to scale the node around its member rect_pivot_offset. + + .. _class_Control_rect_pivot_offset: + +- :ref:`Vector2` **rect_pivot_offset** - By default, the node's pivot is its top-left corner. When you change its :ref:`rect_scale`, it will scale around this pivot. Set this property to :ref:`rect_size` / 2 to center the pivot in the node's rectangle. + + .. _class_Control_rect_position: + +- :ref:`Vector2` **rect_position** - The node's position, relative to its parent. It corresponds to the rectangle's top-left corner. The property is not affected by :ref:`rect_pivot_offset`. + + .. _class_Control_rect_rotation: + +- :ref:`float` **rect_rotation** - The node's rotation around its pivot, in degrees. See :ref:`rect_pivot_offset` to change the pivot's position. + + .. _class_Control_rect_scale: + +- :ref:`Vector2` **rect_scale** - The node's scale, relative to its :ref:`rect_size`. Change this property to scale the node around its :ref:`rect_pivot_offset`. + + .. _class_Control_rect_size: + - :ref:`Vector2` **rect_size** - The size of the node's bounding rectangle, in pixels. :ref:`Container` nodes update this property automatically. + + .. _class_Control_size_flags_horizontal: + - :ref:`int` **size_flags_horizontal** - Tells the parent :ref:`Container` nodes how they should resize and place the node on the X axis. Use one of the ``SIZE\_\*`` constants to change the flags. See the constants to learn what each does. + + .. _class_Control_size_flags_stretch_ratio: + - :ref:`float` **size_flags_stretch_ratio** - If the node and at least one of its neighbours uses the ``SIZE_EXPAND`` size flag, the parent :ref:`Container` will let it take more or less space depending on this property. If this node has a stretch ratio of 2 and its neighbour a ratio of 1, this node will take two thirds of the available space. + + .. _class_Control_size_flags_vertical: + - :ref:`int` **size_flags_vertical** - Tells the parent :ref:`Container` nodes how they should resize and place the node on the Y axis. Use one of the ``SIZE\_\*`` constants to change the flags. See the constants to learn what each does. + + .. _class_Control_theme: + - :ref:`Theme` **theme** - Changing this property replaces the current :ref:`Theme` resource this node and all its ``Control`` children use. + Numeric Constants ----------------- -- **FOCUS_NONE** = **0** --- The node cannot grab focus. Use with member set_focus_mode. -- **FOCUS_CLICK** = **1** --- The node can only grab focus on mouse clicks. Use with member set_focus_mode. -- **FOCUS_ALL** = **2** --- The node can grab focus on mouse click or using the arrows and the Tab keys on the keyboard. Use with member set_focus_mode. -- **NOTIFICATION_RESIZED** = **40** --- Sent when the node changes size. Use member rect_size to get the new size. +- **FOCUS_NONE** = **0** --- The node cannot grab focus. Use with :ref:`set_focus_mode`. +- **FOCUS_CLICK** = **1** --- The node can only grab focus on mouse clicks. Use with :ref:`set_focus_mode`. +- **FOCUS_ALL** = **2** --- The node can grab focus on mouse click or using the arrows and the Tab keys on the keyboard. Use with :ref:`set_focus_mode`. +- **NOTIFICATION_RESIZED** = **40** --- Sent when the node changes size. Use :ref:`rect_size` to get the new size. - **NOTIFICATION_MOUSE_ENTER** = **41** --- Sent when the mouse pointer enters the node's ``Rect`` area. - **NOTIFICATION_MOUSE_EXIT** = **42** --- Sent when the mouse pointer exits the node's ``Rect`` area. - **NOTIFICATION_FOCUS_ENTER** = **43** --- Sent when the node grabs focus. - **NOTIFICATION_FOCUS_EXIT** = **44** --- Sent when the node loses focus. -- **NOTIFICATION_THEME_CHANGED** = **45** --- Sent when the node's member theme changes, right before Godot redraws the ``Control``. Happens when you call one of the ``add\_\*_override`` -- **NOTIFICATION_MODAL_CLOSE** = **46** --- Sent when an open modal dialog closes. See member show_modal. +- **NOTIFICATION_THEME_CHANGED** = **45** --- Sent when the node's :ref:`theme` changes, right before Godot redraws the ``Control``. Happens when you call one of the ``add\_\*_override`` +- **NOTIFICATION_MODAL_CLOSE** = **46** --- Sent when an open modal dialog closes. See :ref:`show_modal`. - **CURSOR_ARROW** = **0** --- Show the system's arrow mouse cursor when the user hovers the node. Use with :ref:`set_default_cursor_shape`. - **CURSOR_IBEAM** = **1** --- Show the system's I-beam mouse cursor when the user hovers the node. The I-beam pointer has a shape similar to "I". It tells the user they can highlight or insert text. - **CURSOR_POINTING_HAND** = **2** --- Show the system's pointing hand mouse cursor when the user hovers the node. @@ -344,18 +443,18 @@ Numeric Constants - **PRESET_MODE_KEEP_HEIGHT** = **2** - **PRESET_MODE_KEEP_WIDTH** = **1** - **PRESET_MODE_KEEP_SIZE** = **3** -- **SIZE_EXPAND** = **2** --- Tells the parent :ref:`Container` to let this node take all the available space on the axis you flag. If multiple neighboring nodes are set to expand, they'll share the space based on their stretch ratio. See member size_flags_stretch_ratio. Use with member size_flags_horizontal and member size_flags_vertical. -- **SIZE_FILL** = **1** --- Tells the parent :ref:`Container` to expand the bounds of this node to fill all the available space without pushing any other node. Use with member size_flags_horizontal and member size_flags_vertical. +- **SIZE_EXPAND** = **2** --- Tells the parent :ref:`Container` to let this node take all the available space on the axis you flag. If multiple neighboring nodes are set to expand, they'll share the space based on their stretch ratio. See :ref:`size_flags_stretch_ratio`. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. +- **SIZE_FILL** = **1** --- Tells the parent :ref:`Container` to expand the bounds of this node to fill all the available space without pushing any other node. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. - **SIZE_EXPAND_FILL** = **3** --- Sets the node's size flags to both fill and expand. See the 2 constants above for more information. -- **SIZE_SHRINK_CENTER** = **4** --- Tells the parent :ref:`Container` to center the node in itself. It centers the ``Control`` based on its bounding box, so it doesn't work with the fill or expand size flags. Use with member size_flags_horizontal and member size_flags_vertical. -- **SIZE_SHRINK_END** = **8** --- Tells the parent :ref:`Container` to align the node with its end, either the bottom or the right edge. It doesn't work with the fill or expand size flags. Use with member size_flags_horizontal and member size_flags_vertical. +- **SIZE_SHRINK_CENTER** = **4** --- Tells the parent :ref:`Container` to center the node in itself. It centers the ``Control`` based on its bounding box, so it doesn't work with the fill or expand size flags. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. +- **SIZE_SHRINK_END** = **8** --- Tells the parent :ref:`Container` to align the node with its end, either the bottom or the right edge. It doesn't work with the fill or expand size flags. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. - **MOUSE_FILTER_STOP** = **0** - **MOUSE_FILTER_PASS** = **1** - **MOUSE_FILTER_IGNORE** = **2** - **GROW_DIRECTION_BEGIN** = **0** - **GROW_DIRECTION_END** = **1** -- **ANCHOR_BEGIN** = **0** --- Snaps one of the 4 anchor's sides to the origin of the node's ``Rect``, in the top left. Use it with one of the ``anchor\_\*`` member variables, like member anchor_left. To change all 4 anchors at once, use :ref:`set_anchors_preset`. -- **ANCHOR_END** = **1** --- Snaps one of the 4 anchor's sides to the end of the node's ``Rect``, in the bottom right. Use it with one of the ``anchor\_\*`` member variables, like member anchor_left. To change all 4 anchors at once, use :ref:`set_anchors_preset`. +- **ANCHOR_BEGIN** = **0** --- Snaps one of the 4 anchor's sides to the origin of the node's ``Rect``, in the top left. Use it with one of the ``anchor\_\*`` member variables, like :ref:`anchor_left`. To change all 4 anchors at once, use :ref:`set_anchors_preset`. +- **ANCHOR_END** = **1** --- Snaps one of the 4 anchor's sides to the end of the node's ``Rect``, in the bottom right. Use it with one of the ``anchor\_\*`` member variables, like :ref:`anchor_left`. To change all 4 anchors at once, use :ref:`set_anchors_preset`. Description ----------- diff --git a/classes/class_convexpolygonshape.rst b/classes/class_convexpolygonshape.rst index 6275a8e35..083d4cb22 100644 --- a/classes/class_convexpolygonshape.rst +++ b/classes/class_convexpolygonshape.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_ConvexPolygonShape_points: + - :ref:`PoolVector3Array` **points** - The list of 3D points forming the convex polygon shape. + Description ----------- diff --git a/classes/class_convexpolygonshape2d.rst b/classes/class_convexpolygonshape2d.rst index abf8fa8b6..3e3fed155 100644 --- a/classes/class_convexpolygonshape2d.rst +++ b/classes/class_convexpolygonshape2d.rst @@ -30,8 +30,11 @@ Member Functions Member Variables ---------------- + .. _class_ConvexPolygonShape2D_points: + - :ref:`PoolVector2Array` **points** - The polygon's list of vertices. Can be in either clockwise or counterclockwise order. + Description ----------- diff --git a/classes/class_cubemesh.rst b/classes/class_cubemesh.rst index dcf450a6f..07461d2ff 100644 --- a/classes/class_cubemesh.rst +++ b/classes/class_cubemesh.rst @@ -40,11 +40,23 @@ Member Functions Member Variables ---------------- + .. _class_CubeMesh_size: + - :ref:`Vector3` **size** - Size of the cuboid mesh. Defaults to (2, 2, 2). + + .. _class_CubeMesh_subdivide_depth: + - :ref:`int` **subdivide_depth** - Number of extra edge loops inserted along the z-axis. Defaults to 0. + + .. _class_CubeMesh_subdivide_height: + - :ref:`int` **subdivide_height** - Number of extra edge loops inserted along the y-axis. Defaults to 0. + + .. _class_CubeMesh_subdivide_width: + - :ref:`int` **subdivide_width** - Number of extra edge loops inserted along the x-axis. Defaults to 0. + Description ----------- diff --git a/classes/class_curve.rst b/classes/class_curve.rst index d24c3dfbe..15a33b51f 100644 --- a/classes/class_curve.rst +++ b/classes/class_curve.rst @@ -72,17 +72,31 @@ Member Functions Signals ------- +.. _class_Curve_range_changed: + - **range_changed** **(** **)** Member Variables ---------------- + .. _class_Curve__data: + - :ref:`Array` **_data** + + .. _class_Curve_bake_resolution: + - :ref:`int` **bake_resolution** + + .. _class_Curve_max_value: + - :ref:`float` **max_value** + + .. _class_Curve_min_value: + - :ref:`float` **min_value** + Numeric Constants ----------------- diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index d9bed5b06..a91d728c9 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -60,9 +60,15 @@ Member Functions Member Variables ---------------- + .. _class_Curve2D__data: + - :ref:`Dictionary` **_data** + + .. _class_Curve2D_bake_interval: + - :ref:`float` **bake_interval** + Description ----------- diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index 3be8d672e..59954acf5 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -66,9 +66,15 @@ Member Functions Member Variables ---------------- + .. _class_Curve3D__data: + - :ref:`Dictionary` **_data** + + .. _class_Curve3D_bake_interval: + - :ref:`float` **bake_interval** + Description ----------- diff --git a/classes/class_curvetexture.rst b/classes/class_curvetexture.rst index 7fd1faaf1..e2c901d4a 100644 --- a/classes/class_curvetexture.rst +++ b/classes/class_curvetexture.rst @@ -30,9 +30,15 @@ Member Functions Member Variables ---------------- + .. _class_CurveTexture_curve: + - :ref:`Curve` **curve** + + .. _class_CurveTexture_width: + - :ref:`int` **width** + Member Function Description --------------------------- diff --git a/classes/class_cylindermesh.rst b/classes/class_cylindermesh.rst index a37362cf0..58143634c 100644 --- a/classes/class_cylindermesh.rst +++ b/classes/class_cylindermesh.rst @@ -44,12 +44,27 @@ Member Functions Member Variables ---------------- + .. _class_CylinderMesh_bottom_radius: + - :ref:`float` **bottom_radius** - Bottom radius of the cylinder. Defaults to 1.0. + + .. _class_CylinderMesh_height: + - :ref:`float` **height** - Full height of the cylinder. Defaults to 2.0. + + .. _class_CylinderMesh_radial_segments: + - :ref:`int` **radial_segments** - Number of radial segments on the cylinder. Defaults to 64. + + .. _class_CylinderMesh_rings: + - :ref:`int` **rings** - Number of edge rings along the height of the cylinder. Defaults to 4. + + .. _class_CylinderMesh_top_radius: + - :ref:`float` **top_radius** - Top radius of the cylinder. Defaults to 1.0. + Description ----------- diff --git a/classes/class_dampedspringjoint2d.rst b/classes/class_dampedspringjoint2d.rst index 7548d4a84..bf5ea0c85 100644 --- a/classes/class_dampedspringjoint2d.rst +++ b/classes/class_dampedspringjoint2d.rst @@ -40,11 +40,23 @@ Member Functions Member Variables ---------------- + .. _class_DampedSpringJoint2D_damping: + - :ref:`float` **damping** + + .. _class_DampedSpringJoint2D_length: + - :ref:`float` **length** + + .. _class_DampedSpringJoint2D_rest_length: + - :ref:`float` **rest_length** + + .. _class_DampedSpringJoint2D_stiffness: + - :ref:`float` **stiffness** + Description ----------- diff --git a/classes/class_directionallight.rst b/classes/class_directionallight.rst index 1a34f1bdc..5851deee8 100644 --- a/classes/class_directionallight.rst +++ b/classes/class_directionallight.rst @@ -36,16 +36,43 @@ Member Functions Member Variables ---------------- + .. _class_DirectionalLight_directional_shadow_bias_split_scale: + - :ref:`float` **directional_shadow_bias_split_scale** + + .. _class_DirectionalLight_directional_shadow_blend_splits: + - :ref:`bool` **directional_shadow_blend_splits** + + .. _class_DirectionalLight_directional_shadow_depth_range: + - :ref:`int` **directional_shadow_depth_range** + + .. _class_DirectionalLight_directional_shadow_max_distance: + - :ref:`float` **directional_shadow_max_distance** + + .. _class_DirectionalLight_directional_shadow_mode: + - :ref:`int` **directional_shadow_mode** + + .. _class_DirectionalLight_directional_shadow_normal_bias: + - :ref:`float` **directional_shadow_normal_bias** + + .. _class_DirectionalLight_directional_shadow_split_1: + - :ref:`float` **directional_shadow_split_1** + + .. _class_DirectionalLight_directional_shadow_split_2: + - :ref:`float` **directional_shadow_split_2** + + .. _class_DirectionalLight_directional_shadow_split_3: + - :ref:`float` **directional_shadow_split_3** + Numeric Constants ----------------- diff --git a/classes/class_dynamicfont.rst b/classes/class_dynamicfont.rst index 9f8530229..37a74cdc0 100644 --- a/classes/class_dynamicfont.rst +++ b/classes/class_dynamicfont.rst @@ -54,15 +54,39 @@ Member Functions Member Variables ---------------- + .. _class_DynamicFont_extra_spacing_bottom: + - :ref:`int` **extra_spacing_bottom** - Extra spacing at the bottom in pixels. + + .. _class_DynamicFont_extra_spacing_char: + - :ref:`int` **extra_spacing_char** - Extra character spacing in pixels. + + .. _class_DynamicFont_extra_spacing_space: + - :ref:`int` **extra_spacing_space** - Extra space spacing in pixels. + + .. _class_DynamicFont_extra_spacing_top: + - :ref:`int` **extra_spacing_top** - Extra spacing at the top in pixels. + + .. _class_DynamicFont_font_data: + - :ref:`DynamicFontData` **font_data** - The font data. + + .. _class_DynamicFont_size: + - :ref:`int` **size** - The font size. + + .. _class_DynamicFont_use_filter: + - :ref:`bool` **use_filter** - If ``true`` filtering is used. + + .. _class_DynamicFont_use_mipmaps: + - :ref:`bool` **use_mipmaps** - If ``true`` mipmapping is used. + Numeric Constants ----------------- diff --git a/classes/class_dynamicfontdata.rst b/classes/class_dynamicfontdata.rst index f44690a35..eab0a5518 100644 --- a/classes/class_dynamicfontdata.rst +++ b/classes/class_dynamicfontdata.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_DynamicFontData_font_path: + - :ref:`String` **font_path** - The path to the vector font file. + Description ----------- diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index a20ef8659..f0fcc818c 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -64,10 +64,16 @@ Member Functions Signals ------- +.. _class_EditorFileDialog_dir_selected: + - **dir_selected** **(** :ref:`String` dir **)** +.. _class_EditorFileDialog_file_selected: + - **file_selected** **(** :ref:`String` path **)** +.. _class_EditorFileDialog_files_selected: + - **files_selected** **(** :ref:`PoolStringArray` paths **)** diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst index efaf1b86e..d0a794cb2 100644 --- a/classes/class_editorfilesystem.rst +++ b/classes/class_editorfilesystem.rst @@ -40,12 +40,18 @@ Member Functions Signals ------- +.. _class_EditorFileSystem_filesystem_changed: + - **filesystem_changed** **(** **)** Emitted if the filesystem changed. +.. _class_EditorFileSystem_resources_reimported: + - **resources_reimported** **(** :ref:`PoolStringArray` resources **)** +.. _class_EditorFileSystem_sources_changed: + - **sources_changed** **(** :ref:`bool` exist **)** Emitted if the source of any imported file changed. diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index f3472f18d..c34b08ee3 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -96,14 +96,20 @@ Member Functions Signals ------- +.. _class_EditorPlugin_main_screen_changed: + - **main_screen_changed** **(** :ref:`String` screen_name **)** Emitted when user change main screen view (2D, 3D, Script, AssetLib). Works also with screens which are defined by plugins. +.. _class_EditorPlugin_scene_changed: + - **scene_changed** **(** :ref:`Object` scene_root **)** Emitted when user change scene. The argument is a root node of freshly opened scene. +.. _class_EditorPlugin_scene_closed: + - **scene_closed** **(** :ref:`String` filepath **)** Emitted when user close scene. The argument is file path to a closed scene. diff --git a/classes/class_editorresourcepreview.rst b/classes/class_editorresourcepreview.rst index 8a2d0a77d..abb3d5ac4 100644 --- a/classes/class_editorresourcepreview.rst +++ b/classes/class_editorresourcepreview.rst @@ -34,6 +34,8 @@ Member Functions Signals ------- +.. _class_EditorResourcePreview_preview_invalidated: + - **preview_invalidated** **(** :ref:`String` path **)** If a preview was invalidated (changed) this signal will emit (using the path of the preview) diff --git a/classes/class_editorselection.rst b/classes/class_editorselection.rst index 26dd199be..d05f483d0 100644 --- a/classes/class_editorselection.rst +++ b/classes/class_editorselection.rst @@ -34,6 +34,8 @@ Member Functions Signals ------- +.. _class_EditorSelection_selection_changed: + - **selection_changed** **(** **)** Emitted when the selection changes. diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index abd66d770..66d2e0501 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -52,6 +52,8 @@ Member Functions Signals ------- +.. _class_EditorSettings_settings_changed: + - **settings_changed** **(** **)** diff --git a/classes/class_environment.rst b/classes/class_environment.rst index a1662bd04..92a944fe3 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -300,82 +300,307 @@ Member Functions Member Variables ---------------- + .. _class_Environment_adjustment_brightness: + - :ref:`float` **adjustment_brightness** - Global brightness value of the rendered scene (default value is 1). + + .. _class_Environment_adjustment_color_correction: + - :ref:`Texture` **adjustment_color_correction** - Applies the provided :ref:`Texture` resource to affect the global color aspect of the rendered scene. + + .. _class_Environment_adjustment_contrast: + - :ref:`float` **adjustment_contrast** - Global contrast value of the rendered scene (default value is 1). + + .. _class_Environment_adjustment_enabled: + - :ref:`bool` **adjustment_enabled** - Enables the adjustment\_\* options provided by this resource. If false, adjustments modifications will have no effect on the rendered scene. + + .. _class_Environment_adjustment_saturation: + - :ref:`float` **adjustment_saturation** - Global color saturation value of the rendered scene (default value is 1). + + .. _class_Environment_ambient_light_color: + - :ref:`Color` **ambient_light_color** - :ref:`Color` of the ambient light. + + .. _class_Environment_ambient_light_energy: + - :ref:`float` **ambient_light_energy** - Energy of the ambient light. The higher the value, the stronger the light. + + .. _class_Environment_ambient_light_sky_contribution: + - :ref:`float` **ambient_light_sky_contribution** - Defines the amount of light that the sky brings on the scene. A value of 0 means that the sky's light emission has no effect on the scene illumination, thus all ambient illumination is provided by the ambient light. On the contrary, a value of 1 means that all the light that affects the scene is provided by the sky, thus the ambient light parameter has no effect on the scene. + + .. _class_Environment_auto_exposure_enabled: + - :ref:`bool` **auto_exposure_enabled** - Enables the tonemapping auto exposure mode of the scene renderer. If activated, the renderer will automatically determine the exposure setting to adapt to the illumination of the scene and the observed light. + + .. _class_Environment_auto_exposure_max_luma: + - :ref:`float` **auto_exposure_max_luma** - Maximum luminance value for the auto exposure. + + .. _class_Environment_auto_exposure_min_luma: + - :ref:`float` **auto_exposure_min_luma** - Minimum luminance value for the auto exposure. + + .. _class_Environment_auto_exposure_scale: + - :ref:`float` **auto_exposure_scale** - Scale of the auto exposure effect. Affects the intensity of auto exposure. + + .. _class_Environment_auto_exposure_speed: + - :ref:`float` **auto_exposure_speed** - Speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure. + + .. _class_Environment_background_canvas_max_layer: + - :ref:`int` **background_canvas_max_layer** - Maximum layer id (if using Layer background mode). + + .. _class_Environment_background_color: + - :ref:`Color` **background_color** - Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes). + + .. _class_Environment_background_energy: + - :ref:`float` **background_energy** - Power of light emitted by the background. + + .. _class_Environment_background_mode: + - :ref:`int` **background_mode** - Defines the mode of background. + + .. _class_Environment_background_sky: + - :ref:`Sky` **background_sky** - :ref:`Sky` resource defined as background. + + .. _class_Environment_background_sky_custom_fov: + - :ref:`float` **background_sky_custom_fov** - :ref:`Sky` resource's custom field of view. + + .. _class_Environment_dof_blur_far_amount: + - :ref:`float` **dof_blur_far_amount** - Amount of far blur. + + .. _class_Environment_dof_blur_far_distance: + - :ref:`float` **dof_blur_far_distance** - Distance from the camera where the far blur effect affects the rendering. + + .. _class_Environment_dof_blur_far_enabled: + - :ref:`bool` **dof_blur_far_enabled** - Enables the far blur effect. + + .. _class_Environment_dof_blur_far_quality: + - :ref:`int` **dof_blur_far_quality** - Quality of the far blur quality. + + .. _class_Environment_dof_blur_far_transition: + - :ref:`float` **dof_blur_far_transition** - Transition between no-blur area and far blur. + + .. _class_Environment_dof_blur_near_amount: + - :ref:`float` **dof_blur_near_amount** - Amount of near blur. + + .. _class_Environment_dof_blur_near_distance: + - :ref:`float` **dof_blur_near_distance** - Distance from the camera where the near blur effect affects the rendering. + + .. _class_Environment_dof_blur_near_enabled: + - :ref:`bool` **dof_blur_near_enabled** - Enables the near blur effect. + + .. _class_Environment_dof_blur_near_quality: + - :ref:`int` **dof_blur_near_quality** - Quality of the near blur quality. + + .. _class_Environment_dof_blur_near_transition: + - :ref:`float` **dof_blur_near_transition** - Transition between near blur and no-blur area. + + .. _class_Environment_fog_color: + - :ref:`Color` **fog_color** - Fog's :ref:`Color`. + + .. _class_Environment_fog_depth_begin: + - :ref:`float` **fog_depth_begin** - Fog's depth starting distance from the camera. + + .. _class_Environment_fog_depth_curve: + - :ref:`float` **fog_depth_curve** - Value defining the fog depth intensity. + + .. _class_Environment_fog_depth_enabled: + - :ref:`bool` **fog_depth_enabled** - Enables the fog depth. + + .. _class_Environment_fog_enabled: + - :ref:`bool` **fog_enabled** - Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually display fog. + + .. _class_Environment_fog_height_curve: + - :ref:`float` **fog_height_curve** - Value defining the fog height intensity. + + .. _class_Environment_fog_height_enabled: + - :ref:`bool` **fog_height_enabled** - Enables the fog height. + + .. _class_Environment_fog_height_max: + - :ref:`float` **fog_height_max** - Maximum height of fog. + + .. _class_Environment_fog_height_min: + - :ref:`float` **fog_height_min** - Minimum height of fog. + + .. _class_Environment_fog_sun_amount: + - :ref:`float` **fog_sun_amount** - Amount of sun that affects the fog rendering. + + .. _class_Environment_fog_sun_color: + - :ref:`Color` **fog_sun_color** - Sun :ref:`Color`. + + .. _class_Environment_fog_transmit_curve: + - :ref:`float` **fog_transmit_curve** - Amount of light that the fog transmits. + + .. _class_Environment_fog_transmit_enabled: + - :ref:`bool` **fog_transmit_enabled** - Enables fog's light transmission. If enabled, lets reflections light to be transmitted by the fog. + + .. _class_Environment_glow_bicubic_upscale: + - :ref:`bool` **glow_bicubic_upscale** + + .. _class_Environment_glow_blend_mode: + - :ref:`int` **glow_blend_mode** - Glow blending mode. + + .. _class_Environment_glow_bloom: + - :ref:`float` **glow_bloom** - Bloom value (global glow). + + .. _class_Environment_glow_enabled: + - :ref:`bool` **glow_enabled** - Enables glow rendering. + + .. _class_Environment_glow_hdr_scale: + - :ref:`float` **glow_hdr_scale** - Bleed scale of the HDR glow. + + .. _class_Environment_glow_hdr_threshold: + - :ref:`float` **glow_hdr_threshold** - Bleed threshold of the HDR glow. + + .. _class_Environment_glow_intensity: + - :ref:`float` **glow_intensity** - Glow intensity. + + .. _class_Environment_glow_levels/1: + - :ref:`bool` **glow_levels/1** - First level of glow (most local). + + .. _class_Environment_glow_levels/2: + - :ref:`bool` **glow_levels/2** - Second level of glow. + + .. _class_Environment_glow_levels/3: + - :ref:`bool` **glow_levels/3** - Third level of glow. + + .. _class_Environment_glow_levels/4: + - :ref:`bool` **glow_levels/4** - Fourth level of glow. + + .. _class_Environment_glow_levels/5: + - :ref:`bool` **glow_levels/5** - Fifth level of glow. + + .. _class_Environment_glow_levels/6: + - :ref:`bool` **glow_levels/6** - Sixth level of glow. + + .. _class_Environment_glow_levels/7: + - :ref:`bool` **glow_levels/7** - Seventh level of glow (most global). + + .. _class_Environment_glow_strength: + - :ref:`float` **glow_strength** - Glow strength. + + .. _class_Environment_ss_reflections_depth_tolerance: + - :ref:`float` **ss_reflections_depth_tolerance** + + .. _class_Environment_ss_reflections_enabled: + - :ref:`bool` **ss_reflections_enabled** + + .. _class_Environment_ss_reflections_fade_in: + - :ref:`float` **ss_reflections_fade_in** + + .. _class_Environment_ss_reflections_fade_out: + - :ref:`float` **ss_reflections_fade_out** + + .. _class_Environment_ss_reflections_max_steps: + - :ref:`int` **ss_reflections_max_steps** + + .. _class_Environment_ss_reflections_roughness: + - :ref:`bool` **ss_reflections_roughness** + + .. _class_Environment_ssao_bias: + - :ref:`float` **ssao_bias** + + .. _class_Environment_ssao_blur: + - :ref:`bool` **ssao_blur** + + .. _class_Environment_ssao_color: + - :ref:`Color` **ssao_color** + + .. _class_Environment_ssao_enabled: + - :ref:`bool` **ssao_enabled** + + .. _class_Environment_ssao_intensity: + - :ref:`float` **ssao_intensity** + + .. _class_Environment_ssao_intensity2: + - :ref:`float` **ssao_intensity2** + + .. _class_Environment_ssao_light_affect: + - :ref:`float` **ssao_light_affect** + + .. _class_Environment_ssao_radius: + - :ref:`float` **ssao_radius** + + .. _class_Environment_ssao_radius2: + - :ref:`float` **ssao_radius2** + + .. _class_Environment_tonemap_exposure: + - :ref:`float` **tonemap_exposure** - Default exposure for tonemap. + + .. _class_Environment_tonemap_mode: + - :ref:`int` **tonemap_mode** - Tonemapping mode. + + .. _class_Environment_tonemap_white: + - :ref:`float` **tonemap_white** - White reference value for tonemap. + Numeric Constants ----------------- diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index 9848d51b2..3c913d962 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -60,14 +60,20 @@ Member Functions Signals ------- +.. _class_FileDialog_dir_selected: + - **dir_selected** **(** :ref:`String` dir **)** Event emitted when the user selects a directory. +.. _class_FileDialog_file_selected: + - **file_selected** **(** :ref:`String` path **)** Event emitted when the user selects a file (double clicks it or presses the OK button). +.. _class_FileDialog_files_selected: + - **files_selected** **(** :ref:`PoolStringArray` paths **)** Event emitted when the user selects multiple files. @@ -76,11 +82,23 @@ Event emitted when the user selects multiple files. Member Variables ---------------- + .. _class_FileDialog_access: + - :ref:`int` **access** + + .. _class_FileDialog_filters: + - :ref:`PoolStringArray` **filters** + + .. _class_FileDialog_mode: + - :ref:`int` **mode** + + .. _class_FileDialog_show_hidden_files: + - :ref:`bool` **show_hidden_files** + Numeric Constants ----------------- diff --git a/classes/class_gdfunctionstate.rst b/classes/class_gdfunctionstate.rst index 965bc5353..f8b6e3a01 100644 --- a/classes/class_gdfunctionstate.rst +++ b/classes/class_gdfunctionstate.rst @@ -28,6 +28,8 @@ Member Functions Signals ------- +.. _class_GDFunctionState_completed: + - **completed** **(** :ref:`Nil` result **)** diff --git a/classes/class_gdnative.rst b/classes/class_gdnative.rst index 5869d56ee..17fa56b20 100644 --- a/classes/class_gdnative.rst +++ b/classes/class_gdnative.rst @@ -34,8 +34,11 @@ Member Functions Member Variables ---------------- + .. _class_GDNative_library: + - :ref:`GDNativeLibrary` **library** + Member Function Description --------------------------- diff --git a/classes/class_gdnativelibrary.rst b/classes/class_gdnativelibrary.rst index dc292183d..4517dc6a7 100644 --- a/classes/class_gdnativelibrary.rst +++ b/classes/class_gdnativelibrary.rst @@ -34,8 +34,11 @@ Member Functions Member Variables ---------------- + .. _class_GDNativeLibrary_singleton_gdnative: + - :ref:`bool` **singleton_gdnative** + Member Function Description --------------------------- diff --git a/classes/class_generic6dofjoint.rst b/classes/class_generic6dofjoint.rst index cc8e6fda7..a5059dc93 100644 --- a/classes/class_generic6dofjoint.rst +++ b/classes/class_generic6dofjoint.rst @@ -48,60 +48,213 @@ Member Functions Member Variables ---------------- + .. _class_Generic6DOFJoint_angular_limit_x/damping: + - :ref:`float` **angular_limit_x/damping** - The amount of rotational damping across the x-axis. The lower, the longer an impulse from one side takes to travel to the other side. + + .. _class_Generic6DOFJoint_angular_limit_x/enabled: + - :ref:`bool` **angular_limit_x/enabled** - If ``true`` rotation across the x-axis is enabled. + + .. _class_Generic6DOFJoint_angular_limit_x/erp: + - :ref:`float` **angular_limit_x/erp** - When rotating across x-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. + + .. _class_Generic6DOFJoint_angular_limit_x/force_limit: + - :ref:`float` **angular_limit_x/force_limit** - The maximum amount of force that can occur, when rotating arround x-axis. + + .. _class_Generic6DOFJoint_angular_limit_x/lower_angle: + - :ref:`float` **angular_limit_x/lower_angle** - The minimum rotation in negative direction to break loose and rotate arround the x-axis. + + .. _class_Generic6DOFJoint_angular_limit_x/restitution: + - :ref:`float` **angular_limit_x/restitution** - The amount of rotational restitution across the x-axis. The lower, the more restitution occurs. + + .. _class_Generic6DOFJoint_angular_limit_x/softness: + - :ref:`float` **angular_limit_x/softness** - The speed of all rotations across the x-axis. + + .. _class_Generic6DOFJoint_angular_limit_x/upper_angle: + - :ref:`float` **angular_limit_x/upper_angle** - The minimum rotation in positive direction to break loose and rotate arround the x-axis. + + .. _class_Generic6DOFJoint_angular_limit_y/damping: + - :ref:`float` **angular_limit_y/damping** - The amount of rotational damping across the y-axis. The lower, the more dampening occurs. + + .. _class_Generic6DOFJoint_angular_limit_y/enabled: + - :ref:`bool` **angular_limit_y/enabled** - If ``true`` rotation across the y-axis is enabled. + + .. _class_Generic6DOFJoint_angular_limit_y/erp: + - :ref:`float` **angular_limit_y/erp** - When rotating across y-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. + + .. _class_Generic6DOFJoint_angular_limit_y/force_limit: + - :ref:`float` **angular_limit_y/force_limit** - The maximum amount of force that can occur, when rotating arround y-axis. + + .. _class_Generic6DOFJoint_angular_limit_y/lower_angle: + - :ref:`float` **angular_limit_y/lower_angle** - The minimum rotation in negative direction to break loose and rotate arround the y-axis. + + .. _class_Generic6DOFJoint_angular_limit_y/restitution: + - :ref:`float` **angular_limit_y/restitution** - The amount of rotational restitution across the y-axis. The lower, the more restitution occurs. + + .. _class_Generic6DOFJoint_angular_limit_y/softness: + - :ref:`float` **angular_limit_y/softness** - The speed of all rotations across the y-axis. + + .. _class_Generic6DOFJoint_angular_limit_y/upper_angle: + - :ref:`float` **angular_limit_y/upper_angle** - The minimum rotation in positive direction to break loose and rotate arround the y-axis. + + .. _class_Generic6DOFJoint_angular_limit_z/damping: + - :ref:`float` **angular_limit_z/damping** - The amount of rotational damping across the z-axis. The lower, the more dampening occurs. + + .. _class_Generic6DOFJoint_angular_limit_z/enabled: + - :ref:`bool` **angular_limit_z/enabled** - If ``true`` rotation across the z-axis is enabled. + + .. _class_Generic6DOFJoint_angular_limit_z/erp: + - :ref:`float` **angular_limit_z/erp** - When rotating across z-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. + + .. _class_Generic6DOFJoint_angular_limit_z/force_limit: + - :ref:`float` **angular_limit_z/force_limit** - The maximum amount of force that can occur, when rotating arround z-axis. + + .. _class_Generic6DOFJoint_angular_limit_z/lower_angle: + - :ref:`float` **angular_limit_z/lower_angle** - The minimum rotation in negative direction to break loose and rotate arround the z-axis. + + .. _class_Generic6DOFJoint_angular_limit_z/restitution: + - :ref:`float` **angular_limit_z/restitution** - The amount of rotational restitution across the z-axis. The lower, the more restitution occurs. + + .. _class_Generic6DOFJoint_angular_limit_z/softness: + - :ref:`float` **angular_limit_z/softness** - The speed of all rotations across the z-axis. + + .. _class_Generic6DOFJoint_angular_limit_z/upper_angle: + - :ref:`float` **angular_limit_z/upper_angle** - The minimum rotation in positive direction to break loose and rotate arround the z-axis. + + .. _class_Generic6DOFJoint_angular_motor_x/enabled: + - :ref:`bool` **angular_motor_x/enabled** - If ``true`` a rotating motor at the x-axis is enabled. + + .. _class_Generic6DOFJoint_angular_motor_x/force_limit: + - :ref:`float` **angular_motor_x/force_limit** - Maximum acceleration for the motor at the x-axis. + + .. _class_Generic6DOFJoint_angular_motor_x/target_velocity: + - :ref:`float` **angular_motor_x/target_velocity** - Target speed for the motor at the x-axis. + + .. _class_Generic6DOFJoint_angular_motor_y/enabled: + - :ref:`bool` **angular_motor_y/enabled** - If ``true`` a rotating motor at the y-axis is enabled. + + .. _class_Generic6DOFJoint_angular_motor_y/force_limit: + - :ref:`float` **angular_motor_y/force_limit** - Maximum acceleration for the motor at the y-axis. + + .. _class_Generic6DOFJoint_angular_motor_y/target_velocity: + - :ref:`float` **angular_motor_y/target_velocity** - Target speed for the motor at the y-axis. + + .. _class_Generic6DOFJoint_angular_motor_z/enabled: + - :ref:`bool` **angular_motor_z/enabled** - If ``true`` a rotating motor at the z-axis is enabled. + + .. _class_Generic6DOFJoint_angular_motor_z/force_limit: + - :ref:`float` **angular_motor_z/force_limit** - Maximum acceleration for the motor at the z-axis. + + .. _class_Generic6DOFJoint_angular_motor_z/target_velocity: + - :ref:`float` **angular_motor_z/target_velocity** - Target speed for the motor at the z-axis. + + .. _class_Generic6DOFJoint_linear_limit_x/damping: + - :ref:`float` **linear_limit_x/damping** - The amount of damping that happens at the x-motion. + + .. _class_Generic6DOFJoint_linear_limit_x/enabled: + - :ref:`bool` **linear_limit_x/enabled** - If ``true`` the linear motion across the x-axis is enabled. + + .. _class_Generic6DOFJoint_linear_limit_x/lower_distance: + - :ref:`float` **linear_limit_x/lower_distance** - The minimum difference between the pivot points' x-axis. + + .. _class_Generic6DOFJoint_linear_limit_x/restitution: + - :ref:`float` **linear_limit_x/restitution** - The amount of restitution on the x-axis movement The lower, the more momentum gets lost. + + .. _class_Generic6DOFJoint_linear_limit_x/softness: + - :ref:`float` **linear_limit_x/softness** - A factor applied to the movement across the x-axis The lower, the slower the movement. + + .. _class_Generic6DOFJoint_linear_limit_x/upper_distance: + - :ref:`float` **linear_limit_x/upper_distance** - The maximum difference between the pivot points' x-axis. + + .. _class_Generic6DOFJoint_linear_limit_y/damping: + - :ref:`float` **linear_limit_y/damping** - The amount of damping that happens at the y-motion. + + .. _class_Generic6DOFJoint_linear_limit_y/enabled: + - :ref:`bool` **linear_limit_y/enabled** - If ``true`` the linear motion across the y-axis is enabled. + + .. _class_Generic6DOFJoint_linear_limit_y/lower_distance: + - :ref:`float` **linear_limit_y/lower_distance** - The minimum difference between the pivot points' y-axis. + + .. _class_Generic6DOFJoint_linear_limit_y/restitution: + - :ref:`float` **linear_limit_y/restitution** - The amount of restitution on the y-axis movement The lower, the more momentum gets lost. + + .. _class_Generic6DOFJoint_linear_limit_y/softness: + - :ref:`float` **linear_limit_y/softness** - A factor applied to the movement across the y-axis The lower, the slower the movement. + + .. _class_Generic6DOFJoint_linear_limit_y/upper_distance: + - :ref:`float` **linear_limit_y/upper_distance** - The maximum difference between the pivot points' y-axis. + + .. _class_Generic6DOFJoint_linear_limit_z/damping: + - :ref:`float` **linear_limit_z/damping** - The amount of damping that happens at the z-motion. + + .. _class_Generic6DOFJoint_linear_limit_z/enabled: + - :ref:`bool` **linear_limit_z/enabled** - If ``true`` the linear motion across the z-axis is enabled. + + .. _class_Generic6DOFJoint_linear_limit_z/lower_distance: + - :ref:`float` **linear_limit_z/lower_distance** - The minimum difference between the pivot points' z-axis. + + .. _class_Generic6DOFJoint_linear_limit_z/restitution: + - :ref:`float` **linear_limit_z/restitution** - The amount of restitution on the z-axis movement The lower, the more momentum gets lost. + + .. _class_Generic6DOFJoint_linear_limit_z/softness: + - :ref:`float` **linear_limit_z/softness** - A factor applied to the movement across the z-axis The lower, the slower the movement. + + .. _class_Generic6DOFJoint_linear_limit_z/upper_distance: + - :ref:`float` **linear_limit_z/upper_distance** - The maximum difference between the pivot points' z-axis. + Numeric Constants ----------------- diff --git a/classes/class_geometryinstance.rst b/classes/class_geometryinstance.rst index c8e104577..d74a19d5b 100644 --- a/classes/class_geometryinstance.rst +++ b/classes/class_geometryinstance.rst @@ -58,15 +58,39 @@ Member Functions Member Variables ---------------- + .. _class_GeometryInstance_cast_shadow: + - :ref:`int` **cast_shadow** + + .. _class_GeometryInstance_extra_cull_margin: + - :ref:`float` **extra_cull_margin** + + .. _class_GeometryInstance_lod_max_distance: + - :ref:`float` **lod_max_distance** + + .. _class_GeometryInstance_lod_max_hysteresis: + - :ref:`float` **lod_max_hysteresis** + + .. _class_GeometryInstance_lod_min_distance: + - :ref:`float` **lod_min_distance** + + .. _class_GeometryInstance_lod_min_hysteresis: + - :ref:`float` **lod_min_hysteresis** + + .. _class_GeometryInstance_material_override: + - :ref:`Material` **material_override** + + .. _class_GeometryInstance_use_in_baked_light: + - :ref:`bool` **use_in_baked_light** + Numeric Constants ----------------- diff --git a/classes/class_giprobe.rst b/classes/class_giprobe.rst index 3f48a9d69..8abe926aa 100644 --- a/classes/class_giprobe.rst +++ b/classes/class_giprobe.rst @@ -68,17 +68,47 @@ Member Functions Member Variables ---------------- + .. _class_GIProbe_bias: + - :ref:`float` **bias** + + .. _class_GIProbe_compress: + - :ref:`bool` **compress** + + .. _class_GIProbe_data: + - :ref:`GIProbeData` **data** + + .. _class_GIProbe_dynamic_range: + - :ref:`int` **dynamic_range** + + .. _class_GIProbe_energy: + - :ref:`float` **energy** + + .. _class_GIProbe_extents: + - :ref:`Vector3` **extents** + + .. _class_GIProbe_interior: + - :ref:`bool` **interior** + + .. _class_GIProbe_normal_bias: + - :ref:`float` **normal_bias** + + .. _class_GIProbe_propagation: + - :ref:`float` **propagation** + + .. _class_GIProbe_subdiv: + - :ref:`int` **subdiv** + Numeric Constants ----------------- diff --git a/classes/class_giprobedata.rst b/classes/class_giprobedata.rst index f5bf1191e..4759dba95 100644 --- a/classes/class_giprobedata.rst +++ b/classes/class_giprobedata.rst @@ -68,18 +68,51 @@ Member Functions Member Variables ---------------- + .. _class_GIProbeData_bias: + - :ref:`float` **bias** + + .. _class_GIProbeData_bounds: + - :ref:`Rect3` **bounds** + + .. _class_GIProbeData_cell_size: + - :ref:`float` **cell_size** + + .. _class_GIProbeData_compress: + - :ref:`bool` **compress** + + .. _class_GIProbeData_dynamic_data: + - :ref:`PoolIntArray` **dynamic_data** + + .. _class_GIProbeData_dynamic_range: + - :ref:`int` **dynamic_range** + + .. _class_GIProbeData_energy: + - :ref:`float` **energy** + + .. _class_GIProbeData_interior: + - :ref:`bool` **interior** + + .. _class_GIProbeData_normal_bias: + - :ref:`float` **normal_bias** + + .. _class_GIProbeData_propagation: + - :ref:`float` **propagation** + + .. _class_GIProbeData_to_cell_xform: + - :ref:`Transform` **to_cell_xform** + Member Function Description --------------------------- diff --git a/classes/class_gradient.rst b/classes/class_gradient.rst index ba916ef94..8a47f0efb 100644 --- a/classes/class_gradient.rst +++ b/classes/class_gradient.rst @@ -48,9 +48,15 @@ Member Functions Member Variables ---------------- + .. _class_Gradient_colors: + - :ref:`PoolColorArray` **colors** - Gradient's colors returned as a :ref:`PoolColorArray`. + + .. _class_Gradient_offsets: + - :ref:`PoolRealArray` **offsets** - Gradient's offsets returned as a :ref:`PoolRealArray`. + Description ----------- diff --git a/classes/class_gradienttexture.rst b/classes/class_gradienttexture.rst index 3e0ecfac8..76cf84095 100644 --- a/classes/class_gradienttexture.rst +++ b/classes/class_gradienttexture.rst @@ -30,9 +30,15 @@ Member Functions Member Variables ---------------- + .. _class_GradientTexture_gradient: + - :ref:`Gradient` **gradient** - The :ref:`Gradient` that will be used to fill the texture. + + .. _class_GradientTexture_width: + - :ref:`int` **width** - The number of color samples that will be obtained from the :ref:`Gradient`. + Description ----------- diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 17a1852e9..c4d4e91c8 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -54,38 +54,58 @@ Member Functions Signals ------- +.. _class_GraphEdit__begin_node_move: + - **_begin_node_move** **(** **)** Signal sent at the beginning of a GraphNode movement. +.. _class_GraphEdit__end_node_move: + - **_end_node_move** **(** **)** Signal sent at the end of a GraphNode movement. +.. _class_GraphEdit_connection_request: + - **connection_request** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`String` to, :ref:`int` to_slot **)** Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be created. +.. _class_GraphEdit_connection_to_empty: + - **connection_to_empty** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`Vector2` release_position **)** +.. _class_GraphEdit_delete_nodes_request: + - **delete_nodes_request** **(** **)** Signal sent when a GraphNode is attempted to be removed from the GraphEdit. +.. _class_GraphEdit_disconnection_request: + - **disconnection_request** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`String` to, :ref:`int` to_slot **)** Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be removed. +.. _class_GraphEdit_duplicate_nodes_request: + - **duplicate_nodes_request** **(** **)** Signal sent when a GraphNode is attempted to be duplicated in the GraphEdit. +.. _class_GraphEdit_node_selected: + - **node_selected** **(** :ref:`Object` node **)** +.. _class_GraphEdit_popup_request: + - **popup_request** **(** :ref:`Vector2` p_position **)** Signal sent when a popup is requested. Happens on right-clicking in the GraphEdit. 'p_position' is the position of the mouse pointer when the signal is sent. +.. _class_GraphEdit_scroll_offset_changed: + - **scroll_offset_changed** **(** :ref:`Vector2` ofs **)** diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index 66a6e4a90..a3036487b 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -86,32 +86,51 @@ Member Functions Signals ------- +.. _class_GraphNode_close_request: + - **close_request** **(** **)** Signal sent on closing the GraphNode. +.. _class_GraphNode_dragged: + - **dragged** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** Signal sent when the GraphNode is dragged. +.. _class_GraphNode_offset_changed: + - **offset_changed** **(** **)** Signal sent when the GraphNode is moved. +.. _class_GraphNode_raise_request: + - **raise_request** **(** **)** Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode. +.. _class_GraphNode_resize_request: + - **resize_request** **(** :ref:`Vector2` new_minsize **)** Member Variables ---------------- + .. _class_GraphNode_resizable: + - :ref:`bool` **resizable** + + .. _class_GraphNode_show_close: + - :ref:`bool` **show_close** + + .. _class_GraphNode_title: + - :ref:`String` **title** + Numeric Constants ----------------- diff --git a/classes/class_gridcontainer.rst b/classes/class_gridcontainer.rst index f6d00945c..bb4333ac1 100644 --- a/classes/class_gridcontainer.rst +++ b/classes/class_gridcontainer.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_GridContainer_columns: + - :ref:`int` **columns** - The number of columns in the ``GridContainer``. If modified, ``GridContainer`` reorders its children to accommodate the new layout. + Description ----------- diff --git a/classes/class_groovejoint2d.rst b/classes/class_groovejoint2d.rst index 10b312352..738a6dd90 100644 --- a/classes/class_groovejoint2d.rst +++ b/classes/class_groovejoint2d.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_GrooveJoint2D_initial_offset: + - :ref:`float` **initial_offset** + + .. _class_GrooveJoint2D_length: + - :ref:`float` **length** + Description ----------- diff --git a/classes/class_hingejoint.rst b/classes/class_hingejoint.rst index 61c5024d3..0eead23bb 100644 --- a/classes/class_hingejoint.rst +++ b/classes/class_hingejoint.rst @@ -32,30 +32,60 @@ Member Functions Member Variables ---------------- + .. _class_HingeJoint_angular_limit/bias: + - :ref:`float` **angular_limit/bias** - The speed with which the rotation across the axis perpendicular to the hinge gets corrected. -- :ref:`bool` **angular_limit/enable** - If ``true`` the hinges maximum and minimum rotation, defined by member angular_limit/lower and member angular_limit/upper has effects. -- :ref:`float` **angular_limit/lower** - The minimum rotation. only active if member angular_limit/enable is ``true``. + + .. _class_HingeJoint_angular_limit/enable: + +- :ref:`bool` **angular_limit/enable** - If ``true`` the hinges maximum and minimum rotation, defined by :ref:`angular_limit/lower` and :ref:`angular_limit/upper` has effects. + + .. _class_HingeJoint_angular_limit/lower: + +- :ref:`float` **angular_limit/lower** - The minimum rotation. only active if :ref:`angular_limit/enable` is ``true``. + + .. _class_HingeJoint_angular_limit/relaxation: + - :ref:`float` **angular_limit/relaxation** - The lower this value, the more the rotation gets slowed down. + + .. _class_HingeJoint_angular_limit/softness: + - :ref:`float` **angular_limit/softness** -- :ref:`float` **angular_limit/upper** - The maximum rotation. only active if member angular_limit/enable is ``true``. + + .. _class_HingeJoint_angular_limit/upper: + +- :ref:`float` **angular_limit/upper** - The maximum rotation. only active if :ref:`angular_limit/enable` is ``true``. + + .. _class_HingeJoint_motor/enable: + - :ref:`bool` **motor/enable** - When activated, a motor turns the hinge. + + .. _class_HingeJoint_motor/max_impulse: + - :ref:`float` **motor/max_impulse** - Maximum acceleration for the motor. + + .. _class_HingeJoint_motor/target_velocity: + - :ref:`float` **motor/target_velocity** - Target speed for the motor. + + .. _class_HingeJoint_params/bias: + - :ref:`float` **params/bias** - The speed with wich the two bodies get pulled together when they move in different directions. + Numeric Constants ----------------- - **PARAM_BIAS** = **0** --- The speed with wich the two bodies get pulled together when they move in different directions. -- **PARAM_LIMIT_UPPER** = **1** --- The maximum rotation. only active if member angular_limit/enable is ``true``. -- **PARAM_LIMIT_LOWER** = **2** --- The minimum rotation. only active if member angular_limit/enable is ``true``. +- **PARAM_LIMIT_UPPER** = **1** --- The maximum rotation. only active if :ref:`angular_limit/enable` is ``true``. +- **PARAM_LIMIT_LOWER** = **2** --- The minimum rotation. only active if :ref:`angular_limit/enable` is ``true``. - **PARAM_LIMIT_BIAS** = **3** --- The speed with which the rotation across the axis perpendicular to the hinge gets corrected. - **PARAM_LIMIT_SOFTNESS** = **4** - **PARAM_LIMIT_RELAXATION** = **5** --- The lower this value, the more the rotation gets slowed down. - **PARAM_MOTOR_TARGET_VELOCITY** = **6** --- Target speed for the motor. - **PARAM_MOTOR_MAX_IMPULSE** = **7** --- Maximum acceleration for the motor. - **PARAM_MAX** = **8** --- End flag of PARAM\_\* constants, used internally. -- **FLAG_USE_LIMIT** = **0** --- If ``true`` the hinges maximum and minimum rotation, defined by member angular_limit/lower and member angular_limit/upper has effects. +- **FLAG_USE_LIMIT** = **0** --- If ``true`` the hinges maximum and minimum rotation, defined by :ref:`angular_limit/lower` and :ref:`angular_limit/upper` has effects. - **FLAG_ENABLE_MOTOR** = **1** --- When activated, a motor turns the hinge. - **FLAG_MAX** = **2** --- End flag of FLAG\_\* constants, used internally. diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index 11a8b0962..3f17c55ba 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -50,6 +50,8 @@ Member Functions Signals ------- +.. _class_HTTPRequest_request_completed: + - **request_completed** **(** :ref:`int` result, :ref:`int` response_code, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** This signal is emitted upon request completion. @@ -58,10 +60,19 @@ This signal is emitted upon request completion. Member Variables ---------------- + .. _class_HTTPRequest_body_size_limit: + - :ref:`int` **body_size_limit** + + .. _class_HTTPRequest_max_redirects: + - :ref:`int` **max_redirects** + + .. _class_HTTPRequest_use_threads: + - :ref:`bool` **use_threads** + Numeric Constants ----------------- diff --git a/classes/class_image.rst b/classes/class_image.rst index 5726da67f..b6060acdd 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -110,8 +110,11 @@ Member Functions Member Variables ---------------- + .. _class_Image_data: + - :ref:`Dictionary` **data** + Numeric Constants ----------------- diff --git a/classes/class_input.rst b/classes/class_input.rst index b068910f6..dccb83c6d 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -96,6 +96,8 @@ Member Functions Signals ------- +.. _class_Input_joy_connection_changed: + - **joy_connection_changed** **(** :ref:`int` index, :ref:`bool` connected **)** Emitted when a joypad device has been connected or disconnected diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index c1a1ec378..cbb8dac76 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -54,8 +54,11 @@ Member Functions Member Variables ---------------- + .. _class_InputEvent_device: + - :ref:`int` **device** - The event's device ID. + Description ----------- diff --git a/classes/class_inputeventaction.rst b/classes/class_inputeventaction.rst index e509abf34..49064f3bb 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -30,9 +30,15 @@ Member Functions Member Variables ---------------- + .. _class_InputEventAction_action: + - :ref:`String` **action** - The action's name. Actions are accessed via this :ref:`String`. + + .. _class_InputEventAction_pressed: + - :ref:`bool` **pressed** - If ``true`` the action's state is pressed. If ``false`` the action's state is released. + Description ----------- diff --git a/classes/class_inputeventjoypadbutton.rst b/classes/class_inputeventjoypadbutton.rst index a72f6b9fa..994a2ca7d 100644 --- a/classes/class_inputeventjoypadbutton.rst +++ b/classes/class_inputeventjoypadbutton.rst @@ -34,10 +34,19 @@ Member Functions Member Variables ---------------- + .. _class_InputEventJoypadButton_button_index: + - :ref:`int` **button_index** - Button identifier. One of the ``JOY_BUTTON\_\*`` constants from @global Scope. + + .. _class_InputEventJoypadButton_pressed: + - :ref:`bool` **pressed** - If ``true`` the button's state is pressed. If ``false`` the button's state is released. + + .. _class_InputEventJoypadButton_pressure: + - :ref:`float` **pressure** - Represents the pressure the user puts on the button with his finger, if the controller supports it. Ranges from ``0`` to ``1``. + Description ----------- diff --git a/classes/class_inputeventjoypadmotion.rst b/classes/class_inputeventjoypadmotion.rst index 527dd94b7..c6c1a5ca5 100644 --- a/classes/class_inputeventjoypadmotion.rst +++ b/classes/class_inputeventjoypadmotion.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_InputEventJoypadMotion_axis: + - :ref:`int` **axis** - Axis identifier. Use one of the ``JOY_AXIS\_\*`` constants in @global Scope. + + .. _class_InputEventJoypadMotion_axis_value: + - :ref:`float` **axis_value** - Current position of the joystick on the given axis. The value ranges from ``-1.0`` to ``1.0``. A value of ``0`` means the axis is in its resting position. + Description ----------- diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index e2d7f6749..fdf29cab9 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -38,15 +38,27 @@ Member Functions Member Variables ---------------- + .. _class_InputEventKey_echo: + - :ref:`bool` **echo** - If ``true`` the key was already pressed before this event. It means the user is holding the key down. + + .. _class_InputEventKey_pressed: + - :ref:`bool` **pressed** - If ``true`` the key's state is pressed. If ``false`` the key's state is released. + + .. _class_InputEventKey_scancode: + - :ref:`int` **scancode** - Key scancode, one of the ``KEY\_\*`` constants in @global Scope. + + .. _class_InputEventKey_unicode: + - :ref:`int` **unicode** - Key unicode identifier when relevant. + Description ----------- -Stores key presses on the keyboard. Supports key presses, key releases and member echo events. +Stores key presses on the keyboard. Supports key presses, key releases and :ref:`echo` events. Member Function Description --------------------------- diff --git a/classes/class_inputeventmouse.rst b/classes/class_inputeventmouse.rst index 1937fcfbd..3d9a0e4a2 100644 --- a/classes/class_inputeventmouse.rst +++ b/classes/class_inputeventmouse.rst @@ -38,10 +38,19 @@ Member Functions Member Variables ---------------- + .. _class_InputEventMouse_button_mask: + - :ref:`int` **button_mask** - Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK\_\* constants in :ref:`@Global Scope`. + + .. _class_InputEventMouse_global_position: + - :ref:`Vector2` **global_position** - Mouse position relative to the current :ref:`Viewport` when used in :ref:`Control._gui_input`, otherwise is at 0,0. + + .. _class_InputEventMouse_position: + - :ref:`Vector2` **position** - Mouse local position relative to the :ref:`Viewport`. If used in :ref:`Control._gui_input` the position is relative to the current :ref:`Control` wich is under the mouse. + Description ----------- diff --git a/classes/class_inputeventmousebutton.rst b/classes/class_inputeventmousebutton.rst index 5efcc3767..e65e5a99a 100644 --- a/classes/class_inputeventmousebutton.rst +++ b/classes/class_inputeventmousebutton.rst @@ -38,11 +38,23 @@ Member Functions Member Variables ---------------- + .. _class_InputEventMouseButton_button_index: + - :ref:`int` **button_index** - Mouse button identifier, one of the BUTTON\_\* or BUTTON_WHEEL\_\* constants in :ref:`@Global Scope`. + + .. _class_InputEventMouseButton_doubleclick: + - :ref:`bool` **doubleclick** - If ``true`` the mouse button's state is a double-click. If ``false`` the mouse button's state is released. + + .. _class_InputEventMouseButton_factor: + - :ref:`float` **factor** - TO TALK in PR, reduz said : i think it's used for apple touch but i don't remember what it does + + .. _class_InputEventMouseButton_pressed: + - :ref:`bool` **pressed** - If ``true`` the mouse button's state is pressed. If ``false`` the mouse button's state is released. + Description ----------- diff --git a/classes/class_inputeventmousemotion.rst b/classes/class_inputeventmousemotion.rst index 0828883ba..2713b2abc 100644 --- a/classes/class_inputeventmousemotion.rst +++ b/classes/class_inputeventmousemotion.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_InputEventMouseMotion_relative: + - :ref:`Vector2` **relative** - Mouse position relative to the previous position (position at the last frame). + + .. _class_InputEventMouseMotion_speed: + - :ref:`Vector2` **speed** - Mouse speed. + Description ----------- diff --git a/classes/class_inputeventscreendrag.rst b/classes/class_inputeventscreendrag.rst index 504d01072..da50fd4d4 100644 --- a/classes/class_inputeventscreendrag.rst +++ b/classes/class_inputeventscreendrag.rst @@ -42,11 +42,23 @@ Member Functions Member Variables ---------------- + .. _class_InputEventScreenDrag_index: + - :ref:`int` **index** - Drag event index in the case of a multi-drag event. + + .. _class_InputEventScreenDrag_position: + - :ref:`Vector2` **position** - Drag position. + + .. _class_InputEventScreenDrag_relative: + - :ref:`Vector2` **relative** - Drag position relative to its start position. + + .. _class_InputEventScreenDrag_speed: + - :ref:`Vector2` **speed** - Drag speed. + Description ----------- diff --git a/classes/class_inputeventscreentouch.rst b/classes/class_inputeventscreentouch.rst index 7d4219725..d3a6c2e66 100644 --- a/classes/class_inputeventscreentouch.rst +++ b/classes/class_inputeventscreentouch.rst @@ -36,14 +36,23 @@ Member Functions Member Variables ---------------- + .. _class_InputEventScreenTouch_index: + - :ref:`int` **index** - Touch index in the case of a multi-touch event. One index = one finger. + + .. _class_InputEventScreenTouch_position: + - :ref:`Vector2` **position** - Touch position. + + .. _class_InputEventScreenTouch_pressed: + - :ref:`bool` **pressed** - If ``true`` the touch's state is pressed. If ``false`` the touch's state is released. + Description ----------- -Stores multi-touch press/release information. Supports touch press, touch release and member index for multi-touch count and order. +Stores multi-touch press/release information. Supports touch press, touch release and :ref:`index` for multi-touch count and order. Member Function Description --------------------------- diff --git a/classes/class_inputeventwithmodifiers.rst b/classes/class_inputeventwithmodifiers.rst index 8b75beb49..dc8fa8cef 100644 --- a/classes/class_inputeventwithmodifiers.rst +++ b/classes/class_inputeventwithmodifiers.rst @@ -46,12 +46,27 @@ Member Functions Member Variables ---------------- + .. _class_InputEventWithModifiers_alt: + - :ref:`bool` **alt** - State of the Alt modifier. + + .. _class_InputEventWithModifiers_command: + - :ref:`bool` **command** - State of the Command modifier. + + .. _class_InputEventWithModifiers_control: + - :ref:`bool` **control** - State of the Ctrl modifier. + + .. _class_InputEventWithModifiers_meta: + - :ref:`bool` **meta** - State of the Meta modifier. + + .. _class_InputEventWithModifiers_shift: + - :ref:`bool` **shift** - State of the Shift modifier. + Description ----------- diff --git a/classes/class_interpolatedcamera.rst b/classes/class_interpolatedcamera.rst index 1ab0ed070..79161d38e 100644 --- a/classes/class_interpolatedcamera.rst +++ b/classes/class_interpolatedcamera.rst @@ -38,10 +38,19 @@ Member Functions Member Variables ---------------- + .. _class_InterpolatedCamera_enabled: + - :ref:`bool` **enabled** + + .. _class_InterpolatedCamera_speed: + - :ref:`float` **speed** + + .. _class_InterpolatedCamera_target: + - :ref:`NodePath` **target** + Member Function Description --------------------------- diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index fc4511f46..e60e78774 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -126,10 +126,14 @@ Member Functions Signals ------- +.. _class_ItemList_item_activated: + - **item_activated** **(** :ref:`int` index **)** Fired when specified list item is activated via double click or Enter. +.. _class_ItemList_item_rmb_selected: + - **item_rmb_selected** **(** :ref:`int` index, :ref:`Vector2` at_position **)** Fired when specified list item has been selected via right mouse clicking. @@ -138,10 +142,14 @@ The click position is also provided to allow appropriate popup of context menus at the correct location. +.. _class_ItemList_item_selected: + - **item_selected** **(** :ref:`int` index **)** Fired when specified item has been selected. +.. _class_ItemList_multi_selected: + - **multi_selected** **(** :ref:`int` index, :ref:`bool` selected **)** Fired when a multiple selection is altered on a list allowing multiple selection. @@ -150,17 +158,47 @@ Fired when a multiple selection is altered on a list allowing multiple selection Member Variables ---------------- + .. _class_ItemList_allow_rmb_select: + - :ref:`bool` **allow_rmb_select** + + .. _class_ItemList_auto_height: + - :ref:`bool` **auto_height** + + .. _class_ItemList_fixed_column_width: + - :ref:`int` **fixed_column_width** + + .. _class_ItemList_icon_mode: + - :ref:`int` **icon_mode** + + .. _class_ItemList_icon_scale: + - :ref:`float` **icon_scale** + + .. _class_ItemList_items: + - :ref:`Array` **items** + + .. _class_ItemList_max_columns: + - :ref:`int` **max_columns** + + .. _class_ItemList_max_text_lines: + - :ref:`int` **max_text_lines** + + .. _class_ItemList_same_column_width: + - :ref:`bool` **same_column_width** + + .. _class_ItemList_select_mode: + - :ref:`int` **select_mode** + Numeric Constants ----------------- diff --git a/classes/class_joint.rst b/classes/class_joint.rst index c519e6540..de97e1050 100644 --- a/classes/class_joint.rst +++ b/classes/class_joint.rst @@ -42,11 +42,23 @@ Member Functions Member Variables ---------------- + .. _class_Joint_collision/exclude_nodes: + - :ref:`bool` **collision/exclude_nodes** - If ``true`` the two bodies of the nodes are not able to collide with each other. + + .. _class_Joint_nodes/node_a: + - :ref:`NodePath` **nodes/node_a** - The :ref:`Node`, the first side of the Joint attaches to. + + .. _class_Joint_nodes/node_b: + - :ref:`NodePath` **nodes/node_b** - The :ref:`Node`, the second side of the Joint attaches to. + + .. _class_Joint_solver/priority: + - :ref:`int` **solver/priority** - The order in wich the solver is executed compared to the other Joints, the lower, the earlier. + Description ----------- diff --git a/classes/class_joint2d.rst b/classes/class_joint2d.rst index 3385fd7d9..a42ee374d 100644 --- a/classes/class_joint2d.rst +++ b/classes/class_joint2d.rst @@ -42,11 +42,23 @@ Member Functions Member Variables ---------------- + .. _class_Joint2D_bias: + - :ref:`float` **bias** + + .. _class_Joint2D_disable_collision: + - :ref:`bool` **disable_collision** + + .. _class_Joint2D_node_a: + - :ref:`NodePath` **node_a** + + .. _class_Joint2D_node_b: + - :ref:`NodePath` **node_b** + Description ----------- diff --git a/classes/class_jsonparseresult.rst b/classes/class_jsonparseresult.rst index de6632c1c..8528e82a9 100644 --- a/classes/class_jsonparseresult.rst +++ b/classes/class_jsonparseresult.rst @@ -40,9 +40,20 @@ Member Functions Member Variables ---------------- + .. _class_JSONParseResult_error: + - :ref:`int` **error** - The error type if JSON source was not successfully parsed. See :ref:`@Global Scope`\ ERR\_\* constants. + + .. _class_JSONParseResult_error_line: + - :ref:`int` **error_line** - The line number where the error occurred if JSON source was not successfully parsed. + + .. _class_JSONParseResult_error_string: + - :ref:`String` **error_string** - The error message if JSON source was not successfully parsed. See :ref:`@Global Scope`\ ERR\_\* constants. + + .. _class_JSONParseResult_result: + - :ref:`Variant` **result** - A :ref:`Variant` containing the parsed JSON. Use typeof() to check if it is what you expect. For example, if JSON source starts with braces ``{}`` a :ref:`Dictionary` will be returned, if JSON source starts with array braces ``[]`` an :ref:`Array` will be returned. *Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to float types.* @@ -55,6 +66,7 @@ Member Variables else: print("unexpected results") + Description ----------- diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index 9eb9bcffc..667bd92b9 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -46,8 +46,11 @@ Member Functions Member Variables ---------------- + .. _class_KinematicBody_collision/safe_margin: + - :ref:`float` **collision/safe_margin** - If the body is at least this close to another body, this body will consider them to be colliding. + Description ----------- diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index e3f0036dc..945e97dc6 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -46,8 +46,11 @@ Member Functions Member Variables ---------------- + .. _class_KinematicBody2D_collision/safe_margin: + - :ref:`float` **collision/safe_margin** - If the body is at least this close to another body, this body will consider them to be colliding. + Description ----------- diff --git a/classes/class_kinematiccollision.rst b/classes/class_kinematiccollision.rst index 52736cfba..8c07a4f9f 100644 --- a/classes/class_kinematiccollision.rst +++ b/classes/class_kinematiccollision.rst @@ -46,18 +46,51 @@ Member Functions Member Variables ---------------- + .. _class_KinematicCollision_collider: + - :ref:`Object` **collider** - The colliding body. + + .. _class_KinematicCollision_collider_id: + - :ref:`int` **collider_id** - The colliding body's unique :ref:`RID`. + + .. _class_KinematicCollision_collider_metadata: + - :ref:`Variant` **collider_metadata** - The colliding body's metadata. See :ref:`Object`. + + .. _class_KinematicCollision_collider_shape: + - :ref:`Object` **collider_shape** - The colliding body's shape. + + .. _class_KinematicCollision_collider_shape_index: + - :ref:`int` **collider_shape_index** - The colliding shape's index. See :ref:`CollisionObject`. + + .. _class_KinematicCollision_collider_velocity: + - :ref:`Vector3` **collider_velocity** - The colliding object's velocity. + + .. _class_KinematicCollision_local_shape: + - :ref:`Object` **local_shape** - The moving object's colliding shape. + + .. _class_KinematicCollision_normal: + - :ref:`Vector3` **normal** - The colliding body's shape's normal at the point of collision. + + .. _class_KinematicCollision_position: + - :ref:`Vector3` **position** - The point of collision. + + .. _class_KinematicCollision_remainder: + - :ref:`Vector3` **remainder** - The moving object's remaining movement vector. + + .. _class_KinematicCollision_travel: + - :ref:`Vector3` **travel** - The distance the moving object traveled before collision. + Description ----------- diff --git a/classes/class_kinematiccollision2d.rst b/classes/class_kinematiccollision2d.rst index 61459318f..144089a81 100644 --- a/classes/class_kinematiccollision2d.rst +++ b/classes/class_kinematiccollision2d.rst @@ -46,18 +46,51 @@ Member Functions Member Variables ---------------- + .. _class_KinematicCollision2D_collider: + - :ref:`Object` **collider** - The colliding body. + + .. _class_KinematicCollision2D_collider_id: + - :ref:`int` **collider_id** - The colliding body's unique :ref:`RID`. + + .. _class_KinematicCollision2D_collider_metadata: + - :ref:`Variant` **collider_metadata** - The colliding body's metadata. See :ref:`Object`. + + .. _class_KinematicCollision2D_collider_shape: + - :ref:`Object` **collider_shape** - The colliding body's shape. + + .. _class_KinematicCollision2D_collider_shape_index: + - :ref:`int` **collider_shape_index** - The colliding shape's index. See :ref:`CollisionObject2D`. + + .. _class_KinematicCollision2D_collider_velocity: + - :ref:`Vector2` **collider_velocity** - The colliding object's velocity. + + .. _class_KinematicCollision2D_local_shape: + - :ref:`Object` **local_shape** - The moving object's colliding shape. + + .. _class_KinematicCollision2D_normal: + - :ref:`Vector2` **normal** - The colliding body's shape's normal at the point of collision. + + .. _class_KinematicCollision2D_position: + - :ref:`Vector2` **position** - The point of collision. + + .. _class_KinematicCollision2D_remainder: + - :ref:`Vector2` **remainder** - The moving object's remaining movement vector. + + .. _class_KinematicCollision2D_travel: + - :ref:`Vector2` **travel** - The distance the moving object traveled before collision. + Description ----------- diff --git a/classes/class_label.rst b/classes/class_label.rst index 5c04d47d4..94ccee6b6 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -72,16 +72,43 @@ Member Functions Member Variables ---------------- + .. _class_Label_align: + - :ref:`int` **align** - Controls the text's horizontal align. Supports left, center, right, and fill, or justify. Set it to one of the ``ALIGN\_\*`` constants. + + .. _class_Label_autowrap: + - :ref:`bool` **autowrap** - If ``true``, wraps the text inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. Default: false. + + .. _class_Label_clip_text: + - :ref:`bool` **clip_text** - If ``true``, the Label only shows the text that fits inside its bounding rectangle. It also lets you scale the node down freely. + + .. _class_Label_lines_skipped: + - :ref:`int` **lines_skipped** - The node ignores the first ``lines_skipped`` lines before it starts to display text. + + .. _class_Label_max_lines_visible: + - :ref:`int` **max_lines_visible** - Limits the lines of text the node shows on screen. + + .. _class_Label_percent_visible: + - :ref:`float` **percent_visible** - Limits the count of visible characters. If you set ``percent_visible`` to 50, only up to half of the text's characters will display on screen. Useful to animate the text in a dialog box. + + .. _class_Label_text: + - :ref:`String` **text** - The text to display on screen. + + .. _class_Label_uppercase: + - :ref:`bool` **uppercase** - If ``true``, all the text displays as UPPERCASE. + + .. _class_Label_valign: + - :ref:`int` **valign** - Controls the text's vertical align. Supports top, center, bottom, and fill. Set it to one of the ``VALIGN\_\*`` constants. + Numeric Constants ----------------- diff --git a/classes/class_largetexture.rst b/classes/class_largetexture.rst index 3a403e1ba..17db71040 100644 --- a/classes/class_largetexture.rst +++ b/classes/class_largetexture.rst @@ -40,6 +40,8 @@ Member Functions Member Variables ---------------- + .. _class_LargeTexture__data: + - :ref:`Array` **_data** - Returns an :ref:`Array` with offsets and textures data of each added piece. Schema is offsets1, texture1, offsets2, texture2, large_texture_size. ``offsets`` : :ref:`Vector2` offsets of the texture piece. @@ -48,6 +50,7 @@ Member Variables ``last entry`` : :ref:`Vector2` size of the entire large texture. + Description ----------- diff --git a/classes/class_light.rst b/classes/class_light.rst index 0869ee9c4..ea2fb121a 100644 --- a/classes/class_light.rst +++ b/classes/class_light.rst @@ -58,18 +58,51 @@ Member Functions Member Variables ---------------- + .. _class_Light_editor_only: + - :ref:`bool` **editor_only** + + .. _class_Light_light_color: + - :ref:`Color` **light_color** + + .. _class_Light_light_cull_mask: + - :ref:`int` **light_cull_mask** + + .. _class_Light_light_energy: + - :ref:`float` **light_energy** + + .. _class_Light_light_negative: + - :ref:`bool` **light_negative** + + .. _class_Light_light_specular: + - :ref:`float` **light_specular** + + .. _class_Light_shadow_bias: + - :ref:`float` **shadow_bias** + + .. _class_Light_shadow_color: + - :ref:`Color` **shadow_color** + + .. _class_Light_shadow_contact: + - :ref:`float` **shadow_contact** + + .. _class_Light_shadow_enabled: + - :ref:`bool` **shadow_enabled** + + .. _class_Light_shadow_reverse_cull_face: + - :ref:`bool` **shadow_reverse_cull_face** + Numeric Constants ----------------- diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index 87c81d952..1b0c46f8d 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -108,28 +108,91 @@ Member Functions Member Variables ---------------- + .. _class_Light2D_color: + - :ref:`Color` **color** - The Light2D's :ref:`Color`. + + .. _class_Light2D_editor_only: + - :ref:`bool` **editor_only** - If ``true`` Light2D will only appear when editing the scene. Default value: ``false``. + + .. _class_Light2D_enabled: + - :ref:`bool` **enabled** - If ``true`` Light2D will emit light. Default value: ``true``. + + .. _class_Light2D_energy: + - :ref:`float` **energy** - The Light2D's energy value. The larger the value, the stronger the light. + + .. _class_Light2D_mode: + - :ref:`int` **mode** - The Light2D's mode. See MODE\_\* constants for values. + + .. _class_Light2D_offset: + - :ref:`Vector2` **offset** - The offset of the Light2D's ``texture``. + + .. _class_Light2D_range_height: + - :ref:`float` **range_height** - The height of the Light2D. Used with 2D normal mapping. + + .. _class_Light2D_range_item_cull_mask: + - :ref:`int` **range_item_cull_mask** - The layer mask. Only objects with a matching mask will be affected by the Light2D. + + .. _class_Light2D_range_layer_max: + - :ref:`int` **range_layer_max** - Maximum layer value of objects that are affected by the Light2D. Default value: ``0``. + + .. _class_Light2D_range_layer_min: + - :ref:`int` **range_layer_min** - Minimum layer value of objects that are affected by the Light2D. Default value: ``0``. + + .. _class_Light2D_range_z_max: + - :ref:`int` **range_z_max** - Maximum ``Z`` value of objects that are affected by the Light2D. Default value: ``1024``. + + .. _class_Light2D_range_z_min: + - :ref:`int` **range_z_min** - Minimum ``z`` value of objects that are affected by the Light2D. Default value: ``-1024``. + + .. _class_Light2D_shadow_buffer_size: + - :ref:`int` **shadow_buffer_size** - Shadow buffer size. Default value: ``2048``. + + .. _class_Light2D_shadow_color: + - :ref:`Color` **shadow_color** - :ref:`Color` of shadows cast by the Light2D. + + .. _class_Light2D_shadow_enabled: + - :ref:`bool` **shadow_enabled** - If ``true`` the Light2D will cast shadows. Default value: ``false``. + + .. _class_Light2D_shadow_filter: + - :ref:`int` **shadow_filter** - Shadow filter type. Use SHADOW_FILTER\_\* constants to set ``shadow_filter``. Default value: ``None``. + + .. _class_Light2D_shadow_filter_smooth: + - :ref:`float` **shadow_filter_smooth** - Smoothing value for shadows. + + .. _class_Light2D_shadow_gradient_length: + - :ref:`float` **shadow_gradient_length** - Smooth shadow gradient length. + + .. _class_Light2D_shadow_item_cull_mask: + - :ref:`int` **shadow_item_cull_mask** - The shadow mask. Used with :ref:`LightOccluder2D` to cast shadows. Only occluders with a matching shadow mask will cast shadows. + + .. _class_Light2D_texture: + - :ref:`Texture` **texture** - :ref:`Texture` used for the Light2D's appearance. + + .. _class_Light2D_texture_scale: + - :ref:`float` **texture_scale** - The ``texture``'s scale factor. + Numeric Constants ----------------- diff --git a/classes/class_lightoccluder2d.rst b/classes/class_lightoccluder2d.rst index e08a19dd9..cb85e6a6f 100644 --- a/classes/class_lightoccluder2d.rst +++ b/classes/class_lightoccluder2d.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_LightOccluder2D_light_mask: + - :ref:`int` **light_mask** - The LightOccluder2D's light mask. The LightOccluder2D will cast shadows only from Light2D(s) that have the same light mask(s). + + .. _class_LightOccluder2D_occluder: + - :ref:`OccluderPolygon2D` **occluder** - The :ref:`OccluderPolygon2D` used to compute the shadow. + Description ----------- diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst index e05a06edc..5230c9648 100644 --- a/classes/class_line2d.rst +++ b/classes/class_line2d.rst @@ -78,18 +78,51 @@ Member Functions Member Variables ---------------- + .. _class_Line2D_begin_cap_mode: + - :ref:`int` **begin_cap_mode** - Controls the style of the line's first point. Use ``LINE_CAP\_\*`` constants. Default value: ``LINE_CAP_NONE``. + + .. _class_Line2D_default_color: + - :ref:`Color` **default_color** - The line's color. Will not be used if a gradient is set. + + .. _class_Line2D_end_cap_mode: + - :ref:`int` **end_cap_mode** - Controls the style of the line's last point. Use ``LINE_CAP\_\*`` constants. Default value: ``LINE_CAP_NONE``. + + .. _class_Line2D_gradient: + - :ref:`Gradient` **gradient** - The gradient is drawn through the whole line from start to finish. The default color will not be used if a gradient is set. + + .. _class_Line2D_joint_mode: + - :ref:`int` **joint_mode** - The style for the points inbetween the start and the end. + + .. _class_Line2D_points: + - :ref:`PoolVector2Array` **points** - The points that form the lines. The line is drawn between every point set in this array. + + .. _class_Line2D_round_precision: + - :ref:`int` **round_precision** - The smoothness of the rounded joints and caps. This is only used if a cap or joint is set as round. + + .. _class_Line2D_sharp_limit: + - :ref:`float` **sharp_limit** - The direction difference in radians between vector points. This value is only used if ``joint mode`` is set to ``LINE_JOINT_SHARP``. + + .. _class_Line2D_texture: + - :ref:`Texture` **texture** - The texture used for the line's texture. Uses ``texture_mode`` for drawing style. + + .. _class_Line2D_texture_mode: + - :ref:`int` **texture_mode** - The style to render the ``texture`` on the line. Use ``LINE_TEXTURE\_\*`` constants. Default value: ``LINE_TEXTURE_NONE``. + + .. _class_Line2D_width: + - :ref:`float` **width** - The line's width. + Numeric Constants ----------------- diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 1b943495f..8b99d0ec6 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -80,10 +80,14 @@ Member Functions Signals ------- +.. _class_LineEdit_text_changed: + - **text_changed** **(** :ref:`String` text **)** When the text changes, this signal is emitted. +.. _class_LineEdit_text_entered: + - **text_entered** **(** :ref:`String` text **)** This signal is emitted when the user presses KEY_ENTER on the :ref:`LineEdit`. This signal is often used as an alternate confirmation mechanism in dialogs. @@ -92,18 +96,51 @@ This signal is emitted when the user presses KEY_ENTER on the :ref:`LineEdit` **align** + + .. _class_LineEdit_caret_blink: + - :ref:`bool` **caret_blink** + + .. _class_LineEdit_caret_blink_speed: + - :ref:`float` **caret_blink_speed** + + .. _class_LineEdit_editable: + - :ref:`bool` **editable** + + .. _class_LineEdit_expand_to_len: + - :ref:`bool` **expand_to_len** + + .. _class_LineEdit_focus_mode: + - :ref:`int` **focus_mode** + + .. _class_LineEdit_max_length: + - :ref:`int` **max_length** + + .. _class_LineEdit_placeholder_alpha: + - :ref:`float` **placeholder_alpha** + + .. _class_LineEdit_placeholder_text: + - :ref:`String` **placeholder_text** + + .. _class_LineEdit_secret: + - :ref:`bool` **secret** + + .. _class_LineEdit_text: + - :ref:`String` **text** + Numeric Constants ----------------- diff --git a/classes/class_lineshape2d.rst b/classes/class_lineshape2d.rst index b04d0ec77..6f9b06603 100644 --- a/classes/class_lineshape2d.rst +++ b/classes/class_lineshape2d.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_LineShape2D_d: + - :ref:`float` **d** - The line's distance from the origin. + + .. _class_LineShape2D_normal: + - :ref:`Vector2` **normal** - The line's normal. + Description ----------- diff --git a/classes/class_linkbutton.rst b/classes/class_linkbutton.rst index 1ffd18257..2f982f046 100644 --- a/classes/class_linkbutton.rst +++ b/classes/class_linkbutton.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_LinkButton_text: + - :ref:`String` **text** + + .. _class_LinkButton_underline: + - :ref:`int` **underline** + Numeric Constants ----------------- diff --git a/classes/class_material.rst b/classes/class_material.rst index b43be4410..2f36d3790 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -34,9 +34,15 @@ Member Functions Member Variables ---------------- + .. _class_Material_next_pass: + - :ref:`Material` **next_pass** + + .. _class_Material_render_priority: + - :ref:`int` **render_priority** + Numeric Constants ----------------- diff --git a/classes/class_menubutton.rst b/classes/class_menubutton.rst index 634875e1e..3a1818043 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -26,6 +26,8 @@ Member Functions Signals ------- +.. _class_MenuButton_about_to_show: + - **about_to_show** **(** **)** Emitted when :ref:`PopupMenu` of this MenuButton is about to show. @@ -34,8 +36,11 @@ Emitted when :ref:`PopupMenu` of this MenuButton is about to sh Member Variables ---------------- + .. _class_MenuButton_items: + - :ref:`Array` **items** + Description ----------- diff --git a/classes/class_meshinstance.rst b/classes/class_meshinstance.rst index b93a7c29f..ec32d97b5 100644 --- a/classes/class_meshinstance.rst +++ b/classes/class_meshinstance.rst @@ -42,9 +42,15 @@ Member Functions Member Variables ---------------- + .. _class_MeshInstance_mesh: + - :ref:`Mesh` **mesh** - The :ref:`Mesh` resource for the instance. + + .. _class_MeshInstance_skeleton: + - :ref:`NodePath` **skeleton** - :ref:`NodePath` to the :ref:`Skeleton` associated with the instance. + Description ----------- diff --git a/classes/class_mobilevrinterface.rst b/classes/class_mobilevrinterface.rst index 20d07642f..feaeb2cb1 100644 --- a/classes/class_mobilevrinterface.rst +++ b/classes/class_mobilevrinterface.rst @@ -48,13 +48,31 @@ Member Functions Member Variables ---------------- + .. _class_MobileVRInterface_display_to_lens: + - :ref:`float` **display_to_lens** - The distance between the display and the lenses inside of the device in centimeters. + + .. _class_MobileVRInterface_display_width: + - :ref:`float` **display_width** - The width of the display in centimeters. + + .. _class_MobileVRInterface_iod: + - :ref:`float` **iod** - The interocular distance, also known as the interpupillary distance. The distance between the pupils of the left and right eye. + + .. _class_MobileVRInterface_k1: + - :ref:`float` **k1** - The k1 lens factor is one of the two constants that define the strength of the lens used and directly influences the lens distortion effect. + + .. _class_MobileVRInterface_k2: + - :ref:`float` **k2** - The k2 lens factor, see k1. + + .. _class_MobileVRInterface_oversample: + - :ref:`float` **oversample** - The oversample setting. Because of the lens distortion we have to render our buffers at a higher resolution then the screen can natively handle. A value between 1.5 and 2.0 often provides good results but at the cost of performance. + Description ----------- diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index 798567bfd..b74e3a2b1 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -50,13 +50,31 @@ Member Functions Member Variables ---------------- + .. _class_MultiMesh_color_array: + - :ref:`PoolColorArray` **color_array** + + .. _class_MultiMesh_color_format: + - :ref:`int` **color_format** + + .. _class_MultiMesh_instance_count: + - :ref:`int` **instance_count** + + .. _class_MultiMesh_mesh: + - :ref:`Mesh` **mesh** + + .. _class_MultiMesh_transform_array: + - :ref:`PoolVector3Array` **transform_array** + + .. _class_MultiMesh_transform_format: + - :ref:`int` **transform_format** + Numeric Constants ----------------- diff --git a/classes/class_multimeshinstance.rst b/classes/class_multimeshinstance.rst index acc4bc4eb..af4817d58 100644 --- a/classes/class_multimeshinstance.rst +++ b/classes/class_multimeshinstance.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_MultiMeshInstance_multimesh: + - :ref:`MultiMesh` **multimesh** + Description ----------- diff --git a/classes/class_nativescript.rst b/classes/class_nativescript.rst index e80bb2ed7..2e94d464c 100644 --- a/classes/class_nativescript.rst +++ b/classes/class_nativescript.rst @@ -34,9 +34,15 @@ Member Functions Member Variables ---------------- + .. _class_NativeScript_class_name: + - :ref:`String` **class_name** + + .. _class_NativeScript_library: + - :ref:`GDNativeLibrary` **library** + Member Function Description --------------------------- diff --git a/classes/class_navigation.rst b/classes/class_navigation.rst index 9c4d23d8f..4f055bdd5 100644 --- a/classes/class_navigation.rst +++ b/classes/class_navigation.rst @@ -44,8 +44,11 @@ Member Functions Member Variables ---------------- + .. _class_Navigation_up_vector: + - :ref:`Vector3` **up_vector** + Member Function Description --------------------------- diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index 99121ec3e..f686ecddd 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -106,26 +106,83 @@ Member Functions Member Variables ---------------- + .. _class_NavigationMesh_agent/height: + - :ref:`float` **agent/height** + + .. _class_NavigationMesh_agent/max_climb: + - :ref:`float` **agent/max_climb** + + .. _class_NavigationMesh_agent/max_slope: + - :ref:`float` **agent/max_slope** + + .. _class_NavigationMesh_agent/radius: + - :ref:`float` **agent/radius** + + .. _class_NavigationMesh_cell/height: + - :ref:`float` **cell/height** + + .. _class_NavigationMesh_cell/size: + - :ref:`float` **cell/size** + + .. _class_NavigationMesh_detail/sample_distance: + - :ref:`float` **detail/sample_distance** + + .. _class_NavigationMesh_detail/sample_max_error: + - :ref:`float` **detail/sample_max_error** + + .. _class_NavigationMesh_edge/max_error: + - :ref:`float` **edge/max_error** + + .. _class_NavigationMesh_edge/max_length: + - :ref:`float` **edge/max_length** + + .. _class_NavigationMesh_filter/filter_walkable_low_height_spans: + - :ref:`bool` **filter/filter_walkable_low_height_spans** + + .. _class_NavigationMesh_filter/ledge_spans: + - :ref:`bool` **filter/ledge_spans** + + .. _class_NavigationMesh_filter/low_hanging_obstacles: + - :ref:`bool` **filter/low_hanging_obstacles** + + .. _class_NavigationMesh_polygon/verts_per_poly: + - :ref:`float` **polygon/verts_per_poly** + + .. _class_NavigationMesh_polygons: + - :ref:`Array` **polygons** + + .. _class_NavigationMesh_region/merge_size: + - :ref:`float` **region/merge_size** + + .. _class_NavigationMesh_region/min_size: + - :ref:`float` **region/min_size** + + .. _class_NavigationMesh_sample_partition_type/sample_partition_type: + - :ref:`int` **sample_partition_type/sample_partition_type** + + .. _class_NavigationMesh_vertices: + - :ref:`PoolVector3Array` **vertices** + Numeric Constants ----------------- diff --git a/classes/class_navigationmeshinstance.rst b/classes/class_navigationmeshinstance.rst index e486be9b8..cf12884d7 100644 --- a/classes/class_navigationmeshinstance.rst +++ b/classes/class_navigationmeshinstance.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_NavigationMeshInstance_enabled: + - :ref:`bool` **enabled** + + .. _class_NavigationMeshInstance_navmesh: + - :ref:`NavigationMesh` **navmesh** + Member Function Description --------------------------- diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index 07d564bfa..ec8c7d9bf 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -52,10 +52,19 @@ Member Functions Member Variables ---------------- + .. _class_NavigationPolygon_outlines: + - :ref:`Array` **outlines** + + .. _class_NavigationPolygon_polygons: + - :ref:`Array` **polygons** + + .. _class_NavigationPolygon_vertices: + - :ref:`PoolVector2Array` **vertices** + Member Function Description --------------------------- diff --git a/classes/class_navigationpolygoninstance.rst b/classes/class_navigationpolygoninstance.rst index 22446f439..28d34bbe8 100644 --- a/classes/class_navigationpolygoninstance.rst +++ b/classes/class_navigationpolygoninstance.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_NavigationPolygonInstance_enabled: + - :ref:`bool` **enabled** + + .. _class_NavigationPolygonInstance_navpoly: + - :ref:`NavigationPolygon` **navpoly** + Member Function Description --------------------------- diff --git a/classes/class_networkedmultiplayerpeer.rst b/classes/class_networkedmultiplayerpeer.rst index c046f1e73..1f52f5dd1 100644 --- a/classes/class_networkedmultiplayerpeer.rst +++ b/classes/class_networkedmultiplayerpeer.rst @@ -42,22 +42,32 @@ Member Functions Signals ------- +.. _class_NetworkedMultiplayerPeer_connection_failed: + - **connection_failed** **(** **)** Emitted when failed to connect to server. +.. _class_NetworkedMultiplayerPeer_connection_succeeded: + - **connection_succeeded** **(** **)** Emitted when successfully connected to server. +.. _class_NetworkedMultiplayerPeer_peer_connected: + - **peer_connected** **(** :ref:`int` id **)** Emitted by the server when a client is connected. +.. _class_NetworkedMultiplayerPeer_peer_disconnected: + - **peer_disconnected** **(** :ref:`int` id **)** Emitted by the server when a client is disconnected. +.. _class_NetworkedMultiplayerPeer_server_disconnected: + - **server_disconnected** **(** **)** Emitted by clients when server is disconnected. diff --git a/classes/class_ninepatchrect.rst b/classes/class_ninepatchrect.rst index 8f9d34bd1..599b352c2 100644 --- a/classes/class_ninepatchrect.rst +++ b/classes/class_ninepatchrect.rst @@ -48,6 +48,8 @@ Member Functions Signals ------- +.. _class_NinePatchRect_texture_changed: + - **texture_changed** **(** **)** Fired when the node's texture changes. @@ -56,16 +58,43 @@ Fired when the node's texture changes. Member Variables ---------------- + .. _class_NinePatchRect_axis_stretch_horizontal: + - :ref:`int` **axis_stretch_horizontal** - Doesn't do anything at the time of writing. + + .. _class_NinePatchRect_axis_stretch_vertical: + - :ref:`int` **axis_stretch_vertical** - Doesn't do anything at the time of writing. + + .. _class_NinePatchRect_draw_center: + - :ref:`bool` **draw_center** - If ``true``, draw the panel's center. Else, only draw the 9-slice's borders. Default value: ``true`` + + .. _class_NinePatchRect_patch_margin_bottom: + - :ref:`int` **patch_margin_bottom** - The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders. + + .. _class_NinePatchRect_patch_margin_left: + - :ref:`int` **patch_margin_left** - The height of the 9-slice's left column. + + .. _class_NinePatchRect_patch_margin_right: + - :ref:`int` **patch_margin_right** - The height of the 9-slice's right column. + + .. _class_NinePatchRect_patch_margin_top: + - :ref:`int` **patch_margin_top** - The height of the 9-slice's top row. + + .. _class_NinePatchRect_region_rect: + - :ref:`Rect2` **region_rect** - Rectangular region of the texture to sample from. If you're working with an atlas, use this property to define the area the 9-slice should use. All other properties are relative to this one. + + .. _class_NinePatchRect_texture: + - :ref:`Texture` **texture** - The node's texture resource. + Numeric Constants ----------------- diff --git a/classes/class_node.rst b/classes/class_node.rst index 29200959b..9b919d41c 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -198,14 +198,20 @@ Member Functions Signals ------- +.. _class_Node_renamed: + - **renamed** **(** **)** Emitted when the node is renamed. +.. _class_Node_tree_entered: + - **tree_entered** **(** **)** Emitted when Node enters the tree. +.. _class_Node_tree_exited: + - **tree_exited** **(** **)** Emitted when Node exits the tree. @@ -214,10 +220,19 @@ Emitted when Node exits the tree. Member Variables ---------------- + .. _class_Node__import_path: + - :ref:`NodePath` **_import_path** + + .. _class_Node_editor/display_folded: + - :ref:`bool` **editor/display_folded** + + .. _class_Node_pause_mode: + - :ref:`int` **pause_mode** + Numeric Constants ----------------- diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index dc705e61c..2e66b81ea 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -94,19 +94,55 @@ Member Functions Member Variables ---------------- + .. _class_Node2D_global_position: + - :ref:`Vector2` **global_position** - Global position. + + .. _class_Node2D_global_rotation: + - :ref:`float` **global_rotation** - Global rotation in radians. + + .. _class_Node2D_global_rotation_deg: + - :ref:`float` **global_rotation_deg** - Global rotation in degrees. + + .. _class_Node2D_global_scale: + - :ref:`Vector2` **global_scale** - Global scale. + + .. _class_Node2D_global_transform: + - :ref:`Transform2D` **global_transform** - Global :ref:`Transform2D`. + + .. _class_Node2D_position: + - :ref:`Vector2` **position** - Position, relative to the node's parent. + + .. _class_Node2D_rotation: + - :ref:`float` **rotation** - Rotation in radians. + + .. _class_Node2D_rotation_deg: + - :ref:`float` **rotation_deg** - Rotation in degrees. + + .. _class_Node2D_scale: + - :ref:`Vector2` **scale** - Rotation in degrees. + + .. _class_Node2D_transform: + - :ref:`Transform2D` **transform** - Local :ref:`Transform2D`. + + .. _class_Node2D_z: + - :ref:`int` **z** - Z-index. Controls the order in which the nodes render. A node with a higher Z-index will display in front of others. + + .. _class_Node2D_z_as_relative: + - :ref:`bool` **z_as_relative** - Make the node's Z-index relative to its parent's Z-index. If this node's Z-index is 2 and its parent's effective Z-index is 3, then this node's effective Z-index will be 2 + 3 = 5. + Description ----------- diff --git a/classes/class_object.rst b/classes/class_object.rst index e7095d6e3..704077cad 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -104,6 +104,8 @@ Member Functions Signals ------- +.. _class_Object_script_changed: + - **script_changed** **(** **)** diff --git a/classes/class_occluderpolygon2d.rst b/classes/class_occluderpolygon2d.rst index 793ba58f9..1c3790acb 100644 --- a/classes/class_occluderpolygon2d.rst +++ b/classes/class_occluderpolygon2d.rst @@ -36,10 +36,19 @@ Member Functions Member Variables ---------------- + .. _class_OccluderPolygon2D_closed: + - :ref:`bool` **closed** + + .. _class_OccluderPolygon2D_cull_mode: + - :ref:`int` **cull_mode** + + .. _class_OccluderPolygon2D_polygon: + - :ref:`PoolVector2Array` **polygon** + Numeric Constants ----------------- diff --git a/classes/class_omnilight.rst b/classes/class_omnilight.rst index fa90522d4..e5b542a6d 100644 --- a/classes/class_omnilight.rst +++ b/classes/class_omnilight.rst @@ -32,11 +32,23 @@ Member Functions Member Variables ---------------- + .. _class_OmniLight_omni_attenuation: + - :ref:`float` **omni_attenuation** + + .. _class_OmniLight_omni_range: + - :ref:`float` **omni_range** + + .. _class_OmniLight_omni_shadow_detail: + - :ref:`int` **omni_shadow_detail** + + .. _class_OmniLight_omni_shadow_mode: + - :ref:`int` **omni_shadow_mode** + Numeric Constants ----------------- diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index dfb949bf9..f56a9584f 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -64,6 +64,8 @@ Member Functions Signals ------- +.. _class_OptionButton_item_selected: + - **item_selected** **(** :ref:`int` ID **)** This signal is emitted when the current item was changed by the user. ID of the item selected is passed as argument (if no IDs were added, ID will be just the item index). @@ -72,9 +74,15 @@ This signal is emitted when the current item was changed by the user. ID of the Member Variables ---------------- + .. _class_OptionButton_items: + - :ref:`Array` **items** + + .. _class_OptionButton_selected: + - :ref:`int` **selected** + Description ----------- diff --git a/classes/class_packeddatacontainer.rst b/classes/class_packeddatacontainer.rst index 8fc2b6979..a1b209502 100644 --- a/classes/class_packeddatacontainer.rst +++ b/classes/class_packeddatacontainer.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_PackedDataContainer___data__: + - :ref:`PoolByteArray` **__data__** + Member Function Description --------------------------- diff --git a/classes/class_packedscene.rst b/classes/class_packedscene.rst index 7c25d7c51..77996ff34 100644 --- a/classes/class_packedscene.rst +++ b/classes/class_packedscene.rst @@ -32,8 +32,11 @@ Member Functions Member Variables ---------------- + .. _class_PackedScene__bundled: + - :ref:`Dictionary` **_bundled** + Numeric Constants ----------------- diff --git a/classes/class_panoramasky.rst b/classes/class_panoramasky.rst index dd53b2442..2448540b2 100644 --- a/classes/class_panoramasky.rst +++ b/classes/class_panoramasky.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_PanoramaSky_panorama: + - :ref:`Texture` **panorama** + Member Function Description --------------------------- diff --git a/classes/class_parallaxbackground.rst b/classes/class_parallaxbackground.rst index 7b45a3282..b16e0071d 100644 --- a/classes/class_parallaxbackground.rst +++ b/classes/class_parallaxbackground.rst @@ -48,13 +48,31 @@ Member Functions Member Variables ---------------- + .. _class_ParallaxBackground_scroll_base_offset: + - :ref:`Vector2` **scroll_base_offset** + + .. _class_ParallaxBackground_scroll_base_scale: + - :ref:`Vector2` **scroll_base_scale** + + .. _class_ParallaxBackground_scroll_ignore_camera_zoom: + - :ref:`bool` **scroll_ignore_camera_zoom** + + .. _class_ParallaxBackground_scroll_limit_begin: + - :ref:`Vector2` **scroll_limit_begin** + + .. _class_ParallaxBackground_scroll_limit_end: + - :ref:`Vector2` **scroll_limit_end** + + .. _class_ParallaxBackground_scroll_offset: + - :ref:`Vector2` **scroll_offset** + Description ----------- diff --git a/classes/class_parallaxlayer.rst b/classes/class_parallaxlayer.rst index 192d0ed8b..ff5a7ebe2 100644 --- a/classes/class_parallaxlayer.rst +++ b/classes/class_parallaxlayer.rst @@ -36,10 +36,19 @@ Member Functions Member Variables ---------------- + .. _class_ParallaxLayer_motion_mirroring: + - :ref:`Vector2` **motion_mirroring** + + .. _class_ParallaxLayer_motion_offset: + - :ref:`Vector2` **motion_offset** + + .. _class_ParallaxLayer_motion_scale: + - :ref:`Vector2` **motion_scale** + Description ----------- diff --git a/classes/class_particles.rst b/classes/class_particles.rst index bd50f8050..8a5ac87d2 100644 --- a/classes/class_particles.rst +++ b/classes/class_particles.rst @@ -92,26 +92,83 @@ Member Functions Member Variables ---------------- + .. _class_Particles_amount: + - :ref:`int` **amount** - Number of particles to emit. + + .. _class_Particles_draw_order: + - :ref:`int` **draw_order** - Particle draw order. Uses ``DRAW_ORDER\_\*`` values. Default value: ``DRAW_ORDER_INDEX``. + + .. _class_Particles_draw_pass_1: + - :ref:`Mesh` **draw_pass_1** + + .. _class_Particles_draw_pass_2: + - :ref:`Mesh` **draw_pass_2** + + .. _class_Particles_draw_pass_3: + - :ref:`Mesh` **draw_pass_3** + + .. _class_Particles_draw_pass_4: + - :ref:`Mesh` **draw_pass_4** + + .. _class_Particles_draw_passes: + - :ref:`int` **draw_passes** + + .. _class_Particles_emitting: + - :ref:`bool` **emitting** - If ``true`` particles are being emitted. Default value: ``true``. + + .. _class_Particles_explosiveness: + - :ref:`float` **explosiveness** - Time ratio between each emission. If ``0`` particles are emitted continuously. If ``1`` all particles are emitted simultaneously. Default value: ``0``. + + .. _class_Particles_fixed_fps: + - :ref:`int` **fixed_fps** + + .. _class_Particles_fract_delta: + - :ref:`bool` **fract_delta** + + .. _class_Particles_lifetime: + - :ref:`float` **lifetime** - Amount of time each particle will exist. Default value: ``1``. + + .. _class_Particles_local_coords: + - :ref:`bool` **local_coords** - If ``true`` particles use the parent node's coordinate space. If ``false`` they use global coordinates. Default value: ``true``. + + .. _class_Particles_one_shot: + - :ref:`bool` **one_shot** - If ``true`` only ``amount`` particles will be emitted. Default value: ``false``. + + .. _class_Particles_preprocess: + - :ref:`float` **preprocess** + + .. _class_Particles_process_material: + - :ref:`Material` **process_material** - :ref:`Material` for processing particles. Can be a :ref:`ParticlesMaterial` or a :ref:`ShaderMaterial`. + + .. _class_Particles_randomness: + - :ref:`float` **randomness** - Emission randomness ratio. Default value: ``0``. + + .. _class_Particles_speed_scale: + - :ref:`float` **speed_scale** - Speed scaling ratio. Default value: ``1``. + + .. _class_Particles_visibility_aabb: + - :ref:`Rect3` **visibility_aabb** + Numeric Constants ----------------- diff --git a/classes/class_particles2d.rst b/classes/class_particles2d.rst index 9a6edf31a..06ced1104 100644 --- a/classes/class_particles2d.rst +++ b/classes/class_particles2d.rst @@ -100,25 +100,79 @@ Member Functions Member Variables ---------------- + .. _class_Particles2D_amount: + - :ref:`int` **amount** - Number of particles emitted in one emission cycle. + + .. _class_Particles2D_draw_order: + - :ref:`int` **draw_order** - Particle draw order. Uses ``DRAW_ORDER\_\*`` values. Default value: ``DRAW_ORDER_INDEX``. + + .. _class_Particles2D_emitting: + - :ref:`bool` **emitting** - If ``true`` particles are being emitted. Default value: ``true``. + + .. _class_Particles2D_explosiveness: + - :ref:`float` **explosiveness** - How rapidly particles in an emission cycle are emitted. If greater than ``0``, there will be a gap in emissions before the next cycle begins. Default value: ``0``. + + .. _class_Particles2D_fixed_fps: + - :ref:`int` **fixed_fps** + + .. _class_Particles2D_fract_delta: + - :ref:`bool` **fract_delta** + + .. _class_Particles2D_h_frames: + - :ref:`int` **h_frames** - Number of horizontal frames in ``texture``. + + .. _class_Particles2D_lifetime: + - :ref:`float` **lifetime** - Amount of time each particle will exist. Default value: ``1``. + + .. _class_Particles2D_local_coords: + - :ref:`bool` **local_coords** - If ``true`` particles use the parent node's coordinate space. If ``false`` they use global coordinates. Default value: ``true``. + + .. _class_Particles2D_normal_map: + - :ref:`Texture` **normal_map** + + .. _class_Particles2D_one_shot: + - :ref:`bool` **one_shot** - If ``true`` only one emission cycle occurs. If set ``true`` during a cycle, emission will stop at the cycle's end. Default value: ``false``. + + .. _class_Particles2D_preprocess: + - :ref:`float` **preprocess** - Particle system starts as if it had already run for this many seconds. + + .. _class_Particles2D_process_material: + - :ref:`Material` **process_material** - :ref:`Material` for processing particles. Can be a :ref:`ParticlesMaterial` or a :ref:`ShaderMaterial`. + + .. _class_Particles2D_randomness: + - :ref:`float` **randomness** - Emission lifetime randomness ratio. Default value: ``0``. + + .. _class_Particles2D_speed_scale: + - :ref:`float` **speed_scale** - Particle system's running speed scaling ratio. Default value: ``1``. + + .. _class_Particles2D_texture: + - :ref:`Texture` **texture** - Particle texture. If ``null`` particles will be squares. + + .. _class_Particles2D_v_frames: + - :ref:`int` **v_frames** - Number of vertical frames in ``texture``. + + .. _class_Particles2D_visibility_rect: + - :ref:`Rect2` **visibility_rect** - Editor visibility helper. + Numeric Constants ----------------- diff --git a/classes/class_particlesmaterial.rst b/classes/class_particlesmaterial.rst index 0e7c73b7a..b3d804c9a 100644 --- a/classes/class_particlesmaterial.rst +++ b/classes/class_particlesmaterial.rst @@ -100,61 +100,223 @@ Member Functions Member Variables ---------------- + .. _class_ParticlesMaterial_angle: + - :ref:`float` **angle** - Initial rotation applied to each particle. + + .. _class_ParticlesMaterial_angle_curve: + - :ref:`Texture` **angle_curve** - Each particle's rotation will be animated along this :ref:`CurveTexture`. + + .. _class_ParticlesMaterial_angle_random: + - :ref:`float` **angle_random** - Rotation randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_angular_velocity: + - :ref:`float` **angular_velocity** - Initial angular velocity applied to each particle. + + .. _class_ParticlesMaterial_angular_velocity_curve: + - :ref:`Texture` **angular_velocity_curve** - Each particle's angular velocity will vary along this :ref:`CurveTexture`. + + .. _class_ParticlesMaterial_angular_velocity_random: + - :ref:`float` **angular_velocity_random** - Angular velocity randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_anim_loop: + - :ref:`bool` **anim_loop** - If ``true`` animation will loop. Default value: ``false``. + + .. _class_ParticlesMaterial_anim_offset: + - :ref:`float` **anim_offset** - Particle animation offset. + + .. _class_ParticlesMaterial_anim_offset_curve: + - :ref:`Texture` **anim_offset_curve** - Each particle's animation offset will vary along this :ref:`CurveTexture`. + + .. _class_ParticlesMaterial_anim_offset_random: + - :ref:`float` **anim_offset_random** - Animation offset randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_anim_speed: + - :ref:`float` **anim_speed** - Particle animation speed. + + .. _class_ParticlesMaterial_anim_speed_curve: + - :ref:`Texture` **anim_speed_curve** - Each particle's animation speed will vary along this :ref:`CurveTexture`. + + .. _class_ParticlesMaterial_anim_speed_random: + - :ref:`float` **anim_speed_random** - Animation speed randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_color: + - :ref:`Color` **color** - Each particle's initial color. If the Particle2D's ``texture`` is defined, it will be multiplied by this color. + + .. _class_ParticlesMaterial_color_ramp: + - :ref:`Texture` **color_ramp** - Each particle's color will vary along this :ref:`GradientTexture`. + + .. _class_ParticlesMaterial_damping: + - :ref:`float` **damping** - The rate at which particles lose velocity. + + .. _class_ParticlesMaterial_damping_curve: + - :ref:`Texture` **damping_curve** - Damping will vary along this :ref:`CurveTexture`. + + .. _class_ParticlesMaterial_damping_random: + - :ref:`float` **damping_random** - Damping randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_emission_box_extents: + - :ref:`Vector3` **emission_box_extents** - The box's extents if ``emission_shape`` is set to ``EMISSION_SHAPE_BOX``. + + .. _class_ParticlesMaterial_emission_color_texture: + - :ref:`Texture` **emission_color_texture** + + .. _class_ParticlesMaterial_emission_normal_texture: + - :ref:`Texture` **emission_normal_texture** + + .. _class_ParticlesMaterial_emission_point_count: + - :ref:`int` **emission_point_count** - The number of emission points if ``emission_shape`` is set to ``EMISSION_SHAPE_POINTS`` or ``EMISSION_SHAPE_DIRECTED_POINTS``. + + .. _class_ParticlesMaterial_emission_point_texture: + - :ref:`Texture` **emission_point_texture** + + .. _class_ParticlesMaterial_emission_shape: + - :ref:`int` **emission_shape** - Particles will be emitted inside this region. Use ``EMISSION_SHAPE\_\*`` constants for values. Default value: ``EMISSION_SHAPE_POINT``. + + .. _class_ParticlesMaterial_emission_sphere_radius: + - :ref:`float` **emission_sphere_radius** - The sphere's radius if ``emission_shape`` is set to ``EMISSION_SHAPE_SPHERE``. + + .. _class_ParticlesMaterial_flag_align_y: + - :ref:`bool` **flag_align_y** + + .. _class_ParticlesMaterial_flag_disable_z: + - :ref:`bool` **flag_disable_z** - If ``true`` particles will not move on the z axis. Default value: ``true`` for :ref:`Particles2D`, ``false`` for :ref:`Particles`. + + .. _class_ParticlesMaterial_flag_rotate_y: + - :ref:`bool` **flag_rotate_y** + + .. _class_ParticlesMaterial_flatness: + - :ref:`float` **flatness** + + .. _class_ParticlesMaterial_gravity: + - :ref:`Vector3` **gravity** - Gravity applied to every particle. Default value: ``(0, 98, 0)``. + + .. _class_ParticlesMaterial_hue_variation: + - :ref:`float` **hue_variation** - Initial hue variation applied to each particle. + + .. _class_ParticlesMaterial_hue_variation_curve: + - :ref:`Texture` **hue_variation_curve** - Each particle's hue will vary along this :ref:`CurveTexture`. + + .. _class_ParticlesMaterial_hue_variation_random: + - :ref:`float` **hue_variation_random** - Hue variation randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_initial_velocity: + - :ref:`float` **initial_velocity** - Initial velocity for each particle. + + .. _class_ParticlesMaterial_initial_velocity_random: + - :ref:`float` **initial_velocity_random** - Initial velocity randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_linear_accel: + - :ref:`float` **linear_accel** - Linear acceleration applied to each particle. + + .. _class_ParticlesMaterial_linear_accel_curve: + - :ref:`Texture` **linear_accel_curve** - Each particle's linear acceleration will vary along this :ref:`CurveTexture`. + + .. _class_ParticlesMaterial_linear_accel_random: + - :ref:`float` **linear_accel_random** - Linear acceleration randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_orbit_velocity: + - :ref:`float` **orbit_velocity** - Orbital velocity applied to each particle. + + .. _class_ParticlesMaterial_orbit_velocity_curve: + - :ref:`Texture` **orbit_velocity_curve** - Each particle's orbital velocity will vary along this :ref:`CurveTexture`. + + .. _class_ParticlesMaterial_orbit_velocity_random: + - :ref:`float` **orbit_velocity_random** - Orbital velocity randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_radial_accel: + - :ref:`float` **radial_accel** - Linear acceleration applied to each particle. + + .. _class_ParticlesMaterial_radial_accel_curve: + - :ref:`Texture` **radial_accel_curve** - Each particle's radial acceleration will vary along this :ref:`CurveTexture`. + + .. _class_ParticlesMaterial_radial_accel_random: + - :ref:`float` **radial_accel_random** - Radial acceleration randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_scale: + - :ref:`float` **scale** - Initial scale applied to each particle. + + .. _class_ParticlesMaterial_scale_curve: + - :ref:`Texture` **scale_curve** - Each particle's scale will vary along this :ref:`CurveTexture`. + + .. _class_ParticlesMaterial_scale_random: + - :ref:`float` **scale_random** - Scale randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_spread: + - :ref:`float` **spread** - Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Default value: ``45``. + + .. _class_ParticlesMaterial_tangential_accel: + - :ref:`float` **tangential_accel** - Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity. + + .. _class_ParticlesMaterial_tangential_accel_curve: + - :ref:`Texture` **tangential_accel_curve** - Each particle's tangential acceleration will vary along this :ref:`CurveTexture`. + + .. _class_ParticlesMaterial_tangential_accel_random: + - :ref:`float` **tangential_accel_random** - Tangential acceleration randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_trail_color_modifier: + - :ref:`GradientTexture` **trail_color_modifier** - Trail particles' color will vary along this :ref:`GradientTexture`. + + .. _class_ParticlesMaterial_trail_divisor: + - :ref:`int` **trail_divisor** - Emitter will emit ``amount`` divided by ``trail_divisor`` particles. The remaining particles will be used as trail(s). + + .. _class_ParticlesMaterial_trail_size_modifier: + - :ref:`CurveTexture` **trail_size_modifier** - Trail particles' size will vary along this :ref:`CurveTexture`. + Numeric Constants ----------------- @@ -171,8 +333,8 @@ Numeric Constants - **PARAM_ANIM_SPEED** = **10** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set animation speed properties. - **PARAM_ANIM_OFFSET** = **11** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set animation offset properties. - **PARAM_MAX** = **12** -- **FLAG_ALIGN_Y_TO_VELOCITY** = **0** --- Use with :ref:`set_flag` to set member flag_align_y. -- **FLAG_ROTATE_Y** = **1** --- Use with :ref:`set_flag` to set member flag_rotate_y +- **FLAG_ALIGN_Y_TO_VELOCITY** = **0** --- Use with :ref:`set_flag` to set :ref:`flag_align_y`. +- **FLAG_ROTATE_Y** = **1** --- Use with :ref:`set_flag` to set :ref:`flag_rotate_y` - **FLAG_MAX** = **4** - **EMISSION_SHAPE_POINT** = **0** --- All particles will be emitted from a single point. - **EMISSION_SHAPE_SPHERE** = **1** --- Particles will be emitted in the volume of a sphere. diff --git a/classes/class_path.rst b/classes/class_path.rst index 7a9e4cf78..25fb695f4 100644 --- a/classes/class_path.rst +++ b/classes/class_path.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_Path_curve: + - :ref:`Curve3D` **curve** + Description ----------- diff --git a/classes/class_path2d.rst b/classes/class_path2d.rst index 423459177..504f6366d 100644 --- a/classes/class_path2d.rst +++ b/classes/class_path2d.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_Path2D_curve: + - :ref:`Curve2D` **curve** + Description ----------- diff --git a/classes/class_physicsbody.rst b/classes/class_physicsbody.rst index 153a3e98c..a5e230961 100644 --- a/classes/class_physicsbody.rst +++ b/classes/class_physicsbody.rst @@ -46,13 +46,19 @@ Member Functions Member Variables ---------------- + .. _class_PhysicsBody_collision_layer: + - :ref:`int` **collision_layer** - The physics layers this area is in. Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. + + .. _class_PhysicsBody_collision_mask: + - :ref:`int` **collision_mask** - The physics layers this area can scan for collisions. + Description ----------- diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index 9e313a795..81446352c 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -46,14 +46,23 @@ Member Functions Member Variables ---------------- + .. _class_PhysicsBody2D_collision_layer: + - :ref:`int` **collision_layer** - The physics layers this area is in. Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. + + .. _class_PhysicsBody2D_collision_mask: + - :ref:`int` **collision_mask** - The physics layers this area can scan for collisions. + + .. _class_PhysicsBody2D_layers: + - :ref:`int` **layers** - Both collision_layer and collision_mask. Returns collision_layer when accessed. Updates collision_layers and collision_mask when modified. + Description ----------- diff --git a/classes/class_pinjoint.rst b/classes/class_pinjoint.rst index 7dfb06a9d..2c046ebed 100644 --- a/classes/class_pinjoint.rst +++ b/classes/class_pinjoint.rst @@ -28,14 +28,23 @@ Member Functions Member Variables ---------------- + .. _class_PinJoint_params/bias: + - :ref:`float` **params/bias** - The force with wich the pinned objects stay in positional relation to each other. The higher, the stronger. + + .. _class_PinJoint_params/damping: + - :ref:`float` **params/damping** - The force with wich the pinned objects stay in velocity relation to each other. The higher, the stronger. + + .. _class_PinJoint_params/impulse_clamp: + - :ref:`float` **params/impulse_clamp** - If above 0, this value is the maximum value for an impulse that this Joint produces. + Numeric Constants ----------------- diff --git a/classes/class_pinjoint2d.rst b/classes/class_pinjoint2d.rst index db4a04b38..df218dade 100644 --- a/classes/class_pinjoint2d.rst +++ b/classes/class_pinjoint2d.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_PinJoint2D_softness: + - :ref:`float` **softness** - The higher this value, the more the bond to the pinned partner can flex. + Description ----------- diff --git a/classes/class_plane.rst b/classes/class_plane.rst index 8754a846f..f595b2088 100644 --- a/classes/class_plane.rst +++ b/classes/class_plane.rst @@ -48,12 +48,27 @@ Member Functions Member Variables ---------------- + .. _class_Plane_d: + - :ref:`float` **d** + + .. _class_Plane_normal: + - :ref:`Vector3` **normal** + + .. _class_Plane_x: + - :ref:`float` **x** + + .. _class_Plane_y: + - :ref:`float` **y** + + .. _class_Plane_z: + - :ref:`float` **z** + Description ----------- diff --git a/classes/class_planemesh.rst b/classes/class_planemesh.rst index a43590652..00172a460 100644 --- a/classes/class_planemesh.rst +++ b/classes/class_planemesh.rst @@ -36,10 +36,19 @@ Member Functions Member Variables ---------------- + .. _class_PlaneMesh_size: + - :ref:`Vector2` **size** - Size of the generated plane. Defaults to (2.0, 2.0). + + .. _class_PlaneMesh_subdivide_depth: + - :ref:`int` **subdivide_depth** - Number of subdivision along the z-axis. Defaults to 0. + + .. _class_PlaneMesh_subdivide_width: + - :ref:`int` **subdivide_width** - Number of subdivision along the x-axis. Defaults to 0. + Description ----------- diff --git a/classes/class_planeshape.rst b/classes/class_planeshape.rst index a46730e91..b58e1b286 100644 --- a/classes/class_planeshape.rst +++ b/classes/class_planeshape.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_PlaneShape_plane: + - :ref:`Plane` **plane** + Member Function Description --------------------------- diff --git a/classes/class_polygon2d.rst b/classes/class_polygon2d.rst index 2c09f58a9..e01e5c180 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -72,19 +72,55 @@ Member Functions Member Variables ---------------- + .. _class_Polygon2D_antialiased: + - :ref:`bool` **antialiased** - If ``true`` polygon edges will be anti-aliased. Default value: ``false``. + + .. _class_Polygon2D_color: + - :ref:`Color` **color** - The polygon's fill color. If ``texture`` is defined, it will be multiplied by this color. It will also be the default color for vertices not set in ``vertex_colors``. + + .. _class_Polygon2D_invert_border: + - :ref:`float` **invert_border** - Added padding applied to the bounding box when using ``invert``. Setting this value too small may result in a "Bad Polygon" error. Default value: ``100``. + + .. _class_Polygon2D_invert_enable: + - :ref:`bool` **invert_enable** - If ``true`` polygon will be inverted, containing the area outside the defined points and extending to the ``invert_border``. Default value: ``false``. + + .. _class_Polygon2D_offset: + - :ref:`Vector2` **offset** - The offset applied to each vertex. + + .. _class_Polygon2D_polygon: + - :ref:`PoolVector2Array` **polygon** - The polygon's list of vertices. The final point will be connected to the first. + + .. _class_Polygon2D_texture: + - :ref:`Texture` **texture** - The polygon's fill texture. Use ``uv`` to set texture coordinates. + + .. _class_Polygon2D_texture_offset: + - :ref:`Vector2` **texture_offset** - Amount to offset the polygon's ``texture``. If ``(0, 0)`` the texture's origin (its top-left corner) will be placed at the polygon's ``position``. + + .. _class_Polygon2D_texture_rotation: + - :ref:`float` **texture_rotation** - The texture's rotation in degrees. + + .. _class_Polygon2D_texture_scale: + - :ref:`Vector2` **texture_scale** - Amount to multiply the ``uv`` coordinates when using a ``texture``. Larger values make the texture smaller, and vice versa. + + .. _class_Polygon2D_uv: + - :ref:`PoolVector2Array` **uv** - Texture coordinates for each vertex of the polygon. There should be one ``uv`` per polygon vertex. If there are fewer, undefined vertices will use ``(0, 0)``. + + .. _class_Polygon2D_vertex_colors: + - :ref:`PoolColorArray` **vertex_colors** - Color for each vertex. Colors are interpolated between vertices, resulting in smooth gradients. There should be one per polygon vertex. If there are fewer, undefined vertices will use ``color``. + Description ----------- diff --git a/classes/class_polygonpathfinder.rst b/classes/class_polygonpathfinder.rst index 6a58cb178..7000442b6 100644 --- a/classes/class_polygonpathfinder.rst +++ b/classes/class_polygonpathfinder.rst @@ -40,8 +40,11 @@ Member Functions Member Variables ---------------- + .. _class_PolygonPathFinder_data: + - :ref:`Dictionary` **data** + Member Function Description --------------------------- diff --git a/classes/class_popup.rst b/classes/class_popup.rst index 09c439ee9..ad38997fa 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -38,10 +38,14 @@ Member Functions Signals ------- +.. _class_Popup_about_to_show: + - **about_to_show** **(** **)** This signal is emitted when a popup is about to be shown. (often used in :ref:`PopupMenu` for clearing the list of options and creating a new one according to the current context). +.. _class_Popup_popup_hide: + - **popup_hide** **(** **)** This signal is emitted when a popup is hidden. @@ -50,8 +54,11 @@ This signal is emitted when a popup is hidden. Member Variables ---------------- + .. _class_Popup_popup_exclusive: + - :ref:`bool` **popup_exclusive** + Numeric Constants ----------------- diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index 673f107e3..915ccf124 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -110,10 +110,14 @@ Member Functions Signals ------- +.. _class_PopupMenu_id_pressed: + - **id_pressed** **(** :ref:`int` ID **)** This event is emitted when an item of some id is pressed or its accelerator is activated. +.. _class_PopupMenu_index_pressed: + - **index_pressed** **(** :ref:`int` index **)** This event is emitted when an item of some index is pressed or its accelerator is activated. @@ -122,10 +126,19 @@ This event is emitted when an item of some index is pressed or its accelerator i Member Variables ---------------- + .. _class_PopupMenu_hide_on_checkable_item_selection: + - :ref:`bool` **hide_on_checkable_item_selection** + + .. _class_PopupMenu_hide_on_item_selection: + - :ref:`bool` **hide_on_item_selection** + + .. _class_PopupMenu_items: + - :ref:`Array` **items** + Description ----------- diff --git a/classes/class_primitivemesh.rst b/classes/class_primitivemesh.rst index 66c9af37a..271abdaf8 100644 --- a/classes/class_primitivemesh.rst +++ b/classes/class_primitivemesh.rst @@ -32,8 +32,11 @@ Member Functions Member Variables ---------------- + .. _class_PrimitiveMesh_material: + - :ref:`Material` **material** - The current :ref:`Material` of the primitive mesh. + Description ----------- diff --git a/classes/class_prismmesh.rst b/classes/class_prismmesh.rst index 6a2e9fa3e..359dda432 100644 --- a/classes/class_prismmesh.rst +++ b/classes/class_prismmesh.rst @@ -44,12 +44,27 @@ Member Functions Member Variables ---------------- + .. _class_PrismMesh_left_to_right: + - :ref:`float` **left_to_right** - Displacement of of the upper edge along the x-axis. 0.0 positions edge straight above the bottome left edge. Defaults to 0.5 (positioned on the midpoint). + + .. _class_PrismMesh_size: + - :ref:`Vector3` **size** - Size of the prism. Defaults to (2.0, 2.0, 2.0). + + .. _class_PrismMesh_subdivide_depth: + - :ref:`int` **subdivide_depth** - Number of added edge loops along the z-axis. Defaults to 0. + + .. _class_PrismMesh_subdivide_height: + - :ref:`int` **subdivide_height** - Number of added edge loops along the y-axis. Defaults to 0. + + .. _class_PrismMesh_subdivide_width: + - :ref:`int` **subdivide_width** - Number of added edge loops along the x-axis. Defaults to 0. + Description ----------- diff --git a/classes/class_proceduralsky.rst b/classes/class_proceduralsky.rst index 4300af077..b9513a4f4 100644 --- a/classes/class_proceduralsky.rst +++ b/classes/class_proceduralsky.rst @@ -88,23 +88,71 @@ Member Functions Member Variables ---------------- + .. _class_ProceduralSky_ground_bottom_color: + - :ref:`Color` **ground_bottom_color** + + .. _class_ProceduralSky_ground_curve: + - :ref:`float` **ground_curve** + + .. _class_ProceduralSky_ground_energy: + - :ref:`float` **ground_energy** + + .. _class_ProceduralSky_ground_horizon_color: + - :ref:`Color` **ground_horizon_color** + + .. _class_ProceduralSky_sky_curve: + - :ref:`float` **sky_curve** + + .. _class_ProceduralSky_sky_energy: + - :ref:`float` **sky_energy** + + .. _class_ProceduralSky_sky_horizon_color: + - :ref:`Color` **sky_horizon_color** + + .. _class_ProceduralSky_sky_top_color: + - :ref:`Color` **sky_top_color** + + .. _class_ProceduralSky_sun_angle_max: + - :ref:`float` **sun_angle_max** + + .. _class_ProceduralSky_sun_angle_min: + - :ref:`float` **sun_angle_min** + + .. _class_ProceduralSky_sun_color: + - :ref:`Color` **sun_color** + + .. _class_ProceduralSky_sun_curve: + - :ref:`float` **sun_curve** + + .. _class_ProceduralSky_sun_energy: + - :ref:`float` **sun_energy** + + .. _class_ProceduralSky_sun_latitude: + - :ref:`float` **sun_latitude** + + .. _class_ProceduralSky_sun_longitude: + - :ref:`float` **sun_longitude** + + .. _class_ProceduralSky_texture_size: + - :ref:`int` **texture_size** + Numeric Constants ----------------- diff --git a/classes/class_progressbar.rst b/classes/class_progressbar.rst index c6ef96ddc..dfa128735 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_ProgressBar_percent_visible: + - :ref:`bool` **percent_visible** + Description ----------- diff --git a/classes/class_proximitygroup.rst b/classes/class_proximitygroup.rst index 7951db089..de8962b0f 100644 --- a/classes/class_proximitygroup.rst +++ b/classes/class_proximitygroup.rst @@ -34,14 +34,19 @@ Member Functions Signals ------- +.. _class_ProximityGroup_broadcast: + - **broadcast** **(** :ref:`String` name, :ref:`Array` parameters **)** Member Variables ---------------- + .. _class_ProximityGroup_grid_radius: + - :ref:`Vector3` **grid_radius** + Description ----------- diff --git a/classes/class_quat.rst b/classes/class_quat.rst index 355be276b..c8d2ea20f 100644 --- a/classes/class_quat.rst +++ b/classes/class_quat.rst @@ -48,11 +48,23 @@ Member Functions Member Variables ---------------- + .. _class_Quat_w: + - :ref:`float` **w** + + .. _class_Quat_x: + - :ref:`float` **x** + + .. _class_Quat_y: + - :ref:`float` **y** + + .. _class_Quat_z: + - :ref:`float` **z** + Description ----------- diff --git a/classes/class_range.rst b/classes/class_range.rst index c97f706bd..647cd9793 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -62,10 +62,14 @@ Member Functions Signals ------- +.. _class_Range_changed: + - **changed** **(** **)** This signal is emitted when min, max, range or step change. +.. _class_Range_value_changed: + - **value_changed** **(** :ref:`float` value **)** This signal is emitted when value changes. @@ -74,14 +78,35 @@ This signal is emitted when value changes. Member Variables ---------------- + .. _class_Range_exp_edit: + - :ref:`bool` **exp_edit** - If ``true`` and ``min_value`` is greater than 0, ``value`` will be represented exponentially rather than linearly. + + .. _class_Range_max_value: + - :ref:`float` **max_value** - Maximum value. Range is clamped if ``value`` is greater than ``max_value``. Default value: 100. + + .. _class_Range_min_value: + - :ref:`float` **min_value** - Minimum value. Range is clamped if ``value`` is less than ``min_value``. Default value: 0. + + .. _class_Range_page: + - :ref:`float` **page** - Page size. Used mainly for :ref:`ScrollBar`. ScrollBar's length is its size multiplied by ``page`` over the difference between ``min_value`` and ``max_value``. + + .. _class_Range_rounded: + - :ref:`bool` **rounded** - If ``true``, ``value`` will always be rounded to the nearest integer. + + .. _class_Range_step: + - :ref:`float` **step** - If greater than 0, ``value`` will always be rounded to a multiple of ``step``. If ``rounded`` is also ``true``, ``value`` will first be rounded to a multiple of ``step`` then rounded to the nearest integer. + + .. _class_Range_value: + - :ref:`float` **value** - Range's current value. + Description ----------- diff --git a/classes/class_raycast.rst b/classes/class_raycast.rst index bbe88e0c5..45c78c618 100644 --- a/classes/class_raycast.rst +++ b/classes/class_raycast.rst @@ -62,9 +62,20 @@ Member Functions Member Variables ---------------- + .. _class_RayCast_cast_to: + - :ref:`Vector3` **cast_to** - The ray's destination point, relative to the RayCast's ``position``. + + .. _class_RayCast_collision_layer: + - :ref:`int` **collision_layer** - The RayCast's collision layer(s). Only bodies in the same collision layer(s) will be detected. + + .. _class_RayCast_enabled: + - :ref:`bool` **enabled** - If ``true``, collisions will be reported. Default value: ``false``. + + .. _class_RayCast_type_mask: + - :ref:`int` **type_mask** - Object types to detect using a logical sum (OR operation) of type constants defined in :ref:`Physics2DDirectSpaceState`. Example: @@ -73,6 +84,7 @@ Example: RayCast.type_mask = Physics2DDirectSpaceState.TYPE_MASK_STATIC_BODY | Physics2DDirectSpaceState.TYPE_MASK_KINEMATIC_BODY + Description ----------- diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index 9197d79f7..604c62443 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -66,10 +66,24 @@ Member Functions Member Variables ---------------- + .. _class_RayCast2D_cast_to: + - :ref:`Vector2` **cast_to** - The ray's destination point, relative to the RayCast's ``position``. + + .. _class_RayCast2D_collision_layer: + - :ref:`int` **collision_layer** - The RayCast2D's collision layer(s). Only bodies in the same collision layer(s) will be detected. + + .. _class_RayCast2D_enabled: + - :ref:`bool` **enabled** - If ``true``, collisions will be reported. Default value: ``false``. + + .. _class_RayCast2D_exclude_parent: + - :ref:`bool` **exclude_parent** - If ``true``, the parent node will be excluded from collision detection. Default value: ``true``. + + .. _class_RayCast2D_type_mask: + - :ref:`int` **type_mask** - Object types to detect using a logical sum (OR operation) of type constants defined in :ref:`Physics2DDirectSpaceState`. Example: @@ -78,6 +92,7 @@ Example: RayCast.type_mask = Physics2DDirectSpaceState.TYPE_MASK_STATIC_BODY | Physics2DDirectSpaceState.TYPE_MASK_KINEMATIC_BODY + Description ----------- diff --git a/classes/class_rayshape.rst b/classes/class_rayshape.rst index 88e5acaf9..850fea39f 100644 --- a/classes/class_rayshape.rst +++ b/classes/class_rayshape.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_RayShape_length: + - :ref:`float` **length** - The ray's length. + Description ----------- diff --git a/classes/class_rayshape2d.rst b/classes/class_rayshape2d.rst index 23161045a..d89c356f7 100644 --- a/classes/class_rayshape2d.rst +++ b/classes/class_rayshape2d.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_RayShape2D_length: + - :ref:`float` **length** - The ray's length. + Description ----------- diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index c5ef957d8..ce22442f3 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -48,10 +48,19 @@ Member Functions Member Variables ---------------- + .. _class_Rect2_end: + - :ref:`Vector2` **end** - Ending corner. + + .. _class_Rect2_position: + - :ref:`Vector2` **position** - Position (starting corner). + + .. _class_Rect2_size: + - :ref:`Vector2` **size** - Size from position to end. + Description ----------- diff --git a/classes/class_rect3.rst b/classes/class_rect3.rst index c809a66a4..81158c0ed 100644 --- a/classes/class_rect3.rst +++ b/classes/class_rect3.rst @@ -64,10 +64,19 @@ Member Functions Member Variables ---------------- + .. _class_Rect3_end: + - :ref:`Vector3` **end** - Ending corner. + + .. _class_Rect3_position: + - :ref:`Vector3` **position** + + .. _class_Rect3_size: + - :ref:`Vector3` **size** - Size from position to end. + Description ----------- diff --git a/classes/class_rectangleshape2d.rst b/classes/class_rectangleshape2d.rst index aceb2c11f..fd45152d0 100644 --- a/classes/class_rectangleshape2d.rst +++ b/classes/class_rectangleshape2d.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_RectangleShape2D_extents: + - :ref:`Vector2` **extents** - The rectangle's half extents. The width and height of this shape is twice the half extents. + Description ----------- diff --git a/classes/class_reflectionprobe.rst b/classes/class_reflectionprobe.rst index e24c855e8..6f3fb9843 100644 --- a/classes/class_reflectionprobe.rst +++ b/classes/class_reflectionprobe.rst @@ -72,19 +72,55 @@ Member Functions Member Variables ---------------- + .. _class_ReflectionProbe_box_projection: + - :ref:`bool` **box_projection** + + .. _class_ReflectionProbe_cull_mask: + - :ref:`int` **cull_mask** + + .. _class_ReflectionProbe_enable_shadows: + - :ref:`bool` **enable_shadows** + + .. _class_ReflectionProbe_extents: + - :ref:`Vector3` **extents** + + .. _class_ReflectionProbe_intensity: + - :ref:`float` **intensity** + + .. _class_ReflectionProbe_interior_ambient_color: + - :ref:`Color` **interior_ambient_color** + + .. _class_ReflectionProbe_interior_ambient_contrib: + - :ref:`float` **interior_ambient_contrib** + + .. _class_ReflectionProbe_interior_ambient_energy: + - :ref:`float` **interior_ambient_energy** + + .. _class_ReflectionProbe_interior_enable: + - :ref:`bool` **interior_enable** + + .. _class_ReflectionProbe_max_distance: + - :ref:`float` **max_distance** + + .. _class_ReflectionProbe_origin_offset: + - :ref:`Vector3` **origin_offset** + + .. _class_ReflectionProbe_update_mode: + - :ref:`int` **update_mode** + Numeric Constants ----------------- diff --git a/classes/class_remotetransform.rst b/classes/class_remotetransform.rst index 7e09f47df..dd0540676 100644 --- a/classes/class_remotetransform.rst +++ b/classes/class_remotetransform.rst @@ -44,12 +44,27 @@ Member Functions Member Variables ---------------- + .. _class_RemoteTransform_remote_path: + - :ref:`NodePath` **remote_path** + + .. _class_RemoteTransform_update_position: + - :ref:`bool` **update_position** + + .. _class_RemoteTransform_update_rotation: + - :ref:`bool` **update_rotation** + + .. _class_RemoteTransform_update_scale: + - :ref:`bool` **update_scale** + + .. _class_RemoteTransform_use_global_coordinates: + - :ref:`bool` **use_global_coordinates** + Member Function Description --------------------------- diff --git a/classes/class_remotetransform2d.rst b/classes/class_remotetransform2d.rst index 12f28bb40..60e8b5954 100644 --- a/classes/class_remotetransform2d.rst +++ b/classes/class_remotetransform2d.rst @@ -44,12 +44,27 @@ Member Functions Member Variables ---------------- + .. _class_RemoteTransform2D_remote_path: + - :ref:`NodePath` **remote_path** + + .. _class_RemoteTransform2D_update_position: + - :ref:`bool` **update_position** + + .. _class_RemoteTransform2D_update_rotation: + - :ref:`bool` **update_rotation** + + .. _class_RemoteTransform2D_update_scale: + - :ref:`bool` **update_scale** + + .. _class_RemoteTransform2D_use_global_coordinates: + - :ref:`bool` **use_global_coordinates** + Member Function Description --------------------------- diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 9141fe6b0..3585d6d5c 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -50,16 +50,27 @@ Member Functions Signals ------- +.. _class_Resource_changed: + - **changed** **(** **)** Member Variables ---------------- + .. _class_Resource_resource_local_to_scene: + - :ref:`bool` **resource_local_to_scene** + + .. _class_Resource_resource_name: + - :ref:`String` **resource_name** + + .. _class_Resource_resource_path: + - :ref:`String` **resource_path** + Description ----------- diff --git a/classes/class_resourcepreloader.rst b/classes/class_resourcepreloader.rst index dda0983cc..644c0910c 100644 --- a/classes/class_resourcepreloader.rst +++ b/classes/class_resourcepreloader.rst @@ -36,8 +36,11 @@ Member Functions Member Variables ---------------- + .. _class_ResourcePreloader_resources: + - :ref:`Array` **resources** + Description ----------- diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 7d512a15c..2b90563a1 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -114,18 +114,35 @@ Member Functions Signals ------- +.. _class_RichTextLabel_meta_clicked: + - **meta_clicked** **(** :ref:`Nil` meta **)** Member Variables ---------------- + .. _class_RichTextLabel_bbcode_enabled: + - :ref:`bool` **bbcode_enabled** + + .. _class_RichTextLabel_bbcode_text: + - :ref:`String` **bbcode_text** + + .. _class_RichTextLabel_override_selected_font_color: + - :ref:`bool` **override_selected_font_color** + + .. _class_RichTextLabel_percent_visible: + - :ref:`float` **percent_visible** + + .. _class_RichTextLabel_visible_characters: + - :ref:`int` **visible_characters** + Numeric Constants ----------------- diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index 8e5d235e4..9ef60c781 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -100,26 +100,36 @@ Member Functions Signals ------- +.. _class_RigidBody_body_entered: + - **body_entered** **(** :ref:`Object` body **)** Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. +.. _class_RigidBody_body_exited: + - **body_exited** **(** :ref:`Object` body **)** Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. +.. _class_RigidBody_body_shape_entered: + - **body_shape_entered** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. This signal not only receives the body that collided with this one, but also its :ref:`RID` (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body collided with. +.. _class_RigidBody_body_shape_exited: + - **body_shape_exited** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. This signal not only receives the body that stopped colliding with this one, but also its :ref:`RID` (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body stopped colliding with. +.. _class_RigidBody_sleeping_state_changed: + - **sleeping_state_changed** **(** **)** Emitted when the body changes its sleeping state. Either by sleeping or waking up. @@ -128,26 +138,77 @@ Emitted when the body changes its sleeping state. Either by sleeping or waking u Member Variables ---------------- + .. _class_RigidBody_angular_damp: + - :ref:`float` **angular_damp** - Damps RigidBody's rotational forces. + + .. _class_RigidBody_angular_velocity: + - :ref:`Vector3` **angular_velocity** - RigidBody's rotational velocity. + + .. _class_RigidBody_axis_lock: + - :ref:`int` **axis_lock** - Locks the rotational forces to a particular axis, preventing rotations on other axes. + + .. _class_RigidBody_bounce: + - :ref:`float` **bounce** - RigidBody's bounciness. + + .. _class_RigidBody_can_sleep: + - :ref:`bool` **can_sleep** - If ``true`` the RigidBody will not calculate forces and will act as a static body while there is no movement. It will wake up when forces are applied through other collisions or when the ``apply_impulse`` method is used. + + .. _class_RigidBody_contact_monitor: + - :ref:`bool` **contact_monitor** - If true, the RigidBody will emit signals when it collides with another RigidBody. + + .. _class_RigidBody_contacts_reported: + - :ref:`int` **contacts_reported** - The maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. + + .. _class_RigidBody_continuous_cd: + - :ref:`bool` **continuous_cd** - If ``true`` continuous collision detection is used. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. Continuous collision detection is more precise, and misses less impacts by small, fast-moving objects. Not using continuous collision detection is faster to compute, but can miss small, fast-moving objects. + + .. _class_RigidBody_custom_integrator: + - :ref:`bool` **custom_integrator** - If ``true`` internal force integration will be disabled (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the :ref:`_integrate_forces` function, if defined. + + .. _class_RigidBody_friction: + - :ref:`float` **friction** - The body friction, from 0 (frictionless) to 1 (max friction). + + .. _class_RigidBody_gravity_scale: + - :ref:`float` **gravity_scale** - This is multiplied by the global 3D gravity setting found in "Project > Project Settings > Physics > 3d" to produce RigidBody's gravity. E.g. a value of 1 will be normal gravity, 2 will apply double gravity, and 0.5 will apply half gravity to this object. + + .. _class_RigidBody_linear_damp: + - :ref:`float` **linear_damp** - RigidBody's linear damp. Default value: -1, cannot be less than -1. If this value is different from -1, any linear damp derived from the world or areas will be overridden. + + .. _class_RigidBody_linear_velocity: + - :ref:`Vector3` **linear_velocity** - RigidBody's linear velocity. Can be used sporadically, but **DON'T SET THIS IN EVERY FRAME**, because physics may run in another thread and runs at a different granularity. Use :ref:`_integrate_forces` as your process loop for precise control of the body state. + + .. _class_RigidBody_mass: + - :ref:`float` **mass** - RigidBody's mass. + + .. _class_RigidBody_mode: + - :ref:`int` **mode** - The body mode from the MODE\_\* enum. Modes include: MODE_STATIC, MODE_KINEMATIC, MODE_RIGID, and MODE_CHARACTER. + + .. _class_RigidBody_sleeping: + - :ref:`bool` **sleeping** - If ``true`` RigidBody is sleeping and will not calculate forces until woken up by a collision or the ``apply_impulse`` method. + + .. _class_RigidBody_weight: + - :ref:`float` **weight** - RigidBody's weight based on its mass and the global 3D gravity. Global values are set in "Project > Project Settings > Physics > 3d". + Numeric Constants ----------------- diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index 709500499..7b1c914e5 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -112,49 +112,107 @@ Member Functions Signals ------- +.. _class_RigidBody2D_body_entered: + - **body_entered** **(** :ref:`Object` body **)** -Emitted when a body enters into contact with this one. member contact_monitor must be ``true`` and member contacts_reported greater than ``0``. +Emitted when a body enters into contact with this one. :ref:`contact_monitor` must be ``true`` and :ref:`contacts_reported` greater than ``0``. + +.. _class_RigidBody2D_body_exited: - **body_exited** **(** :ref:`Object` body **)** -Emitted when a body exits contact with this one. member contact_monitor must be ``true`` and member contacts_reported greater than ``0``. +Emitted when a body exits contact with this one. :ref:`contact_monitor` must be ``true`` and :ref:`contacts_reported` greater than ``0``. + +.. _class_RigidBody2D_body_shape_entered: - **body_shape_entered** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** -Emitted when a body enters into contact with this one. Reports colliding shape information. See :ref:`CollisionObject2D` for shape index information. member contact_monitor must be ``true`` and member contacts_reported greater than ``0``. +Emitted when a body enters into contact with this one. Reports colliding shape information. See :ref:`CollisionObject2D` for shape index information. :ref:`contact_monitor` must be ``true`` and :ref:`contacts_reported` greater than ``0``. + +.. _class_RigidBody2D_body_shape_exited: - **body_shape_exited** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** -Emitted when a body shape exits contact with this one. Reports colliding shape information. See :ref:`CollisionObject2D` for shape index information. member contact_monitor must be ``true`` and member contacts_reported greater than ``0``. +Emitted when a body shape exits contact with this one. Reports colliding shape information. See :ref:`CollisionObject2D` for shape index information. :ref:`contact_monitor` must be ``true`` and :ref:`contacts_reported` greater than ``0``. + +.. _class_RigidBody2D_sleeping_state_changed: - **sleeping_state_changed** **(** **)** -Emitted when member sleeping changes. +Emitted when :ref:`sleeping` changes. Member Variables ---------------- -- :ref:`float` **angular_damp** - Damps the body's member angular_velocity. If ``-1`` the body will use the "Default Angular Damp" in "Project > Project Settings > Physics > 2d". Default value: ``-1``. + .. _class_RigidBody2D_angular_damp: + +- :ref:`float` **angular_damp** - Damps the body's :ref:`angular_velocity`. If ``-1`` the body will use the "Default Angular Damp" in "Project > Project Settings > Physics > 2d". Default value: ``-1``. + + .. _class_RigidBody2D_angular_velocity: + - :ref:`float` **angular_velocity** - The body's rotational velocity. + + .. _class_RigidBody2D_bounce: + - :ref:`float` **bounce** - The body's bounciness. Default value: ``0``. + + .. _class_RigidBody2D_can_sleep: + - :ref:`bool` **can_sleep** - If ``true`` the body will not calculate forces and will act as a static body if there is no movement. The body will wake up when other forces are applied via collisions or by using :ref:`apply_impulse` or :ref:`add_force`. Default value: ``true``. -- :ref:`bool` **contact_monitor** - If ``true`` the body will emit signals when it collides with another RigidBody2D. See also member contacts_reported. Default value: ``false``. + + .. _class_RigidBody2D_contact_monitor: + +- :ref:`bool` **contact_monitor** - If ``true`` the body will emit signals when it collides with another RigidBody2D. See also :ref:`contacts_reported`. Default value: ``false``. + + .. _class_RigidBody2D_contacts_reported: + - :ref:`int` **contacts_reported** - The maximum number of contacts to report. Default value: ``0``. + + .. _class_RigidBody2D_continuous_cd: + - :ref:`int` **continuous_cd** - Continuous collision detection mode. Default value: ``CCD_MODE_DISABLED``. Continuous collision detection tries to predict where a moving body will collide instead of moving it and correcting its movement after collision. Continuous collision detection is slower, but more precise and misses fewer collisions with small, fast-moving objects. Raycasting and shapecasting methods are available. See ``CCD_MODE\_`` constants for details. + + .. _class_RigidBody2D_custom_integrator: + - :ref:`bool` **custom_integrator** - If ``true`` internal force integration is disabled for this body. Aside from collision response, the body will only move as determined by the :ref:`_integrate_forces` function. + + .. _class_RigidBody2D_friction: + - :ref:`float` **friction** - The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction). Default value: ``1``. + + .. _class_RigidBody2D_gravity_scale: + - :ref:`float` **gravity_scale** - Multiplies the gravity applied to the body. The body's gravity is calculated from the "Default Gravity" value in "Project > Project Settings > Physics > 2d" and/or any additional gravity vector applied by :ref:`Area2D`\ s. Default value: ``1``. -- :ref:`float` **linear_damp** - Damps the body's member linear_velocity. If ``-1`` the body will use the "Default Linear Damp" in "Project > Project Settings > Physics > 2d". Default value: ``-1``. + + .. _class_RigidBody2D_linear_damp: + +- :ref:`float` **linear_damp** - Damps the body's :ref:`linear_velocity`. If ``-1`` the body will use the "Default Linear Damp" in "Project > Project Settings > Physics > 2d". Default value: ``-1``. + + .. _class_RigidBody2D_linear_velocity: + - :ref:`Vector2` **linear_velocity** - The body's linear velocity. + + .. _class_RigidBody2D_mass: + - :ref:`float` **mass** - The body's mass. Default value: ``1``. + + .. _class_RigidBody2D_mode: + - :ref:`int` **mode** - The body's mode. See ``MODE\_\*`` constants. Default value: ``MODE_RIGID``. + + .. _class_RigidBody2D_sleeping: + - :ref:`bool` **sleeping** - If ``true`` the body is sleeping and will not calculate forces until woken up by a collision or by using :ref:`apply_impulse` or :ref:`add_force`. + + .. _class_RigidBody2D_weight: + - :ref:`float` **weight** - The body's weight based on its mass and the "Default Gravity" value in "Project > Project Settings > Physics > 2d". + Numeric Constants ----------------- @@ -171,7 +229,7 @@ Description This node implements simulated 2D physics. You do not control a RigidBody2D directly. Instead you apply forces to it (gravity, impulses, etc.) and the physics simulation calculates the resulting movement based on its mass, friction, and other physical properties. -A RigidBody2D has 4 behavior modes (see member mode): +A RigidBody2D has 4 behavior modes (see :ref:`mode`): - **Rigid**: The body behaves as a physical object. It collides with other bodies and responds to forces applied to it. This is the default mode. @@ -183,7 +241,7 @@ A RigidBody2D has 4 behavior modes (see member mode): **Note:** You should not change a RigidBody2D's ``position`` or ``linear_velocity`` every frame or even very often. If you need to directly affect the body's state, use :ref:`_integrate_forces`, which allows you to directly access the physics state. -If you need to override the default physics behavior, you can write a custom force integration. See member custom_integrator. +If you need to override the default physics behavior, you can write a custom force integration. See :ref:`custom_integrator`. Member Function Description --------------------------- @@ -192,7 +250,7 @@ Member Function Description - void **_integrate_forces** **(** :ref:`Physics2DDirectBodyState` state **)** virtual -Allows you to read and safely modify the simulation state for the object. Use this instead of Node._physics_process if you need to directly change the body's ``position`` or other physics properties. By default it works in addition to the usual physics behavior, but member custom_integrator allows you to disable the default behavior and write custom force integration for a body. +Allows you to read and safely modify the simulation state for the object. Use this instead of Node._physics_process if you need to directly change the body's ``position`` or other physics properties. By default it works in addition to the usual physics behavior, but :ref:`custom_integrator` allows you to disable the default behavior and write custom force integration for a body. .. _class_RigidBody2D_add_force: @@ -240,7 +298,7 @@ Return the body bounciness. - :ref:`Array` **get_colliding_bodies** **(** **)** const -Returns a list of the bodies colliding with this one. Use member contacts_reported to set the maximum number reported. You must also set member contact_monitor to ``true``. +Returns a list of the bodies colliding with this one. Use :ref:`contacts_reported` to set the maximum number reported. You must also set :ref:`contact_monitor` to ``true``. .. _class_RigidBody2D_get_continuous_collision_detection_mode: diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index e3fddadc2..334a624d5 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -102,30 +102,56 @@ Member Functions Signals ------- +.. _class_SceneTree_connected_to_server: + - **connected_to_server** **(** **)** +.. _class_SceneTree_connection_failed: + - **connection_failed** **(** **)** +.. _class_SceneTree_files_dropped: + - **files_dropped** **(** :ref:`PoolStringArray` files, :ref:`int` screen **)** +.. _class_SceneTree_idle_frame: + - **idle_frame** **(** **)** +.. _class_SceneTree_network_peer_connected: + - **network_peer_connected** **(** :ref:`int` id **)** +.. _class_SceneTree_network_peer_disconnected: + - **network_peer_disconnected** **(** :ref:`int` id **)** +.. _class_SceneTree_node_added: + - **node_added** **(** :ref:`Object` node **)** +.. _class_SceneTree_node_configuration_warning_changed: + - **node_configuration_warning_changed** **(** :ref:`Object` node **)** +.. _class_SceneTree_node_removed: + - **node_removed** **(** :ref:`Object` node **)** +.. _class_SceneTree_physics_frame: + - **physics_frame** **(** **)** +.. _class_SceneTree_screen_resized: + - **screen_resized** **(** **)** +.. _class_SceneTree_server_disconnected: + - **server_disconnected** **(** **)** +.. _class_SceneTree_tree_changed: + - **tree_changed** **(** **)** diff --git a/classes/class_scenetreetimer.rst b/classes/class_scenetreetimer.rst index 4da9fdd3c..01bf1e270 100644 --- a/classes/class_scenetreetimer.rst +++ b/classes/class_scenetreetimer.rst @@ -28,6 +28,8 @@ Member Functions Signals ------- +.. _class_SceneTreeTimer_timeout: + - **timeout** **(** **)** diff --git a/classes/class_scripteditor.rst b/classes/class_scripteditor.rst index 6e4e9eb5e..d3ad88be5 100644 --- a/classes/class_scripteditor.rst +++ b/classes/class_scripteditor.rst @@ -28,10 +28,14 @@ Member Functions Signals ------- +.. _class_ScriptEditor_editor_script_changed: + - **editor_script_changed** **(** :ref:`Object` script **)** Emitted when user changed active script. Argument is a freshly activated :ref:`Script`. +.. _class_ScriptEditor_script_close: + - **script_close** **(** :ref:`Object` script **)** Emitted when editor is about to close the active script. Argument is a :ref:`Script` that is going to be closed. diff --git a/classes/class_scrollbar.rst b/classes/class_scrollbar.rst index e1c1828a7..d2901f188 100644 --- a/classes/class_scrollbar.rst +++ b/classes/class_scrollbar.rst @@ -30,14 +30,19 @@ Member Functions Signals ------- +.. _class_ScrollBar_scrolling: + - **scrolling** **(** **)** Member Variables ---------------- + .. _class_ScrollBar_custom_step: + - :ref:`float` **custom_step** + Description ----------- diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index 524719d5b..5c36ae8f6 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -40,9 +40,15 @@ Member Functions Member Variables ---------------- + .. _class_ScrollContainer_scroll_horizontal: + - :ref:`bool` **scroll_horizontal** + + .. _class_ScrollContainer_scroll_vertical: + - :ref:`bool` **scroll_vertical** + Description ----------- diff --git a/classes/class_segmentshape2d.rst b/classes/class_segmentshape2d.rst index 15f9ffb9e..0aeafe6fb 100644 --- a/classes/class_segmentshape2d.rst +++ b/classes/class_segmentshape2d.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_SegmentShape2D_a: + - :ref:`Vector2` **a** - The segment's first point position. + + .. _class_SegmentShape2D_b: + - :ref:`Vector2` **b** - The segment's second point position. + Description ----------- diff --git a/classes/class_shader.rst b/classes/class_shader.rst index 6a5fb3fd1..65b9c9dcd 100644 --- a/classes/class_shader.rst +++ b/classes/class_shader.rst @@ -36,8 +36,11 @@ Member Functions Member Variables ---------------- + .. _class_Shader_code: + - :ref:`String` **code** + Numeric Constants ----------------- diff --git a/classes/class_shape2d.rst b/classes/class_shape2d.rst index 993502b46..7ae0adc67 100644 --- a/classes/class_shape2d.rst +++ b/classes/class_shape2d.rst @@ -38,8 +38,11 @@ Member Functions Member Variables ---------------- + .. _class_Shape2D_custom_solver_bias: + - :ref:`float` **custom_solver_bias** + Description ----------- diff --git a/classes/class_shortcut.rst b/classes/class_shortcut.rst index 40c96602a..07a00b814 100644 --- a/classes/class_shortcut.rst +++ b/classes/class_shortcut.rst @@ -34,8 +34,11 @@ Member Functions Member Variables ---------------- + .. _class_ShortCut_shortcut: + - :ref:`InputEvent` **shortcut** + Member Function Description --------------------------- diff --git a/classes/class_sky.rst b/classes/class_sky.rst index 1ffe2deb4..8f62f76ad 100644 --- a/classes/class_sky.rst +++ b/classes/class_sky.rst @@ -30,8 +30,11 @@ Member Functions Member Variables ---------------- + .. _class_Sky_radiance_size: + - :ref:`int` **radiance_size** + Numeric Constants ----------------- diff --git a/classes/class_slider.rst b/classes/class_slider.rst index 3e402abb1..4527aebb0 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -38,11 +38,23 @@ Member Functions Member Variables ---------------- + .. _class_Slider_editable: + - :ref:`bool` **editable** + + .. _class_Slider_focus_mode: + - :ref:`int` **focus_mode** + + .. _class_Slider_tick_count: + - :ref:`int` **tick_count** + + .. _class_Slider_ticks_on_borders: + - :ref:`bool` **ticks_on_borders** + Description ----------- diff --git a/classes/class_sliderjoint.rst b/classes/class_sliderjoint.rst index cc70ac1cd..88cddd961 100644 --- a/classes/class_sliderjoint.rst +++ b/classes/class_sliderjoint.rst @@ -28,35 +28,101 @@ Member Functions Member Variables ---------------- + .. _class_SliderJoint_angular_limit/damping: + - :ref:`float` **angular_limit/damping** - The amount of damping of the rotation when the limit is surpassed. A lower damping value allows a rotation initiated by body A to travel to body B slower. + + .. _class_SliderJoint_angular_limit/lower_angle: + - :ref:`float` **angular_limit/lower_angle** - The lower limit of rotation in the slider. + + .. _class_SliderJoint_angular_limit/restitution: + - :ref:`float` **angular_limit/restitution** - The amount of restitution of the rotation when the limit is surpassed. Does not affect damping. + + .. _class_SliderJoint_angular_limit/softness: + - :ref:`float` **angular_limit/softness** - A factor applied to the all rotation once the limit is surpassed. Makes all rotation slower when between 0 and 1. + + .. _class_SliderJoint_angular_limit/upper_angle: + - :ref:`float` **angular_limit/upper_angle** - The upper limit of rotation in the slider. + + .. _class_SliderJoint_angular_motion/damping: + - :ref:`float` **angular_motion/damping** - The amount of damping of the rotation in the limits. + + .. _class_SliderJoint_angular_motion/restitution: + - :ref:`float` **angular_motion/restitution** - The amount of restitution of the rotation in the limits. + + .. _class_SliderJoint_angular_motion/softness: + - :ref:`float` **angular_motion/softness** - A factor applied to the all rotation in the limits. + + .. _class_SliderJoint_angular_ortho/damping: + - :ref:`float` **angular_ortho/damping** - The amount of damping of the rotation across axes orthogonal to the slider. + + .. _class_SliderJoint_angular_ortho/restitution: + - :ref:`float` **angular_ortho/restitution** - The amount of restitution of the rotation across axes orthogonal to the slider. + + .. _class_SliderJoint_angular_ortho/softness: + - :ref:`float` **angular_ortho/softness** - A factor applied to the all rotation across axes orthogonal to the slider. -- :ref:`float` **linear_limit/damping** - The amount of damping that happens once the limit defined by member linear_limit/lower_distance and member linear_limit/upper_distance is surpassed. + + .. _class_SliderJoint_linear_limit/damping: + +- :ref:`float` **linear_limit/damping** - The amount of damping that happens once the limit defined by :ref:`linear_limit/lower_distance` and :ref:`linear_limit/upper_distance` is surpassed. + + .. _class_SliderJoint_linear_limit/lower_distance: + - :ref:`float` **linear_limit/lower_distance** - The minimum difference between the pivot points on their x-axis before damping happens. + + .. _class_SliderJoint_linear_limit/restitution: + - :ref:`float` **linear_limit/restitution** - The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost. + + .. _class_SliderJoint_linear_limit/softness: + - :ref:`float` **linear_limit/softness** - A factor applied to the movement accross the slider axis once the limits get surpassed. The lower, the slower the movement. + + .. _class_SliderJoint_linear_limit/upper_distance: + - :ref:`float` **linear_limit/upper_distance** - The maximum difference between the pivot points on their x-axis before damping happens. + + .. _class_SliderJoint_linear_motion/damping: + - :ref:`float` **linear_motion/damping** - The amount of damping inside the slider limits. + + .. _class_SliderJoint_linear_motion/restitution: + - :ref:`float` **linear_motion/restitution** - The amount of restitution inside the slider limits. + + .. _class_SliderJoint_linear_motion/softness: + - :ref:`float` **linear_motion/softness** - A factor applied to the movement accross the slider axis as long as the slider is in the limits. The lower, the slower the movement. + + .. _class_SliderJoint_linear_ortho/damping: + - :ref:`float` **linear_ortho/damping** - The amount of damping when movement is accross axes orthogonal to the slider. + + .. _class_SliderJoint_linear_ortho/restitution: + - :ref:`float` **linear_ortho/restitution** - The amount of restitution when movement is accross axes orthogonal to the slider. + + .. _class_SliderJoint_linear_ortho/softness: + - :ref:`float` **linear_ortho/softness** - A factor applied to the movement accross axes orthogonal to the slider. + Numeric Constants ----------------- diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index 4eb4f197a..835f8cc76 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -110,6 +110,8 @@ Member Functions Signals ------- +.. _class_Spatial_visibility_changed: + - **visibility_changed** **(** **)** Emitted when node visibility changes. @@ -118,14 +120,35 @@ Emitted when node visibility changes. Member Variables ---------------- + .. _class_Spatial_global_transform: + - :ref:`Transform` **global_transform** - World space (global) :ref:`Transform` of this node. + + .. _class_Spatial_rotation: + - :ref:`Vector3` **rotation** - Local euler rotation in radians of this node. + + .. _class_Spatial_rotation_deg: + - :ref:`Vector3` **rotation_deg** - Local euler rotation in degrees of this node. + + .. _class_Spatial_scale: + - :ref:`Vector3` **scale** - Local scale of this node. + + .. _class_Spatial_transform: + - :ref:`Transform` **transform** - Local space :ref:`Transform` of this node. + + .. _class_Spatial_translation: + - :ref:`Vector3` **translation** - Local translation of this node. + + .. _class_Spatial_visible: + - :ref:`bool` **visible** - Visibility of this node. Toggles if this node is rendered. + Numeric Constants ----------------- diff --git a/classes/class_spatialmaterial.rst b/classes/class_spatialmaterial.rst index 3d1c0e8bb..92fa78075 100644 --- a/classes/class_spatialmaterial.rst +++ b/classes/class_spatialmaterial.rst @@ -240,98 +240,371 @@ Member Functions Member Variables ---------------- + .. _class_SpatialMaterial_albedo_color: + - :ref:`Color` **albedo_color** + + .. _class_SpatialMaterial_albedo_texture: + - :ref:`Texture` **albedo_texture** + + .. _class_SpatialMaterial_anisotropy: + - :ref:`float` **anisotropy** + + .. _class_SpatialMaterial_anisotropy_enabled: + - :ref:`bool` **anisotropy_enabled** + + .. _class_SpatialMaterial_anisotropy_flowmap: + - :ref:`Texture` **anisotropy_flowmap** + + .. _class_SpatialMaterial_ao_enabled: + - :ref:`bool` **ao_enabled** + + .. _class_SpatialMaterial_ao_light_affect: + - :ref:`float` **ao_light_affect** + + .. _class_SpatialMaterial_ao_on_uv2: + - :ref:`bool` **ao_on_uv2** + + .. _class_SpatialMaterial_ao_texture: + - :ref:`Texture` **ao_texture** + + .. _class_SpatialMaterial_ao_texture_channel: + - :ref:`int` **ao_texture_channel** + + .. _class_SpatialMaterial_clearcoat: + - :ref:`float` **clearcoat** + + .. _class_SpatialMaterial_clearcoat_enabled: + - :ref:`bool` **clearcoat_enabled** + + .. _class_SpatialMaterial_clearcoat_gloss: + - :ref:`float` **clearcoat_gloss** + + .. _class_SpatialMaterial_clearcoat_texture: + - :ref:`Texture` **clearcoat_texture** + + .. _class_SpatialMaterial_depth_deep_parallax: + - :ref:`bool` **depth_deep_parallax** + + .. _class_SpatialMaterial_depth_enabled: + - :ref:`bool` **depth_enabled** + + .. _class_SpatialMaterial_depth_max_layers: + - :ref:`int` **depth_max_layers** + + .. _class_SpatialMaterial_depth_min_layers: + - :ref:`int` **depth_min_layers** + + .. _class_SpatialMaterial_depth_scale: + - :ref:`float` **depth_scale** + + .. _class_SpatialMaterial_depth_texture: + - :ref:`Texture` **depth_texture** + + .. _class_SpatialMaterial_detail_albedo: + - :ref:`Texture` **detail_albedo** + + .. _class_SpatialMaterial_detail_blend_mode: + - :ref:`int` **detail_blend_mode** + + .. _class_SpatialMaterial_detail_enabled: + - :ref:`bool` **detail_enabled** + + .. _class_SpatialMaterial_detail_mask: + - :ref:`Texture` **detail_mask** + + .. _class_SpatialMaterial_detail_normal: + - :ref:`Texture` **detail_normal** + + .. _class_SpatialMaterial_detail_uv_layer: + - :ref:`int` **detail_uv_layer** + + .. _class_SpatialMaterial_distance_fade_enable: + - :ref:`bool` **distance_fade_enable** + + .. _class_SpatialMaterial_distance_fade_max_distance: + - :ref:`float` **distance_fade_max_distance** + + .. _class_SpatialMaterial_distance_fade_min_distance: + - :ref:`float` **distance_fade_min_distance** + + .. _class_SpatialMaterial_emission: + - :ref:`Color` **emission** + + .. _class_SpatialMaterial_emission_enabled: + - :ref:`bool` **emission_enabled** + + .. _class_SpatialMaterial_emission_energy: + - :ref:`float` **emission_energy** + + .. _class_SpatialMaterial_emission_texture: + - :ref:`Texture` **emission_texture** + + .. _class_SpatialMaterial_flags_fixed_size: + - :ref:`bool` **flags_fixed_size** + + .. _class_SpatialMaterial_flags_no_depth_test: + - :ref:`bool` **flags_no_depth_test** + + .. _class_SpatialMaterial_flags_transparent: + - :ref:`bool` **flags_transparent** + + .. _class_SpatialMaterial_flags_unshaded: + - :ref:`bool` **flags_unshaded** + + .. _class_SpatialMaterial_flags_use_point_size: + - :ref:`bool` **flags_use_point_size** + + .. _class_SpatialMaterial_flags_vertex_lighting: + - :ref:`bool` **flags_vertex_lighting** + + .. _class_SpatialMaterial_flags_world_triplanar: + - :ref:`bool` **flags_world_triplanar** + + .. _class_SpatialMaterial_metallic: + - :ref:`float` **metallic** + + .. _class_SpatialMaterial_metallic_specular: + - :ref:`float` **metallic_specular** + + .. _class_SpatialMaterial_metallic_texture: + - :ref:`Texture` **metallic_texture** + + .. _class_SpatialMaterial_metallic_texture_channel: + - :ref:`int` **metallic_texture_channel** + + .. _class_SpatialMaterial_normal_enabled: + - :ref:`bool` **normal_enabled** + + .. _class_SpatialMaterial_normal_scale: + - :ref:`float` **normal_scale** + + .. _class_SpatialMaterial_normal_texture: + - :ref:`Texture` **normal_texture** + + .. _class_SpatialMaterial_params_alpha_scissor_threshold: + - :ref:`float` **params_alpha_scissor_threshold** + + .. _class_SpatialMaterial_params_billboard_mode: + - :ref:`int` **params_billboard_mode** + + .. _class_SpatialMaterial_params_blend_mode: + - :ref:`int` **params_blend_mode** + + .. _class_SpatialMaterial_params_cull_mode: + - :ref:`int` **params_cull_mode** + + .. _class_SpatialMaterial_params_depth_draw_mode: + - :ref:`int` **params_depth_draw_mode** + + .. _class_SpatialMaterial_params_diffuse_mode: + - :ref:`int` **params_diffuse_mode** + + .. _class_SpatialMaterial_params_grow: + - :ref:`bool` **params_grow** + + .. _class_SpatialMaterial_params_grow_amount: + - :ref:`float` **params_grow_amount** + + .. _class_SpatialMaterial_params_line_width: + - :ref:`float` **params_line_width** + + .. _class_SpatialMaterial_params_point_size: + - :ref:`float` **params_point_size** + + .. _class_SpatialMaterial_params_specular_mode: + - :ref:`int` **params_specular_mode** + + .. _class_SpatialMaterial_params_use_alpha_scissor: + - :ref:`bool` **params_use_alpha_scissor** + + .. _class_SpatialMaterial_particles_anim_h_frames: + - :ref:`int` **particles_anim_h_frames** + + .. _class_SpatialMaterial_particles_anim_loop: + - :ref:`int` **particles_anim_loop** + + .. _class_SpatialMaterial_particles_anim_v_frames: + - :ref:`int` **particles_anim_v_frames** + + .. _class_SpatialMaterial_proximity_fade_distance: + - :ref:`float` **proximity_fade_distance** + + .. _class_SpatialMaterial_proximity_fade_enable: + - :ref:`bool` **proximity_fade_enable** + + .. _class_SpatialMaterial_refraction_enabled: + - :ref:`bool` **refraction_enabled** + + .. _class_SpatialMaterial_refraction_scale: + - :ref:`float` **refraction_scale** + + .. _class_SpatialMaterial_refraction_texture: + - :ref:`Texture` **refraction_texture** + + .. _class_SpatialMaterial_refraction_texture_channel: + - :ref:`int` **refraction_texture_channel** + + .. _class_SpatialMaterial_rim: + - :ref:`float` **rim** + + .. _class_SpatialMaterial_rim_enabled: + - :ref:`bool` **rim_enabled** + + .. _class_SpatialMaterial_rim_texture: + - :ref:`Texture` **rim_texture** + + .. _class_SpatialMaterial_rim_tint: + - :ref:`float` **rim_tint** + + .. _class_SpatialMaterial_roughness: + - :ref:`float` **roughness** + + .. _class_SpatialMaterial_roughness_texture: + - :ref:`Texture` **roughness_texture** + + .. _class_SpatialMaterial_roughness_texture_channel: + - :ref:`int` **roughness_texture_channel** + + .. _class_SpatialMaterial_subsurf_scatter_enabled: + - :ref:`bool` **subsurf_scatter_enabled** + + .. _class_SpatialMaterial_subsurf_scatter_strength: + - :ref:`float` **subsurf_scatter_strength** + + .. _class_SpatialMaterial_subsurf_scatter_texture: + - :ref:`Texture` **subsurf_scatter_texture** + + .. _class_SpatialMaterial_transmission: + - :ref:`Color` **transmission** + + .. _class_SpatialMaterial_transmission_enabled: + - :ref:`bool` **transmission_enabled** + + .. _class_SpatialMaterial_transmission_texture: + - :ref:`Texture` **transmission_texture** + + .. _class_SpatialMaterial_uv1_offset: + - :ref:`Vector3` **uv1_offset** + + .. _class_SpatialMaterial_uv1_scale: + - :ref:`Vector3` **uv1_scale** + + .. _class_SpatialMaterial_uv1_triplanar: + - :ref:`bool` **uv1_triplanar** + + .. _class_SpatialMaterial_uv1_triplanar_sharpness: + - :ref:`float` **uv1_triplanar_sharpness** + + .. _class_SpatialMaterial_uv2_offset: + - :ref:`Vector3` **uv2_offset** + + .. _class_SpatialMaterial_uv2_scale: + - :ref:`Vector3` **uv2_scale** + + .. _class_SpatialMaterial_uv2_triplanar: + - :ref:`bool` **uv2_triplanar** + + .. _class_SpatialMaterial_uv2_triplanar_sharpness: + - :ref:`float` **uv2_triplanar_sharpness** + + .. _class_SpatialMaterial_vertex_color_is_srgb: + - :ref:`bool` **vertex_color_is_srgb** + + .. _class_SpatialMaterial_vertex_color_use_as_albedo: + - :ref:`bool` **vertex_color_use_as_albedo** + Numeric Constants ----------------- diff --git a/classes/class_spheremesh.rst b/classes/class_spheremesh.rst index 0519dd289..410797d1e 100644 --- a/classes/class_spheremesh.rst +++ b/classes/class_spheremesh.rst @@ -44,12 +44,27 @@ Member Functions Member Variables ---------------- + .. _class_SphereMesh_height: + - :ref:`float` **height** - Full height of the sphere. Defaults to 2.0. + + .. _class_SphereMesh_is_hemisphere: + - :ref:`bool` **is_hemisphere** - Determines whether a full sphere or a hemisphere is created. Attention: To get a regular hemisphere the height and radius of the sphere have to equal. Defaults to false. + + .. _class_SphereMesh_radial_segments: + - :ref:`int` **radial_segments** - Number of radial segments on the sphere. Defaults to 64. + + .. _class_SphereMesh_radius: + - :ref:`float` **radius** - Radius of sphere. Defaults to 1.0. + + .. _class_SphereMesh_rings: + - :ref:`int` **rings** - Number of segments along the height of the sphere. Defaults to 32. + Description ----------- diff --git a/classes/class_sphereshape.rst b/classes/class_sphereshape.rst index 71003bedb..023bd5375 100644 --- a/classes/class_sphereshape.rst +++ b/classes/class_sphereshape.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_SphereShape_radius: + - :ref:`float` **radius** - The sphere's radius. The shape's diameter is double the radius. + Description ----------- diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index 548bf2de0..46964b62d 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -38,10 +38,19 @@ Member Functions Member Variables ---------------- + .. _class_SpinBox_editable: + - :ref:`bool` **editable** + + .. _class_SpinBox_prefix: + - :ref:`String` **prefix** + + .. _class_SpinBox_suffix: + - :ref:`String` **suffix** + Description ----------- diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index afba5b652..e57ad2083 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -38,6 +38,8 @@ Member Functions Signals ------- +.. _class_SplitContainer_dragged: + - **dragged** **(** :ref:`int` offset **)** Emitted when the dragger is dragged by user. @@ -46,10 +48,19 @@ Emitted when the dragger is dragged by user. Member Variables ---------------- + .. _class_SplitContainer_collapsed: + - :ref:`bool` **collapsed** + + .. _class_SplitContainer_dragger_visibility: + - :ref:`int` **dragger_visibility** + + .. _class_SplitContainer_split_offset: + - :ref:`int` **split_offset** + Numeric Constants ----------------- diff --git a/classes/class_spotlight.rst b/classes/class_spotlight.rst index e67426643..5b0d42c1e 100644 --- a/classes/class_spotlight.rst +++ b/classes/class_spotlight.rst @@ -19,11 +19,23 @@ Spotlight :ref:`Light`, such as a reflector spotlight or a lantern. Member Variables ---------------- + .. _class_SpotLight_spot_angle: + - :ref:`float` **spot_angle** + + .. _class_SpotLight_spot_angle_attenuation: + - :ref:`float` **spot_angle_attenuation** + + .. _class_SpotLight_spot_attenuation: + - :ref:`float` **spot_attenuation** + + .. _class_SpotLight_spot_range: + - :ref:`float` **spot_range** + Description ----------- diff --git a/classes/class_sprite.rst b/classes/class_sprite.rst index ae5067ab3..05ac0615a 100644 --- a/classes/class_sprite.rst +++ b/classes/class_sprite.rst @@ -72,31 +72,71 @@ Member Functions Signals ------- +.. _class_Sprite_frame_changed: + - **frame_changed** **(** **)** -Emitted when the member frame changes. +Emitted when the :ref:`frame` changes. + +.. _class_Sprite_texture_changed: - **texture_changed** **(** **)** -Emitted when the member texture changes. +Emitted when the :ref:`texture` changes. Member Variables ---------------- + .. _class_Sprite_centered: + - :ref:`bool` **centered** - If ``true`` texture is centered. Default value: ``true``. + + .. _class_Sprite_flip_h: + - :ref:`bool` **flip_h** - If ``true`` texture is flipped horizontally. Default value: ``false``. + + .. _class_Sprite_flip_v: + - :ref:`bool` **flip_v** - If ``true`` texture is flipped vertically. Default value: ``false``. -- :ref:`int` **frame** - Current frame to display from sprite sheet. member vframes or member hframes must be greater than 1. + + .. _class_Sprite_frame: + +- :ref:`int` **frame** - Current frame to display from sprite sheet. :ref:`vframes` or :ref:`hframes` must be greater than 1. + + .. _class_Sprite_hframes: + - :ref:`int` **hframes** - The number of collumns in the sprite sheet. + + .. _class_Sprite_normal_map: + - :ref:`Texture` **normal_map** - The normal map gives depth to the Sprite. + + .. _class_Sprite_offset: + - :ref:`Vector2` **offset** - The texture's drawing offset. + + .. _class_Sprite_region_enabled: + - :ref:`bool` **region_enabled** - If ``true`` texture is cut from a larger atlas texture. See ``region_rect``. Default value: ``false``. + + .. _class_Sprite_region_filter_clip: + - :ref:`bool` **region_filter_clip** - If ``true`` the outermost pixels get blurred out. -- :ref:`Rect2` **region_rect** - The region of the atlas texture to display. member region_enabled must be ``true``. + + .. _class_Sprite_region_rect: + +- :ref:`Rect2` **region_rect** - The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. + + .. _class_Sprite_texture: + - :ref:`Texture` **texture** - :ref:`Texture` object to draw. + + .. _class_Sprite_vframes: + - :ref:`int` **vframes** - The number of rows in the sprite sheet. + Description ----------- diff --git a/classes/class_sprite3d.rst b/classes/class_sprite3d.rst index f8de05ee6..488cbe62f 100644 --- a/classes/class_sprite3d.rst +++ b/classes/class_sprite3d.rst @@ -48,21 +48,41 @@ Member Functions Signals ------- +.. _class_Sprite3D_frame_changed: + - **frame_changed** **(** **)** -Emitted when the member frame changes. +Emitted when the :ref:`frame` changes. Member Variables ---------------- -- :ref:`int` **frame** - Current frame to display from sprite sheet. member vframes or member hframes must be greater than 1. + .. _class_Sprite3D_frame: + +- :ref:`int` **frame** - Current frame to display from sprite sheet. :ref:`vframes` or :ref:`hframes` must be greater than 1. + + .. _class_Sprite3D_hframes: + - :ref:`int` **hframes** - The number of columns in the sprite sheet. -- :ref:`bool` **region_enabled** - If ``true`` texture will be cut from a larger atlas texture. See member region_rect. Default value: ``false``. -- :ref:`Rect2` **region_rect** - The region of the atlas texture to display. member region_enabled must be ``true``. + + .. _class_Sprite3D_region_enabled: + +- :ref:`bool` **region_enabled** - If ``true`` texture will be cut from a larger atlas texture. See :ref:`region_rect`. Default value: ``false``. + + .. _class_Sprite3D_region_rect: + +- :ref:`Rect2` **region_rect** - The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. + + .. _class_Sprite3D_texture: + - :ref:`Texture` **texture** - :ref:`Texture` object to draw. + + .. _class_Sprite3D_vframes: + - :ref:`int` **vframes** - The number of rows in the sprite sheet. + Description ----------- diff --git a/classes/class_spritebase3d.rst b/classes/class_spritebase3d.rst index 8f2f52dce..0d181aa4a 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -68,19 +68,55 @@ Member Functions Member Variables ---------------- + .. _class_SpriteBase3D_alpha_cut: + - :ref:`int` **alpha_cut** + + .. _class_SpriteBase3D_axis: + - :ref:`int` **axis** - The direction in which the front of the texture faces. + + .. _class_SpriteBase3D_centered: + - :ref:`bool` **centered** - If ``true`` texture will be centered. Default value: ``true``. + + .. _class_SpriteBase3D_double_sided: + - :ref:`bool` **double_sided** - If ``true`` texture can be seen from the back as well, if ``false``, it is invisible when looking at it from behind. Default value: ``true``. + + .. _class_SpriteBase3D_flip_h: + - :ref:`bool` **flip_h** - If ``true`` texture is flipped horizontally. Default value: ``false``. + + .. _class_SpriteBase3D_flip_v: + - :ref:`bool` **flip_v** - If ``true`` texture is flipped vertically. Default value: ``false``. + + .. _class_SpriteBase3D_modulate: + - :ref:`Color` **modulate** - A color value that gets multiplied on, could be used for mood-coloring or to simulate the color of light. + + .. _class_SpriteBase3D_offset: + - :ref:`Vector2` **offset** - The texture's drawing offset. + + .. _class_SpriteBase3D_opacity: + - :ref:`float` **opacity** - The objects visibility on a scale from ``0`` fully invisible to ``1`` fully visible. + + .. _class_SpriteBase3D_pixel_size: + - :ref:`float` **pixel_size** - The size of one pixel's width on the Sprite to scale it in 3D. + + .. _class_SpriteBase3D_shaded: + - :ref:`bool` **shaded** - If ``true`` the :ref:`Light` in the :ref:`Environment` has effects on the Sprite. Default value: ``false``. + + .. _class_SpriteBase3D_transparent: + - :ref:`bool` **transparent** - If ``true`` the texture's transparency and the opacity are used to make those parts of the Sprite invisible. Default value: ``true``. + Numeric Constants ----------------- diff --git a/classes/class_spriteframes.rst b/classes/class_spriteframes.rst index 1b9e02e1f..195a8362a 100644 --- a/classes/class_spriteframes.rst +++ b/classes/class_spriteframes.rst @@ -54,9 +54,15 @@ Member Functions Member Variables ---------------- + .. _class_SpriteFrames_animations: + - :ref:`Array` **animations** - An :ref:`Array` containing the ``name``, ``speed``, ``loop``, and ``frames`` of each animation. + + .. _class_SpriteFrames_frames: + - :ref:`Array` **frames** + Description ----------- diff --git a/classes/class_staticbody.rst b/classes/class_staticbody.rst index 3264e623d..36ac71d1b 100644 --- a/classes/class_staticbody.rst +++ b/classes/class_staticbody.rst @@ -40,11 +40,23 @@ Member Functions Member Variables ---------------- + .. _class_StaticBody_bounce: + - :ref:`float` **bounce** - The body bounciness. + + .. _class_StaticBody_constant_angular_velocity: + - :ref:`Vector3` **constant_angular_velocity** - The constant angular velocity for the body. This does not rotate the body, but affects other bodies that touch it, as if it was in a state of rotation. + + .. _class_StaticBody_constant_linear_velocity: + - :ref:`Vector3` **constant_linear_velocity** - The constant linear velocity for the body. This does not move the body, but affects other bodies that touch it, as if it was in a state of movement. + + .. _class_StaticBody_friction: + - :ref:`float` **friction** - The body friction, from 0 (frictionless) to 1 (full friction). + Description ----------- diff --git a/classes/class_staticbody2d.rst b/classes/class_staticbody2d.rst index 9de79ba26..da50e918d 100644 --- a/classes/class_staticbody2d.rst +++ b/classes/class_staticbody2d.rst @@ -40,11 +40,23 @@ Member Functions Member Variables ---------------- + .. _class_StaticBody2D_bounce: + - :ref:`float` **bounce** - The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness). + + .. _class_StaticBody2D_constant_angular_velocity: + - :ref:`float` **constant_angular_velocity** - Constant angular velocity for the body. This does not rotate the body, but affects colliding bodies, as if it were rotating. + + .. _class_StaticBody2D_constant_linear_velocity: + - :ref:`Vector2` **constant_linear_velocity** - Constant linear velocity for the body. This does not move the body, but affects colliding bodies, as if it were moving. + + .. _class_StaticBody2D_friction: + - :ref:`float` **friction** - The body's friction. Values range from ``0`` (no friction) to ``1`` (full friction). + Description ----------- diff --git a/classes/class_streamtexture.rst b/classes/class_streamtexture.rst index e44e2aca6..59d2a0234 100644 --- a/classes/class_streamtexture.rst +++ b/classes/class_streamtexture.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_StreamTexture_load_path: + - :ref:`String` **load_path** + Member Function Description --------------------------- diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index 8bcbfc78e..11fb1c0c1 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -42,11 +42,23 @@ Member Functions Member Variables ---------------- + .. _class_StyleBox_content_margin_bottom: + - :ref:`float` **content_margin_bottom** + + .. _class_StyleBox_content_margin_left: + - :ref:`float` **content_margin_left** + + .. _class_StyleBox_content_margin_right: + - :ref:`float` **content_margin_right** + + .. _class_StyleBox_content_margin_top: + - :ref:`float` **content_margin_top** + Description ----------- diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index 1fae6a959..f314e84f1 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -84,32 +84,95 @@ Member Functions Member Variables ---------------- + .. _class_StyleBoxFlat_anti_aliasing: + - :ref:`bool` **anti_aliasing** - Anti Aliasing draws a small ring around edges. This ring fades to transparent. As a result edges look much smoother. This is only noticeable when using rounded corners. + + .. _class_StyleBoxFlat_anti_aliasing_size: + - :ref:`int` **anti_aliasing_size** - This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect. + + .. _class_StyleBoxFlat_bg_color: + - :ref:`Color` **bg_color** - The background color of the stylebox. + + .. _class_StyleBoxFlat_border_blend: + - :ref:`bool` **border_blend** - When set to true, the border will fade into the background color. + + .. _class_StyleBoxFlat_border_color: + - :ref:`Color` **border_color** - Sets the color of the border. + + .. _class_StyleBoxFlat_border_width_bottom: + - :ref:`int` **border_width_bottom** - Border width for the bottom border. + + .. _class_StyleBoxFlat_border_width_left: + - :ref:`int` **border_width_left** - Border width for the left border. + + .. _class_StyleBoxFlat_border_width_right: + - :ref:`int` **border_width_right** - Border width for the right border. + + .. _class_StyleBoxFlat_border_width_top: + - :ref:`int` **border_width_top** - Border width for the top border. + + .. _class_StyleBoxFlat_corner_detail: + - :ref:`int` **corner_detail** - This sets the amount of vertices used for each corner. Higher values result in rounder corners but take more processing power to compute. When choosing a value you should take the corner radius (:ref:`set_corner_radius`) into account. For corner radius smaller than 10: 4-5 should be enough For corner radius smaller than 30: 8-12 should be enough ... + + .. _class_StyleBoxFlat_corner_radius_bottom_left: + - :ref:`int` **corner_radius_bottom_left** - The corner radius of the bottom left corner. When set to 0 the corner is not rounded. + + .. _class_StyleBoxFlat_corner_radius_bottom_right: + - :ref:`int` **corner_radius_bottom_right** - The corner radius of the bottom right corner. When set to 0 the corner is not rounded. + + .. _class_StyleBoxFlat_corner_radius_top_left: + - :ref:`int` **corner_radius_top_left** - The corner radius of the top left corner. When set to 0 the corner is not rounded. + + .. _class_StyleBoxFlat_corner_radius_top_right: + - :ref:`int` **corner_radius_top_right** - The corner radius of the top right corner. When set to 0 the corner is not rounded. + + .. _class_StyleBoxFlat_draw_center: + - :ref:`bool` **draw_center** - Toggels drawing of the inner part of the stylebox. + + .. _class_StyleBoxFlat_expand_margin_bottom: + - :ref:`float` **expand_margin_bottom** - Expands the stylebox outside of the control rect on the bottom edge. Useful in combination with border_width_bottom. To draw a border outside the control rect. + + .. _class_StyleBoxFlat_expand_margin_left: + - :ref:`float` **expand_margin_left** - Expands the stylebox outside of the control rect on the left edge. Useful in combination with border_width_left. To draw a border outside the control rect. + + .. _class_StyleBoxFlat_expand_margin_right: + - :ref:`float` **expand_margin_right** - Expands the stylebox outside of the control rect on the right edge. Useful in combination with border_width_right. To draw a border outside the control rect. + + .. _class_StyleBoxFlat_expand_margin_top: + - :ref:`float` **expand_margin_top** - Expands the stylebox outside of the control rect on the top edge. Useful in combination with border_width_top. To draw a border outside the control rect. + + .. _class_StyleBoxFlat_shadow_color: + - :ref:`Color` **shadow_color** - The color of the shadow. (This has no effect when shadow_size < 1) + + .. _class_StyleBoxFlat_shadow_size: + - :ref:`int` **shadow_size** - The shadow size in pixels. + Description ----------- diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index 1e791e48b..ddc20d796 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -64,28 +64,75 @@ Member Functions Signals ------- +.. _class_StyleBoxTexture_texture_changed: + - **texture_changed** **(** **)** Member Variables ---------------- + .. _class_StyleBoxTexture_axis_stretch_horizontal: + - :ref:`int` **axis_stretch_horizontal** + + .. _class_StyleBoxTexture_axis_stretch_vertical: + - :ref:`int` **axis_stretch_vertical** + + .. _class_StyleBoxTexture_draw_center: + - :ref:`bool` **draw_center** + + .. _class_StyleBoxTexture_expand_margin_bottom: + - :ref:`float` **expand_margin_bottom** + + .. _class_StyleBoxTexture_expand_margin_left: + - :ref:`float` **expand_margin_left** + + .. _class_StyleBoxTexture_expand_margin_right: + - :ref:`float` **expand_margin_right** + + .. _class_StyleBoxTexture_expand_margin_top: + - :ref:`float` **expand_margin_top** + + .. _class_StyleBoxTexture_margin_bottom: + - :ref:`float` **margin_bottom** + + .. _class_StyleBoxTexture_margin_left: + - :ref:`float` **margin_left** + + .. _class_StyleBoxTexture_margin_right: + - :ref:`float` **margin_right** + + .. _class_StyleBoxTexture_margin_top: + - :ref:`float` **margin_top** + + .. _class_StyleBoxTexture_modulate_color: + - :ref:`Color` **modulate_color** + + .. _class_StyleBoxTexture_normal_map: + - :ref:`Resource` **normal_map** + + .. _class_StyleBoxTexture_region_rect: + - :ref:`Rect2` **region_rect** + + .. _class_StyleBoxTexture_texture: + - :ref:`Resource` **texture** + Numeric Constants ----------------- diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index 059e46ebf..faa22a5dc 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -60,12 +60,18 @@ Member Functions Signals ------- +.. _class_TabContainer_pre_popup_pressed: + - **pre_popup_pressed** **(** **)** +.. _class_TabContainer_tab_changed: + - **tab_changed** **(** :ref:`int` tab **)** Emitted only when the current tab changes. +.. _class_TabContainer_tab_selected: + - **tab_selected** **(** :ref:`int` tab **)** Emitted when a tab is being selected, even if it is the same tab. @@ -74,10 +80,19 @@ Emitted when a tab is being selected, even if it is the same tab. Member Variables ---------------- + .. _class_TabContainer_current_tab: + - :ref:`int` **current_tab** - The current tab. + + .. _class_TabContainer_tab_align: + - :ref:`int` **tab_align** - The alignment of all the tabs of the tab container. See the ``ALIGN\_\*`` constants. + + .. _class_TabContainer_tabs_visible: + - :ref:`bool` **tabs_visible** - If ``true`` all tabs that are children of the TabContainer will be visible. + Numeric Constants ----------------- diff --git a/classes/class_tabs.rst b/classes/class_tabs.rst index a1e7ae80a..8383f792a 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -60,25 +60,43 @@ Member Functions Signals ------- +.. _class_Tabs_reposition_active_tab_request: + - **reposition_active_tab_request** **(** :ref:`int` idx_to **)** +.. _class_Tabs_right_button_pressed: + - **right_button_pressed** **(** :ref:`int` tab **)** +.. _class_Tabs_tab_changed: + - **tab_changed** **(** :ref:`int` tab **)** +.. _class_Tabs_tab_clicked: + - **tab_clicked** **(** :ref:`int` tab **)** +.. _class_Tabs_tab_close: + - **tab_close** **(** :ref:`int` tab **)** +.. _class_Tabs_tab_hover: + - **tab_hover** **(** :ref:`int` tab **)** Member Variables ---------------- + .. _class_Tabs_current_tab: + - :ref:`int` **current_tab** + + .. _class_Tabs_tab_close_display_policy: + - :ref:`int` **tab_close_display_policy** + Numeric Constants ----------------- diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 5a4c4213f..d1275b7f8 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -126,18 +126,28 @@ Member Functions Signals ------- +.. _class_TextEdit_breakpoint_toggled: + - **breakpoint_toggled** **(** :ref:`int` row **)** Emitted when a breakpoint is placed via the breakpoint gutter. +.. _class_TextEdit_cursor_changed: + - **cursor_changed** **(** **)** Emitted when the cursor changes. +.. _class_TextEdit_request_completion: + - **request_completion** **(** **)** +.. _class_TextEdit_symbol_lookup: + - **symbol_lookup** **(** :ref:`String` symbol, :ref:`int` row, :ref:`int` column **)** +.. _class_TextEdit_text_changed: + - **text_changed** **(** **)** Emitted when the text changes. @@ -146,16 +156,43 @@ Emitted when the text changes. Member Variables ---------------- + .. _class_TextEdit_caret_blink: + - :ref:`bool` **caret_blink** + + .. _class_TextEdit_caret_blink_speed: + - :ref:`float` **caret_blink_speed** + + .. _class_TextEdit_caret_block_mode: + - :ref:`bool` **caret_block_mode** + + .. _class_TextEdit_highlight_all_occurrences: + - :ref:`bool` **highlight_all_occurrences** + + .. _class_TextEdit_override_selected_font_color: + - :ref:`bool` **override_selected_font_color** + + .. _class_TextEdit_show_line_numbers: + - :ref:`bool` **show_line_numbers** + + .. _class_TextEdit_smooth_scrolling: + - :ref:`bool` **smooth_scrolling** + + .. _class_TextEdit_syntax_highlighting: + - :ref:`bool` **syntax_highlighting** + + .. _class_TextEdit_v_scroll_speed: + - :ref:`float` **v_scroll_speed** + Numeric Constants ----------------- diff --git a/classes/class_texturebutton.rst b/classes/class_texturebutton.rst index 321e10c2d..d6d8d3f4d 100644 --- a/classes/class_texturebutton.rst +++ b/classes/class_texturebutton.rst @@ -56,14 +56,38 @@ Member Functions Member Variables ---------------- -- :ref:`bool` **expand** - If ``true`` the texture stretches to the edges of the node's bounding rectangle using the member stretch_mode. If ``false`` the texture will not scale with the node. Default value: ``false``. -- :ref:`int` **stretch_mode** - Controls the texture's behavior when you resize the node's bounding rectangle, **only if** member expand is ``true``. Set it to one of the ``STRETCH\_\*`` constants. See the constants to learn more. + .. _class_TextureButton_expand: + +- :ref:`bool` **expand** - If ``true`` the texture stretches to the edges of the node's bounding rectangle using the :ref:`stretch_mode`. If ``false`` the texture will not scale with the node. Default value: ``false``. + + .. _class_TextureButton_stretch_mode: + +- :ref:`int` **stretch_mode** - Controls the texture's behavior when you resize the node's bounding rectangle, **only if** :ref:`expand` is ``true``. Set it to one of the ``STRETCH\_\*`` constants. See the constants to learn more. + + .. _class_TextureButton_texture_click_mask: + - :ref:`BitMap` **texture_click_mask** - Pure black and white Bitmap image to use for click detection. On the mask, white pixels represent the button's clickable area. Use it to create buttons with curved shapes. -- :ref:`Texture` **texture_disabled** - Texture to display when the node is disabled. See member BaseButton.disabled. + + .. _class_TextureButton_texture_disabled: + +- :ref:`Texture` **texture_disabled** - Texture to display when the node is disabled. See :ref:`BaseButton.disabled`. + + .. _class_TextureButton_texture_focused: + - :ref:`Texture` **texture_focused** - Texture to display when the node has mouse or keyboard focus. + + .. _class_TextureButton_texture_hover: + - :ref:`Texture` **texture_hover** - Texture to display when the mouse hovers the node. + + .. _class_TextureButton_texture_normal: + - :ref:`Texture` **texture_normal** - Texture to display by default, when the node is **not** in the disabled, focused, hover or pressed state. -- :ref:`Texture` **texture_pressed** - Texture to display on mouse down over the node, if the node has keyboard focus and the player presses the enter key or if the player presses the member BaseButton.shortcut key. + + .. _class_TextureButton_texture_pressed: + +- :ref:`Texture` **texture_pressed** - Texture to display on mouse down over the node, if the node has keyboard focus and the player presses the enter key or if the player presses the :ref:`BaseButton.shortcut` key. + Numeric Constants ----------------- diff --git a/classes/class_textureprogress.rst b/classes/class_textureprogress.rst index fbaeee949..5a0c23b4e 100644 --- a/classes/class_textureprogress.rst +++ b/classes/class_textureprogress.rst @@ -60,32 +60,68 @@ Member Functions Member Variables ---------------- + .. _class_TextureProgress_fill_mode: + - :ref:`int` **fill_mode** - The fill direction. Uses FILL\_\* constants. -- :ref:`bool` **nine_patch_stretch** - If ``true`` Godot treats the bar's textures like :ref:`NinePatchRect`. Use ``stretch_margin\_\*``, like member stretch_margin_bottom, to set up the nine patch's 3x3 grid. Default value: ``false``. -- :ref:`Vector2` **radial_center_offset** - Offsets member texture_progress if member fill_mode is ``FILL_CLOCKWISE`` or ``FILL_COUNTER_CLOCKWISE``. -- :ref:`float` **radial_fill_degrees** - Upper limit for the fill of member texture_progress if member fill_mode is ``FILL_CLOCKWISE`` or ``FILL_COUNTER_CLOCKWISE``. When the node's ``value`` is equal to its ``max_value``, the texture fills up to this angle. -See member Range.value, member Range.max_value. -- :ref:`float` **radial_initial_angle** - Starting angle for the fill of member texture_progress if member fill_mode is ``FILL_CLOCKWISE`` or ``FILL_COUNTER_CLOCKWISE``. When the node's ``value`` is equal to its ``min_value``, the texture doesn't show up at all. When the ``value`` increases, the texture fills and tends towards member radial_fill_degrees. + .. _class_TextureProgress_nine_patch_stretch: + +- :ref:`bool` **nine_patch_stretch** - If ``true`` Godot treats the bar's textures like :ref:`NinePatchRect`. Use ``stretch_margin\_\*``, like :ref:`stretch_margin_bottom`, to set up the nine patch's 3x3 grid. Default value: ``false``. + + .. _class_TextureProgress_radial_center_offset: + +- :ref:`Vector2` **radial_center_offset** - Offsets :ref:`texture_progress` if :ref:`fill_mode` is ``FILL_CLOCKWISE`` or ``FILL_COUNTER_CLOCKWISE``. + + .. _class_TextureProgress_radial_fill_degrees: + +- :ref:`float` **radial_fill_degrees** - Upper limit for the fill of :ref:`texture_progress` if :ref:`fill_mode` is ``FILL_CLOCKWISE`` or ``FILL_COUNTER_CLOCKWISE``. When the node's ``value`` is equal to its ``max_value``, the texture fills up to this angle. + +See :ref:`Range.value`, :ref:`Range.max_value`. + + .. _class_TextureProgress_radial_initial_angle: + +- :ref:`float` **radial_initial_angle** - Starting angle for the fill of :ref:`texture_progress` if :ref:`fill_mode` is ``FILL_CLOCKWISE`` or ``FILL_COUNTER_CLOCKWISE``. When the node's ``value`` is equal to its ``min_value``, the texture doesn't show up at all. When the ``value`` increases, the texture fills and tends towards :ref:`radial_fill_degrees`. + + .. _class_TextureProgress_stretch_margin_bottom: + - :ref:`int` **stretch_margin_bottom** - The height of the 9-patch's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders. -- :ref:`int` **stretch_margin_left** - The width of the 9-patch's left column. -- :ref:`int` **stretch_margin_right** - The width of the 9-patch's right column. -- :ref:`int` **stretch_margin_top** - The height of the 9-patch's top row. -- :ref:`Texture` **texture_over** - :ref:`Texture` that draws over the progress bar. Use it to add highlights or an upper-frame that hides part of member texture_progress. -- :ref:`Texture` **texture_progress** - :ref:`Texture` that clips based on the node's ``value`` and member fill_mode. As ``value`` increased, the texture fills up. It shows entirely when ``value`` reaches ``max_value``. It doesn't show at all if ``value`` is equal to ``min_value``. -The ``value`` property comes from :ref:`Range`. See member Range.value, member Range.min_value, member Range.max_value. + .. _class_TextureProgress_stretch_margin_left: + +- :ref:`int` **stretch_margin_left** - The width of the 9-patch's left column. + + .. _class_TextureProgress_stretch_margin_right: + +- :ref:`int` **stretch_margin_right** - The width of the 9-patch's right column. + + .. _class_TextureProgress_stretch_margin_top: + +- :ref:`int` **stretch_margin_top** - The height of the 9-patch's top row. + + .. _class_TextureProgress_texture_over: + +- :ref:`Texture` **texture_over** - :ref:`Texture` that draws over the progress bar. Use it to add highlights or an upper-frame that hides part of :ref:`texture_progress`. + + .. _class_TextureProgress_texture_progress: + +- :ref:`Texture` **texture_progress** - :ref:`Texture` that clips based on the node's ``value`` and :ref:`fill_mode`. As ``value`` increased, the texture fills up. It shows entirely when ``value`` reaches ``max_value``. It doesn't show at all if ``value`` is equal to ``min_value``. + +The ``value`` property comes from :ref:`Range`. See :ref:`Range.value`, :ref:`Range.min_value`, :ref:`Range.max_value`. + + .. _class_TextureProgress_texture_under: + - :ref:`Texture` **texture_under** - :ref:`Texture` that draws under the progress bar. The bar's background. + Numeric Constants ----------------- -- **FILL_LEFT_TO_RIGHT** = **0** --- The member texture_progress fills from left to right. -- **FILL_RIGHT_TO_LEFT** = **1** --- The member texture_progress fills from right to left. -- **FILL_TOP_TO_BOTTOM** = **2** --- The member texture_progress fills from top to bototm. -- **FILL_BOTTOM_TO_TOP** = **3** --- The member texture_progress fills from bottom to top. -- **FILL_CLOCKWISE** = **4** --- Turns the node into a radial bar. The member texture_progress fills clockwise. See member radial_center_offset, member radial_initial_angle and member radial_fill_degrees to refine its behavior. -- **FILL_COUNTER_CLOCKWISE** = **5** --- Turns the node into a radial bar. The member texture_progress fills counter-clockwise. See member radial_center_offset, member radial_initial_angle and member radial_fill_degrees to refine its behavior. +- **FILL_LEFT_TO_RIGHT** = **0** --- The :ref:`texture_progress` fills from left to right. +- **FILL_RIGHT_TO_LEFT** = **1** --- The :ref:`texture_progress` fills from right to left. +- **FILL_TOP_TO_BOTTOM** = **2** --- The :ref:`texture_progress` fills from top to bototm. +- **FILL_BOTTOM_TO_TOP** = **3** --- The :ref:`texture_progress` fills from bottom to top. +- **FILL_CLOCKWISE** = **4** --- Turns the node into a radial bar. The :ref:`texture_progress` fills clockwise. See :ref:`radial_center_offset`, :ref:`radial_initial_angle` and :ref:`radial_fill_degrees` to refine its behavior. +- **FILL_COUNTER_CLOCKWISE** = **5** --- Turns the node into a radial bar. The :ref:`texture_progress` fills counter-clockwise. See :ref:`radial_center_offset`, :ref:`radial_initial_angle` and :ref:`radial_fill_degrees` to refine its behavior. Description ----------- diff --git a/classes/class_texturerect.rst b/classes/class_texturerect.rst index 42293a6cb..460f0d5b7 100644 --- a/classes/class_texturerect.rst +++ b/classes/class_texturerect.rst @@ -36,10 +36,19 @@ Member Functions Member Variables ---------------- + .. _class_TextureRect_expand: + - :ref:`bool` **expand** - If ``true``, the texture scales to fit its bounding rectangle. Default value: ``false``. + + .. _class_TextureRect_stretch_mode: + - :ref:`int` **stretch_mode** - Controls the texture's behavior when you resize the node's bounding rectangle. Set it to one of the ``STRETCH\_\*`` constants. See the constants to learn more. + + .. _class_TextureRect_texture: + - :ref:`Texture` **texture** - The node's :ref:`Texture` resource. + Numeric Constants ----------------- diff --git a/classes/class_theme.rst b/classes/class_theme.rst index 5f8eee6f4..0feef4576 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -84,8 +84,11 @@ Member Functions Member Variables ---------------- + .. _class_Theme_default_font: + - :ref:`Font` **default_font** + Description ----------- diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index 789b4c521..edeb0c8a1 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -122,6 +122,8 @@ Member Functions Signals ------- +.. _class_TileMap_settings_changed: + - **settings_changed** **(** **)** Emitted when a tilemap setting has changed. @@ -130,22 +132,67 @@ Emitted when a tilemap setting has changed. Member Variables ---------------- + .. _class_TileMap_cell_custom_transform: + - :ref:`Transform2D` **cell_custom_transform** - The custom :ref:`Transform2D` to be applied to the TileMap's cells. + + .. _class_TileMap_cell_half_offset: + - :ref:`int` **cell_half_offset** - Amount to offset alternating tiles. Uses HALF_OFFSET\_\* constants. Default value: HALF_OFFSET_DISABLED. + + .. _class_TileMap_cell_quadrant_size: + - :ref:`int` **cell_quadrant_size** - The TileMap's quadrant size. Optimizes drawing by batching, using chunks of this size. Default value: 16. + + .. _class_TileMap_cell_size: + - :ref:`Vector2` **cell_size** - The TileMap's cell size. + + .. _class_TileMap_cell_tile_origin: + - :ref:`int` **cell_tile_origin** - Position for tile origin. Uses TILE_ORIGIN\_\* constants. Default value: TILE_ORIGIN_TOP_LEFT. + + .. _class_TileMap_cell_y_sort: + - :ref:`bool` **cell_y_sort** - If ``true`` the TileMap's children will be drawn in order of their Y coordinate. Default value: ``false``. + + .. _class_TileMap_collision_bounce: + - :ref:`float` **collision_bounce** - Bounce value for static body collisions (see ``collision_use_kinematic``). Default value: 0. + + .. _class_TileMap_collision_friction: + - :ref:`float` **collision_friction** - Friction value for static body collisions (see ``collision_use_kinematic``). Default value: 1. + + .. _class_TileMap_collision_layer: + - :ref:`int` **collision_layer** - The collision layer(s) for all colliders in the TileMap. + + .. _class_TileMap_collision_mask: + - :ref:`int` **collision_mask** - The collision mask(s) for all colliders in the TileMap. + + .. _class_TileMap_collision_use_kinematic: + - :ref:`bool` **collision_use_kinematic** - If ``true`` TileMap collisions will be handled as a kinematic body. If ``false`` collisions will be handled as static body. Default value: ``false``. + + .. _class_TileMap_mode: + - :ref:`int` **mode** - The TileMap orientation mode. Uses MODE\_\* constants. Default value: MODE_SQUARE. + + .. _class_TileMap_occluder_light_mask: + - :ref:`int` **occluder_light_mask** - The light mask assigned to all light occluders in the TileMap. The TileSet's light occluders will cast shadows only from Light2D(s) that have the same light mask(s). + + .. _class_TileMap_tile_data: + - :ref:`PoolIntArray` **tile_data** - A :ref:`PoolIntArray` containing + + .. _class_TileMap_tile_set: + - :ref:`TileSet` **tile_set** - The assigned :ref:`TileSet`. + Numeric Constants ----------------- diff --git a/classes/class_timer.rst b/classes/class_timer.rst index df36dc6c4..97f1b7e84 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -52,6 +52,8 @@ Member Functions Signals ------- +.. _class_Timer_timeout: + - **timeout** **(** **)** Emitted when the Timer reaches 0. @@ -60,11 +62,23 @@ Emitted when the Timer reaches 0. Member Variables ---------------- + .. _class_Timer_autostart: + - :ref:`bool` **autostart** - If ``true``, Timer will automatically start when entering the scene tree. Default value: ``false``. + + .. _class_Timer_one_shot: + - :ref:`bool` **one_shot** - If ``true``, Timer will stop when reaching 0. If ``false``, it will restart. Default value: ``false``. + + .. _class_Timer_process_mode: + - :ref:`int` **process_mode** - Processing mode. Uses TIMER_PROCESS\_\* constants as value. + + .. _class_Timer_wait_time: + - :ref:`float` **wait_time** - Wait time in seconds. + Numeric Constants ----------------- diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index fb6ff48f0..776eed8da 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -62,10 +62,14 @@ Member Functions Signals ------- +.. _class_TouchScreenButton_pressed: + - **pressed** **(** **)** Emitted when the button is pressed (down). +.. _class_TouchScreenButton_released: + - **released** **(** **)** Emitted when the button is released (up). @@ -74,16 +78,43 @@ Emitted when the button is released (up). Member Variables ---------------- + .. _class_TouchScreenButton_action: + - :ref:`String` **action** - The button's action. Actions can be handled with :ref:`InputEventAction`. + + .. _class_TouchScreenButton_bitmask: + - :ref:`BitMap` **bitmask** - The button's bitmask. + + .. _class_TouchScreenButton_normal: + - :ref:`Texture` **normal** - The button's texture for the normal state. + + .. _class_TouchScreenButton_passby_press: + - :ref:`bool` **passby_press** - If ``true`` passby presses are enabled. + + .. _class_TouchScreenButton_pressed: + - :ref:`Texture` **pressed** - The button's texture for the pressed state. + + .. _class_TouchScreenButton_shape: + - :ref:`Shape2D` **shape** - The button's shape. + + .. _class_TouchScreenButton_shape_centered: + - :ref:`bool` **shape_centered** - If ``true`` the button's shape is centered. + + .. _class_TouchScreenButton_shape_visible: + - :ref:`bool` **shape_visible** - If ``true`` the button's shape is visible. + + .. _class_TouchScreenButton_visibility_mode: + - :ref:`int` **visibility_mode** - The button's visibility mode. See ``VISIBILITY\_\*`` constants. + Numeric Constants ----------------- diff --git a/classes/class_transform.rst b/classes/class_transform.rst index 774d7b179..6b7960657 100644 --- a/classes/class_transform.rst +++ b/classes/class_transform.rst @@ -52,9 +52,15 @@ Member Functions Member Variables ---------------- + .. _class_Transform_basis: + - :ref:`Basis` **basis** - The basis is a matrix containing 3 :ref:`Vector3` as its columns: X axis, Y axis, and Z axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. + + .. _class_Transform_origin: + - :ref:`Vector3` **origin** - The translation offset of the transform. + Description ----------- diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index f696198ba..f474aa558 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -56,10 +56,19 @@ Member Functions Member Variables ---------------- + .. _class_Transform2D_origin: + - :ref:`Vector2` **origin** - The translation offset of the transform. + + .. _class_Transform2D_x: + - :ref:`Vector2` **x** - The X axis of 2x2 basis matrix containing 2 :ref:`Vector2` as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. + + .. _class_Transform2D_y: + - :ref:`Vector2` **y** - The Y axis of 2x2 basis matrix containing 2 :ref:`Vector2` as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. + Description ----------- diff --git a/classes/class_translation.rst b/classes/class_translation.rst index af88fd7f4..bb31cb254 100644 --- a/classes/class_translation.rst +++ b/classes/class_translation.rst @@ -40,9 +40,15 @@ Member Functions Member Variables ---------------- + .. _class_Translation_locale: + - :ref:`String` **locale** + + .. _class_Translation_messages: + - :ref:`PoolStringArray` **messages** + Description ----------- diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 07475fb0b..0efd59dd7 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -94,56 +94,84 @@ Member Functions Signals ------- +.. _class_Tree_button_pressed: + - **button_pressed** **(** :ref:`Object` item, :ref:`int` column, :ref:`int` id **)** Emitted when a button on the tree was pressed (see :ref:`TreeItem.add_button`). +.. _class_Tree_cell_selected: + - **cell_selected** **(** **)** Emitted when a cell is selected. +.. _class_Tree_column_title_pressed: + - **column_title_pressed** **(** :ref:`int` column **)** Emitted when a column's title is pressed. +.. _class_Tree_custom_popup_edited: + - **custom_popup_edited** **(** :ref:`bool` arrow_clicked **)** Emitted when a cell with the ``CELL_MODE_CUSTOM`` is clicked to be edited. +.. _class_Tree_empty_tree_rmb_selected: + - **empty_tree_rmb_selected** **(** :ref:`Vector2` position **)** Emitted when the right mouse button is pressed if RMB selection is active and the tree is empty. +.. _class_Tree_item_activated: + - **item_activated** **(** **)** Emitted when an item is activated (double-clicked). +.. _class_Tree_item_collapsed: + - **item_collapsed** **(** :ref:`Object` item **)** Emitted when an item is collapsed by a click on the folding arrow. +.. _class_Tree_item_custom_button_pressed: + - **item_custom_button_pressed** **(** **)** +.. _class_Tree_item_double_clicked: + - **item_double_clicked** **(** **)** Emitted when an item is double clicked. +.. _class_Tree_item_edited: + - **item_edited** **(** **)** Emitted when an item is edited. +.. _class_Tree_item_rmb_edited: + - **item_rmb_edited** **(** **)** Emitted when an item is edited using the right mouse button. +.. _class_Tree_item_rmb_selected: + - **item_rmb_selected** **(** :ref:`Vector2` position **)** Emitted when an item is selected with right mouse button. +.. _class_Tree_item_selected: + - **item_selected** **(** **)** Emitted when an item is selected with right mouse button. +.. _class_Tree_multi_selected: + - **multi_selected** **(** :ref:`Object` item, :ref:`int` column, :ref:`bool` selected **)** Emitted instead of ``item_selected`` when ``select_mode`` is ``SELECT_MULTI``. diff --git a/classes/class_tween.rst b/classes/class_tween.rst index f481e6e2d..48bbf42ab 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -80,14 +80,20 @@ Member Functions Signals ------- +.. _class_Tween_tween_completed: + - **tween_completed** **(** :ref:`Object` object, :ref:`String` key **)** This signal is emitted when a tween ends. +.. _class_Tween_tween_started: + - **tween_started** **(** :ref:`Object` object, :ref:`String` key **)** This signal is emitted when a tween starts. +.. _class_Tween_tween_step: + - **tween_step** **(** :ref:`Object` object, :ref:`String` key, :ref:`float` elapsed, :ref:`Object` value **)** This signal is emitted each step of the tweening. @@ -96,8 +102,11 @@ This signal is emitted each step of the tweening. Member Variables ---------------- + .. _class_Tween_playback_process_mode: + - :ref:`int` **playback_process_mode** + Numeric Constants ----------------- diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index 8a09f571d..54b193388 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -68,9 +68,15 @@ Member Functions Member Variables ---------------- + .. _class_Vector2_x: + - :ref:`float` **x** - X component of the vector. + + .. _class_Vector2_y: + - :ref:`float` **y** - Y component of the vector. + Description ----------- diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index e7f748cc1..1a399cf72 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -72,10 +72,19 @@ Member Functions Member Variables ---------------- + .. _class_Vector3_x: + - :ref:`float` **x** - X component of the vector. + + .. _class_Vector3_y: + - :ref:`float` **y** - Y component of the vector. + + .. _class_Vector3_z: + - :ref:`float` **z** - Z component of the vector. + Numeric Constants ----------------- diff --git a/classes/class_vehiclebody.rst b/classes/class_vehiclebody.rst index 6e95f69a2..6632134e2 100644 --- a/classes/class_vehiclebody.rst +++ b/classes/class_vehiclebody.rst @@ -46,12 +46,27 @@ Member Functions Member Variables ---------------- + .. _class_VehicleBody_brake: + - :ref:`float` **brake** + + .. _class_VehicleBody_engine_force: + - :ref:`float` **engine_force** + + .. _class_VehicleBody_friction: + - :ref:`float` **friction** + + .. _class_VehicleBody_mass: + - :ref:`float` **mass** + + .. _class_VehicleBody_steering: + - :ref:`float` **steering** + Member Function Description --------------------------- diff --git a/classes/class_vehiclewheel.rst b/classes/class_vehiclewheel.rst index 4c91e10e2..2366a4d2c 100644 --- a/classes/class_vehiclewheel.rst +++ b/classes/class_vehiclewheel.rst @@ -72,18 +72,51 @@ Member Functions Member Variables ---------------- + .. _class_VehicleWheel_damping_compression: + - :ref:`float` **damping_compression** + + .. _class_VehicleWheel_damping_relaxation: + - :ref:`float` **damping_relaxation** + + .. _class_VehicleWheel_suspension_max_force: + - :ref:`float` **suspension_max_force** + + .. _class_VehicleWheel_suspension_stiffness: + - :ref:`float` **suspension_stiffness** + + .. _class_VehicleWheel_suspension_travel: + - :ref:`float` **suspension_travel** + + .. _class_VehicleWheel_use_as_steering: + - :ref:`bool` **use_as_steering** + + .. _class_VehicleWheel_use_as_traction: + - :ref:`bool` **use_as_traction** + + .. _class_VehicleWheel_wheel_friction_slip: + - :ref:`float` **wheel_friction_slip** + + .. _class_VehicleWheel_wheel_radius: + - :ref:`float` **wheel_radius** + + .. _class_VehicleWheel_wheel_rest_length: + - :ref:`float` **wheel_rest_length** + + .. _class_VehicleWheel_wheel_roll_influence: + - :ref:`float` **wheel_roll_influence** + Member Function Description --------------------------- diff --git a/classes/class_videoplayer.rst b/classes/class_videoplayer.rst index 2a2a3a800..b4ecf1e80 100644 --- a/classes/class_videoplayer.rst +++ b/classes/class_videoplayer.rst @@ -70,13 +70,31 @@ Member Functions Member Variables ---------------- + .. _class_VideoPlayer_audio_track: + - :ref:`int` **audio_track** + + .. _class_VideoPlayer_autoplay: + - :ref:`bool` **autoplay** + + .. _class_VideoPlayer_expand: + - :ref:`bool` **expand** + + .. _class_VideoPlayer_paused: + - :ref:`bool` **paused** + + .. _class_VideoPlayer_stream: + - :ref:`VideoStream` **stream** + + .. _class_VideoPlayer_volume_db: + - :ref:`float` **volume_db** + Description ----------- diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index ea067102e..999554228 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -158,6 +158,8 @@ Member Functions Signals ------- +.. _class_Viewport_size_changed: + - **size_changed** **(** **)** Emitted when the size of the viewport is changed, whether by :ref:`set_size_override`, resize of window, or some other means. @@ -166,30 +168,99 @@ Emitted when the size of the viewport is changed, whether by :ref:`set_size_over Member Variables ---------------- + .. _class_Viewport_arvr: + - :ref:`bool` **arvr** + + .. _class_Viewport_audio_listener_enable_2d: + - :ref:`bool` **audio_listener_enable_2d** + + .. _class_Viewport_audio_listener_enable_3d: + - :ref:`bool` **audio_listener_enable_3d** + + .. _class_Viewport_debug_draw: + - :ref:`int` **debug_draw** + + .. _class_Viewport_disable_3d: + - :ref:`bool` **disable_3d** + + .. _class_Viewport_gui_disable_input: + - :ref:`bool` **gui_disable_input** + + .. _class_Viewport_gui_snap_controls_to_pixels: + - :ref:`bool` **gui_snap_controls_to_pixels** + + .. _class_Viewport_hdr: + - :ref:`bool` **hdr** + + .. _class_Viewport_msaa: + - :ref:`int` **msaa** + + .. _class_Viewport_own_world: + - :ref:`bool` **own_world** + + .. _class_Viewport_physics_object_picking: + - :ref:`bool` **physics_object_picking** + + .. _class_Viewport_render_target_clear_mode: + - :ref:`int` **render_target_clear_mode** + + .. _class_Viewport_render_target_update_mode: + - :ref:`int` **render_target_update_mode** + + .. _class_Viewport_render_target_v_flip: + - :ref:`bool` **render_target_v_flip** + + .. _class_Viewport_shadow_atlas_quad_0: + - :ref:`int` **shadow_atlas_quad_0** + + .. _class_Viewport_shadow_atlas_quad_1: + - :ref:`int` **shadow_atlas_quad_1** + + .. _class_Viewport_shadow_atlas_quad_2: + - :ref:`int` **shadow_atlas_quad_2** + + .. _class_Viewport_shadow_atlas_quad_3: + - :ref:`int` **shadow_atlas_quad_3** + + .. _class_Viewport_shadow_atlas_size: + - :ref:`int` **shadow_atlas_size** + + .. _class_Viewport_size: + - :ref:`Vector2` **size** + + .. _class_Viewport_transparent_bg: + - :ref:`bool` **transparent_bg** + + .. _class_Viewport_usage: + - :ref:`int` **usage** + + .. _class_Viewport_world: + - :ref:`World` **world** + Numeric Constants ----------------- diff --git a/classes/class_viewportcontainer.rst b/classes/class_viewportcontainer.rst index 2f76aa088..cbc9c71ce 100644 --- a/classes/class_viewportcontainer.rst +++ b/classes/class_viewportcontainer.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_ViewportContainer_stretch: + - :ref:`bool` **stretch** + Member Function Description --------------------------- diff --git a/classes/class_viewporttexture.rst b/classes/class_viewporttexture.rst index 599f4226f..544f08e65 100644 --- a/classes/class_viewporttexture.rst +++ b/classes/class_viewporttexture.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_ViewportTexture_viewport_path: + - :ref:`NodePath` **viewport_path** + Member Function Description --------------------------- diff --git a/classes/class_visibilityenabler.rst b/classes/class_visibilityenabler.rst index 72b9f6a93..ecdee554d 100644 --- a/classes/class_visibilityenabler.rst +++ b/classes/class_visibilityenabler.rst @@ -28,9 +28,15 @@ Member Functions Member Variables ---------------- + .. _class_VisibilityEnabler_freeze_bodies: + - :ref:`bool` **freeze_bodies** + + .. _class_VisibilityEnabler_pause_animations: + - :ref:`bool` **pause_animations** + Numeric Constants ----------------- diff --git a/classes/class_visibilityenabler2d.rst b/classes/class_visibilityenabler2d.rst index 7654ee25d..8f53e1c6a 100644 --- a/classes/class_visibilityenabler2d.rst +++ b/classes/class_visibilityenabler2d.rst @@ -28,13 +28,31 @@ Member Functions Member Variables ---------------- + .. _class_VisibilityEnabler2D_freeze_bodies: + - :ref:`bool` **freeze_bodies** + + .. _class_VisibilityEnabler2D_pause_animated_sprites: + - :ref:`bool` **pause_animated_sprites** + + .. _class_VisibilityEnabler2D_pause_animations: + - :ref:`bool` **pause_animations** + + .. _class_VisibilityEnabler2D_pause_particles: + - :ref:`bool` **pause_particles** + + .. _class_VisibilityEnabler2D_physics_process_parent: + - :ref:`bool` **physics_process_parent** + + .. _class_VisibilityEnabler2D_process_parent: + - :ref:`bool` **process_parent** + Numeric Constants ----------------- diff --git a/classes/class_visibilitynotifier.rst b/classes/class_visibilitynotifier.rst index 1b8f8c870..de24afcff 100644 --- a/classes/class_visibilitynotifier.rst +++ b/classes/class_visibilitynotifier.rst @@ -32,18 +32,26 @@ Member Functions Signals ------- +.. _class_VisibilityNotifier_camera_entered: + - **camera_entered** **(** :ref:`Object` camera **)** Emitted when the VisibilityNotifier enters a :ref:`Camera`'s view. +.. _class_VisibilityNotifier_camera_exited: + - **camera_exited** **(** :ref:`Object` camera **)** Emitted when the VisibilityNotifier exits a :ref:`Camera`'s view. +.. _class_VisibilityNotifier_screen_entered: + - **screen_entered** **(** **)** Emitted when the VisibilityNotifier enters the screen. +.. _class_VisibilityNotifier_screen_exited: + - **screen_exited** **(** **)** Emitted when the VisibilityNotifier exits the screen. @@ -52,8 +60,11 @@ Emitted when the VisibilityNotifier exits the screen. Member Variables ---------------- + .. _class_VisibilityNotifier_aabb: + - :ref:`Rect3` **aabb** - The VisibilityNotifier's bounding box. + Description ----------- diff --git a/classes/class_visibilitynotifier2d.rst b/classes/class_visibilitynotifier2d.rst index 0a03074b8..58d721c0f 100644 --- a/classes/class_visibilitynotifier2d.rst +++ b/classes/class_visibilitynotifier2d.rst @@ -32,18 +32,26 @@ Member Functions Signals ------- +.. _class_VisibilityNotifier2D_screen_entered: + - **screen_entered** **(** **)** Emitted when the VisibilityNotifier2D enters the screen. +.. _class_VisibilityNotifier2D_screen_exited: + - **screen_exited** **(** **)** Emitted when the VisibilityNotifier2D exits the screen. +.. _class_VisibilityNotifier2D_viewport_entered: + - **viewport_entered** **(** :ref:`Object` viewport **)** Emitted when the VisibilityNotifier2D enters a :ref:`Viewport`'s view. +.. _class_VisibilityNotifier2D_viewport_exited: + - **viewport_exited** **(** :ref:`Object` viewport **)** Emitted when the VisibilityNotifier2D exits a :ref:`Viewport`'s view. @@ -52,8 +60,11 @@ Emitted when the VisibilityNotifier2D exits a :ref:`Viewport`'s Member Variables ---------------- + .. _class_VisibilityNotifier2D_rect: + - :ref:`Rect2` **rect** - The VisibilityNotifier2D's bounding rectangle. + Description ----------- diff --git a/classes/class_visualinstance.rst b/classes/class_visualinstance.rst index e10cf4ba8..9bf00ce38 100644 --- a/classes/class_visualinstance.rst +++ b/classes/class_visualinstance.rst @@ -36,8 +36,11 @@ Member Functions Member Variables ---------------- + .. _class_VisualInstance_layers: + - :ref:`int` **layers** + Member Function Description --------------------------- diff --git a/classes/class_visualscript.rst b/classes/class_visualscript.rst index 6ae59dd3c..498b3ce80 100644 --- a/classes/class_visualscript.rst +++ b/classes/class_visualscript.rst @@ -108,6 +108,8 @@ Member Functions Signals ------- +.. _class_VisualScript_node_ports_changed: + - **node_ports_changed** **(** :ref:`String` function, :ref:`int` id **)** Emitted when the ports of a node are changed. @@ -116,8 +118,11 @@ Emitted when the ports of a node are changed. Member Variables ---------------- + .. _class_VisualScript_data: + - :ref:`Dictionary` **data** + Description ----------- diff --git a/classes/class_visualscriptbasictypeconstant.rst b/classes/class_visualscriptbasictypeconstant.rst index 289a14ead..568da43ea 100644 --- a/classes/class_visualscriptbasictypeconstant.rst +++ b/classes/class_visualscriptbasictypeconstant.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptBasicTypeConstant_basic_type: + - :ref:`int` **basic_type** - The type to get the constant from. + + .. _class_VisualScriptBasicTypeConstant_constant: + - :ref:`String` **constant** - The name of the constant to return. + Description ----------- diff --git a/classes/class_visualscriptbuiltinfunc.rst b/classes/class_visualscriptbuiltinfunc.rst index 7cf24a3e3..d807ec57a 100644 --- a/classes/class_visualscriptbuiltinfunc.rst +++ b/classes/class_visualscriptbuiltinfunc.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptBuiltinFunc_function: + - :ref:`int` **function** - The function to be executed. + Numeric Constants ----------------- @@ -92,7 +95,7 @@ Numeric Constants - **VAR_TO_BYTES** = **56** --- Serialize a :ref:`Variant` to a :ref:`PoolByteArray`. - **BYTES_TO_VAR** = **57** --- Deserialize a :ref:`Variant` from a :ref:`PoolByteArray` serialized using VAR_TO_BYTES. - **COLORN** = **58** --- Return the :ref:`Color` with the given name and alpha ranging from 0 to 1. Note: names are defined in color_names.inc. -- **FUNC_MAX** = **59** --- The maximum value the member function property can have. +- **FUNC_MAX** = **59** --- The maximum value the :ref:`function` property can have. Description ----------- diff --git a/classes/class_visualscriptclassconstant.rst b/classes/class_visualscriptclassconstant.rst index e21c07509..4edbc6ddd 100644 --- a/classes/class_visualscriptclassconstant.rst +++ b/classes/class_visualscriptclassconstant.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptClassConstant_base_type: + - :ref:`String` **base_type** - The constant's parent class. + + .. _class_VisualScriptClassConstant_constant: + - :ref:`String` **constant** - The constant to return. See the given class for its available constants. + Description ----------- diff --git a/classes/class_visualscriptcomment.rst b/classes/class_visualscriptcomment.rst index df0011136..6755f52bb 100644 --- a/classes/class_visualscriptcomment.rst +++ b/classes/class_visualscriptcomment.rst @@ -36,10 +36,19 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptComment_description: + - :ref:`String` **description** - The text inside the comment node. + + .. _class_VisualScriptComment_size: + - :ref:`Vector2` **size** - The comment node's size (in pixels). + + .. _class_VisualScriptComment_title: + - :ref:`String` **title** - The comment node's title. + Description ----------- diff --git a/classes/class_visualscriptconstant.rst b/classes/class_visualscriptconstant.rst index 7192f7904..389e79e68 100644 --- a/classes/class_visualscriptconstant.rst +++ b/classes/class_visualscriptconstant.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptConstant_type: + - :ref:`int` **type** - The constant's type. + + .. _class_VisualScriptConstant_value: + - :ref:`Variant` **value** - The constant's value. + Description ----------- diff --git a/classes/class_visualscriptconstructor.rst b/classes/class_visualscriptconstructor.rst index 0e7b29fb4..81783ab61 100644 --- a/classes/class_visualscriptconstructor.rst +++ b/classes/class_visualscriptconstructor.rst @@ -32,6 +32,8 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptConstructor_constructor: + - :ref:`Dictionary` **constructor** - The constructor function's method info. Has roughly the following structure: :: @@ -50,8 +52,12 @@ Member Variables id = 0 return = {type = TYPE\_\*} } + + .. _class_VisualScriptConstructor_type: + - :ref:`int` **type** - The type to be constructed. + Description ----------- diff --git a/classes/class_visualscriptdeconstruct.rst b/classes/class_visualscriptdeconstruct.rst index 7916e3d77..aef5270f4 100644 --- a/classes/class_visualscriptdeconstruct.rst +++ b/classes/class_visualscriptdeconstruct.rst @@ -28,9 +28,15 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptDeconstruct_elem_cache: + - :ref:`Array` **elem_cache** + + .. _class_VisualScriptDeconstruct_type: + - :ref:`int` **type** - The type to deconstruct. + Description ----------- diff --git a/classes/class_visualscriptemitsignal.rst b/classes/class_visualscriptemitsignal.rst index 7c18ef301..3e6a916b4 100644 --- a/classes/class_visualscriptemitsignal.rst +++ b/classes/class_visualscriptemitsignal.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptEmitSignal_signal: + - :ref:`String` **signal** - The signal to emit. + Description ----------- diff --git a/classes/class_visualscriptenginesingleton.rst b/classes/class_visualscriptenginesingleton.rst index 01e93ef39..e697ae3d1 100644 --- a/classes/class_visualscriptenginesingleton.rst +++ b/classes/class_visualscriptenginesingleton.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptEngineSingleton_constant: + - :ref:`String` **constant** - The singleton's name. + Description ----------- diff --git a/classes/class_visualscriptfunctioncall.rst b/classes/class_visualscriptfunctioncall.rst index 49f49951e..3b59cd115 100644 --- a/classes/class_visualscriptfunctioncall.rst +++ b/classes/class_visualscriptfunctioncall.rst @@ -64,18 +64,51 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptFunctionCall_argument_cache: + - :ref:`Dictionary` **argument_cache** + + .. _class_VisualScriptFunctionCall_base_script: + - :ref:`String` **base_script** + + .. _class_VisualScriptFunctionCall_base_type: + - :ref:`String` **base_type** + + .. _class_VisualScriptFunctionCall_basic_type: + - :ref:`int` **basic_type** + + .. _class_VisualScriptFunctionCall_call_mode: + - :ref:`int` **call_mode** + + .. _class_VisualScriptFunctionCall_function: + - :ref:`String` **function** + + .. _class_VisualScriptFunctionCall_node_path: + - :ref:`NodePath` **node_path** + + .. _class_VisualScriptFunctionCall_rpc_call_mode: + - :ref:`int` **rpc_call_mode** + + .. _class_VisualScriptFunctionCall_singleton: + - :ref:`String` **singleton** + + .. _class_VisualScriptFunctionCall_use_default_args: + - :ref:`int` **use_default_args** + + .. _class_VisualScriptFunctionCall_validate: + - :ref:`bool` **validate** + Numeric Constants ----------------- diff --git a/classes/class_visualscriptglobalconstant.rst b/classes/class_visualscriptglobalconstant.rst index 190c4f61b..2db21a047 100644 --- a/classes/class_visualscriptglobalconstant.rst +++ b/classes/class_visualscriptglobalconstant.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptGlobalConstant_constant: + - :ref:`int` **constant** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptinputaction.rst b/classes/class_visualscriptinputaction.rst index f8003ee30..f34579b80 100644 --- a/classes/class_visualscriptinputaction.rst +++ b/classes/class_visualscriptinputaction.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptInputAction_action: + - :ref:`String` **action** + + .. _class_VisualScriptInputAction_mode: + - :ref:`int` **mode** + Numeric Constants ----------------- diff --git a/classes/class_visualscriptlocalvar.rst b/classes/class_visualscriptlocalvar.rst index 3cb98a7ec..29f907bb6 100644 --- a/classes/class_visualscriptlocalvar.rst +++ b/classes/class_visualscriptlocalvar.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptLocalVar_type: + - :ref:`int` **type** - The local variable's type. + + .. _class_VisualScriptLocalVar_var_name: + - :ref:`String` **var_name** - The local variable's name. + Description ----------- diff --git a/classes/class_visualscriptlocalvarset.rst b/classes/class_visualscriptlocalvarset.rst index db5f7cbf9..7aaa166f3 100644 --- a/classes/class_visualscriptlocalvarset.rst +++ b/classes/class_visualscriptlocalvarset.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptLocalVarSet_type: + - :ref:`int` **type** - The local variable's type. + + .. _class_VisualScriptLocalVarSet_var_name: + - :ref:`String` **var_name** - The local variable's name. + Description ----------- diff --git a/classes/class_visualscriptmathconstant.rst b/classes/class_visualscriptmathconstant.rst index 8fef39e70..45c528384 100644 --- a/classes/class_visualscriptmathconstant.rst +++ b/classes/class_visualscriptmathconstant.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptMathConstant_constant: + - :ref:`int` **constant** - The math constant. + Numeric Constants ----------------- diff --git a/classes/class_visualscriptnode.rst b/classes/class_visualscriptnode.rst index e244753d5..b85fe6c70 100644 --- a/classes/class_visualscriptnode.rst +++ b/classes/class_visualscriptnode.rst @@ -34,6 +34,8 @@ Member Functions Signals ------- +.. _class_VisualScriptNode_ports_changed: + - **ports_changed** **(** **)** Emitted when the available input/output ports are changed. @@ -42,8 +44,11 @@ Emitted when the available input/output ports are changed. Member Variables ---------------- + .. _class_VisualScriptNode__default_input_values: + - :ref:`Array` **_default_input_values** + Description ----------- diff --git a/classes/class_visualscriptoperator.rst b/classes/class_visualscriptoperator.rst index c9665b511..63f25f325 100644 --- a/classes/class_visualscriptoperator.rst +++ b/classes/class_visualscriptoperator.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptOperator_operator: + - :ref:`int` **operator** + + .. _class_VisualScriptOperator_type: + - :ref:`int` **type** + Description ----------- diff --git a/classes/class_visualscriptpreload.rst b/classes/class_visualscriptpreload.rst index c7f8f286e..530ddd85c 100644 --- a/classes/class_visualscriptpreload.rst +++ b/classes/class_visualscriptpreload.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptPreload_resource: + - :ref:`Resource` **resource** - The :ref:`Resource` to load. + Description ----------- diff --git a/classes/class_visualscriptpropertyget.rst b/classes/class_visualscriptpropertyget.rst index 4030931a8..c36acbd1d 100644 --- a/classes/class_visualscriptpropertyget.rst +++ b/classes/class_visualscriptpropertyget.rst @@ -52,15 +52,39 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptPropertyGet_base_script: + - :ref:`String` **base_script** + + .. _class_VisualScriptPropertyGet_base_type: + - :ref:`String` **base_type** + + .. _class_VisualScriptPropertyGet_basic_type: + - :ref:`int` **basic_type** + + .. _class_VisualScriptPropertyGet_index: + - :ref:`String` **index** + + .. _class_VisualScriptPropertyGet_node_path: + - :ref:`NodePath` **node_path** + + .. _class_VisualScriptPropertyGet_property: + - :ref:`String` **property** + + .. _class_VisualScriptPropertyGet_set_mode: + - :ref:`int` **set_mode** + + .. _class_VisualScriptPropertyGet_type_cache: + - :ref:`int` **type_cache** + Numeric Constants ----------------- diff --git a/classes/class_visualscriptpropertyset.rst b/classes/class_visualscriptpropertyset.rst index 0a96db21c..1f83d1cec 100644 --- a/classes/class_visualscriptpropertyset.rst +++ b/classes/class_visualscriptpropertyset.rst @@ -56,16 +56,43 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptPropertySet_assign_op: + - :ref:`int` **assign_op** + + .. _class_VisualScriptPropertySet_base_script: + - :ref:`String` **base_script** + + .. _class_VisualScriptPropertySet_base_type: + - :ref:`String` **base_type** + + .. _class_VisualScriptPropertySet_basic_type: + - :ref:`int` **basic_type** + + .. _class_VisualScriptPropertySet_index: + - :ref:`String` **index** + + .. _class_VisualScriptPropertySet_node_path: + - :ref:`NodePath` **node_path** + + .. _class_VisualScriptPropertySet_property: + - :ref:`String` **property** + + .. _class_VisualScriptPropertySet_set_mode: + - :ref:`int` **set_mode** + + .. _class_VisualScriptPropertySet_type_cache: + - :ref:`Dictionary` **type_cache** + Numeric Constants ----------------- diff --git a/classes/class_visualscriptresourcepath.rst b/classes/class_visualscriptresourcepath.rst index 473d2f0c2..83e4a3e5d 100644 --- a/classes/class_visualscriptresourcepath.rst +++ b/classes/class_visualscriptresourcepath.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptResourcePath_path: + - :ref:`String` **path** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptreturn.rst b/classes/class_visualscriptreturn.rst index 75b8db8bc..6627e7c81 100644 --- a/classes/class_visualscriptreturn.rst +++ b/classes/class_visualscriptreturn.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptReturn_return_enabled: + - :ref:`bool` **return_enabled** - If ``true`` the ``return`` input port is available. + + .. _class_VisualScriptReturn_return_type: + - :ref:`int` **return_type** - The return value's data type. + Description ----------- diff --git a/classes/class_visualscriptscenenode.rst b/classes/class_visualscriptscenenode.rst index e459504a7..72e2f4b1a 100644 --- a/classes/class_visualscriptscenenode.rst +++ b/classes/class_visualscriptscenenode.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptSceneNode_node_path: + - :ref:`NodePath` **node_path** - The node's path in the scene tree. + Description ----------- diff --git a/classes/class_visualscriptselect.rst b/classes/class_visualscriptselect.rst index 377884586..f02b92b7c 100644 --- a/classes/class_visualscriptselect.rst +++ b/classes/class_visualscriptselect.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptSelect_type: + - :ref:`int` **type** - The input variables' type. + Description ----------- diff --git a/classes/class_visualscriptsequence.rst b/classes/class_visualscriptsequence.rst index 6d813a5a9..cd7d31da9 100644 --- a/classes/class_visualscriptsequence.rst +++ b/classes/class_visualscriptsequence.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptSequence_steps: + - :ref:`int` **steps** - The number of steps in the sequence. + Description ----------- diff --git a/classes/class_visualscripttypecast.rst b/classes/class_visualscripttypecast.rst index 1248ecb7a..ab87efc52 100644 --- a/classes/class_visualscripttypecast.rst +++ b/classes/class_visualscripttypecast.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptTypeCast_base_script: + - :ref:`String` **base_script** + + .. _class_VisualScriptTypeCast_base_type: + - :ref:`String` **base_type** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptvariableget.rst b/classes/class_visualscriptvariableget.rst index 58d1fa4ab..e2938b774 100644 --- a/classes/class_visualscriptvariableget.rst +++ b/classes/class_visualscriptvariableget.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptVariableGet_var_name: + - :ref:`String` **var_name** - The variable's name. + Description ----------- diff --git a/classes/class_visualscriptvariableset.rst b/classes/class_visualscriptvariableset.rst index 1221e623c..00cd95287 100644 --- a/classes/class_visualscriptvariableset.rst +++ b/classes/class_visualscriptvariableset.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptVariableSet_var_name: + - :ref:`String` **var_name** - The variable's name. + Description ----------- diff --git a/classes/class_visualscriptyield.rst b/classes/class_visualscriptyield.rst index d02ea5c50..2c6d94332 100644 --- a/classes/class_visualscriptyield.rst +++ b/classes/class_visualscriptyield.rst @@ -32,9 +32,15 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptYield_mode: + - :ref:`int` **mode** + + .. _class_VisualScriptYield_wait_time: + - :ref:`float` **wait_time** + Numeric Constants ----------------- diff --git a/classes/class_visualscriptyieldsignal.rst b/classes/class_visualscriptyieldsignal.rst index acc84c853..3c389889e 100644 --- a/classes/class_visualscriptyieldsignal.rst +++ b/classes/class_visualscriptyieldsignal.rst @@ -40,11 +40,23 @@ Member Functions Member Variables ---------------- + .. _class_VisualScriptYieldSignal_base_type: + - :ref:`String` **base_type** + + .. _class_VisualScriptYieldSignal_call_mode: + - :ref:`int` **call_mode** + + .. _class_VisualScriptYieldSignal_node_path: + - :ref:`NodePath` **node_path** + + .. _class_VisualScriptYieldSignal_signal: + - :ref:`String` **signal** + Numeric Constants ----------------- diff --git a/classes/class_windowdialog.rst b/classes/class_windowdialog.rst index 9bab47ffa..66048af74 100644 --- a/classes/class_windowdialog.rst +++ b/classes/class_windowdialog.rst @@ -36,9 +36,15 @@ Member Functions Member Variables ---------------- + .. _class_WindowDialog_resizable: + - :ref:`bool` **resizable** + + .. _class_WindowDialog_window_title: + - :ref:`String` **window_title** + Description ----------- diff --git a/classes/class_world.rst b/classes/class_world.rst index 4b32e527e..23c9da95e 100644 --- a/classes/class_world.rst +++ b/classes/class_world.rst @@ -38,9 +38,15 @@ Member Functions Member Variables ---------------- + .. _class_World_environment: + - :ref:`Environment` **environment** + + .. _class_World_fallback_environment: + - :ref:`Environment` **fallback_environment** + Description ----------- diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index 4812f4463..49e183464 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_WorldEnvironment_environment: + - :ref:`Environment` **environment** + Description ----------- diff --git a/classes/class_ysort.rst b/classes/class_ysort.rst index e57c158ae..e6f7d4440 100644 --- a/classes/class_ysort.rst +++ b/classes/class_ysort.rst @@ -28,8 +28,11 @@ Member Functions Member Variables ---------------- + .. _class_YSort_sort_enabled: + - :ref:`bool` **sort_enabled** + Description -----------