diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index db82cab49..6f9189c76 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -482,7 +482,6 @@ Numeric Constants - **ERR_BUSY** = **44** --- Busy error - **ERR_HELP** = **46** --- Help error - **ERR_BUG** = **47** --- Bug error -- **ERR_WTF** = **49** --- WTF error (something probably went really wrong) - **PROPERTY_HINT_NONE** = **0** --- No hint for edited property. - **PROPERTY_HINT_RANGE** = **1** --- Hints that the string is a range, defined as "min,max" or "min,max,step". This is valid for integers and floats. - **PROPERTY_HINT_EXP_RANGE** = **2** --- Hints that the string is an exponential range, defined as "min,max" or "min,max,step". This is valid for integers and floats. @@ -520,7 +519,7 @@ Numeric Constants - **PROPERTY_USAGE_SCRIPT_VARIABLE** = **8192** - **PROPERTY_USAGE_DEFAULT** = **7** --- Default usage (storage and editor). - **PROPERTY_USAGE_DEFAULT_INTL** = **71** -- **PROPERTY_USAGE_NOEDITOR** = **5** +- **PROPERTY_USAGE_NOEDITOR** = **1048581** - **METHOD_FLAG_NORMAL** = **1** --- Flag for normal method - **METHOD_FLAG_EDITOR** = **2** --- Flag for editor method - **METHOD_FLAG_NOSCRIPT** = **4** diff --git a/classes/class_animation.rst b/classes/class_animation.rst index 95a88a0ef..f5f990db4 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -24,6 +24,8 @@ Member Functions +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`copy_track` **(** :ref:`int` track, :ref:`Animation` to_animation **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find_track` **(** :ref:`NodePath` path **)** const | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_length` **(** **)** const | @@ -68,6 +70,8 @@ Member Functions +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`track_is_enabled` **(** :ref:`int` idx **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`track_is_imported` **(** :ref:`int` idx **)** const | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`track_move_down` **(** :ref:`int` idx **)** | @@ -78,6 +82,8 @@ Member Functions +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`track_remove_key_at_position` **(** :ref:`int` idx, :ref:`float` position **)** | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_enabled` **(** :ref:`int` idx, :ref:`bool` enabled **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`track_set_imported` **(** :ref:`int` idx, :ref:`bool` imported **)** | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`track_set_interpolation_loop_wrap` **(** :ref:`int` idx, :ref:`bool` interpolation **)** | @@ -136,6 +142,10 @@ Add a track to the Animation. The track type must be specified as any of the val Clear the animation (clear all tracks and reset all). +.. _class_Animation_copy_track: + +- void **copy_track** **(** :ref:`int` track, :ref:`Animation` to_animation **)** + .. _class_Animation_find_track: - :ref:`int` **find_track** **(** :ref:`NodePath` path **)** const @@ -218,6 +228,8 @@ Find the key index by time in a given track. Optionally, only find it if the exa - :ref:`bool` **track_get_interpolation_loop_wrap** **(** :ref:`int` idx **)** const +Returns ``true`` if the track at ``idx`` wraps the interpolation loop. Default value: ``true``. + .. _class_Animation_track_get_interpolation_type: - :ref:`int` **track_get_interpolation_type** **(** :ref:`int` idx **)** const @@ -266,6 +278,10 @@ Get the type of a track. Insert a generic key in a given track. +.. _class_Animation_track_is_enabled: + +- :ref:`bool` **track_is_enabled** **(** :ref:`int` idx **)** const + .. _class_Animation_track_is_imported: - :ref:`bool` **track_is_imported** **(** :ref:`int` idx **)** const @@ -296,6 +312,10 @@ Remove a key by index in a given track. Remove a key by position (seconds) in a given track. +.. _class_Animation_track_set_enabled: + +- void **track_set_enabled** **(** :ref:`int` idx, :ref:`bool` enabled **)** + .. _class_Animation_track_set_imported: - void **track_set_imported** **(** :ref:`int` idx, :ref:`bool` imported **)** @@ -306,6 +326,8 @@ Set the given track as imported or not. - void **track_set_interpolation_loop_wrap** **(** :ref:`int` idx, :ref:`bool` interpolation **)** +If ``true`` the track at ``idx`` wraps the interpolation loop. + .. _class_Animation_track_set_interpolation_type: - void **track_set_interpolation_type** **(** :ref:`int` idx, :ref:`int` interpolation **)** diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index a1e04108c..e7e370390 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -38,24 +38,14 @@ Member Functions +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`get_animation_list` **(** **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_autoplay` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_animation` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_current_animation_length` **(** **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_current_animation_position` **(** **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_position` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_speed_scale` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_animation` **(** :ref:`String` name **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_active` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_playing` **(** **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`play` **(** :ref:`String` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** | @@ -70,16 +60,8 @@ Member Functions +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`seek` **(** :ref:`float` seconds, :ref:`bool` update=false **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_active` **(** :ref:`bool` active **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_autoplay` **(** :ref:`String` name **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to, :ref:`float` sec **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_animation` **(** :ref:`String` anim **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_speed_scale` **(** :ref:`float` speed **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`stop` **(** :ref:`bool` reset=true **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`stop_all` **(** **)** | @@ -92,35 +74,51 @@ Signals - **animation_changed** **(** :ref:`String` old_name, :ref:`String` new_name **)** -If the currently being played animation changes, this signal will notify of such change. +Emitted when the :ref:`Animation` with key :ref:`current_anim` is modified. .. _class_AnimationPlayer_animation_finished: - **animation_finished** **(** :ref:`String` name **)** -Notifies when an animation finished playing. +Emitted when an animation finishes. .. _class_AnimationPlayer_animation_started: - **animation_started** **(** :ref:`String` name **)** -Notifies when an animation starts playing. +Emitted when an animation starts. Member Variables ---------------- + .. _class_AnimationPlayer_active: + +- :ref:`bool` **active** - If ``true`` updates animations in response to process-related notifications. Default value: ``true``. + + .. _class_AnimationPlayer_autoplay: + +- :ref:`String` **autoplay** - The name of the animation to play when the scene loads. Default value: ``""``. + + .. _class_AnimationPlayer_current_animation: + +- :ref:`String` **current_animation** - The name of the current animation. Default value: ``""``. + .. _class_AnimationPlayer_playback_default_blend_time: - :ref:`float` **playback_default_blend_time** .. _class_AnimationPlayer_playback_process_mode: -- :ref:`int` **playback_process_mode** +- :ref:`int` **playback_process_mode** - The process notification in which to update animations. Default value: enum ANIMATION_PROCESS_IDLE. .. _class_AnimationPlayer_root_node: -- :ref:`NodePath` **root_node** +- :ref:`NodePath` **root_node** - The node from which node path references will travel. Default value: ``".."``. + + .. _class_AnimationPlayer_speed_scale: + +- :ref:`float` **speed_scale** - The speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default value: ``1``. Numeric Constants @@ -141,127 +139,97 @@ Member Function Description - :ref:`int` **add_animation** **(** :ref:`String` name, :ref:`Animation` animation **)** -Add an animation resource to the player, which will be later referenced by the "name" argument. +Adds ``animation`` to the player accessible with the key ``name``. .. _class_AnimationPlayer_advance: - void **advance** **(** :ref:`float` delta **)** -Used to skip ahead or skip back in an animation. Delta is the time in seconds to skip. +Shifts position in the animation timeline. Delta is the time in seconds to shift. .. _class_AnimationPlayer_animation_get_next: - :ref:`String` **animation_get_next** **(** :ref:`String` anim_from **)** const -Return the name of the next animation in the queue. +Returns the name of the next animation in the queue. .. _class_AnimationPlayer_animation_set_next: - void **animation_set_next** **(** :ref:`String` anim_from, :ref:`String` anim_to **)** -Set the name of an animation that will be played after. +Triggers the ``anim_to`` animation when the ``anim_from`` animation completes. .. _class_AnimationPlayer_clear_caches: - void **clear_caches** **(** **)** -The animation player creates caches for faster access to the nodes it will animate. However, if a specific node is removed, it may not notice it, so clear_caches will force the player to search for the nodes again. +``AnimationPlayer`` caches animated nodes. It may not notice if a node disappears, so clear_caches forces it to update the cache again. .. _class_AnimationPlayer_clear_queue: - void **clear_queue** **(** **)** -If animations are queued to play, clear them. +Clears all queued, unplayed animations. .. _class_AnimationPlayer_find_animation: - :ref:`String` **find_animation** **(** :ref:`Animation` animation **)** const -Find an animation name by resource. +Returns the name of ``animation`` or empty string if not found. .. _class_AnimationPlayer_get_animation: - :ref:`Animation` **get_animation** **(** :ref:`String` name **)** const -Get an :ref:`Animation` resource by requesting a name. +Returns the :ref:`Animation` with key ``name`` or ``null`` if not found. .. _class_AnimationPlayer_get_animation_list: - :ref:`PoolStringArray` **get_animation_list** **(** **)** const -Get the list of names of the animations stored in the player. - -.. _class_AnimationPlayer_get_autoplay: - -- :ref:`String` **get_autoplay** **(** **)** const - -Return the name of the animation that will be automatically played when the scene is loaded. +Returns the list of stored animation names. .. _class_AnimationPlayer_get_blend_time: - :ref:`float` **get_blend_time** **(** :ref:`String` anim_from, :ref:`String` anim_to **)** const -Get the blend time between two animations, referenced by their names. - -.. _class_AnimationPlayer_get_current_animation: - -- :ref:`String` **get_current_animation** **(** **)** const - -Return the name of the animation being played. +Get the blend time (in seconds) between two animations, referenced by their names. .. _class_AnimationPlayer_get_current_animation_length: - :ref:`float` **get_current_animation_length** **(** **)** const -Get the length (in seconds) of the currently being played animation. +Get the length (in seconds) of the currently playing animation. .. _class_AnimationPlayer_get_current_animation_position: - :ref:`float` **get_current_animation_position** **(** **)** const -Get the position (in seconds) of the currently being played animation. - -.. _class_AnimationPlayer_get_position: - -- :ref:`float` **get_position** **(** **)** const - -Return the playback position (in seconds) in an animation channel (or channel 0 if none is provided). - -.. _class_AnimationPlayer_get_speed_scale: - -- :ref:`float` **get_speed_scale** **(** **)** const - -Get the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is *1* (no scaling). +Get the position (in seconds) of the currently playing animation. .. _class_AnimationPlayer_has_animation: - :ref:`bool` **has_animation** **(** :ref:`String` name **)** const -Request whether an :ref:`Animation` name exist within the player. - -.. _class_AnimationPlayer_is_active: - -- :ref:`bool` **is_active** **(** **)** const - -Return true if the player is active. +Returns ``true`` if the ``AnimationPlayer`` stores an :ref:`Animation` with key ``name``. .. _class_AnimationPlayer_is_playing: - :ref:`bool` **is_playing** **(** **)** const -Return whether an animation is playing. +Returns ``true`` if playing an animation. .. _class_AnimationPlayer_play: - void **play** **(** :ref:`String` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** -Play a given animation by the animation name. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards. +Play the animation with key ``name``. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards. .. _class_AnimationPlayer_play_backwards: - void **play_backwards** **(** :ref:`String` name="", :ref:`float` custom_blend=-1 **)** -Play a given animation by the animation name in reverse. +Play the animation with key ``name`` in reverse. .. _class_AnimationPlayer_queue: @@ -273,31 +241,19 @@ Queue an animation for playback once the current one is done. - void **remove_animation** **(** :ref:`String` name **)** -Remove an animation from the player (by supplying the same name used to add it). +Remove the animation with key ``name``. .. _class_AnimationPlayer_rename_animation: - void **rename_animation** **(** :ref:`String` name, :ref:`String` newname **)** -Rename an existing animation. +Rename an existing animation with key ``name`` to ``newname``. .. _class_AnimationPlayer_seek: - void **seek** **(** :ref:`float` seconds, :ref:`bool` update=false **)** -Seek the animation to a given position in time (in seconds). If 'update' is true, the animation will be updated too, otherwise it will be updated at process time. - -.. _class_AnimationPlayer_set_active: - -- void **set_active** **(** :ref:`bool` active **)** - -Set the player as active (playing). If false, it will do nothing. - -.. _class_AnimationPlayer_set_autoplay: - -- void **set_autoplay** **(** :ref:`String` name **)** - -Set the name of the animation that will be automatically played when the scene is loaded. +Seek the animation to the ``seconds`` point in time (in seconds). If 'update' is true, the animation updates too, otherwise it updates at process time. .. _class_AnimationPlayer_set_blend_time: @@ -305,23 +261,11 @@ Set the name of the animation that will be automatically played when the scene i Specify a blend time (in seconds) between two animations, referenced by their names. -.. _class_AnimationPlayer_set_current_animation: - -- void **set_current_animation** **(** :ref:`String` anim **)** - -Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to calling play(). - -.. _class_AnimationPlayer_set_speed_scale: - -- void **set_speed_scale** **(** :ref:`float` speed **)** - -Set a speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is *1* (no scaling). - .. _class_AnimationPlayer_stop: - void **stop** **(** :ref:`bool` reset=true **)** -Stop the currently playing animation. +Stop the currently playing animation. If ``reset`` is ``true``, the anim position is reset to ``0``. .. _class_AnimationPlayer_stop_all: diff --git a/classes/class_animationtreeplayer.rst b/classes/class_animationtreeplayer.rst index 784c6b9ce..411daf1d5 100644 --- a/classes/class_animationtreeplayer.rst +++ b/classes/class_animationtreeplayer.rst @@ -54,14 +54,8 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_nodes` **(** :ref:`String` id, :ref:`int` dst_input_idx **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_base_path` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_master_player` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`get_node_list` **(** **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_active` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`mix_node_get_amount` **(** :ref:`String` id **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`mix_node_set_amount` **(** :ref:`String` id, :ref:`float` ratio **)** | @@ -114,12 +108,6 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`reset` **(** **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_active` **(** :ref:`bool` enabled **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_path` **(** :ref:`NodePath` path **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_master_player` **(** :ref:`NodePath` nodepath **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`timescale_node_get_scale` **(** :ref:`String` id **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`timescale_node_set_scale` **(** :ref:`String` id, :ref:`float` scale **)** | @@ -148,9 +136,21 @@ Member Functions Member Variables ---------------- + .. _class_AnimationTreePlayer_active: + +- :ref:`bool` **active** - If ``true`` the ``AnimationTreePlayer`` is able to play animations. Default value: ``false``. + + .. _class_AnimationTreePlayer_base_path: + +- :ref:`NodePath` **base_path** - The node from which to relatively access other nodes. Default value: ``".."``. + + .. _class_AnimationTreePlayer_master_player: + +- :ref:`NodePath` **master_player** - The path to the :ref:`AnimationPlayer` from which this ``AnimationTreePlayer`` binds animations to animation nodes. + .. _class_AnimationTreePlayer_playback_process_mode: -- :ref:`int` **playback_process_mode** +- :ref:`int` **playback_process_mode** - The thread in which to update animations. Default value: enum ANIMATION_PROCESS_IDLE. Numeric Constants @@ -166,13 +166,13 @@ Numeric Constants - **NODE_TIMESCALE** = **7** --- TimeScale node. - **NODE_TIMESEEK** = **8** --- TimeSeek node. - **NODE_TRANSITION** = **9** --- Transition node. -- **ANIMATION_PROCESS_PHYSICS** = **0** -- **ANIMATION_PROCESS_IDLE** = **1** +- **ANIMATION_PROCESS_PHYSICS** = **0** --- Process animation during the physics process. This is especially useful when animating physics bodies. +- **ANIMATION_PROCESS_IDLE** = **1** --- Process animation during the idle process. Description ----------- -Animation Player that uses a node graph for the blending. This kind of player is very useful when animating character or other skeleton based rigs, because it can combine several animations to form a desired pose. +A node graph tool for blending multiple animations bound to an :ref:`AnimationPlayer`. Especially useful for animating characters or other skeleton-based rigs. It can combine several animations to form a desired pose. Member Function Description --------------------------- @@ -181,36 +181,44 @@ Member Function Description - void **add_node** **(** :ref:`int` type, :ref:`String` id **)** -Add a node of a given type in the graph with given id. +Adds a ``type`` node to the graph with name ``id``. .. _class_AnimationTreePlayer_advance: - void **advance** **(** :ref:`float` delta **)** +Shifts position in the animation timeline. Delta is the time in seconds to shift. + .. _class_AnimationTreePlayer_animation_node_get_animation: - :ref:`Animation` **animation_node_get_animation** **(** :ref:`String` id **)** const -Returns an animation given its name. +Returns the :ref:`AnimationPlayer`'s animation bound to the ``AnimationTreePlayer``'s animation node with name ``id``. .. _class_AnimationTreePlayer_animation_node_get_master_animation: - :ref:`String` **animation_node_get_master_animation** **(** :ref:`String` id **)** const +Returns the name of the :ref:`master_player`'s animation bound to this animation node. + .. _class_AnimationTreePlayer_animation_node_set_animation: - void **animation_node_set_animation** **(** :ref:`String` id, :ref:`Animation` animation **)** -Set the animation for an animation node. +Binds a new animation from the :ref:`master_player` to the ``AnimationTreePlayer``'s animation node with name ``id``. .. _class_AnimationTreePlayer_animation_node_set_filter_path: - void **animation_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** +If ``enable`` is ``true``, the animation node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate. + .. _class_AnimationTreePlayer_animation_node_set_master_animation: - void **animation_node_set_master_animation** **(** :ref:`String` id, :ref:`String` source **)** +Binds the animation named ``source`` from :ref:`master_player` to the animation node ``id``. Recalculates caches. + .. _class_AnimationTreePlayer_are_nodes_connected: - :ref:`bool` **are_nodes_connected** **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** const @@ -233,6 +241,8 @@ Sets the blend amount of a Blend2 node given its name and value. - void **blend2_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** +If ``enable`` is ``true``, the blend2 node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate. + .. _class_AnimationTreePlayer_blend3_node_get_amount: - :ref:`float` **blend3_node_get_amount** **(** :ref:`String` id **)** const @@ -269,26 +279,12 @@ Connects node ``id`` to ``dst_id`` at the specified input slot. Disconnects nodes connected to ``id`` at the specified input slot. -.. _class_AnimationTreePlayer_get_base_path: - -- :ref:`NodePath` **get_base_path** **(** **)** const - -.. _class_AnimationTreePlayer_get_master_player: - -- :ref:`NodePath` **get_master_player** **(** **)** const - .. _class_AnimationTreePlayer_get_node_list: - :ref:`PoolStringArray` **get_node_list** **(** **)** Returns a PoolStringArray containing the name of all nodes. -.. _class_AnimationTreePlayer_is_active: - -- :ref:`bool` **is_active** **(** **)** const - -Returns whether this AnimationTreePlayer is active. - .. _class_AnimationTreePlayer_mix_node_get_amount: - :ref:`float` **mix_node_get_amount** **(** :ref:`String` id **)** const @@ -413,6 +409,8 @@ Sets fade out time of a OneShot node given its name and value in seconds. - void **oneshot_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** +If ``enable`` is ``true``, the oneshot node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate. + .. _class_AnimationTreePlayer_oneshot_node_start: - void **oneshot_node_start** **(** :ref:`String` id **)** @@ -423,90 +421,96 @@ Starts a OneShot node given its name. - void **oneshot_node_stop** **(** :ref:`String` id **)** -Stops a OneShot node given its name. +Stops the OneShot node with name ``id``. .. _class_AnimationTreePlayer_recompute_caches: - void **recompute_caches** **(** **)** +Manually recalculates the cache of track information generated from animation nodes. Needed when external sources modify the animation nodes' state. + .. _class_AnimationTreePlayer_remove_node: - void **remove_node** **(** :ref:`String` id **)** +Removes the animation node with name ``id``. + .. _class_AnimationTreePlayer_reset: - void **reset** **(** **)** Resets this AnimationTreePlayer. -.. _class_AnimationTreePlayer_set_active: - -- void **set_active** **(** :ref:`bool` enabled **)** - -Sets whether this AnimationTreePlayer is active. AnimationTreePlayer will start processing if set to active. - -.. _class_AnimationTreePlayer_set_base_path: - -- void **set_base_path** **(** :ref:`NodePath` path **)** - -Sets base path of this AnimationTreePlayer. - -.. _class_AnimationTreePlayer_set_master_player: - -- void **set_master_player** **(** :ref:`NodePath` nodepath **)** - .. _class_AnimationTreePlayer_timescale_node_get_scale: - :ref:`float` **timescale_node_get_scale** **(** :ref:`String` id **)** const -Returns time scale value of a TimeScale node given its name. +Returns time scale value of the TimeScale node with name ``id``. .. _class_AnimationTreePlayer_timescale_node_set_scale: - void **timescale_node_set_scale** **(** :ref:`String` id, :ref:`float` scale **)** -Sets time scale value of a TimeScale node given its name and value. +Sets the time scale of the TimeScale node with name ``id`` to ``scale``. .. _class_AnimationTreePlayer_timeseek_node_seek: - void **timeseek_node_seek** **(** :ref:`String` id, :ref:`float` seconds **)** -Sets time seek value of a TimeSeek node given its name and value. +Sets the time seek value of the TimeSeek node with name ``id`` to ``seconds`` .. _class_AnimationTreePlayer_transition_node_delete_input: - void **transition_node_delete_input** **(** :ref:`String` id, :ref:`int` input_idx **)** +Deletes the input at ``input_idx`` for the transition node with name ``id``. + .. _class_AnimationTreePlayer_transition_node_get_current: - :ref:`int` **transition_node_get_current** **(** :ref:`String` id **)** const +Returns the index of the currently evaluated input for the transition node with name ``id``. + .. _class_AnimationTreePlayer_transition_node_get_input_count: - :ref:`int` **transition_node_get_input_count** **(** :ref:`String` id **)** const +Returns the number of inputs for the transition node with name ``id``. + .. _class_AnimationTreePlayer_transition_node_get_xfade_time: - :ref:`float` **transition_node_get_xfade_time** **(** :ref:`String` id **)** const +Returns the cross fade time for the transition node with name ``id``. + .. _class_AnimationTreePlayer_transition_node_has_input_auto_advance: - :ref:`bool` **transition_node_has_input_auto_advance** **(** :ref:`String` id, :ref:`int` input_idx **)** const +Returns ``true`` if the input at ``input_idx`` on transition node with name ``id`` is set to automatically advance to the next input upon completion. + .. _class_AnimationTreePlayer_transition_node_set_current: - void **transition_node_set_current** **(** :ref:`String` id, :ref:`int` input_idx **)** +The transition node with name ``id`` sets its current input at ``input_idx``. + .. _class_AnimationTreePlayer_transition_node_set_input_auto_advance: - void **transition_node_set_input_auto_advance** **(** :ref:`String` id, :ref:`int` input_idx, :ref:`bool` enable **)** +The transition node with name ``id`` advances to its next input automatically when the input at ``input_idx`` completes. + .. _class_AnimationTreePlayer_transition_node_set_input_count: - void **transition_node_set_input_count** **(** :ref:`String` id, :ref:`int` count **)** +Resizes the number of inputs available for the transition node with name ``id``. + .. _class_AnimationTreePlayer_transition_node_set_xfade_time: - void **transition_node_set_xfade_time** **(** :ref:`String` id, :ref:`float` time_sec **)** +The transition node with name ``id`` sets its cross fade time to ``time_sec``. + diff --git a/classes/class_area.rst b/classes/class_area.rst index 3f06933f3..94a9f6d6d 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -146,19 +146,19 @@ Member Variables .. _class_Area_reverb_bus_amount: -- :ref:`float` **reverb_bus_amount** +- :ref:`float` **reverb_bus_amount** - The degree to which this area applies reverb to its associated audio. Ranges from ``0`` to ``1`` with ``0.1`` precision. .. _class_Area_reverb_bus_enable: -- :ref:`bool` **reverb_bus_enable** +- :ref:`bool` **reverb_bus_enable** - If ``true`` the area applies reverb to its associated audio. .. _class_Area_reverb_bus_name: -- :ref:`String` **reverb_bus_name** +- :ref:`String` **reverb_bus_name** - The reverb bus name to use for this area's associated audio. .. _class_Area_reverb_bus_uniformity: -- :ref:`float` **reverb_bus_uniformity** +- :ref:`float` **reverb_bus_uniformity** - The degree to which this area's reverb is a uniform effect. Ranges from ``0`` to ``1`` with ``0.1`` precision. .. _class_Area_space_override: @@ -186,13 +186,13 @@ Member Function Description - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const -Return an individual bit on the layer mask. +Returns an individual bit on the layer mask. .. _class_Area_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const -Return an individual bit on the collision mask. +Returns an individual bit on the collision mask. .. _class_Area_get_overlapping_areas: @@ -222,12 +222,12 @@ If ``true`` the given body overlaps the Area. - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** -Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. +Set/clear individual bits on the layer mask. This simplifies editing this ``Area[code]'s layers. .. _class_Area_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** -Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. +Set/clear individual bits on the collision mask. This simplifies editing which ``Area`` layers this ``Area`` scans. diff --git a/classes/class_array.rst b/classes/class_array.rst index afa44244c..82be76316 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -298,4 +298,15 @@ Sort the array using natural order and return reference to the array. Sort the array using a custom method and return reference to the array. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. Note: you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. +:: + + class MyCustomSorter: + static func sort(a, b): + if a[0] < b[0]: + return true + return false + + var my_items = [[5, "Potato"], [9, "Rice"], [4, "Tomato"]] + my_items.sort_custom(MyCustomSorter, "sort") + diff --git a/classes/class_arvrcontroller.rst b/classes/class_arvrcontroller.rst index 227fce3aa..0a91784bf 100644 --- a/classes/class_arvrcontroller.rst +++ b/classes/class_arvrcontroller.rst @@ -40,13 +40,13 @@ Signals - **button_pressed** **(** :ref:`int` button **)** -When a button on this controller is pressed, this signal is given. +Emitted when a button on this controller is pressed. .. _class_ARVRController_button_release: - **button_release** **(** :ref:`int` button **)** -When a button on this controller is released, this signal is given. +Emitted when a button on this controller is released. Member Variables @@ -58,7 +58,7 @@ Member Variables .. _class_ARVRController_rumble: -- :ref:`float` **rumble** +- :ref:`float` **rumble** - The degree to which the tracker rumbles. Ranges from ``0.0`` to ``1.0`` with precision ``.01``. If changed, updates :ref:`ARVRPositionalTracker.rumble` accordingly. Description @@ -89,7 +89,7 @@ Returns the hand holding this controller, if known. See TRACKER\_\* constants in - :ref:`bool` **get_is_active** **(** **)** const -Returns true if the controller bound to this node is currently active and being tracked. +Returns ``true`` if the bound controller is active. ARVR systems attempt to track active controllers. .. _class_ARVRController_get_joystick_axis: @@ -107,6 +107,6 @@ Returns the ID of the joystick object bound to this. Every controller tracked by - :ref:`int` **is_button_pressed** **(** :ref:`int` button **)** const -Is the given button currently pressed? +Returns ``true`` if the button at index ``button`` is pressed. diff --git a/classes/class_arvrpositionaltracker.rst b/classes/class_arvrpositionaltracker.rst index b30babe31..57c696d26 100644 --- a/classes/class_arvrpositionaltracker.rst +++ b/classes/class_arvrpositionaltracker.rst @@ -44,7 +44,7 @@ Member Variables .. _class_ARVRPositionalTracker_rumble: -- :ref:`float` **rumble** +- :ref:`float` **rumble** - The degree to which the tracker rumbles. Ranges from ``0.0`` to ``1.0`` with precision ``.01``. Numeric Constants @@ -82,42 +82,42 @@ If this is a controller that is being tracked the controller will also be repres - :ref:`String` **get_name** **(** **)** const -If available this returns the name of the controller or anchor point. +Returns the controller or anchor point's name if available. .. _class_ARVRPositionalTracker_get_orientation: - :ref:`Basis` **get_orientation** **(** **)** const -Returns the orientation matrix of the controller. +Returns the controller's orientation matrix. .. _class_ARVRPositionalTracker_get_position: - :ref:`Vector3` **get_position** **(** **)** const -Returns the position of the controller adjusted by world scale. +Returns the world-space controller position. .. _class_ARVRPositionalTracker_get_tracks_orientation: - :ref:`bool` **get_tracks_orientation** **(** **)** const -Returns true if the orientation of this device is being tracked. +Returns ``true`` if this device tracks orientation. .. _class_ARVRPositionalTracker_get_tracks_position: - :ref:`bool` **get_tracks_position** **(** **)** const -Returns true if the position of this device is being tracked. +Returns ``true`` if this device tracks position. .. _class_ARVRPositionalTracker_get_transform: - :ref:`Transform` **get_transform** **(** :ref:`bool` adjust_by_reference_frame **)** const -Returns the transform combining the orientation and position of this device. +Returns the transform combining this device's orientation and position. .. _class_ARVRPositionalTracker_get_type: - :ref:`int` **get_type** **(** **)** const -Type of tracker. +Returns the tracker's type. diff --git a/classes/class_astar.rst b/classes/class_astar.rst index 5cd483728..88c0b96ea 100644 --- a/classes/class_astar.rst +++ b/classes/class_astar.rst @@ -229,6 +229,8 @@ Returns the weight scale of the point associated with the given id. - :ref:`Array` **get_points** **(** **)** +Returns an array of all points. + .. _class_AStar_has_point: - :ref:`bool` **has_point** **(** :ref:`int` id **)** const diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index d9447f097..ed5c6d319 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -25,7 +25,7 @@ Member Variables .. _class_AtlasTexture_filter_clip: -- :ref:`bool` **filter_clip** +- :ref:`bool` **filter_clip** - If ``true`` clips the area outside of the region to avoid bleeding of the surrounding texture pixels. .. _class_AtlasTexture_margin: diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index 100360818..5f3450da6 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -16,24 +16,53 @@ Brief Description OGG Vorbis audio stream driver. -Member Variables +Member Functions ---------------- - .. _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. - ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** const | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_loop_offset` **(** **)** const | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_loop` **(** **)** const | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_data` **(** :ref:`PoolByteArray` data **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_loop` **(** :ref:`bool` enable **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_loop_offset` **(** :ref:`float` seconds **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------+ Description ----------- OGG Vorbis audio stream driver. +Member Function Description +--------------------------- + +.. _class_AudioStreamOGGVorbis_get_data: + +- :ref:`PoolByteArray` **get_data** **(** **)** const + +.. _class_AudioStreamOGGVorbis_get_loop_offset: + +- :ref:`float` **get_loop_offset** **(** **)** const + +.. _class_AudioStreamOGGVorbis_has_loop: + +- :ref:`bool` **has_loop** **(** **)** const + +.. _class_AudioStreamOGGVorbis_set_data: + +- void **set_data** **(** :ref:`PoolByteArray` data **)** + +.. _class_AudioStreamOGGVorbis_set_loop: + +- void **set_loop** **(** :ref:`bool` enable **)** + +.. _class_AudioStreamOGGVorbis_set_loop_offset: + +- void **set_loop_offset** **(** :ref:`float` seconds **)** + + diff --git a/classes/class_audiostreamsample.rst b/classes/class_audiostreamsample.rst index 0b1fb49ab..77bd6bc81 100644 --- a/classes/class_audiostreamsample.rst +++ b/classes/class_audiostreamsample.rst @@ -16,12 +16,17 @@ Brief Description Plays audio. -Member Variables +Member Functions ---------------- - .. _class_AudioStreamSample_data: ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_data` **(** :ref:`PoolByteArray` data **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ -- :ref:`PoolByteArray` **data** - Raw audio data. +Member Variables +---------------- .. _class_AudioStreamSample_format: @@ -63,3 +68,15 @@ Description Plays audio, can loop. +Member Function Description +--------------------------- + +.. _class_AudioStreamSample_get_data: + +- :ref:`PoolByteArray` **get_data** **(** **)** const + +.. _class_AudioStreamSample_set_data: + +- void **set_data** **(** :ref:`PoolByteArray` data **)** + + diff --git a/classes/class_basis.rst b/classes/class_basis.rst index bc07b0186..99d3ce49b 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -60,15 +60,15 @@ Member Variables .. _class_Basis_x: -- :ref:`Vector3` **x** +- :ref:`Vector3` **x** - The basis matrix's x vector. .. _class_Basis_y: -- :ref:`Vector3` **y** +- :ref:`Vector3` **y** - The basis matrix's y vector. .. _class_Basis_z: -- :ref:`Vector3` **z** +- :ref:`Vector3` **z** - The basis matrix's z vector. Description diff --git a/classes/class_bitmap.rst b/classes/class_bitmap.rst index d2949a0e7..30d81eb3c 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -35,18 +35,6 @@ Member Functions | void | :ref:`set_bit_rect` **(** :ref:`Rect2` p_rect, :ref:`bool` bit **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -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 cd28c822a..de345032a 100644 --- a/classes/class_bitmapfont.rst +++ b/classes/class_bitmapfont.rst @@ -46,10 +46,6 @@ Member Variables - :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. @@ -62,14 +58,6 @@ Member Variables - :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_camera2d.rst b/classes/class_camera2d.rst index 84225f51d..e7835378b 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -138,8 +138,8 @@ Member Variables Numeric Constants ----------------- -- **ANCHOR_MODE_FIXED_TOP_LEFT** = **0** -- **ANCHOR_MODE_DRAG_CENTER** = **1** +- **ANCHOR_MODE_FIXED_TOP_LEFT** = **0** --- The camera's position is fixed so that the top-left corner is always at the origin. +- **ANCHOR_MODE_DRAG_CENTER** = **1** --- The camera's position takes into account vertical/horizontal offsets and the screen size. Description ----------- @@ -161,6 +161,8 @@ Align the camera to the tracked node - void **clear_current** **(** **)** +Removes any ``Camera2D`` from the ancestor :ref:`Viewport`'s internal currently-assigned camera. + .. _class_Camera2D_force_update_scroll: - void **force_update_scroll** **(** **)** @@ -177,18 +179,26 @@ Return the camera position. - :ref:`Vector2` **get_camera_screen_center** **(** **)** const +Returns the location of the ``Camera2D``'s screen-center, relative to the origin. + .. _class_Camera2D_get_custom_viewport: - :ref:`Node` **get_custom_viewport** **(** **)** const +Returns the :ref:`Viewport` used by the camera if it is not using the default viewport. + .. _class_Camera2D_get_h_offset: - :ref:`float` **get_h_offset** **(** **)** const +Returns the horizontal offset of the camera. + .. _class_Camera2D_get_v_offset: - :ref:`float` **get_v_offset** **(** **)** const +Returns the vertical offset of the camera. + .. _class_Camera2D_make_current: - void **make_current** **(** **)** @@ -207,12 +217,18 @@ This has no effect if smoothing is disabled. - void **set_custom_viewport** **(** :ref:`Node` viewport **)** +Assigns a custom :ref:`Viewport` node to the ``Camera2D``. If ``viewport`` is not a :ref:`Viewport`, it re-assigns the default viewport instead. + .. _class_Camera2D_set_h_offset: - void **set_h_offset** **(** :ref:`float` ofs **)** +The camera's horizontal offset is set to ``ofs``. + .. _class_Camera2D_set_v_offset: - void **set_v_offset** **(** :ref:`float` ofs **)** +The camera's vertical offset is set to ``ofs``. + diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 5c3cc8f52..77e97e881 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -32,6 +32,10 @@ Member Functions +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_line` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_multiline` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_multiline_colors` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_polygon` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_polyline` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | @@ -136,35 +140,35 @@ Member Variables .. _class_CanvasItem_light_mask: -- :ref:`int` **light_mask** +- :ref:`int` **light_mask** - The rendering layers in which this ``CanvasItem`` responds to :ref:`Light2D` nodes. Default value: ``1``. .. _class_CanvasItem_material: -- :ref:`Material` **material** +- :ref:`Material` **material** - The material applied to textures on this ``CanvasItem``. Default value: ``null``. .. _class_CanvasItem_modulate: -- :ref:`Color` **modulate** +- :ref:`Color` **modulate** - The color applied to textures on this ``CanvasItem``. Default value: ``Color(1, 1, 1, 1)`` (opaque "white"). .. _class_CanvasItem_self_modulate: -- :ref:`Color` **self_modulate** +- :ref:`Color` **self_modulate** - The color applied to textures on this ``CanvasItem``. This is not inherited by children ``CanvasItem``\ s. Default value: ``Color(1, 1, 1, 1)`` (opaque "white").. .. _class_CanvasItem_show_behind_parent: -- :ref:`bool` **show_behind_parent** +- :ref:`bool` **show_behind_parent** - If ``true`` the object draws behind its parent. Default value: ``false``. .. _class_CanvasItem_show_on_top: -- :ref:`bool` **show_on_top** +- :ref:`bool` **show_on_top** - If ``true`` the object draws on top of its parent. Default value: ``true``. .. _class_CanvasItem_use_parent_material: -- :ref:`bool` **use_parent_material** +- :ref:`bool` **use_parent_material** - If ``true`` the parent ``CanvasItem``'s :ref:`material` property is used as this one's material. Default value: ``false``. .. _class_CanvasItem_visible: -- :ref:`bool` **visible** +- :ref:`bool` **visible** - If ``true`` this ``CanvasItem`` is drawn. Default value: ``true``. Numeric Constants @@ -227,6 +231,14 @@ Draw a colored polygon of any amount of points, convex or concave. Draw a line from a 2D point to another, with a given color and width. It can be optionally antialiased. +.. _class_CanvasItem_draw_multiline: + +- void **draw_multiline** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** + +.. _class_CanvasItem_draw_multiline_colors: + +- void **draw_multiline_colors** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** + .. _class_CanvasItem_draw_polygon: - void **draw_polygon** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** @@ -237,10 +249,14 @@ Draw a polygon of any amount of points, convex or concave. - void **draw_polyline** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +Draw a polyline with a uniform ``color`` and ``width`` and optional antialiasing. + .. _class_CanvasItem_draw_polyline_colors: - void **draw_polyline_colors** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +Draw a polyline with a uniform ``width``, segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between ``points`` and ``colors``. + .. _class_CanvasItem_draw_primitive: - void **draw_primitive** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=null, :ref:`float` width=1.0, :ref:`Texture` normal_map=null **)** @@ -257,12 +273,14 @@ Draw a colored rectangle. - void **draw_set_transform** **(** :ref:`Vector2` position, :ref:`float` rotation, :ref:`Vector2` scale **)** -Set a custom transform for drawing. Anything drawn afterwards will be transformed by this. +Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this. .. _class_CanvasItem_draw_set_transform_matrix: - void **draw_set_transform_matrix** **(** :ref:`Transform2D` xform **)** +Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this. + .. _class_CanvasItem_draw_string: - void **draw_string** **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` text, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** @@ -369,6 +387,8 @@ Hide the CanvasItem currently visible. - :ref:`bool` **is_local_transform_notification_enabled** **(** **)** const +Returns ``true`` if local transform notifications are communicated to children. + .. _class_CanvasItem_is_set_as_toplevel: - :ref:`bool` **is_set_as_toplevel** **(** **)** const @@ -379,32 +399,44 @@ Return if set as toplevel. See :ref:`set_as_toplevel` **is_transform_notification_enabled** **(** **)** const +Returns ``true`` if global transform notifications are communicated to children. + .. _class_CanvasItem_is_visible_in_tree: - :ref:`bool` **is_visible_in_tree** **(** **)** const +Returns ``true`` if the node is in the :ref:`SceneTree` and is visible on-screen. + .. _class_CanvasItem_make_canvas_position_local: - :ref:`Vector2` **make_canvas_position_local** **(** :ref:`Vector2` screen_point **)** const +Assigns ``screen_point`` as this node's new local transform. + .. _class_CanvasItem_make_input_local: - :ref:`InputEvent` **make_input_local** **(** :ref:`InputEvent` event **)** const +Transformations issued by ``event``'s inputs are applied in local space instead of global space. + .. _class_CanvasItem_set_as_toplevel: - void **set_as_toplevel** **(** :ref:`bool` enable **)** -Set as top level. This means that it will not inherit transform from parent canvas items. +Sets as top level. This means that it will not inherit transform from parent canvas items. .. _class_CanvasItem_set_notify_local_transform: - void **set_notify_local_transform** **(** :ref:`bool` enable **)** +If ``enable`` is ``true``, children will be updated with local transform data. + .. _class_CanvasItem_set_notify_transform: - void **set_notify_transform** **(** :ref:`bool` enable **)** +If ``enable`` is ``true``, children will be updated with global transform data. + .. _class_CanvasItem_show: - void **show** **(** **)** diff --git a/classes/class_canvasitemmaterial.rst b/classes/class_canvasitemmaterial.rst index c9192abab..64beaf8e2 100644 --- a/classes/class_canvasitemmaterial.rst +++ b/classes/class_canvasitemmaterial.rst @@ -14,29 +14,34 @@ CanvasItemMaterial Brief Description ----------------- - +A material for :ref:`CanvasItem`\ s. Member Variables ---------------- .. _class_CanvasItemMaterial_blend_mode: -- :ref:`int` **blend_mode** +- :ref:`int` **blend_mode** - The manner in which a material's rendering is applied to underlying textures. .. _class_CanvasItemMaterial_light_mode: -- :ref:`int` **light_mode** +- :ref:`int` **light_mode** - The manner in which material reacts to lighting. Numeric Constants ----------------- -- **BLEND_MODE_MIX** = **0** -- **BLEND_MODE_ADD** = **1** -- **BLEND_MODE_SUB** = **2** -- **BLEND_MODE_MUL** = **3** -- **BLEND_MODE_PREMULT_ALPHA** = **4** -- **LIGHT_MODE_NORMAL** = **0** -- **LIGHT_MODE_UNSHADED** = **1** -- **LIGHT_MODE_LIGHT_ONLY** = **2** +- **BLEND_MODE_MIX** = **0** --- Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value. +- **BLEND_MODE_ADD** = **1** --- Additive blending mode. +- **BLEND_MODE_SUB** = **2** --- Subtractive blending mode. +- **BLEND_MODE_MUL** = **3** --- Multiplicative blending mode. +- **BLEND_MODE_PREMULT_ALPHA** = **4** --- Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value. +- **LIGHT_MODE_NORMAL** = **0** --- Render the material using both light and non-light sensitive material properties. +- **LIGHT_MODE_UNSHADED** = **1** --- Render the material as if there were no light. +- **LIGHT_MODE_LIGHT_ONLY** = **2** --- Render the material as if there were only light. + +Description +----------- + +``CanvasItemMaterial``\ s provide a means of modifying the textures associated with a CanvasItem. They specialize in describing blend and lighting behaviors for textures. Use a :ref:`ShaderMaterial` to more fully customize a material's interactions with a :ref:`CanvasItem`. diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index c0652ce66..d8a144915 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -69,6 +69,8 @@ Member Function Description - :ref:`Node` **get_custom_viewport** **(** **)** const +Returns the :ref:`Viewport` used by the camera if it is not using the default viewport. + .. _class_CanvasLayer_get_rotation: - :ref:`float` **get_rotation** **(** **)** const @@ -91,6 +93,8 @@ Return the :ref:`World2D` used by this layer. - void **set_custom_viewport** **(** :ref:`Node` viewport **)** +Assigns a custom :ref:`Viewport` node to the ``CanvasLayer``. If ``viewport`` is not a :ref:`Viewport`, it re-assigns the default viewport instead. + .. _class_CanvasLayer_set_rotation: - void **set_rotation** **(** :ref:`float` radians **)** diff --git a/classes/class_centercontainer.rst b/classes/class_centercontainer.rst index 7d927b0cc..172c4931c 100644 --- a/classes/class_centercontainer.rst +++ b/classes/class_centercontainer.rst @@ -21,7 +21,7 @@ Member Variables .. _class_CenterContainer_use_top_left: -- :ref:`bool` **use_top_left** +- :ref:`bool` **use_top_left** - If ``true`` centers children relative to the ``CenterContainer``'s top left corner. Default value: ``false``. Description diff --git a/classes/class_classdb.rst b/classes/class_classdb.rst index 0abbb5194..449264718 100644 --- a/classes/class_classdb.rst +++ b/classes/class_classdb.rst @@ -85,6 +85,8 @@ Returns whether the specified 'class' is available or not. - :ref:`String` **class_get_category** **(** :ref:`String` class **)** const +Returns a category associated with the class for use in documentation and the Asset Library. Debug mode required. + .. _class_ClassDB_class_get_integer_constant: - :ref:`int` **class_get_integer_constant** **(** :ref:`String` class, :ref:`String` name **)** const diff --git a/classes/class_collisionobject.rst b/classes/class_collisionobject.rst index b95576443..8f1e6df36 100644 --- a/classes/class_collisionobject.rst +++ b/classes/class_collisionobject.rst @@ -64,6 +64,8 @@ Signals - **input_event** **(** :ref:`Object` camera, :ref:`Object` event, :ref:`Vector3` click_position, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** +Emitted when :ref:`_input_event` receives an event. See its description for details. + .. _class_CollisionObject_mouse_entered: - **mouse_entered** **(** **)** @@ -82,11 +84,11 @@ Member Variables .. _class_CollisionObject_input_capture_on_drag: -- :ref:`bool` **input_capture_on_drag** +- :ref:`bool` **input_capture_on_drag** - If ``true`` the ``CollisionObject`` will continue to receive input events as the mouse is dragged across its shapes. Default value: ``false``. .. _class_CollisionObject_input_ray_pickable: -- :ref:`bool` **input_ray_pickable** +- :ref:`bool` **input_ray_pickable** - If ``true`` the :ref:`CollisionObject`'s shapes will respond to :ref:`RayCast`\ s. Default value: ``true``. Description @@ -101,6 +103,8 @@ Member Function Description - void **_input_event** **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_position, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** virtual +Accepts unhandled :ref:`InputEvent`\ s. ``click_position`` is the clicked location in world space and ``click_normal`` is the normal vector extending from the clicked surface of the :ref:`Shape` at ``shape_idx``. Connect to the ``input_event`` signal to easily pick up these events. + .. _class_CollisionObject_create_shape_owner: - :ref:`int` **create_shape_owner** **(** :ref:`Object` owner **)** @@ -171,6 +175,8 @@ Returns the number of shapes the given shape owner contains. - :ref:`int` **shape_owner_get_shape_index** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const +Returns the child index of the :ref:`Shape` with the given id from the given shape owner. + .. _class_CollisionObject_shape_owner_get_transform: - :ref:`Transform` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** const diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index 7333b76a2..7f13c7048 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -68,7 +68,7 @@ Signals - **input_event** **(** :ref:`Object` viewport, :ref:`Object` event, :ref:`int` shape_idx **)** -Emitted when an input event occurs and ``input_pickable`` is ``true``. +Emitted when an input event occurs and ``input_pickable`` is ``true``. See :ref:`_input_event` for details. .. _class_CollisionObject2D_mouse_entered: @@ -103,6 +103,8 @@ Member Function Description - void **_input_event** **(** :ref:`Object` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** virtual +Accepts unhandled :ref:`InputEvent`\ s. ``shape_idx`` is the child index of the clicked :ref:`Shape2D`. Connect to the ``input_event`` signal to easily pick up these events. + .. _class_CollisionObject2D_create_shape_owner: - :ref:`int` **create_shape_owner** **(** :ref:`Object` owner **)** @@ -131,6 +133,8 @@ If ``true`` the shape owner and its shapes are disabled. - :ref:`bool` **is_shape_owner_one_way_collision_enabled** **(** :ref:`int` owner_id **)** const +Returns ``true`` if collisions for the shape owner originating from this ``CollisionObject2D`` will not be reported to collided with ``CollisionObject2D``\ s. + .. _class_CollisionObject2D_remove_shape_owner: - void **remove_shape_owner** **(** :ref:`int` owner_id **)** @@ -177,6 +181,8 @@ Returns the number of shapes the given shape owner contains. - :ref:`int` **shape_owner_get_shape_index** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const +Returns the child index of the :ref:`Shape2D` with the given id from the given shape owner. + .. _class_CollisionObject2D_shape_owner_get_transform: - :ref:`Transform2D` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** const @@ -199,6 +205,8 @@ If ``true`` disables the given shape owner. - void **shape_owner_set_one_way_collision** **(** :ref:`int` owner_id, :ref:`bool` enable **)** +If ``enable`` is ``true``, collisions for the shape owner originating from this ``CollisionObject2D`` will not be reported to collided with ``CollisionObject2D``\ s. + .. _class_CollisionObject2D_shape_owner_set_transform: - void **shape_owner_set_transform** **(** :ref:`int` owner_id, :ref:`Transform2D` transform **)** diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index bed9533d7..ebb8570c0 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -22,6 +22,8 @@ Member Functions +----------------------------------------+-------------------------------------------------------------------+ | :ref:`ColorPicker` | :ref:`get_picker` **(** **)** | +----------------------------------------+-------------------------------------------------------------------+ +| :ref:`PopupPanel` | :ref:`get_popup` **(** **)** | ++----------------------------------------+-------------------------------------------------------------------+ Signals ------- @@ -30,7 +32,7 @@ Signals - **color_changed** **(** :ref:`Color` color **)** -Emitted when the color is changed. +Emitted when the color changes. Member Variables @@ -38,11 +40,11 @@ Member Variables .. _class_ColorPickerButton_color: -- :ref:`Color` **color** +- :ref:`Color` **color** - The currently selected color. .. _class_ColorPickerButton_edit_alpha: -- :ref:`bool` **edit_alpha** +- :ref:`bool` **edit_alpha** - If ``true`` the alpha channel in the displayed :ref:`ColorPicker` will be visible. Default value: ``true``. Description @@ -57,4 +59,12 @@ Member Function Description - :ref:`ColorPicker` **get_picker** **(** **)** +Returns the ``ColorPicker`` that this ``ColorPickerButton`` toggles. + +.. _class_ColorPickerButton_get_popup: + +- :ref:`PopupPanel` **get_popup** **(** **)** + +Returns the control's :ref:`PopupPanel` which allows you to connect to Popup Signals. This allows you to handle events when the ColorPicker is shown or hidden. + diff --git a/classes/class_curve.rst b/classes/class_curve.rst index aa9a62bcb..29e4fbbdf 100644 --- a/classes/class_curve.rst +++ b/classes/class_curve.rst @@ -68,10 +68,6 @@ Signals Member Variables ---------------- - .. _class_Curve__data: - -- :ref:`Array` **_data** - .. _class_Curve_bake_resolution: - :ref:`int` **bake_resolution** diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index fd6dd24a2..dba13a270 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -56,10 +56,6 @@ Member Functions Member Variables ---------------- - .. _class_Curve2D__data: - -- :ref:`Dictionary` **_data** - The points describing the curve. Value is a :ref:`Dictionary` with the keys ``in``, ``out``, and ``pos``. The key pos is the position of a vertex of the curve, the key in is the vector from that position to the control point before this vertex, the key out is the vector from that position to the controlpoint after this vertex. - .. _class_Curve2D_bake_interval: - :ref:`float` **bake_interval** - The distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time the :ref:`get_baked_points` or :ref:`get_baked_length` function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care. diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index 439bd69f4..1e1cda977 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -62,10 +62,6 @@ Member Functions Member Variables ---------------- - .. _class_Curve3D__data: - -- :ref:`Dictionary` **_data** - .. _class_Curve3D_bake_interval: - :ref:`float` **bake_interval** diff --git a/classes/class_curvetexture.rst b/classes/class_curvetexture.rst index 054749521..4fe453139 100644 --- a/classes/class_curvetexture.rst +++ b/classes/class_curvetexture.rst @@ -14,17 +14,22 @@ CurveTexture Brief Description ----------------- - +A texture that shows a curve. Member Variables ---------------- .. _class_CurveTexture_curve: -- :ref:`Curve` **curve** +- :ref:`Curve` **curve** - The ``curve`` rendered onto the texture. .. _class_CurveTexture_width: -- :ref:`int` **width** +- :ref:`int` **width** - The width of the texture. +Description +----------- + +Renders a given :ref:`Curve` provided to it. Simplifies the task of drawing curves and/or saving them as image files. + diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index 200fae3a9..428f6c67c 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -19,47 +19,15 @@ Brief Description Member Functions ---------------- -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_filter` **(** :ref:`String` filter **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_filters` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_access` **(** **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_dir` **(** **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_file` **(** **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_path` **(** **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_display_mode` **(** **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mode` **(** **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VBoxContainer` | :ref:`get_vbox` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invalidate` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_overwrite_warning_disabled` **(** **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_showing_hidden_files` **(** **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_access` **(** :ref:`int` access **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_dir` **(** :ref:`String` dir **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_file` **(** :ref:`String` file **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_path` **(** :ref:`String` path **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_overwrite_warning` **(** :ref:`bool` disable **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_display_mode` **(** :ref:`int` mode **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mode` **(** :ref:`int` mode **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_show_hidden_files` **(** :ref:`bool` show **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`add_filter` **(** :ref:`String` filter **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_filters` **(** **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`VBoxContainer` | :ref:`get_vbox` **(** **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`invalidate` **(** **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------+ Signals ------- @@ -68,28 +36,70 @@ Signals - **dir_selected** **(** :ref:`String` dir **)** +Emitted when a directory is selected. + .. _class_EditorFileDialog_file_selected: - **file_selected** **(** :ref:`String` path **)** +Emitted when a file is selected. + .. _class_EditorFileDialog_files_selected: - **files_selected** **(** :ref:`PoolStringArray` paths **)** +Emitted when multiple files are selected. + + +Member Variables +---------------- + + .. _class_EditorFileDialog_access: + +- :ref:`int` **access** - The location from which the user may select a file, including ``res://``, ``user://``, and the local file system. + + .. _class_EditorFileDialog_current_dir: + +- :ref:`String` **current_dir** - The currently occupied directory. + + .. _class_EditorFileDialog_current_file: + +- :ref:`String` **current_file** - The currently selected file. + + .. _class_EditorFileDialog_current_path: + +- :ref:`String` **current_path** - The file system path in the address bar. + + .. _class_EditorFileDialog_disable_overwrite_warning: + +- :ref:`bool` **disable_overwrite_warning** - If ``true`` the ``EditorFileDialog`` will not warn the user before overwriting files. + + .. _class_EditorFileDialog_display_mode: + +- :ref:`int` **display_mode** - The view format in which the ``EditorFileDialog`` displays resources to the user. + + .. _class_EditorFileDialog_mode: + +- :ref:`int` **mode** - The purpose of the ``EditorFileDialog``. Changes allowed behaviors. + + .. _class_EditorFileDialog_show_hidden_files: + +- :ref:`bool` **show_hidden_files** - If ``true`` hidden files and directories will be visible in the ``EditorFileDialog``. + Numeric Constants ----------------- -- **MODE_OPEN_FILE** = **0** -- **MODE_OPEN_FILES** = **1** -- **MODE_OPEN_DIR** = **2** -- **MODE_OPEN_ANY** = **3** -- **MODE_SAVE_FILE** = **4** -- **ACCESS_RESOURCES** = **0** -- **ACCESS_USERDATA** = **1** -- **ACCESS_FILESYSTEM** = **2** -- **DISPLAY_THUMBNAILS** = **0** -- **DISPLAY_LIST** = **1** +- **MODE_OPEN_FILE** = **0** --- The ``EditorFileDialog`` can select only one file. Accepting the window will open the file. +- **MODE_OPEN_FILES** = **1** --- The ``EditorFileDialog`` can select multiple files. Accepting the window will open all files. +- **MODE_OPEN_DIR** = **2** --- The ``EditorFileDialog`` can select only one directory. Accepting the window will open the directory. +- **MODE_OPEN_ANY** = **3** --- The ``EditorFileDialog`` can select a file or directory. Accepting the window will open it. +- **MODE_SAVE_FILE** = **4** --- The ``EditorFileDialog`` can select only one file. Accepting the window will save the file. +- **ACCESS_RESOURCES** = **0** --- The ``EditorFileDialog`` can only view ``res://`` directory contents. +- **ACCESS_USERDATA** = **1** --- The ``EditorFileDialog`` can only view ``user://`` directory contents. +- **ACCESS_FILESYSTEM** = **2** --- The ``EditorFileDialog`` can view the entire local file system. +- **DISPLAY_THUMBNAILS** = **0** --- The ``EditorFileDialog`` displays resources as thumbnails. +- **DISPLAY_LIST** = **1** --- The ``EditorFileDialog`` displays resources as a list of filenames. Member Function Description --------------------------- @@ -98,80 +108,26 @@ Member Function Description - void **add_filter** **(** :ref:`String` filter **)** +Adds a comma-delimited file extension filter option to the ``EditorFileDialog`` with an optional semi-colon-delimited label. + +Example: "\*.tscn, \*.scn; Scenes", results in filter text "Scenes (\*.tscn, \*.scn)". + .. _class_EditorFileDialog_clear_filters: - void **clear_filters** **(** **)** -.. _class_EditorFileDialog_get_access: - -- :ref:`int` **get_access** **(** **)** const - -.. _class_EditorFileDialog_get_current_dir: - -- :ref:`String` **get_current_dir** **(** **)** const - -.. _class_EditorFileDialog_get_current_file: - -- :ref:`String` **get_current_file** **(** **)** const - -.. _class_EditorFileDialog_get_current_path: - -- :ref:`String` **get_current_path** **(** **)** const - -.. _class_EditorFileDialog_get_display_mode: - -- :ref:`int` **get_display_mode** **(** **)** const - -.. _class_EditorFileDialog_get_mode: - -- :ref:`int` **get_mode** **(** **)** const +Removes all filters except for "All Files (\*)". .. _class_EditorFileDialog_get_vbox: - :ref:`VBoxContainer` **get_vbox** **(** **)** +Returns the ``VBoxContainer`` used to display the file system. + .. _class_EditorFileDialog_invalidate: - void **invalidate** **(** **)** -.. _class_EditorFileDialog_is_overwrite_warning_disabled: - -- :ref:`bool` **is_overwrite_warning_disabled** **(** **)** const - -.. _class_EditorFileDialog_is_showing_hidden_files: - -- :ref:`bool` **is_showing_hidden_files** **(** **)** const - -.. _class_EditorFileDialog_set_access: - -- void **set_access** **(** :ref:`int` access **)** - -.. _class_EditorFileDialog_set_current_dir: - -- void **set_current_dir** **(** :ref:`String` dir **)** - -.. _class_EditorFileDialog_set_current_file: - -- void **set_current_file** **(** :ref:`String` file **)** - -.. _class_EditorFileDialog_set_current_path: - -- void **set_current_path** **(** :ref:`String` path **)** - -.. _class_EditorFileDialog_set_disable_overwrite_warning: - -- void **set_disable_overwrite_warning** **(** :ref:`bool` disable **)** - -.. _class_EditorFileDialog_set_display_mode: - -- void **set_display_mode** **(** :ref:`int` mode **)** - -.. _class_EditorFileDialog_set_mode: - -- void **set_mode** **(** :ref:`int` mode **)** - -.. _class_EditorFileDialog_set_show_hidden_files: - -- void **set_show_hidden_files** **(** :ref:`bool` show **)** +Notify the ``EditorFileDialog`` that its view of the data is no longer accurate. Updates the view contents on next view update. diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst index e0a61febc..a31142b00 100644 --- a/classes/class_editorfilesystem.rst +++ b/classes/class_editorfilesystem.rst @@ -50,6 +50,8 @@ Emitted if the filesystem changed. - **resources_reimported** **(** :ref:`PoolStringArray` resources **)** +Remitted if a resource is reimported. + .. _class_EditorFileSystem_sources_changed: - **sources_changed** **(** :ref:`bool` exist **)** @@ -81,6 +83,8 @@ Get the root directory object. - :ref:`EditorFileSystemDirectory` **get_filesystem_path** **(** :ref:`String` path **)** +Returns a view into the filesystem at ``path``. + .. _class_EditorFileSystem_get_scanning_progress: - :ref:`float` **get_scanning_progress** **(** **)** const diff --git a/classes/class_editorfilesystemdirectory.rst b/classes/class_editorfilesystemdirectory.rst index c9c514167..3d07e7cc4 100644 --- a/classes/class_editorfilesystemdirectory.rst +++ b/classes/class_editorfilesystemdirectory.rst @@ -45,6 +45,11 @@ Member Functions | :ref:`int` | :ref:`get_subdir_count` **(** **)** const | +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +Description +----------- + +A more generalized, low-level variation of the directory concept. + Member Function Description --------------------------- @@ -52,48 +57,72 @@ Member Function Description - :ref:`int` **find_dir_index** **(** :ref:`String` name **)** const +Returns the index of the directory with name ``name`` or ``-1`` if not found. + .. _class_EditorFileSystemDirectory_find_file_index: - :ref:`int` **find_file_index** **(** :ref:`String` name **)** const +Returns the index of the file with name ``name`` or ``-1`` if not found. + .. _class_EditorFileSystemDirectory_get_file: - :ref:`String` **get_file** **(** :ref:`int` idx **)** const +Returns the name of the file at index ``idx``. + .. _class_EditorFileSystemDirectory_get_file_count: - :ref:`int` **get_file_count** **(** **)** const +Returns the number of files in this directory. + .. _class_EditorFileSystemDirectory_get_file_import_is_valid: - :ref:`bool` **get_file_import_is_valid** **(** :ref:`int` idx **)** const +Returns ``true`` if the file at index ``idx`` imported properly. + .. _class_EditorFileSystemDirectory_get_file_path: - :ref:`String` **get_file_path** **(** :ref:`int` idx **)** const +Returns the path to the file at index ``idx``. + .. _class_EditorFileSystemDirectory_get_file_type: - :ref:`String` **get_file_type** **(** :ref:`int` idx **)** const +Returns the file extension of the file at index ``idx``. + .. _class_EditorFileSystemDirectory_get_name: - :ref:`String` **get_name** **(** **)** +Returns the name of this directory. + .. _class_EditorFileSystemDirectory_get_parent: - :ref:`EditorFileSystemDirectory` **get_parent** **(** **)** +Returns the parent directory for this directory or null if called on a directory at ``res://`` or ``user://``. + .. _class_EditorFileSystemDirectory_get_path: - :ref:`String` **get_path** **(** **)** const +Returns the path to this directory. + .. _class_EditorFileSystemDirectory_get_subdir: - :ref:`EditorFileSystemDirectory` **get_subdir** **(** :ref:`int` idx **)** +Returns the subdirectory at index ``idx``. + .. _class_EditorFileSystemDirectory_get_subdir_count: - :ref:`int` **get_subdir_count** **(** **)** const +Returns the number of subdirectories in this directory. + diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index b53f1b7a2..4f1b0c6ed 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -32,6 +32,8 @@ Member Functions +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_import_plugin` **(** :ref:`EditorImportPlugin` importer **)** | +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_scene_import_plugin` **(** :ref:`EditorSceneImporter` scene_importer **)** | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_tool_submenu_item` **(** :ref:`String` name, :ref:`Object` submenu **)** | +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`apply_changes` **(** **)** virtual | @@ -54,6 +56,8 @@ Member Functions +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorInterface` | :ref:`get_editor_interface` **(** **)** | +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_plugin_icon` **(** **)** virtual | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_plugin_name` **(** **)** virtual | +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_state` **(** **)** virtual | @@ -84,6 +88,8 @@ Member Functions +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_import_plugin` **(** :ref:`EditorImportPlugin` importer **)** | +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_scene_import_plugin` **(** :ref:`EditorSceneImporter` scene_importer **)** | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`save_external_data` **(** **)** virtual | +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_force_draw_over_forwarding_enabled` **(** **)** | @@ -194,6 +200,10 @@ During run-time, this will be a simple object with a script so this function doe - void **add_import_plugin** **(** :ref:`EditorImportPlugin` importer **)** +.. _class_EditorPlugin_add_scene_import_plugin: + +- void **add_scene_import_plugin** **(** :ref:`EditorSceneImporter` scene_importer **)** + .. _class_EditorPlugin_add_tool_submenu_item: - void **add_tool_submenu_item** **(** :ref:`String` name, :ref:`Object` submenu **)** @@ -254,6 +264,10 @@ This is for editors that edit script based objects. You can return a list of bre - :ref:`EditorInterface` **get_editor_interface** **(** **)** +.. _class_EditorPlugin_get_plugin_icon: + +- :ref:`Object` **get_plugin_icon** **(** **)** virtual + .. _class_EditorPlugin_get_plugin_name: - :ref:`String` **get_plugin_name** **(** **)** virtual @@ -336,6 +350,10 @@ Remove a custom type added by :ref:`EditorPlugin.add_custom_type` importer **)** +.. _class_EditorPlugin_remove_scene_import_plugin: + +- void **remove_scene_import_plugin** **(** :ref:`EditorSceneImporter` scene_importer **)** + .. _class_EditorPlugin_save_external_data: - void **save_external_data** **(** **)** virtual diff --git a/classes/class_editorsceneimporter.rst b/classes/class_editorsceneimporter.rst new file mode 100644 index 000000000..b4c31edc1 --- /dev/null +++ b/classes/class_editorsceneimporter.rst @@ -0,0 +1,77 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the EditorSceneImporter.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_EditorSceneImporter: + +EditorSceneImporter +=================== + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`_get_extensions` **(** **)** virtual | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_import_flags` **(** **)** virtual | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Animation` | :ref:`_import_animation` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** virtual | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`_import_scene` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** virtual | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Animation` | :ref:`import_animation_from_other_importer` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`import_scene_from_other_importer` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Numeric Constants +----------------- + +- **IMPORT_SCENE** = **1** +- **IMPORT_ANIMATION** = **2** +- **IMPORT_ANIMATION_DETECT_LOOP** = **4** +- **IMPORT_ANIMATION_OPTIMIZE** = **8** +- **IMPORT_ANIMATION_FORCE_ALL_TRACKS_IN_ALL_CLIPS** = **16** +- **IMPORT_ANIMATION_KEEP_VALUE_TRACKS** = **32** +- **IMPORT_GENERATE_TANGENT_ARRAYS** = **256** +- **IMPORT_FAIL_ON_MISSING_DEPENDENCIES** = **512** +- **IMPORT_MATERIALS_IN_INSTANCES** = **1024** +- **IMPORT_USE_COMPRESSION** = **2048** + +Member Function Description +--------------------------- + +.. _class_EditorSceneImporter__get_extensions: + +- :ref:`Array` **_get_extensions** **(** **)** virtual + +.. _class_EditorSceneImporter__get_import_flags: + +- :ref:`int` **_get_import_flags** **(** **)** virtual + +.. _class_EditorSceneImporter__import_animation: + +- :ref:`Animation` **_import_animation** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** virtual + +.. _class_EditorSceneImporter__import_scene: + +- :ref:`Node` **_import_scene** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** virtual + +.. _class_EditorSceneImporter_import_animation_from_other_importer: + +- :ref:`Animation` **import_animation_from_other_importer** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** + +.. _class_EditorSceneImporter_import_scene_from_other_importer: + +- :ref:`Node` **import_scene_from_other_importer** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** + + diff --git a/classes/class_editorscript.rst b/classes/class_editorscript.rst index dc3eb43fc..2df5dea2c 100644 --- a/classes/class_editorscript.rst +++ b/classes/class_editorscript.rst @@ -59,6 +59,10 @@ This method is executed by the Editor when ``File -> Run`` is used. - void **add_root_node** **(** :ref:`Node` node **)** +Adds ``node`` as a child of the root node in the editor context. + +WARNING: The implementation of this method is currently disabled. + .. _class_EditorScript_get_editor_interface: - :ref:`EditorInterface` **get_editor_interface** **(** **)** diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index 5ef55aa6f..648d7f007 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -80,6 +80,10 @@ Member Variables - :ref:`int` **mode** + .. _class_FileDialog_mode_overrides_title: + +- :ref:`bool` **mode_overrides_title** - If ``true``, changing the ``mode`` property will set the window title accordingly (e. g. setting mode to ``MODE_OPEN_FILE`` will change the window title to "Open a File"). + .. _class_FileDialog_show_hidden_files: - :ref:`bool` **show_hidden_files** diff --git a/classes/class_giprobedata.rst b/classes/class_giprobedata.rst index 131774bf8..36286568f 100644 --- a/classes/class_giprobedata.rst +++ b/classes/class_giprobedata.rst @@ -16,51 +16,144 @@ Brief Description -Member Variables +Member Functions ---------------- - .. _class_GIProbeData_bias: ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bias` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`get_bounds` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_cell_size` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_dynamic_data` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_dynamic_range` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_energy` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_normal_bias` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_propagation` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_to_cell_xform` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_compressed` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_interior` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bias` **(** :ref:`float` bias **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bounds` **(** :ref:`AABB` bounds **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_size` **(** :ref:`float` cell_size **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_compress` **(** :ref:`bool` compress **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dynamic_data` **(** :ref:`PoolIntArray` dynamic_data **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dynamic_range` **(** :ref:`int` dynamic_range **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_energy` **(** :ref:`float` energy **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_interior` **(** :ref:`bool` interior **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_normal_bias` **(** :ref:`float` bias **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_propagation` **(** :ref:`float` propagation **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_to_cell_xform` **(** :ref:`Transform` to_cell_xform **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -- :ref:`float` **bias** +Member Function Description +--------------------------- - .. _class_GIProbeData_bounds: +.. _class_GIProbeData_get_bias: -- :ref:`AABB` **bounds** +- :ref:`float` **get_bias** **(** **)** const - .. _class_GIProbeData_cell_size: +.. _class_GIProbeData_get_bounds: -- :ref:`float` **cell_size** +- :ref:`AABB` **get_bounds** **(** **)** const - .. _class_GIProbeData_compress: +.. _class_GIProbeData_get_cell_size: -- :ref:`bool` **compress** +- :ref:`float` **get_cell_size** **(** **)** const - .. _class_GIProbeData_dynamic_data: +.. _class_GIProbeData_get_dynamic_data: -- :ref:`PoolIntArray` **dynamic_data** +- :ref:`PoolIntArray` **get_dynamic_data** **(** **)** const - .. _class_GIProbeData_dynamic_range: +.. _class_GIProbeData_get_dynamic_range: -- :ref:`int` **dynamic_range** +- :ref:`int` **get_dynamic_range** **(** **)** const - .. _class_GIProbeData_energy: +.. _class_GIProbeData_get_energy: -- :ref:`float` **energy** +- :ref:`float` **get_energy** **(** **)** const - .. _class_GIProbeData_interior: +.. _class_GIProbeData_get_normal_bias: -- :ref:`bool` **interior** +- :ref:`float` **get_normal_bias** **(** **)** const - .. _class_GIProbeData_normal_bias: +.. _class_GIProbeData_get_propagation: -- :ref:`float` **normal_bias** +- :ref:`float` **get_propagation** **(** **)** const - .. _class_GIProbeData_propagation: +.. _class_GIProbeData_get_to_cell_xform: -- :ref:`float` **propagation** +- :ref:`Transform` **get_to_cell_xform** **(** **)** const - .. _class_GIProbeData_to_cell_xform: +.. _class_GIProbeData_is_compressed: -- :ref:`Transform` **to_cell_xform** +- :ref:`bool` **is_compressed** **(** **)** const + +.. _class_GIProbeData_is_interior: + +- :ref:`bool` **is_interior** **(** **)** const + +.. _class_GIProbeData_set_bias: + +- void **set_bias** **(** :ref:`float` bias **)** + +.. _class_GIProbeData_set_bounds: + +- void **set_bounds** **(** :ref:`AABB` bounds **)** + +.. _class_GIProbeData_set_cell_size: + +- void **set_cell_size** **(** :ref:`float` cell_size **)** + +.. _class_GIProbeData_set_compress: + +- void **set_compress** **(** :ref:`bool` compress **)** + +.. _class_GIProbeData_set_dynamic_data: + +- void **set_dynamic_data** **(** :ref:`PoolIntArray` dynamic_data **)** + +.. _class_GIProbeData_set_dynamic_range: + +- void **set_dynamic_range** **(** :ref:`int` dynamic_range **)** + +.. _class_GIProbeData_set_energy: + +- void **set_energy** **(** :ref:`float` energy **)** + +.. _class_GIProbeData_set_interior: + +- void **set_interior** **(** :ref:`bool` interior **)** + +.. _class_GIProbeData_set_normal_bias: + +- void **set_normal_bias** **(** :ref:`float` bias **)** + +.. _class_GIProbeData_set_propagation: + +- void **set_propagation** **(** :ref:`float` propagation **)** + +.. _class_GIProbeData_set_to_cell_xform: + +- void **set_to_cell_xform** **(** :ref:`Transform` to_cell_xform **)** diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 8dd8d9215..a1021c31c 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -150,10 +150,6 @@ Member Variables - :ref:`float` **icon_scale** - .. _class_ItemList_items: - -- :ref:`Array` **items** - .. _class_ItemList_max_columns: - :ref:`int` **max_columns** diff --git a/classes/class_json.rst b/classes/class_json.rst index 89e678737..93f2de2df 100644 --- a/classes/class_json.rst +++ b/classes/class_json.rst @@ -19,11 +19,11 @@ Helper class for parsing JSON data. Member Functions ---------------- -+------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`JSONParseResult` | :ref:`parse` **(** :ref:`String` json **)** | -+------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`print` **(** :ref:`Variant` value **)** | -+------------------------------------------------+--------------------------------------------------------------------------------+ ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`JSONParseResult` | :ref:`parse` **(** :ref:`String` json **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`print` **(** :ref:`Variant` value, :ref:`String` indent="", :ref:`bool` sort_keys=false **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -41,7 +41,7 @@ Parses a JSON encoded string and returns a :ref:`JSONParseResult` **print** **(** :ref:`Variant` value **)** +- :ref:`String` **print** **(** :ref:`Variant` value, :ref:`String` indent="", :ref:`bool` sort_keys=false **)** Converts a Variant var to JSON text and returns the result. Useful for serializing data to store or send over the network. diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index 42a7b7ad9..5dc146d9a 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -42,6 +42,18 @@ Member Functions Member Variables ---------------- + .. _class_KinematicBody_axis_lock_x: + +- :ref:`bool` **axis_lock_x** + + .. _class_KinematicBody_axis_lock_y: + +- :ref:`bool` **axis_lock_y** + + .. _class_KinematicBody_axis_lock_z: + +- :ref:`bool` **axis_lock_z** + .. _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. diff --git a/classes/class_largetexture.rst b/classes/class_largetexture.rst index ad57ace6f..eab4bf9a4 100644 --- a/classes/class_largetexture.rst +++ b/classes/class_largetexture.rst @@ -37,20 +37,6 @@ Member Functions | void | :ref:`set_size` **(** :ref:`Vector2` size **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -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. - -``second`` : :ref:`StreamTexture` data of the texture piece. - -``last entry`` : :ref:`Vector2` size of the entire large texture. - - Description ----------- diff --git a/classes/class_menubutton.rst b/classes/class_menubutton.rst index 294733d26..0fa69f070 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -33,14 +33,6 @@ Signals Emitted when :ref:`PopupMenu` of this MenuButton is about to show. -Member Variables ----------------- - - .. _class_MenuButton_items: - -- :ref:`Array` **items** - - Description ----------- diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index 8bda06aab..f0157ec48 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -33,6 +33,14 @@ Member Functions | :ref:`PoolVector3Array` | :ref:`get_faces` **(** **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + + .. _class_Mesh_lightmap_size_hint: + +- :ref:`Vector2` **lightmap_size_hint** + + Numeric Constants ----------------- diff --git a/classes/class_meshinstance.rst b/classes/class_meshinstance.rst index 7b3598e5b..42784fe87 100644 --- a/classes/class_meshinstance.rst +++ b/classes/class_meshinstance.rst @@ -46,7 +46,7 @@ Member Variables Description ----------- -MeshInstance is a :ref:`Node` that takes a :ref:`Mesh` resource and adds it to the current scenario by creating an instance of it. This is the class most often used to get 3D geometry rendered and can be used to instance a single :ref:`Mesh` in many places. This allows to reuse geometry and save on resources. When a :ref:`Mesh` has to be instanced more than thousands of times at close proximity, consider using a :ref:`MultiMesh` in a :ref:`MultiMeshInstance` instead. +MeshInstance is a node that takes a :ref:`Mesh` resource and adds it to the current scenario by creating an instance of it. This is the class most often used to get 3D geometry rendered and can be used to instance a single :ref:`Mesh` in many places. This allows to reuse geometry and save on resources. When a :ref:`Mesh` has to be instanced more than thousands of times at close proximity, consider using a :ref:`MultiMesh` in a :ref:`MultiMeshInstance` instead. Member Function Description --------------------------- @@ -55,17 +55,19 @@ Member Function Description - void **create_convex_collision** **(** **)** -This helper creates a :ref:`StaticBody` child :ref:`Node` with a :ref:`ConvexPolygonShape` :ref:`CollisionShape` calculated from the mesh geometry. It's mainly used for testing. +This helper creates a :ref:`StaticBody` child node with a :ref:`ConvexPolygonShape` collision shape calculated from the mesh geometry. It's mainly used for testing. .. _class_MeshInstance_create_debug_tangents: - void **create_debug_tangents** **(** **)** +This helper creates a :ref:`MeshInstance` child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing. + .. _class_MeshInstance_create_trimesh_collision: - void **create_trimesh_collision** **(** **)** -This helper creates a :ref:`StaticBody` child :ref:`Node` with a :ref:`ConcavePolygonShape` :ref:`CollisionShape` calculated from the mesh geometry. It's mainly used for testing. +This helper creates a :ref:`StaticBody` child node with a :ref:`ConcavePolygonShape` collision shape calculated from the mesh geometry. It's mainly used for testing. .. _class_MeshInstance_get_surface_material: diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index 45153cd55..d73b5160b 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -34,10 +34,6 @@ Member Functions Member Variables ---------------- - .. _class_MultiMesh_color_array: - -- :ref:`PoolColorArray` **color_array** - .. _class_MultiMesh_color_format: - :ref:`int` **color_format** @@ -50,10 +46,6 @@ Member Variables - :ref:`Mesh` **mesh** - .. _class_MultiMesh_transform_array: - -- :ref:`PoolVector3Array` **transform_array** - .. _class_MultiMesh_transform_format: - :ref:`int` **transform_format** diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index 36a783e54..a5e7eea5e 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -19,17 +19,21 @@ Brief Description Member Functions ---------------- -+------------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_polygons` **(** **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_mesh` **(** :ref:`Mesh` mesh **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_polygons` **(** **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from_mesh` **(** :ref:`Mesh` mesh **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_vertices` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertices` **(** :ref:`PoolVector3Array` vertices **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -90,10 +94,6 @@ Member Variables - :ref:`float` **polygon/verts_per_poly** - .. _class_NavigationMesh_polygons: - -- :ref:`Array` **polygons** - .. _class_NavigationMesh_region/merge_size: - :ref:`float` **region/merge_size** @@ -106,10 +106,6 @@ Member Variables - :ref:`int` **sample_partition_type/sample_partition_type** - .. _class_NavigationMesh_vertices: - -- :ref:`PoolVector3Array` **vertices** - Numeric Constants ----------------- @@ -141,4 +137,12 @@ Member Function Description - :ref:`int` **get_polygon_count** **(** **)** const +.. _class_NavigationMesh_get_vertices: + +- :ref:`PoolVector3Array` **get_vertices** **(** **)** const + +.. _class_NavigationMesh_set_vertices: + +- void **set_vertices** **(** :ref:`PoolVector3Array` vertices **)** + diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index b8f0ccd73..fa0fe3d72 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -38,28 +38,16 @@ Member Functions +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_polygon_count` **(** **)** const | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_vertices` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`make_polygons_from_outlines` **(** **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_outline` **(** :ref:`int` idx **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_outline` **(** :ref:`int` idx, :ref:`PoolVector2Array` outline **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Member Variables ----------------- - - .. _class_NavigationPolygon_outlines: - -- :ref:`Array` **outlines** - - .. _class_NavigationPolygon_polygons: - -- :ref:`Array` **polygons** - - .. _class_NavigationPolygon_vertices: - -- :ref:`PoolVector2Array` **vertices** - +| void | :ref:`set_vertices` **(** :ref:`PoolVector2Array` vertices **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- @@ -100,6 +88,10 @@ Member Function Description - :ref:`int` **get_polygon_count** **(** **)** const +.. _class_NavigationPolygon_get_vertices: + +- :ref:`PoolVector2Array` **get_vertices** **(** **)** const + .. _class_NavigationPolygon_make_polygons_from_outlines: - void **make_polygons_from_outlines** **(** **)** @@ -112,4 +104,8 @@ Member Function Description - void **set_outline** **(** :ref:`int` idx, :ref:`PoolVector2Array` outline **)** +.. _class_NavigationPolygon_set_vertices: + +- void **set_vertices** **(** :ref:`PoolVector2Array` vertices **)** + diff --git a/classes/class_networkedmultiplayerpeer.rst b/classes/class_networkedmultiplayerpeer.rst index be7bf04b4..863a43344 100644 --- a/classes/class_networkedmultiplayerpeer.rst +++ b/classes/class_networkedmultiplayerpeer.rst @@ -16,7 +16,7 @@ NetworkedMultiplayerPeer Brief Description ----------------- - +A high-level network interface to simplify multiplayer interactions. Member Functions ---------------- @@ -46,44 +46,49 @@ Signals - **connection_failed** **(** **)** -Emitted when failed to connect to server. +Emitted when a connection attempt fails. .. _class_NetworkedMultiplayerPeer_connection_succeeded: - **connection_succeeded** **(** **)** -Emitted when successfully connected to server. +Emitted when a connection attempt succeeds. .. _class_NetworkedMultiplayerPeer_peer_connected: - **peer_connected** **(** :ref:`int` id **)** -Emitted by the server when a client is connected. +Emitted by the server when a client connects. .. _class_NetworkedMultiplayerPeer_peer_disconnected: - **peer_disconnected** **(** :ref:`int` id **)** -Emitted by the server when a client is disconnected. +Emitted by the server when a client disconnects. .. _class_NetworkedMultiplayerPeer_server_disconnected: - **server_disconnected** **(** **)** -Emitted by clients when server is disconnected. +Emitted by clients when the server disconnects. Numeric Constants ----------------- -- **TRANSFER_MODE_UNRELIABLE** = **0** -- **TRANSFER_MODE_UNRELIABLE_ORDERED** = **1** -- **TRANSFER_MODE_RELIABLE** = **2** -- **CONNECTION_DISCONNECTED** = **0** -- **CONNECTION_CONNECTING** = **1** -- **CONNECTION_CONNECTED** = **2** -- **TARGET_PEER_BROADCAST** = **0** -- **TARGET_PEER_SERVER** = **1** +- **TRANSFER_MODE_UNRELIABLE** = **0** --- Packets are sent via unordered UDP packets. +- **TRANSFER_MODE_UNRELIABLE_ORDERED** = **1** --- Packets are sent via ordered UDP packets. +- **TRANSFER_MODE_RELIABLE** = **2** --- Packets are sent via TCP packets. +- **CONNECTION_DISCONNECTED** = **0** --- The ongoing connection disconnected. +- **CONNECTION_CONNECTING** = **1** --- A connection attempt is ongoing. +- **CONNECTION_CONNECTED** = **2** --- The connection attempt succeeded. +- **TARGET_PEER_BROADCAST** = **0** --- Packets are sent to the server and then redistributed to other peers. +- **TARGET_PEER_SERVER** = **1** --- Packets are sent to the server alone. + +Description +----------- + +Manages the connection to network peers. Assigns unique IDs to each client connected to the server. Member Function Description --------------------------- @@ -92,36 +97,48 @@ Member Function Description - :ref:`int` **get_connection_status** **(** **)** const +Returns the current state of the connection. See enum ConnectionStatus. + .. _class_NetworkedMultiplayerPeer_get_packet_peer: - :ref:`int` **get_packet_peer** **(** **)** const +Returns the ID of the ``NetworkedMultiplayerPeer`` who sent the most recent packet. + .. _class_NetworkedMultiplayerPeer_get_unique_id: - :ref:`int` **get_unique_id** **(** **)** const +Returns the ID of this ``NetworkedMultiplayerPeer``. + .. _class_NetworkedMultiplayerPeer_is_refusing_new_connections: - :ref:`bool` **is_refusing_new_connections** **(** **)** const -Return whether this ``NetworkedMultiplayerPeer`` is refusing new connections. +Returns ``true`` if this ``NetworkedMultiplayerPeer`` refuses new connections. Default value: ``false``. .. _class_NetworkedMultiplayerPeer_poll: - void **poll** **(** **)** +Waits up to 1 second to receive a new network event. + .. _class_NetworkedMultiplayerPeer_set_refuse_new_connections: - void **set_refuse_new_connections** **(** :ref:`bool` enable **)** -If ``endable`` is true, this ``NetworkedMultiplayerPeer`` will refuse new connections. +If ``true`` this ``NetworkedMultiplayerPeer`` refuses new connections. Default value: ``false``. .. _class_NetworkedMultiplayerPeer_set_target_peer: - void **set_target_peer** **(** :ref:`int` id **)** +The peer to which packets will be sent. Default value: ``0``. + .. _class_NetworkedMultiplayerPeer_set_transfer_mode: - void **set_transfer_mode** **(** :ref:`int` mode **)** +The manner in which to send packets to the ``target_peer``. See enum TransferMode. + diff --git a/classes/class_node.rst b/classes/class_node.rst index 4de859e85..45bdfff54 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -96,6 +96,8 @@ Member Functions +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_a_parent_of` **(** :ref:`Node` node **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_displayed_folded` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_greater_than` **(** :ref:`Node` node **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_in_group` **(** :ref:`String` group **)** const | @@ -162,6 +164,8 @@ Member Functions +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`rset_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_display_folded` **(** :ref:`bool` fold **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_filename` **(** :ref:`String` filename **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_name` **(** :ref:`String` name **)** | @@ -212,14 +216,6 @@ 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** @@ -542,6 +538,10 @@ Returns ``true`` if the node that the :ref:`NodePath` points to Returns ``true`` if the "node" argument is a direct or indirect child of the current node, otherwise return ``false[code]. +.. _class_Node_is_displayed_folded: + +- :ref:`bool` **is_displayed_folded** **(** **)** const + .. _class_Node_is_greater_than: - :ref:`bool` **is_greater_than** **(** :ref:`Node` node **)** const @@ -732,6 +732,10 @@ Remotely changes property's value on other peers (and locally) using an unreliab Remotely changes property's value on a specific peer identified by *peer_id* using an unreliable protocol. +.. _class_Node_set_display_folded: + +- void **set_display_folded** **(** :ref:`bool` fold **)** + .. _class_Node_set_filename: - void **set_filename** **(** :ref:`String` filename **)** diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 3502c54b2..335668c0f 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -28,6 +28,8 @@ Member Functions +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`get_relative_transform_to_parent` **(** :ref:`Node` parent **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotation` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`global_translate` **(** :ref:`Vector2` offset **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`look_at` **(** :ref:`Vector2` point **)** | @@ -38,6 +40,8 @@ Member Functions +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`rotate` **(** :ref:`float` radians **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`to_global` **(** :ref:`Vector2` local_point **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`to_local` **(** :ref:`Vector2` global_point **)** const | @@ -72,10 +76,6 @@ Member Variables - :ref:`Vector2` **position** - Position, relative to the node's parent. - .. _class_Node2D_rotation: - -- :ref:`float` **rotation** - Rotation in radians, relative to the node's parent. - .. _class_Node2D_rotation_degrees: - :ref:`float` **rotation_degrees** - Rotation in degrees, relative to the node's parent. @@ -123,6 +123,10 @@ Returns the angle between the node and the 'point' in radians. Returns the :ref:`Transform2D` relative to this node's parent. +.. _class_Node2D_get_rotation: + +- :ref:`float` **get_rotation** **(** **)** const + .. _class_Node2D_global_translate: - void **global_translate** **(** :ref:`Vector2` offset **)** @@ -153,6 +157,10 @@ Applies a local translation on the node's Y axis based on the :ref:`Node._proces Applies a rotation to the node, in radians, starting from its current rotation. +.. _class_Node2D_set_rotation: + +- void **set_rotation** **(** :ref:`float` radians **)** + .. _class_Node2D_to_global: - :ref:`Vector2` **to_global** **(** :ref:`Vector2` local_point **)** const diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index d82f03b64..ed2e0279c 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -72,10 +72,6 @@ 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** diff --git a/classes/class_packedscene.rst b/classes/class_packedscene.rst index 4b7823a91..a17aa1112 100644 --- a/classes/class_packedscene.rst +++ b/classes/class_packedscene.rst @@ -14,7 +14,7 @@ PackedScene Brief Description ----------------- - +An abstraction of a serialized scene. Member Functions ---------------- @@ -34,19 +34,23 @@ Member Variables .. _class_PackedScene__bundled: -- :ref:`Dictionary` **_bundled** +- :ref:`Dictionary` **_bundled** - A dictionary representation of the scene contents. + +Available keys include "rnames" and "variants" for resources, "node_count", "nodes", "node_paths" for nodes, "editable_instances" for base scene children overrides, "conn_count" and "conns" for signal connections, and "version" for the format style of the PackedScene. Numeric Constants ----------------- -- **GEN_EDIT_STATE_DISABLED** = **0** -- **GEN_EDIT_STATE_INSTANCE** = **1** -- **GEN_EDIT_STATE_MAIN** = **2** +- **GEN_EDIT_STATE_DISABLED** = **0** --- If passed to :ref:`instance`, blocks edits to the scene state. +- **GEN_EDIT_STATE_INSTANCE** = **1** --- If passed to :ref:`instance`, provides local scene resources to the local scene. Requires tools compiled. +- **GEN_EDIT_STATE_MAIN** = **2** --- If passed to :ref:`instance`, provides local scene resources to the local scene. Only the main scene should receive the main edit state. Requires tools compiled. Description ----------- +A simplified interface to a scene file. Provides access to operations and checks that can be performed on the scene resource itself. + TODO: explain ownership, and that node does not need to own itself Member Function Description @@ -56,14 +60,20 @@ Member Function Description - :ref:`bool` **can_instance** **(** **)** const +Returns ``true`` if the scene file has nodes. + .. _class_PackedScene_get_state: - :ref:`SceneState` **get_state** **(** **)** +Returns the ``SceneState`` representing the scene file contents. + .. _class_PackedScene_instance: - :ref:`Node` **instance** **(** :ref:`int` edit_state=0 **)** const +Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). Triggers the enum Object.NOTIFICATION_INSTANCED notification on the root node. + .. _class_PackedScene_pack: - :ref:`int` **pack** **(** :ref:`Node` path **)** diff --git a/classes/class_physicsserver.rst b/classes/class_physicsserver.rst index 2270d0c2a..234ffe2d7 100644 --- a/classes/class_physicsserver.rst +++ b/classes/class_physicsserver.rst @@ -84,7 +84,7 @@ Member Functions +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`body_create` **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_axis_lock` **(** :ref:`RID` body **)** const | +| :ref:`bool` | :ref:`body_get_axis_lock` **(** :ref:`RID` body **)** const | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`body_get_collision_layer` **(** :ref:`RID` body **)** const | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -122,7 +122,7 @@ Member Functions +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_axis_lock` **(** :ref:`RID` body, :ref:`int` axis **)** | +| void | :ref:`body_set_axis_lock` **(** :ref:`RID` body, :ref:`int` axis, :ref:`bool` lock **)** | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector3` axis_velocity **)** | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -365,10 +365,6 @@ The higher, the faster. - **SPACE_PARAM_BODY_TIME_TO_SLEEP** = **5** --- Constant to set/get the maximum time of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after this time. - **SPACE_PARAM_BODY_ANGULAR_VELOCITY_DAMP_RATIO** = **6** - **SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS** = **7** --- Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision. -- **BODY_AXIS_LOCK_DISABLED** = **0** --- The Body can rotate and move freely. -- **BODY_AXIS_LOCK_X** = **1** --- The Body cannot move across x axis can only rotate across x axis. -- **BODY_AXIS_LOCK_Y** = **2** --- The Body cannot move across y axis can only rotate across y axis. -- **BODY_AXIS_LOCK_Z** = **3** --- The Body cannot move across z axis can only rotate across z axis. Description ----------- @@ -576,7 +572,7 @@ Creates a physics body. The first parameter can be any value from constants BODY .. _class_PhysicsServer_body_get_axis_lock: -- :ref:`int` **body_get_axis_lock** **(** :ref:`RID` body **)** const +- :ref:`bool` **body_get_axis_lock** **(** :ref:`RID` body **)** const Gets the information, which Axis is locked if any. The can be any calue from the constants BODY_AXIS_LOCK\* @@ -692,9 +688,7 @@ Removes a shape from a body. The shape is not deleted, so it can be reused after .. _class_PhysicsServer_body_set_axis_lock: -- void **body_set_axis_lock** **(** :ref:`RID` body, :ref:`int` axis **)** - -Locks velocity along one axis to 0 and only allows rotation along this axis, can also be set to disabled which disables this functionality. +- void **body_set_axis_lock** **(** :ref:`RID` body, :ref:`int` axis, :ref:`bool` lock **)** .. _class_PhysicsServer_body_set_axis_velocity: diff --git a/classes/class_polygonpathfinder.rst b/classes/class_polygonpathfinder.rst index 013a1b148..95fa183bc 100644 --- a/classes/class_polygonpathfinder.rst +++ b/classes/class_polygonpathfinder.rst @@ -37,14 +37,6 @@ Member Functions | void | :ref:`setup` **(** :ref:`PoolVector2Array` points, :ref:`PoolIntArray` connections **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_PolygonPathFinder_data: - -- :ref:`Dictionary` **data** - - Member Function Description --------------------------- diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index bfe41dd1c..0849acb22 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -126,10 +126,6 @@ Member Variables - :ref:`bool` **hide_on_item_selection** - .. _class_PopupMenu_items: - -- :ref:`Array` **items** - Description ----------- diff --git a/classes/class_proxytexture.rst b/classes/class_proxytexture.rst new file mode 100644 index 000000000..8808e9d5f --- /dev/null +++ b/classes/class_proxytexture.rst @@ -0,0 +1,26 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ProxyTexture.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ProxyTexture: + +ProxyTexture +============ + +**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_ProxyTexture_base: + +- :ref:`Texture` **base** + + diff --git a/classes/class_raycast.rst b/classes/class_raycast.rst index 219a55580..99f261580 100644 --- a/classes/class_raycast.rst +++ b/classes/class_raycast.rst @@ -60,7 +60,11 @@ Member Variables .. _class_RayCast_enabled: -- :ref:`bool` **enabled** - If ``true``, collisions will be reported. Default value: ``false``. +- :ref:`bool` **enabled** - If ``true`` collisions will be reported. Default value: ``false``. + + .. _class_RayCast_exclude_parent: + +- :ref:`bool` **exclude_parent** - If ``true`` collisions will be ignored for this RayCast's immediate parent. Default value: ``true``. Description @@ -133,6 +137,8 @@ Example: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const +Returns ``true`` if the bit index passed is turned on. Note that bit indexes range from 0-19. + .. _class_RayCast_get_collision_normal: - :ref:`Vector3` **get_collision_normal** **(** **)** const @@ -167,4 +173,6 @@ Removes a collision exception so the ray does report collisions with the specifi - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** +Sets the bit index passed to the ``value`` passed. Note that bit indexes range from 0-19. + diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index ff262dcd3..9a575acb1 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -22,6 +22,8 @@ Member Functions +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`Rect2` **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`abs` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`clip` **(** :ref:`Rect2` b **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`encloses` **(** :ref:`Rect2` b **)** | @@ -81,6 +83,10 @@ Constructs a ``Rect2`` by position and size. Constructs a ``Rect2`` by x, y, width, and height. +.. _class_Rect2_abs: + +- :ref:`Rect2` **abs** **(** **)** + .. _class_Rect2_clip: - :ref:`Rect2` **clip** **(** :ref:`Rect2` b **)** diff --git a/classes/class_reference.rst b/classes/class_reference.rst index 214bace01..fc77c60f1 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -9,7 +9,7 @@ Reference **Inherits:** :ref:`Object` -**Inherited By:** :ref:`RegExMatch`, :ref:`RegEx`, :ref:`EncodedObjectAsID`, :ref:`SpatialGizmo`, :ref:`TriangleMesh`, :ref:`EditorScenePostImport`, :ref:`PhysicsShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`GDScriptNativeClass`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`Resource`, :ref:`KinematicCollision`, :ref:`SurfaceTool`, :ref:`JSONParseResult`, :ref:`SpatialVelocityTracker`, :ref:`EditorResourcePreviewGenerator`, :ref:`Physics2DShapeQueryParameters`, :ref:`EditorExportPlugin`, :ref:`ARVRInterface`, :ref:`EditorScript`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`WeakRef`, :ref:`GDScriptFunctionState`, :ref:`Marshalls`, :ref:`SceneState`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`AStar`, :ref:`ResourceImporter`, :ref:`EditorResourceConversionPlugin`, :ref:`SceneTreeTimer`, :ref:`Thread`, :ref:`ResourceInteractiveLoader`, :ref:`PackedDataContainerRef`, :ref:`KinematicCollision2D`, :ref:`GDNative`, :ref:`PhysicsShapeQueryParameters` +**Inherited By:** :ref:`RegExMatch`, :ref:`RegEx`, :ref:`EncodedObjectAsID`, :ref:`SpatialGizmo`, :ref:`TriangleMesh`, :ref:`EditorScenePostImport`, :ref:`PhysicsShapeQueryResult`, :ref:`EditorSceneImporter`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`GDScriptNativeClass`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`Resource`, :ref:`KinematicCollision`, :ref:`SurfaceTool`, :ref:`JSONParseResult`, :ref:`SpatialVelocityTracker`, :ref:`EditorResourcePreviewGenerator`, :ref:`Physics2DShapeQueryParameters`, :ref:`EditorExportPlugin`, :ref:`ARVRInterface`, :ref:`EditorScript`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`WeakRef`, :ref:`GDScriptFunctionState`, :ref:`Marshalls`, :ref:`SceneState`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`AStar`, :ref:`ResourceImporter`, :ref:`EditorResourceConversionPlugin`, :ref:`SceneTreeTimer`, :ref:`Thread`, :ref:`ResourceInteractiveLoader`, :ref:`PackedDataContainerRef`, :ref:`KinematicCollision2D`, :ref:`GDNative`, :ref:`PhysicsShapeQueryParameters` **Category:** Core diff --git a/classes/class_resourcepreloader.rst b/classes/class_resourcepreloader.rst index eafb8c0c0..9e070ba64 100644 --- a/classes/class_resourcepreloader.rst +++ b/classes/class_resourcepreloader.rst @@ -33,14 +33,6 @@ Member Functions | void | :ref:`rename_resource` **(** :ref:`String` name, :ref:`String` newname **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_ResourcePreloader_resources: - -- :ref:`Array` **resources** - - Description ----------- diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index 8656bc56b..27483ea09 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -78,9 +78,17 @@ Member Variables - :ref:`Vector3` **angular_velocity** - RigidBody's rotational velocity. - .. _class_RigidBody_axis_lock: + .. _class_RigidBody_axis_lock_x: -- :ref:`int` **axis_lock** - Locks the rotational forces to a particular axis, preventing rotations on other axes. +- :ref:`bool` **axis_lock_x** + + .. _class_RigidBody_axis_lock_y: + +- :ref:`bool` **axis_lock_y** + + .. _class_RigidBody_axis_lock_z: + +- :ref:`bool` **axis_lock_z** .. _class_RigidBody_bounce: @@ -148,10 +156,6 @@ Numeric Constants - **MODE_STATIC** = **1** --- Static mode. The body behaves like a :ref:`StaticBody`, and can only move by user code. - **MODE_CHARACTER** = **2** --- Character body. This behaves like a rigid body, but can not rotate. - **MODE_KINEMATIC** = **3** --- Kinematic body. The body behaves like a :ref:`KinematicBody`, and can only move by user code. -- **AXIS_LOCK_DISABLED** = **0** -- **AXIS_LOCK_X** = **1** -- **AXIS_LOCK_Y** = **2** -- **AXIS_LOCK_Z** = **3** Description ----------- diff --git a/classes/class_scenestate.rst b/classes/class_scenestate.rst index 2bf45ccea..e1dae0ab9 100644 --- a/classes/class_scenestate.rst +++ b/classes/class_scenestate.rst @@ -14,7 +14,7 @@ SceneState Brief Description ----------------- - +A script interface to a scene file's data. Member Functions ---------------- @@ -62,9 +62,14 @@ Member Functions Numeric Constants ----------------- -- **GEN_EDIT_STATE_DISABLED** = **0** -- **GEN_EDIT_STATE_INSTANCE** = **1** -- **GEN_EDIT_STATE_MAIN** = **2** +- **GEN_EDIT_STATE_DISABLED** = **0** --- If passed to :ref:`PackedScene.instance`, blocks edits to the scene state. +- **GEN_EDIT_STATE_INSTANCE** = **1** --- If passed to :ref:`PackedScene.instance`, provides inherited scene resources to the local scene. Requires tools compiled. +- **GEN_EDIT_STATE_MAIN** = **2** --- If passed to :ref:`PackedScene.instance`, provides local scene resources to the local scene. Only the main scene should receive the main edit state. Requires tools compiled. + +Description +----------- + +Maintains a list of resources, nodes, exported and overridden properties, and built-in scripts associated with a scene. Member Function Description --------------------------- @@ -73,76 +78,114 @@ Member Function Description - :ref:`Array` **get_connection_binds** **(** :ref:`int` idx **)** const +Returns the list of bound parameters for the signal at ``idx``. + .. _class_SceneState_get_connection_count: - :ref:`int` **get_connection_count** **(** **)** const +Returns the number of signal connections in the scene. + .. _class_SceneState_get_connection_flags: - :ref:`int` **get_connection_flags** **(** :ref:`int` idx **)** const +Returns the flags for the signal at ``idx``. See :ref:`Object`'s ``CONNECT\_\*`` flags. + .. _class_SceneState_get_connection_method: - :ref:`String` **get_connection_method** **(** :ref:`int` idx **)** const +Returns the method connected to the signal at ``idx``. + .. _class_SceneState_get_connection_signal: - :ref:`String` **get_connection_signal** **(** :ref:`int` idx **)** const +Returns the name of the signal at ``idx``. + .. _class_SceneState_get_connection_source: - :ref:`NodePath` **get_connection_source** **(** :ref:`int` idx **)** const +Returns the path to the node that owns the signal at ``idx``, relative to the root node. + .. _class_SceneState_get_connection_target: - :ref:`NodePath` **get_connection_target** **(** :ref:`int` idx **)** const +Returns the path to the node that owns the method connected to the signal at ``idx``, relative to the root node. + .. _class_SceneState_get_node_count: - :ref:`int` **get_node_count** **(** **)** const +Returns the number of nodes in the scene. + .. _class_SceneState_get_node_groups: - :ref:`PoolStringArray` **get_node_groups** **(** :ref:`int` idx **)** const +Returns the list of group names associated with the node at ``idx``. + .. _class_SceneState_get_node_instance: - :ref:`PackedScene` **get_node_instance** **(** :ref:`int` idx **)** const +Returns the scene for the node at ``idx`` or ``null`` if the node is not an instance. + .. _class_SceneState_get_node_instance_placeholder: - :ref:`String` **get_node_instance_placeholder** **(** :ref:`int` idx **)** const +Returns the path to the represented scene file if the node at ``idx`` is an :ref:`InstancePlaceholder`. + .. _class_SceneState_get_node_name: - :ref:`String` **get_node_name** **(** :ref:`int` idx **)** const +Returns the name of the node at ``idx``. + .. _class_SceneState_get_node_owner_path: - :ref:`NodePath` **get_node_owner_path** **(** :ref:`int` idx **)** const +Returns the path to the owner of the node at ``idx``, relative to the root node. + .. _class_SceneState_get_node_path: - :ref:`NodePath` **get_node_path** **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** const +Returns the path to the node at ``idx``. + .. _class_SceneState_get_node_property_count: - :ref:`int` **get_node_property_count** **(** :ref:`int` idx **)** const +Returns the number of exported or overridden properties for the node at ``idx``. + .. _class_SceneState_get_node_property_name: - :ref:`String` **get_node_property_name** **(** :ref:`int` idx, :ref:`int` prop_idx **)** const +Returns the name of the property at ``prop_idx`` for the node at ``idx``. + .. _class_SceneState_get_node_property_value: - :ref:`Variant` **get_node_property_value** **(** :ref:`int` idx, :ref:`int` prop_idx **)** const +Returns the value of the property at ``prop_idx`` for the node at ``idx``. + .. _class_SceneState_get_node_type: - :ref:`String` **get_node_type** **(** :ref:`int` idx **)** const +Returns the type of the node at ``idx``. + .. _class_SceneState_is_node_instance_placeholder: - :ref:`bool` **is_node_instance_placeholder** **(** :ref:`int` idx **)** const +Returns ``true`` if the node at ``idx`` is an :ref:`InstancePlaceholder`. + diff --git a/classes/class_shader.rst b/classes/class_shader.rst index 6f5eaf303..8a70c3051 100644 --- a/classes/class_shader.rst +++ b/classes/class_shader.rst @@ -19,6 +19,8 @@ To be changed, ignore. Member Functions ---------------- ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_code` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_default_texture_param` **(** :ref:`String` param **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -26,17 +28,11 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_param` **(** :ref:`String` name **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_code` **(** :ref:`String` code **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_default_texture_param` **(** :ref:`String` param, :ref:`Texture` texture **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_Shader_code: - -- :ref:`String` **code** - - Numeric Constants ----------------- @@ -52,6 +48,10 @@ To be changed, ignore. Member Function Description --------------------------- +.. _class_Shader_get_code: + +- :ref:`String` **get_code** **(** **)** const + .. _class_Shader_get_default_texture_param: - :ref:`Texture` **get_default_texture_param** **(** :ref:`String` param **)** const @@ -64,6 +64,10 @@ Member Function Description - :ref:`bool` **has_param** **(** :ref:`String` name **)** const +.. _class_Shader_set_code: + +- void **set_code** **(** :ref:`String` code **)** + .. _class_Shader_set_default_texture_param: - void **set_default_texture_param** **(** :ref:`String` param, :ref:`Texture` texture **)** diff --git a/classes/class_spatialmaterial.rst b/classes/class_spatialmaterial.rst index 5c34301fe..6ffa93e2b 100644 --- a/classes/class_spatialmaterial.rst +++ b/classes/class_spatialmaterial.rst @@ -155,6 +155,10 @@ Member Variables - :ref:`Texture` **emission_texture** + .. _class_SpatialMaterial_flags_albedo_tex_force_srgb: + +- :ref:`bool` **flags_albedo_tex_force_srgb** + .. _class_SpatialMaterial_flags_fixed_size: - :ref:`bool` **flags_fixed_size** @@ -446,7 +450,8 @@ Numeric Constants - **FLAG_AO_ON_UV2** = **10** - **FLAG_USE_ALPHA_SCISSOR** = **11** - **FLAG_TRIPLANAR_USE_WORLD** = **9** -- **FLAG_MAX** = **12** +- **FLAG_ALBEDO_TEXTURE_FORCE_SRGB** = **12** +- **FLAG_MAX** = **13** - **DIFFUSE_BURLEY** = **0** - **DIFFUSE_LAMBERT** = **1** - **DIFFUSE_LAMBERT_WRAP** = **2** diff --git a/classes/class_spriteframes.rst b/classes/class_spriteframes.rst index fc285ef5f..e0600b3c3 100644 --- a/classes/class_spriteframes.rst +++ b/classes/class_spriteframes.rst @@ -54,10 +54,6 @@ 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** diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index ac89d5654..b8664ff63 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -50,7 +50,7 @@ Member Functions +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ArrayMesh` | :ref:`commit` **(** :ref:`ArrayMesh` existing=null **)** | +| :ref:`ArrayMesh` | :ref:`commit` **(** :ref:`ArrayMesh` existing=null, :ref:`int` flags=97792 **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_from` **(** :ref:`Mesh` existing, :ref:`int` surface **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -173,7 +173,7 @@ Clear all information passed into the surface tool so far. .. _class_SurfaceTool_commit: -- :ref:`ArrayMesh` **commit** **(** :ref:`ArrayMesh` existing=null **)** +- :ref:`ArrayMesh` **commit** **(** :ref:`ArrayMesh` existing=null, :ref:`int` flags=97792 **)** Returns a constructed :ref:`ArrayMesh` from current information passed in. If an existing :ref:`ArrayMesh` is passed in as an argument, will add an extra surface to the existing :ref:`ArrayMesh`. diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 6c31bc458..0e35f6e6a 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -90,6 +90,8 @@ Member Functions +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_wrap` **(** :ref:`bool` enable **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`toggle_fold_line` **(** :ref:`int` line **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`undo` **(** **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`unfold_line` **(** :ref:`int` line **)** | @@ -397,6 +399,12 @@ Set the maximum amount of characters editable. Enable text wrapping when it goes beyond he edge of what is visible. +.. _class_TextEdit_toggle_fold_line: + +- void **toggle_fold_line** **(** :ref:`int` line **)** + +Toggle the folding of the code block at the given line. + .. _class_TextEdit_undo: - void **undo** **(** **)** diff --git a/classes/class_texture.rst b/classes/class_texture.rst index 0c84a10ba..df1375f2b 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -9,7 +9,7 @@ Texture **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`CurveTexture`, :ref:`AtlasTexture`, :ref:`GradientTexture`, :ref:`ViewportTexture`, :ref:`StreamTexture`, :ref:`ImageTexture`, :ref:`LargeTexture` +**Inherited By:** :ref:`CurveTexture`, :ref:`AtlasTexture`, :ref:`ProxyTexture`, :ref:`GradientTexture`, :ref:`ViewportTexture`, :ref:`StreamTexture`, :ref:`ImageTexture`, :ref:`LargeTexture` **Category:** Core @@ -46,13 +46,15 @@ Member Functions Numeric Constants ----------------- -- **FLAG_MIPMAPS** = **1** --- Generate mipmaps, to enable smooth zooming out of the texture. -- **FLAG_REPEAT** = **2** --- Repeat (instead of clamp to edge). -- **FLAG_FILTER** = **4** --- Turn on magnifying filter, to enable smooth zooming in of the texture. +- **FLAG_MIPMAPS** = **1** --- Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio. +- **FLAG_REPEAT** = **2** --- Repeats texture (instead of clamp to edge). +- **FLAG_FILTER** = **4** --- Magnifying filter, to enable smooth zooming in of the texture. - **FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled. -- **FLAG_ANISOTROPIC_FILTER** = **8** -- **FLAG_CONVERT_TO_LINEAR** = **16** -- **FLAG_MIRRORED_REPEAT** = **32** +- **FLAG_ANISOTROPIC_FILTER** = **8** --- Anisotropic mipmap filtering. Generates smaller versions of the same texture with different aspect ratios. + +More effective on planes often shown going to the horrizon as those textures (Walls or Ground for example) get squashed in the viewport to different aspect ratios and regular mipmaps keep the aspect ratio so they don't optimize storage that well in those cases. +- **FLAG_CONVERT_TO_LINEAR** = **16** --- Converts texture to SRGB color space. +- **FLAG_MIRRORED_REPEAT** = **32** --- Repeats texture with alternate sections mirrored. - **FLAG_VIDEO_SURFACE** = **4096** --- Texture is a video surface. Description diff --git a/classes/class_translation.rst b/classes/class_translation.rst index 05f87e62f..2172efa72 100644 --- a/classes/class_translation.rst +++ b/classes/class_translation.rst @@ -40,10 +40,6 @@ Member Variables - :ref:`String` **locale** - .. _class_Translation_messages: - -- :ref:`PoolStringArray` **messages** - Description ----------- diff --git a/classes/class_videostreamtheora.rst b/classes/class_videostreamtheora.rst index 7f312cbe1..f9be83285 100644 --- a/classes/class_videostreamtheora.rst +++ b/classes/class_videostreamtheora.rst @@ -16,11 +16,24 @@ Brief Description -Member Variables +Member Functions ---------------- - .. _class_VideoStreamTheora_file: ++------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file` **(** **)** | ++------------------------------+------------------------------------------------------------------------------------------------+ +| void | :ref:`set_file` **(** :ref:`String` file **)** | ++------------------------------+------------------------------------------------------------------------------------------------+ -- :ref:`String` **file** +Member Function Description +--------------------------- + +.. _class_VideoStreamTheora_get_file: + +- :ref:`String` **get_file** **(** **)** + +.. _class_VideoStreamTheora_set_file: + +- void **set_file** **(** :ref:`String` file **)** diff --git a/classes/class_videostreamwebm.rst b/classes/class_videostreamwebm.rst index ed24450cb..90ca19868 100644 --- a/classes/class_videostreamwebm.rst +++ b/classes/class_videostreamwebm.rst @@ -16,11 +16,24 @@ Brief Description -Member Variables +Member Functions ---------------- - .. _class_VideoStreamWebm_file: ++------------------------------+----------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------+ +| void | :ref:`set_file` **(** :ref:`String` file **)** | ++------------------------------+----------------------------------------------------------------------------------------------+ -- :ref:`String` **file** +Member Function Description +--------------------------- + +.. _class_VideoStreamWebm_get_file: + +- :ref:`String` **get_file** **(** **)** + +.. _class_VideoStreamWebm_set_file: + +- void **set_file** **(** :ref:`String` file **)** diff --git a/classes/class_visualscript.rst b/classes/class_visualscript.rst index d2a288501..88522a1b3 100644 --- a/classes/class_visualscript.rst +++ b/classes/class_visualscript.rst @@ -115,14 +115,6 @@ Signals Emitted when the ports of a node are changed. -Member Variables ----------------- - - .. _class_VisualScript_data: - -- :ref:`Dictionary` **data** - - Description ----------- diff --git a/classes/class_visualscriptconstructor.rst b/classes/class_visualscriptconstructor.rst index 218a087e9..10bc8fd6a 100644 --- a/classes/class_visualscriptconstructor.rst +++ b/classes/class_visualscriptconstructor.rst @@ -16,37 +16,41 @@ Brief Description A Visual Script node which calls a base type constructor. -Member Variables +Member Functions ---------------- - .. _class_VisualScriptConstructor_constructor: - -- :ref:`Dictionary` **constructor** - The constructor function's method info. Has roughly the following structure: - -:: - - { - name = "string", - args = [{ - name = "string" - class_name = "string" - type = TYPE\_\* - hint = PROPERTY_HINT\_\* - hint_string = "string" - }] - default_args = [] # Array of variants - flags = METHOD_FLAG\_\* - id = 0 - return = {type = TYPE\_\*} - } - - .. _class_VisualScriptConstructor_type: - -- :ref:`int` **type** - The type to be constructed. - ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_constructor` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_constructor_type` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_constructor` **(** :ref:`Dictionary` constructor **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_constructor_type` **(** :ref:`int` type **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ Description ----------- A Visual Script node which calls a base type constructor. It can be used for type conversion as well. +Member Function Description +--------------------------- + +.. _class_VisualScriptConstructor_get_constructor: + +- :ref:`Dictionary` **get_constructor** **(** **)** const + +.. _class_VisualScriptConstructor_get_constructor_type: + +- :ref:`int` **get_constructor_type** **(** **)** const + +.. _class_VisualScriptConstructor_set_constructor: + +- void **set_constructor** **(** :ref:`Dictionary` constructor **)** + +.. _class_VisualScriptConstructor_set_constructor_type: + +- void **set_constructor_type** **(** :ref:`int` type **)** + + diff --git a/classes/class_visualscriptdeconstruct.rst b/classes/class_visualscriptdeconstruct.rst index 6973d00d9..b0dc0c254 100644 --- a/classes/class_visualscriptdeconstruct.rst +++ b/classes/class_visualscriptdeconstruct.rst @@ -19,10 +19,6 @@ A Visual Script node which deconstructs a base type instance into its parts. Member Variables ---------------- - .. _class_VisualScriptDeconstruct_elem_cache: - -- :ref:`Array` **elem_cache** - .. _class_VisualScriptDeconstruct_type: - :ref:`int` **type** - The type to deconstruct. diff --git a/classes/class_visualscriptfunctioncall.rst b/classes/class_visualscriptfunctioncall.rst index 642795313..b64cabb8b 100644 --- a/classes/class_visualscriptfunctioncall.rst +++ b/classes/class_visualscriptfunctioncall.rst @@ -19,10 +19,6 @@ Brief Description Member Variables ---------------- - .. _class_VisualScriptFunctionCall_argument_cache: - -- :ref:`Dictionary` **argument_cache** - .. _class_VisualScriptFunctionCall_base_script: - :ref:`String` **base_script** diff --git a/classes/class_visualscriptnode.rst b/classes/class_visualscriptnode.rst index 304a631b1..c901ab0d8 100644 --- a/classes/class_visualscriptnode.rst +++ b/classes/class_visualscriptnode.rst @@ -41,14 +41,6 @@ Signals 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_visualscriptpropertyget.rst b/classes/class_visualscriptpropertyget.rst index 4064049ee..dc5e712a2 100644 --- a/classes/class_visualscriptpropertyget.rst +++ b/classes/class_visualscriptpropertyget.rst @@ -47,10 +47,6 @@ Member Variables - :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 9bcff4ec0..c1563cbf8 100644 --- a/classes/class_visualscriptpropertyset.rst +++ b/classes/class_visualscriptpropertyset.rst @@ -51,10 +51,6 @@ Member Variables - :ref:`int` **set_mode** - .. _class_VisualScriptPropertySet_type_cache: - -- :ref:`Dictionary` **type_cache** - Numeric Constants ----------------- diff --git a/classes/class_visualscriptyield.rst b/classes/class_visualscriptyield.rst index 981cc4778..6dd9b3034 100644 --- a/classes/class_visualscriptyield.rst +++ b/classes/class_visualscriptyield.rst @@ -16,12 +16,17 @@ Brief Description -Member Variables +Member Functions ---------------- - .. _class_VisualScriptYield_mode: ++------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_yield_mode` **(** **)** | ++------------------------+------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_yield_mode` **(** :ref:`int` mode **)** | ++------------------------+------------------------------------------------------------------------------------------------------+ -- :ref:`int` **mode** +Member Variables +---------------- .. _class_VisualScriptYield_wait_time: @@ -35,3 +40,15 @@ Numeric Constants - **YIELD_PHYSICS_FRAME** = **2** - **YIELD_WAIT** = **3** +Member Function Description +--------------------------- + +.. _class_VisualScriptYield_get_yield_mode: + +- :ref:`int` **get_yield_mode** **(** **)** + +.. _class_VisualScriptYield_set_yield_mode: + +- void **set_yield_mode** **(** :ref:`int` mode **)** + + diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index 8c1eb72b6..7f8f67a85 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -382,84 +382,86 @@ Signals Numeric Constants ----------------- -- **NO_INDEX_ARRAY** = **-1** +- **NO_INDEX_ARRAY** = **-1** --- Marks an error that shows that the index array is empty. - **ARRAY_WEIGHTS_SIZE** = **4** -- **CANVAS_ITEM_Z_MIN** = **-4096** -- **CANVAS_ITEM_Z_MAX** = **4096** +- **CANVAS_ITEM_Z_MIN** = **-4096** --- The minimum Z-layer for canvas items. +- **CANVAS_ITEM_Z_MAX** = **4096** --- The maximum Z-layer for canvas items. - **MAX_GLOW_LEVELS** = **7** - **MAX_CURSORS** = **8** -- **MATERIAL_RENDER_PRIORITY_MIN** = **-128** -- **MATERIAL_RENDER_PRIORITY_MAX** = **127** -- **CUBEMAP_LEFT** = **0** -- **CUBEMAP_RIGHT** = **1** -- **CUBEMAP_BOTTOM** = **2** -- **CUBEMAP_TOP** = **3** -- **CUBEMAP_FRONT** = **4** -- **CUBEMAP_BACK** = **5** -- **TEXTURE_FLAG_MIPMAPS** = **1** -- **TEXTURE_FLAG_REPEAT** = **2** -- **TEXTURE_FLAG_FILTER** = **4** -- **TEXTURE_FLAG_ANISOTROPIC_FILTER** = **8** -- **TEXTURE_FLAG_CONVERT_TO_LINEAR** = **16** -- **TEXTURE_FLAG_MIRRORED_REPEAT** = **32** -- **TEXTURE_FLAG_CUBEMAP** = **2048** -- **TEXTURE_FLAG_USED_FOR_STREAMING** = **4096** -- **TEXTURE_FLAGS_DEFAULT** = **7** -- **SHADER_SPATIAL** = **0** -- **SHADER_CANVAS_ITEM** = **1** -- **SHADER_PARTICLES** = **2** -- **SHADER_MAX** = **3** -- **ARRAY_VERTEX** = **0** -- **ARRAY_NORMAL** = **1** -- **ARRAY_TANGENT** = **2** -- **ARRAY_COLOR** = **3** -- **ARRAY_TEX_UV** = **4** -- **ARRAY_TEX_UV2** = **5** -- **ARRAY_BONES** = **6** -- **ARRAY_WEIGHTS** = **7** -- **ARRAY_INDEX** = **8** -- **ARRAY_MAX** = **9** -- **ARRAY_FORMAT_VERTEX** = **1** -- **ARRAY_FORMAT_NORMAL** = **2** -- **ARRAY_FORMAT_TANGENT** = **4** -- **ARRAY_FORMAT_COLOR** = **8** -- **ARRAY_FORMAT_TEX_UV** = **16** -- **ARRAY_FORMAT_TEX_UV2** = **32** -- **ARRAY_FORMAT_BONES** = **64** -- **ARRAY_FORMAT_WEIGHTS** = **128** -- **ARRAY_FORMAT_INDEX** = **256** -- **ARRAY_COMPRESS_VERTEX** = **512** -- **ARRAY_COMPRESS_NORMAL** = **1024** -- **ARRAY_COMPRESS_TANGENT** = **2048** -- **ARRAY_COMPRESS_COLOR** = **4096** -- **ARRAY_COMPRESS_TEX_UV** = **8192** -- **ARRAY_COMPRESS_TEX_UV2** = **16384** +- **MATERIAL_RENDER_PRIORITY_MIN** = **-128** --- The minimum renderpriority of all materials. +- **MATERIAL_RENDER_PRIORITY_MAX** = **127** --- The maximum renderpriority of all materials. +- **CUBEMAP_LEFT** = **0** --- Marks the left side of a cubemap. +- **CUBEMAP_RIGHT** = **1** --- Marks the right side of a cubemap. +- **CUBEMAP_BOTTOM** = **2** --- Marks the bottom side of a cubemap. +- **CUBEMAP_TOP** = **3** --- Marks the top side of a cubemap. +- **CUBEMAP_FRONT** = **4** --- Marks the front side of a cubemap. +- **CUBEMAP_BACK** = **5** --- Marks the back side of a cubemap. +- **TEXTURE_FLAG_MIPMAPS** = **1** --- Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio. +- **TEXTURE_FLAG_REPEAT** = **2** --- Repeat (instead of clamp to edge). +- **TEXTURE_FLAG_FILTER** = **4** --- Turn on magnifying filter, to enable smooth zooming in of the texture. +- **TEXTURE_FLAG_ANISOTROPIC_FILTER** = **8** --- Anisotropic mipmap filtering. Generates smaller versions of the same texture with different aspect ratios. + +More effective on planes often shown going to the horrizon as those textures (Walls or Ground for example) get squashed in the viewport to different aspect ratios and regular mipmaps keep the aspect ratio so they don't optimize storage that well in those cases. +- **TEXTURE_FLAG_CONVERT_TO_LINEAR** = **16** --- Converts texture to SRGB color space. +- **TEXTURE_FLAG_MIRRORED_REPEAT** = **32** --- Repeat texture with alternate sections mirrored. +- **TEXTURE_FLAG_CUBEMAP** = **2048** --- Texture is a cubemap. +- **TEXTURE_FLAG_USED_FOR_STREAMING** = **4096** --- Texture is a video surface. +- **TEXTURE_FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled. +- **SHADER_SPATIAL** = **0** --- Shader is a 3D shader. +- **SHADER_CANVAS_ITEM** = **1** --- Shader is a 2D shader. +- **SHADER_PARTICLES** = **2** --- Shader is a particle shader. +- **SHADER_MAX** = **3** --- Marks maximum of the shader types array. used internally. +- **ARRAY_VERTEX** = **0** --- Array is a vertex array. +- **ARRAY_NORMAL** = **1** --- Array is a normal array. +- **ARRAY_TANGENT** = **2** --- Array is a tangent array. +- **ARRAY_COLOR** = **3** --- Array is a color array. +- **ARRAY_TEX_UV** = **4** --- Array is a uv coordinates array. +- **ARRAY_TEX_UV2** = **5** --- Array is a uv coordinates array for the second uv coordinates. +- **ARRAY_BONES** = **6** --- Array contains bone information. +- **ARRAY_WEIGHTS** = **7** --- Array is weight information. +- **ARRAY_INDEX** = **8** --- Array is index array. +- **ARRAY_MAX** = **9** --- Marks the maximum of the array types. Used internally. +- **ARRAY_FORMAT_VERTEX** = **1** --- Flag used to mark a vertex array. +- **ARRAY_FORMAT_NORMAL** = **2** --- Flag used to mark a normal array. +- **ARRAY_FORMAT_TANGENT** = **4** --- Flag used to mark a tangent array. +- **ARRAY_FORMAT_COLOR** = **8** --- Flag used to mark a color array. +- **ARRAY_FORMAT_TEX_UV** = **16** --- Flag used to mark a uv coordinates array. +- **ARRAY_FORMAT_TEX_UV2** = **32** --- Flag used to mark a uv coordinates array for the second uv coordinates. +- **ARRAY_FORMAT_BONES** = **64** --- Flag used to mark a bone information array. +- **ARRAY_FORMAT_WEIGHTS** = **128** --- Flag used to mark a weights array. +- **ARRAY_FORMAT_INDEX** = **256** --- Flag used to mark a index array. +- **ARRAY_COMPRESS_VERTEX** = **512** --- Flag used to mark a compressed (half float) vertex array. +- **ARRAY_COMPRESS_NORMAL** = **1024** --- Flag used to mark a compressed (half float) normal array. +- **ARRAY_COMPRESS_TANGENT** = **2048** --- Flag used to mark a compressed (half float) tangent array. +- **ARRAY_COMPRESS_COLOR** = **4096** --- Flag used to mark a compressed (half float) color array. +- **ARRAY_COMPRESS_TEX_UV** = **8192** --- Flag used to mark a compressed (half float) uv coordinates array. +- **ARRAY_COMPRESS_TEX_UV2** = **16384** --- Flag used to mark a compressed (half float) uv coordinates array for the second uv coordinates. - **ARRAY_COMPRESS_BONES** = **32768** -- **ARRAY_COMPRESS_WEIGHTS** = **65536** +- **ARRAY_COMPRESS_WEIGHTS** = **65536** --- Flag used to mark a compressed (half float) weight array. - **ARRAY_COMPRESS_INDEX** = **131072** -- **ARRAY_FLAG_USE_2D_VERTICES** = **262144** -- **ARRAY_FLAG_USE_16_BIT_BONES** = **524288** -- **ARRAY_COMPRESS_DEFAULT** = **97792** -- **PRIMITIVE_POINTS** = **0** -- **PRIMITIVE_LINES** = **1** -- **PRIMITIVE_LINE_STRIP** = **2** -- **PRIMITIVE_LINE_LOOP** = **3** -- **PRIMITIVE_TRIANGLES** = **4** -- **PRIMITIVE_TRIANGLE_STRIP** = **5** -- **PRIMITIVE_TRIANGLE_FAN** = **6** -- **PRIMITIVE_MAX** = **7** +- **ARRAY_FLAG_USE_2D_VERTICES** = **262144** --- Flag used to mark that the array contains 2D vertices. +- **ARRAY_FLAG_USE_16_BIT_BONES** = **524288** --- Flag used to mark that the array uses 16 bit bones instead of 8 bit. +- **ARRAY_COMPRESS_DEFAULT** = **97792** --- Used to set flags ARRAY_COMPRESS_VERTEX, ARRAY_COMPRESS_NORMAL, ARRAY_COMPRESS_TANGENT, ARRAY_COMPRESS_COLOR, ARRAY_COMPRESS_TEX_UV, ARRAY_COMPRESS_TEX_UV2 and ARRAY_COMPRESS_WEIGHTS quickly. +- **PRIMITIVE_POINTS** = **0** --- Primitive to draw consists of points. +- **PRIMITIVE_LINES** = **1** --- Primitive to draw consists of lines. +- **PRIMITIVE_LINE_STRIP** = **2** --- Primitive to draw consists of a line strip from start to end. +- **PRIMITIVE_LINE_LOOP** = **3** --- Primitive to draw consists of a line loop (a line strip with a line between the last and the first vertex). +- **PRIMITIVE_TRIANGLES** = **4** --- Primitive to draw consists of triangles. +- **PRIMITIVE_TRIANGLE_STRIP** = **5** --- Primitive to draw consists of a triangle strip (the last 3 verticies are always combined to make a triangle). +- **PRIMITIVE_TRIANGLE_FAN** = **6** --- Primitive to draw consists of a triangle strip (the last 2 verticies are always combined with the first to make a triangle). +- **PRIMITIVE_MAX** = **7** --- Marks the primitive types endpoint. used internally. - **BLEND_SHAPE_MODE_NORMALIZED** = **0** - **BLEND_SHAPE_MODE_RELATIVE** = **1** -- **LIGHT_DIRECTIONAL** = **0** -- **LIGHT_OMNI** = **1** -- **LIGHT_SPOT** = **2** -- **LIGHT_PARAM_ENERGY** = **0** -- **LIGHT_PARAM_SPECULAR** = **2** -- **LIGHT_PARAM_RANGE** = **3** -- **LIGHT_PARAM_ATTENUATION** = **4** -- **LIGHT_PARAM_SPOT_ANGLE** = **5** -- **LIGHT_PARAM_SPOT_ATTENUATION** = **6** -- **LIGHT_PARAM_CONTACT_SHADOW_SIZE** = **7** +- **LIGHT_DIRECTIONAL** = **0** --- Is a directional (sun) light. +- **LIGHT_OMNI** = **1** --- is an omni light. +- **LIGHT_SPOT** = **2** --- is an spot light. +- **LIGHT_PARAM_ENERGY** = **0** --- The light's energy. +- **LIGHT_PARAM_SPECULAR** = **2** --- The light's influence on specularity. +- **LIGHT_PARAM_RANGE** = **3** --- The light's range. +- **LIGHT_PARAM_ATTENUATION** = **4** --- The light's attenuation. +- **LIGHT_PARAM_SPOT_ANGLE** = **5** --- The spotlight's angle. +- **LIGHT_PARAM_SPOT_ATTENUATION** = **6** --- The spotlight's attenuation. +- **LIGHT_PARAM_CONTACT_SHADOW_SIZE** = **7** --- Scales the shadow color. - **LIGHT_PARAM_SHADOW_MAX_DISTANCE** = **8** - **LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET** = **9** - **LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET** = **10** @@ -467,74 +469,74 @@ Numeric Constants - **LIGHT_PARAM_SHADOW_NORMAL_BIAS** = **12** - **LIGHT_PARAM_SHADOW_BIAS** = **13** - **LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE** = **14** -- **LIGHT_PARAM_MAX** = **15** +- **LIGHT_PARAM_MAX** = **15** --- The light parameters endpoint. Used internally. - **VIEWPORT_UPDATE_DISABLED** = **0** - **VIEWPORT_UPDATE_ONCE** = **1** - **VIEWPORT_UPDATE_WHEN_VISIBLE** = **2** - **VIEWPORT_UPDATE_ALWAYS** = **3** -- **VIEWPORT_CLEAR_ALWAYS** = **0** -- **VIEWPORT_CLEAR_NEVER** = **1** -- **VIEWPORT_CLEAR_ONLY_NEXT_FRAME** = **2** -- **VIEWPORT_MSAA_DISABLED** = **0** -- **VIEWPORT_MSAA_2X** = **1** -- **VIEWPORT_MSAA_4X** = **2** -- **VIEWPORT_MSAA_8X** = **3** -- **VIEWPORT_MSAA_16X** = **4** -- **VIEWPORT_USAGE_2D** = **0** -- **VIEWPORT_USAGE_2D_NO_SAMPLING** = **1** -- **VIEWPORT_USAGE_3D** = **2** -- **VIEWPORT_USAGE_3D_NO_EFFECTS** = **3** +- **VIEWPORT_CLEAR_ALWAYS** = **0** --- The viewport is always cleared before drawing. +- **VIEWPORT_CLEAR_NEVER** = **1** --- The viewport is never cleared before drawing. +- **VIEWPORT_CLEAR_ONLY_NEXT_FRAME** = **2** --- The viewport is cleared once, then the clear mode is set to VIEWPORT_CLEAR_NEVER. +- **VIEWPORT_MSAA_DISABLED** = **0** --- Multisample antialiasing is disabled. +- **VIEWPORT_MSAA_2X** = **1** --- Multisample antialiasing is set to 2X. +- **VIEWPORT_MSAA_4X** = **2** --- Multisample antialiasing is set to 4X. +- **VIEWPORT_MSAA_8X** = **3** --- Multisample antialiasing is set to 8X. +- **VIEWPORT_MSAA_16X** = **4** --- Multisample antialiasing is set to 16X. +- **VIEWPORT_USAGE_2D** = **0** --- The Viewport does not render 3D but samples. +- **VIEWPORT_USAGE_2D_NO_SAMPLING** = **1** --- The Viewport does not render 3D and does not sample. +- **VIEWPORT_USAGE_3D** = **2** --- The Viewport renders 3D with effects. +- **VIEWPORT_USAGE_3D_NO_EFFECTS** = **3** --- The Viewport renders 3D but without effects. - **VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME** = **0** - **VIEWPORT_RENDER_INFO_VERTICES_IN_FRAME** = **1** - **VIEWPORT_RENDER_INFO_MATERIAL_CHANGES_IN_FRAME** = **2** - **VIEWPORT_RENDER_INFO_SHADER_CHANGES_IN_FRAME** = **3** - **VIEWPORT_RENDER_INFO_SURFACE_CHANGES_IN_FRAME** = **4** - **VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME** = **5** -- **VIEWPORT_RENDER_INFO_MAX** = **6** -- **VIEWPORT_DEBUG_DRAW_DISABLED** = **0** -- **VIEWPORT_DEBUG_DRAW_UNSHADED** = **1** -- **VIEWPORT_DEBUG_DRAW_OVERDRAW** = **2** -- **VIEWPORT_DEBUG_DRAW_WIREFRAME** = **3** +- **VIEWPORT_RENDER_INFO_MAX** = **6** --- Marks end of VIEWPORT_RENDER_INFO\* constants. Used internally. +- **VIEWPORT_DEBUG_DRAW_DISABLED** = **0** --- Debug draw is disabled. Default setting. +- **VIEWPORT_DEBUG_DRAW_UNSHADED** = **1** --- Debug draw sets objects to unshaded. +- **VIEWPORT_DEBUG_DRAW_OVERDRAW** = **2** --- Overwrites clear color to ``(0,0,0,0)``. +- **VIEWPORT_DEBUG_DRAW_WIREFRAME** = **3** --- Debug draw draws objects in wireframe. - **SCENARIO_DEBUG_DISABLED** = **0** - **SCENARIO_DEBUG_WIREFRAME** = **1** - **SCENARIO_DEBUG_OVERDRAW** = **2** - **SCENARIO_DEBUG_SHADELESS** = **3** -- **INSTANCE_NONE** = **0** -- **INSTANCE_MESH** = **1** -- **INSTANCE_MULTIMESH** = **2** -- **INSTANCE_IMMEDIATE** = **3** -- **INSTANCE_PARTICLES** = **4** -- **INSTANCE_LIGHT** = **5** +- **INSTANCE_NONE** = **0** --- The instance does not have a type. +- **INSTANCE_MESH** = **1** --- The instance is a mesh. +- **INSTANCE_MULTIMESH** = **2** --- The instance is a multimesh. +- **INSTANCE_IMMEDIATE** = **3** --- The instance is an immediate geometry. +- **INSTANCE_PARTICLES** = **4** --- The instance is a particle emitter. +- **INSTANCE_LIGHT** = **5** --- The instance is a light. - **INSTANCE_REFLECTION_PROBE** = **6** - **INSTANCE_GI_PROBE** = **7** -- **INSTANCE_MAX** = **8** -- **INSTANCE_GEOMETRY_MASK** = **30** -- **NINE_PATCH_STRETCH** = **0** -- **NINE_PATCH_TILE** = **1** -- **NINE_PATCH_TILE_FIT** = **2** -- **CANVAS_LIGHT_MODE_ADD** = **0** -- **CANVAS_LIGHT_MODE_SUB** = **1** -- **CANVAS_LIGHT_MODE_MIX** = **2** -- **CANVAS_LIGHT_MODE_MASK** = **3** +- **INSTANCE_MAX** = **8** --- The max value for INSTANCE\_\* constants, used internally. +- **INSTANCE_GEOMETRY_MASK** = **30** --- A combination of the flags of geometry instances (mesh, multimesh, immediate and particles). +- **NINE_PATCH_STRETCH** = **0** --- The nine patch gets stretched where needed. +- **NINE_PATCH_TILE** = **1** --- The nine patch gets filled with tiles where needed. +- **NINE_PATCH_TILE_FIT** = **2** --- The nine patch gets filled with tiles where needed and stretches them a bit if needed. +- **CANVAS_LIGHT_MODE_ADD** = **0** --- Adds light color additive to the canvas. +- **CANVAS_LIGHT_MODE_SUB** = **1** --- Adds light color subtractive to the canvas. +- **CANVAS_LIGHT_MODE_MIX** = **2** --- The light adds color depending on transparency. +- **CANVAS_LIGHT_MODE_MASK** = **3** --- The light adds color depending on mask. - **CANVAS_LIGHT_FILTER_NONE** = **0** - **CANVAS_LIGHT_FILTER_PCF3** = **1** - **CANVAS_LIGHT_FILTER_PCF5** = **2** - **CANVAS_LIGHT_FILTER_PCF7** = **3** - **CANVAS_LIGHT_FILTER_PCF9** = **4** - **CANVAS_LIGHT_FILTER_PCF13** = **5** -- **CANVAS_OCCLUDER_POLYGON_CULL_DISABLED** = **0** -- **CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE** = **1** -- **CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE** = **2** -- **INFO_OBJECTS_IN_FRAME** = **0** -- **INFO_VERTICES_IN_FRAME** = **1** -- **INFO_MATERIAL_CHANGES_IN_FRAME** = **2** -- **INFO_SHADER_CHANGES_IN_FRAME** = **3** -- **INFO_SURFACE_CHANGES_IN_FRAME** = **4** -- **INFO_DRAW_CALLS_IN_FRAME** = **5** +- **CANVAS_OCCLUDER_POLYGON_CULL_DISABLED** = **0** --- Culling of the canvas occluder is disabled. +- **CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE** = **1** --- Culling of the canvas occluder is clockwise. +- **CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE** = **2** --- Culling of the canvas occluder is counterclockwise. +- **INFO_OBJECTS_IN_FRAME** = **0** --- The amount of objects in the frame. +- **INFO_VERTICES_IN_FRAME** = **1** --- The amount of vertices in the frame. +- **INFO_MATERIAL_CHANGES_IN_FRAME** = **2** --- The amount of modified materials in the frame. +- **INFO_SHADER_CHANGES_IN_FRAME** = **3** --- The amount of shader rebinds in the frame. +- **INFO_SURFACE_CHANGES_IN_FRAME** = **4** --- The amount of surface changes in the frame. +- **INFO_DRAW_CALLS_IN_FRAME** = **5** --- The amount of draw calls in frame. - **INFO_USAGE_VIDEO_MEM_TOTAL** = **6** -- **INFO_VIDEO_MEM_USED** = **7** -- **INFO_TEXTURE_MEM_USED** = **8** -- **INFO_VERTEX_MEM_USED** = **9** +- **INFO_VIDEO_MEM_USED** = **7** --- The amount of vertex memory and texture memory used. +- **INFO_TEXTURE_MEM_USED** = **8** --- The amount of texture memory used. +- **INFO_VERTEX_MEM_USED** = **9** --- The amount of vertex memory used. - **FEATURE_SHADERS** = **0** - **FEATURE_MULTITHREADED** = **1** @@ -552,94 +554,144 @@ Member Function Description - void **black_bars_set_images** **(** :ref:`RID` left, :ref:`RID` top, :ref:`RID` right, :ref:`RID` bottom **)** +Sets images to be rendered in the window margin. + .. _class_VisualServer_black_bars_set_margins: - void **black_bars_set_margins** **(** :ref:`int` left, :ref:`int` top, :ref:`int` right, :ref:`int` bottom **)** +Sets margin size, where black bars (or images, if :ref:`black_bars_set_images` was used) are rendered. + .. _class_VisualServer_canvas_create: - :ref:`RID` **canvas_create** **(** **)** +Creates a canvas and returns the assigned :ref:`RID`. + .. _class_VisualServer_canvas_item_add_circle: - void **canvas_item_add_circle** **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** +Adds a circle command to the :ref:`CanvasItem`'s draw commands. + .. _class_VisualServer_canvas_item_add_clip_ignore: - void **canvas_item_add_clip_ignore** **(** :ref:`RID` item, :ref:`bool` ignore **)** +If ignore is ``true``, the VisualServer does not perform clipping. + .. _class_VisualServer_canvas_item_add_line: - void **canvas_item_add_line** **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +Adds a line command to the :ref:`CanvasItem`'s draw commands. + .. _class_VisualServer_canvas_item_add_mesh: - void **canvas_item_add_mesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` skeleton **)** +Adds a :ref:`Mesh` to the :ref:`CanvasItem`'s draw commands. Only affects its aabb at the moment. + .. _class_VisualServer_canvas_item_add_multimesh: - void **canvas_item_add_multimesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` skeleton **)** +Adds a :ref:`MultiMesh` to the :ref:`CanvasItem`'s draw commands. Only affects its aabb at the moment. + .. _class_VisualServer_canvas_item_add_nine_patch: - void **canvas_item_add_nine_patch** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`int` x_axis_mode=0, :ref:`int` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`RID` normal_map **)** +Adds a nine patch image to the :ref:`CanvasItem`'s draw commands. + +See :ref:`NinePatchRect` for more explanation. + .. _class_VisualServer_canvas_item_add_particles: - void **canvas_item_add_particles** **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture, :ref:`RID` normal_map, :ref:`int` h_frames, :ref:`int` v_frames **)** +Adds a particles system to the :ref:`CanvasItem`'s draw commands. + .. _class_VisualServer_canvas_item_add_polygon: - void **canvas_item_add_polygon** **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`RID` texture, :ref:`RID` normal_map, :ref:`bool` antialiased=false **)** +Adds a polygon to the :ref:`CanvasItem`'s draw commands. + .. _class_VisualServer_canvas_item_add_polyline: - void **canvas_item_add_polyline** **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +Adds a polyline, which is a line from mutliple points with a width, to the :ref:`CanvasItem`'s draw commands. + .. _class_VisualServer_canvas_item_add_primitive: - void **canvas_item_add_primitive** **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`RID` texture, :ref:`float` width=1.0, :ref:`RID` normal_map **)** +Adds a primitive to the :ref:`CanvasItem`'s draw commands. + .. _class_VisualServer_canvas_item_add_rect: - void **canvas_item_add_rect** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** +Adds a rectangle to the :ref:`CanvasItem`'s draw commands. + .. _class_VisualServer_canvas_item_add_set_transform: - void **canvas_item_add_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** +Adds a :ref:`Transform2D` command to the :ref:`CanvasItem`'s draw commands. + +This sets the extra_matrix uniform when executed. This affects the later command's of the canvas item. + .. _class_VisualServer_canvas_item_add_texture_rect: - void **canvas_item_add_texture_rect** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map **)** +Adds a textured rect to the :ref:`CanvasItem`'s draw commands. + .. _class_VisualServer_canvas_item_add_texture_rect_region: - void **canvas_item_add_texture_rect_region** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map, :ref:`bool` clip_uv=true **)** +Adds a texture rect with region setting to the :ref:`CanvasItem`'s draw commands. + .. _class_VisualServer_canvas_item_add_triangle_array: - void **canvas_item_add_triangle_array** **(** :ref:`RID` item, :ref:`PoolIntArray` indices, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`RID` texture, :ref:`int` count=-1, :ref:`RID` normal_map **)** +Adds a triangle array to the :ref:`CanvasItem`'s draw commands. + .. _class_VisualServer_canvas_item_clear: - void **canvas_item_clear** **(** :ref:`RID` item **)** +Clears the :ref:`CanvasItem` and removes all commands in it. + .. _class_VisualServer_canvas_item_create: - :ref:`RID` **canvas_item_create** **(** **)** +Creates a new :ref:`CanvasItem` and returns its :ref:`RID`. + .. _class_VisualServer_canvas_item_set_clip: - void **canvas_item_set_clip** **(** :ref:`RID` item, :ref:`bool` clip **)** +Sets clipping for the :ref:`CanvasItem`. + .. _class_VisualServer_canvas_item_set_copy_to_backbuffer: - void **canvas_item_set_copy_to_backbuffer** **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** +Sets the :ref:`CanvasItem` to copy a rect to the backbuffer. + .. _class_VisualServer_canvas_item_set_custom_rect: - void **canvas_item_set_custom_rect** **(** :ref:`RID` item, :ref:`bool` use_custom_rect, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ) **)** +Defines a custom drawing rectangle for the :ref:`CanvasItem`. + .. _class_VisualServer_canvas_item_set_distance_field_mode: - void **canvas_item_set_distance_field_mode** **(** :ref:`RID` item, :ref:`bool` enabled **)** @@ -648,118 +700,176 @@ Member Function Description - void **canvas_item_set_draw_behind_parent** **(** :ref:`RID` item, :ref:`bool` enabled **)** +Sets :ref:`CanvasItem` to be drawn behind its parent. + .. _class_VisualServer_canvas_item_set_draw_index: - void **canvas_item_set_draw_index** **(** :ref:`RID` item, :ref:`int` index **)** +Sets the index for the :ref:`CanvasItem`. + .. _class_VisualServer_canvas_item_set_light_mask: - void **canvas_item_set_light_mask** **(** :ref:`RID` item, :ref:`int` mask **)** +The light mask. See :ref:`LightOccluder2D` for more information on light masks. + .. _class_VisualServer_canvas_item_set_material: - void **canvas_item_set_material** **(** :ref:`RID` item, :ref:`RID` material **)** +Sets a new material to the :ref:`CanvasItem`. + .. _class_VisualServer_canvas_item_set_modulate: - void **canvas_item_set_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** +Sets the color that modulates the :ref:`CanvasItem` and its children. + .. _class_VisualServer_canvas_item_set_parent: - void **canvas_item_set_parent** **(** :ref:`RID` item, :ref:`RID` parent **)** +Sets the parent for the :ref:`CanvasItem`. + .. _class_VisualServer_canvas_item_set_self_modulate: - void **canvas_item_set_self_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** +Sets the color that modulates the :ref:`CanvasItem` without children. + .. _class_VisualServer_canvas_item_set_sort_children_by_y: - void **canvas_item_set_sort_children_by_y** **(** :ref:`RID` item, :ref:`bool` enabled **)** +Sets if :ref:`CanvasItem`'s children should be sorted by y-position. + .. _class_VisualServer_canvas_item_set_transform: - void **canvas_item_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** +Sets the :ref:`CanvasItem`'s :ref:`Transform2D`. + .. _class_VisualServer_canvas_item_set_use_parent_material: - void **canvas_item_set_use_parent_material** **(** :ref:`RID` item, :ref:`bool` enabled **)** +Sets if the :ref:`CanvasItem` uses its parent's material. + .. _class_VisualServer_canvas_item_set_visible: - void **canvas_item_set_visible** **(** :ref:`RID` item, :ref:`bool` visible **)** +Sets if the canvas item (including its children) is visible. + .. _class_VisualServer_canvas_item_set_z: - void **canvas_item_set_z** **(** :ref:`RID` item, :ref:`int` z **)** +Sets the :ref:`CanvasItem`'s z order position. + .. _class_VisualServer_canvas_item_set_z_as_relative_to_parent: - void **canvas_item_set_z_as_relative_to_parent** **(** :ref:`RID` item, :ref:`bool` enabled **)** +If this is enabled, the z-position of the parent will be added to the childrens z-position. + .. _class_VisualServer_canvas_light_attach_to_canvas: - void **canvas_light_attach_to_canvas** **(** :ref:`RID` light, :ref:`RID` canvas **)** +Attaches the canvas light to the canvas. Removes it from its previous canvas. + .. _class_VisualServer_canvas_light_create: - :ref:`RID` **canvas_light_create** **(** **)** +Creates a canvas light. + .. _class_VisualServer_canvas_light_occluder_attach_to_canvas: - void **canvas_light_occluder_attach_to_canvas** **(** :ref:`RID` occluder, :ref:`RID` canvas **)** +Attaches a light occluder to the canvas. Removes it from its previous canvas. + .. _class_VisualServer_canvas_light_occluder_create: - :ref:`RID` **canvas_light_occluder_create** **(** **)** +Creates a light occluder. + .. _class_VisualServer_canvas_light_occluder_set_enabled: - void **canvas_light_occluder_set_enabled** **(** :ref:`RID` occluder, :ref:`bool` enabled **)** +Enables or disables light occluder. + .. _class_VisualServer_canvas_light_occluder_set_light_mask: - void **canvas_light_occluder_set_light_mask** **(** :ref:`RID` occluder, :ref:`int` mask **)** +The light mask. See :ref:`LightOccluder2D` for more information on light masks + .. _class_VisualServer_canvas_light_occluder_set_polygon: - void **canvas_light_occluder_set_polygon** **(** :ref:`RID` occluder, :ref:`RID` polygon **)** +Sets a light occluder's polygon. + .. _class_VisualServer_canvas_light_occluder_set_transform: - void **canvas_light_occluder_set_transform** **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** +Sets a light occluder's :ref:`Transform2D`. + .. _class_VisualServer_canvas_light_set_color: - void **canvas_light_set_color** **(** :ref:`RID` light, :ref:`Color` color **)** +Sets the color for a light. + .. _class_VisualServer_canvas_light_set_enabled: - void **canvas_light_set_enabled** **(** :ref:`RID` light, :ref:`bool` enabled **)** +Enables or disables a canvas light. + .. _class_VisualServer_canvas_light_set_energy: - void **canvas_light_set_energy** **(** :ref:`RID` light, :ref:`float` energy **)** +Sets a canvas light's energy. + .. _class_VisualServer_canvas_light_set_height: - void **canvas_light_set_height** **(** :ref:`RID` light, :ref:`float` height **)** +Sets a canvas light's height. + .. _class_VisualServer_canvas_light_set_item_cull_mask: - void **canvas_light_set_item_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** +The light mask. See :ref:`LightOccluder2D` for more information on light masks + .. _class_VisualServer_canvas_light_set_item_shadow_cull_mask: - void **canvas_light_set_item_shadow_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** +The shadow mask. binary about wich layers this canvas light affects wich canvas item's shadows. See :ref:`LightOccluder2D` for more information on light masks. + .. _class_VisualServer_canvas_light_set_layer_range: - void **canvas_light_set_layer_range** **(** :ref:`RID` light, :ref:`int` min_layer, :ref:`int` max_layer **)** +The layer range that gets rendered with this light. + .. _class_VisualServer_canvas_light_set_mode: - void **canvas_light_set_mode** **(** :ref:`RID` light, :ref:`int` mode **)** +The mode of the light, see CANVAS_LIGHT_MODE\_\* constants. + .. _class_VisualServer_canvas_light_set_scale: - void **canvas_light_set_scale** **(** :ref:`RID` light, :ref:`float` scale **)** @@ -768,26 +878,38 @@ Member Function Description - void **canvas_light_set_shadow_buffer_size** **(** :ref:`RID` light, :ref:`int` size **)** +Sets the width of the shadow buffer, size gets scaled to the next power of two for this. + .. _class_VisualServer_canvas_light_set_shadow_color: - void **canvas_light_set_shadow_color** **(** :ref:`RID` light, :ref:`Color` color **)** +Sets the color of the canvas light's shadow. + .. _class_VisualServer_canvas_light_set_shadow_enabled: - void **canvas_light_set_shadow_enabled** **(** :ref:`RID` light, :ref:`bool` enabled **)** +Enables or disables the canvas light's shadow. + .. _class_VisualServer_canvas_light_set_shadow_filter: - void **canvas_light_set_shadow_filter** **(** :ref:`RID` light, :ref:`int` filter **)** +Sets the canvas light's shadow's filter, see CANVAS_LIGHT_SHADOW_FILTER\_\* constants. + .. _class_VisualServer_canvas_light_set_shadow_gradient_length: - void **canvas_light_set_shadow_gradient_length** **(** :ref:`RID` light, :ref:`float` length **)** +Sets the length of the shadow's gradient. + .. _class_VisualServer_canvas_light_set_shadow_smooth: - void **canvas_light_set_shadow_smooth** **(** :ref:`RID` light, :ref:`float` smooth **)** +Smoothens the shadow. The lower, the more smooth. + .. _class_VisualServer_canvas_light_set_texture: - void **canvas_light_set_texture** **(** :ref:`RID` light, :ref:`RID` texture **)** @@ -800,6 +922,8 @@ Member Function Description - void **canvas_light_set_transform** **(** :ref:`RID` light, :ref:`Transform2D` transform **)** +Sets the canvas light's :ref:`Transform2D`. + .. _class_VisualServer_canvas_light_set_z_range: - void **canvas_light_set_z_range** **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** @@ -808,66 +932,98 @@ Member Function Description - :ref:`RID` **canvas_occluder_polygon_create** **(** **)** +Creates a new light occluder polygon. + .. _class_VisualServer_canvas_occluder_polygon_set_cull_mode: - void **canvas_occluder_polygon_set_cull_mode** **(** :ref:`RID` occluder_polygon, :ref:`int` mode **)** +Sets an occluder polygons cull mode. See CANVAS_OCCLUDER_POLYGON_CULL_MODE\_\* constants. + .. _class_VisualServer_canvas_occluder_polygon_set_shape: - void **canvas_occluder_polygon_set_shape** **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape, :ref:`bool` closed **)** +Sets the shape of the occluder polygon. + .. _class_VisualServer_canvas_occluder_polygon_set_shape_as_lines: - void **canvas_occluder_polygon_set_shape_as_lines** **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape **)** +Sets the shape of the occluder polygon as lines. + .. _class_VisualServer_canvas_set_item_mirroring: - void **canvas_set_item_mirroring** **(** :ref:`RID` canvas, :ref:`RID` item, :ref:`Vector2` mirroring **)** +A copy of the canvas item will be drawn with a local offset of the mirroring :ref:`Vector2`. + .. _class_VisualServer_canvas_set_modulate: - void **canvas_set_modulate** **(** :ref:`RID` canvas, :ref:`Color` color **)** +Modulates all colors in the given canvas. + .. _class_VisualServer_draw: - void **draw** **(** :ref:`bool` swap_buffers=true **)** +Draws a frame. + .. _class_VisualServer_finish: - void **finish** **(** **)** +Removes buffers and clears testcubes. + .. _class_VisualServer_force_draw: - void **force_draw** **(** :ref:`bool` swap_buffers=true **)** +Draws a frame. Same as :ref:`draw`. + .. _class_VisualServer_force_sync: - void **force_sync** **(** **)** +Syncronizes threads. + .. _class_VisualServer_free: - void **free** **(** :ref:`RID` rid **)** +Tries to free an object in the VisualServer. + .. _class_VisualServer_get_render_info: - :ref:`int` **get_render_info** **(** :ref:`int` info **)** +Returns a certain information, see RENDER_INFO\_\* for options. + .. _class_VisualServer_get_test_cube: - :ref:`RID` **get_test_cube** **(** **)** +Returns the id of the test cube. Creates one if none exists. + .. _class_VisualServer_get_test_texture: - :ref:`RID` **get_test_texture** **(** **)** +Returns the id of the test texture. Creates one if none exists. + .. _class_VisualServer_get_white_texture: - :ref:`RID` **get_white_texture** **(** **)** +Returns the id of a white texture. Creates one if none exists. + .. _class_VisualServer_has_changed: - :ref:`bool` **has_changed** **(** **)** const +Returns ``true`` if changes have been made to the VisualServer's data. :ref:`draw` is usually called if this happens. + .. _class_VisualServer_has_feature: - :ref:`bool` **has_feature** **(** :ref:`int` feature **)** const @@ -876,138 +1032,206 @@ Member Function Description - :ref:`bool` **has_os_feature** **(** :ref:`String` feature **)** const +Returns true, if the OS supports a certain feature. Features might be s3tc, etc, etc2 and pvrtc, + .. _class_VisualServer_init: - void **init** **(** **)** +Initializes the visual server. + .. _class_VisualServer_make_sphere_mesh: - :ref:`RID` **make_sphere_mesh** **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** +Returns a mesh of a sphere with the given amount of horizontal and vertical subdivisions. + .. _class_VisualServer_material_create: - :ref:`RID` **material_create** **(** **)** +Returns an empty material. + .. _class_VisualServer_material_get_param: - :ref:`Variant` **material_get_param** **(** :ref:`RID` material, :ref:`String` parameter **)** const +Returns the value of a certain material's parameter. + .. _class_VisualServer_material_get_shader: - :ref:`RID` **material_get_shader** **(** :ref:`RID` shader_material **)** const +Returns the shader of a certain material's shader. Returns an empty RID if the material doesn't have a shader. + .. _class_VisualServer_material_set_line_width: - void **material_set_line_width** **(** :ref:`RID` material, :ref:`float` width **)** +Sets a materials line width. + .. _class_VisualServer_material_set_next_pass: - void **material_set_next_pass** **(** :ref:`RID` material, :ref:`RID` next_material **)** +Sets an objects next material. + .. _class_VisualServer_material_set_param: - void **material_set_param** **(** :ref:`RID` material, :ref:`String` parameter, :ref:`Variant` value **)** +Sets a materials parameter. + .. _class_VisualServer_material_set_render_priority: - void **material_set_render_priority** **(** :ref:`RID` material, :ref:`int` priority **)** +Sets a material's render priority. + .. _class_VisualServer_material_set_shader: - void **material_set_shader** **(** :ref:`RID` shader_material, :ref:`RID` shader **)** +Sets a shader material's shader. + .. _class_VisualServer_mesh_add_surface_from_arrays: - void **mesh_add_surface_from_arrays** **(** :ref:`RID` mesh, :ref:`int` primtive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_format=97792 **)** +Adds a surface generated from the Arrays to a mesh. See PRIMITIVE_TYPE\_\* constants for types. + .. _class_VisualServer_mesh_clear: - void **mesh_clear** **(** :ref:`RID` mesh **)** +Removes all surfaces from a mesh. + .. _class_VisualServer_mesh_create: - :ref:`RID` **mesh_create** **(** **)** +Creates a new mesh. + .. _class_VisualServer_mesh_get_blend_shape_count: - :ref:`int` **mesh_get_blend_shape_count** **(** :ref:`RID` mesh **)** const +Returns a mesh's blend shape count. + .. _class_VisualServer_mesh_get_blend_shape_mode: - :ref:`int` **mesh_get_blend_shape_mode** **(** :ref:`RID` mesh **)** const +Returns a mesh's blend shape mode. + .. _class_VisualServer_mesh_get_custom_aabb: - :ref:`AABB` **mesh_get_custom_aabb** **(** :ref:`RID` mesh **)** const +Returns a mesh's custom aabb. + .. _class_VisualServer_mesh_get_surface_count: - :ref:`int` **mesh_get_surface_count** **(** :ref:`RID` mesh **)** const +Returns a mesh's number of surfaces. + .. _class_VisualServer_mesh_remove_surface: - void **mesh_remove_surface** **(** :ref:`RID` mesh, :ref:`int` index **)** +Removes a mesh's surface. + .. _class_VisualServer_mesh_set_blend_shape_count: - void **mesh_set_blend_shape_count** **(** :ref:`RID` mesh, :ref:`int` amount **)** +Sets a mesh's blend shape count. + .. _class_VisualServer_mesh_set_blend_shape_mode: - void **mesh_set_blend_shape_mode** **(** :ref:`RID` mesh, :ref:`int` mode **)** +Sets a mesh's blend shape mode. + .. _class_VisualServer_mesh_set_custom_aabb: - void **mesh_set_custom_aabb** **(** :ref:`RID` mesh, :ref:`AABB` aabb **)** +Sets a mesh's custom aabb. + .. _class_VisualServer_mesh_surface_get_aabb: - :ref:`AABB` **mesh_surface_get_aabb** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +Returns a mesh's surface's aabb. + .. _class_VisualServer_mesh_surface_get_array: - :ref:`PoolByteArray` **mesh_surface_get_array** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +Returns a mesh's surface's vertex buffer. + .. _class_VisualServer_mesh_surface_get_array_index_len: - :ref:`int` **mesh_surface_get_array_index_len** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +Returns a mesh's surface's amount of indices. + .. _class_VisualServer_mesh_surface_get_array_len: - :ref:`int` **mesh_surface_get_array_len** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +Returns a mesh's surface's amount of vertices. + .. _class_VisualServer_mesh_surface_get_arrays: - :ref:`Array` **mesh_surface_get_arrays** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +Returns a mesh's surface's buffer arrays. + .. _class_VisualServer_mesh_surface_get_blend_shape_arrays: - :ref:`Array` **mesh_surface_get_blend_shape_arrays** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +Returns a mesh's surface's arrays for blend shapes + .. _class_VisualServer_mesh_surface_get_format: - :ref:`int` **mesh_surface_get_format** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +Returns the format of a mesh's surface. + .. _class_VisualServer_mesh_surface_get_index_array: - :ref:`PoolByteArray` **mesh_surface_get_index_array** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +Returns a mesh's surface's index buffer. + .. _class_VisualServer_mesh_surface_get_material: - :ref:`RID` **mesh_surface_get_material** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +Returns a mesh's surface's material. + .. _class_VisualServer_mesh_surface_get_primitive_type: - :ref:`int` **mesh_surface_get_primitive_type** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +Returns the primitive type of a mesh's surface. + .. _class_VisualServer_mesh_surface_get_skeleton_aabb: - :ref:`Array` **mesh_surface_get_skeleton_aabb** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +Returns the aabb of a mesh's surface's skeleton. + .. _class_VisualServer_mesh_surface_set_material: - void **mesh_surface_set_material** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** +Sets a mesh's surface's material. + .. _class_VisualServer_request_frame_drawn_callback: - void **request_frame_drawn_callback** **(** :ref:`Object` where, :ref:`String` method, :ref:`Variant` userdata **)** @@ -1020,6 +1244,8 @@ The callback method must use only 1 argument which will be called with 'userdata - void **set_boot_image** **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale **)** +Sets a boot image. The color defines the background color and if scale is ``true``, the image will be scaled to fit the screen size. + .. _class_VisualServer_set_debug_generate_wireframes: - void **set_debug_generate_wireframes** **(** :ref:`bool` generate **)** @@ -1032,34 +1258,50 @@ The callback method must use only 1 argument which will be called with 'userdata - :ref:`RID` **shader_create** **(** **)** +Creates an empty shader. + .. _class_VisualServer_shader_get_code: - :ref:`String` **shader_get_code** **(** :ref:`RID` shader **)** const +Returns a shader's code. + .. _class_VisualServer_shader_get_default_texture_param: - :ref:`RID` **shader_get_default_texture_param** **(** :ref:`RID` shader, :ref:`String` name **)** const +Returns a default texture from a shader searched by name. + .. _class_VisualServer_shader_get_param_list: - :ref:`Array` **shader_get_param_list** **(** :ref:`RID` shader **)** const +Returns the parameters of a shader. + .. _class_VisualServer_shader_set_code: - void **shader_set_code** **(** :ref:`RID` shader, :ref:`String` code **)** +Sets a shader's code. + .. _class_VisualServer_shader_set_default_texture_param: - void **shader_set_default_texture_param** **(** :ref:`RID` shader, :ref:`String` name, :ref:`RID` texture **)** +Sets a shader's default texture. Overwrites the texture given by name. + .. _class_VisualServer_sky_create: - :ref:`RID` **sky_create** **(** **)** +Creates an empty sky. + .. _class_VisualServer_sky_set_texture: - void **sky_set_texture** **(** :ref:`RID` sky, :ref:`RID` cube_map, :ref:`int` radiance_size **)** +Sets a sky's texture. + .. _class_VisualServer_sync: - void **sync** **(** **)** @@ -1068,142 +1310,212 @@ The callback method must use only 1 argument which will be called with 'userdata - void **texture_allocate** **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` format, :ref:`int` flags=7 **)** +Allocates space for a texture's image or video. + .. _class_VisualServer_texture_create: - :ref:`RID` **texture_create** **(** **)** +Creates an empty texture. + .. _class_VisualServer_texture_create_from_image: - :ref:`RID` **texture_create_from_image** **(** :ref:`Image` image, :ref:`int` flags=7 **)** +Creates a texture, allocates the space for an image, and fills in the image. + .. _class_VisualServer_texture_debug_usage: - :ref:`Array` **texture_debug_usage** **(** **)** +Returns a list of all the textures and their information. + .. _class_VisualServer_texture_get_data: - :ref:`Image` **texture_get_data** **(** :ref:`RID` texture, :ref:`int` cube_side=0 **)** const +Returns a copy of a texture's image unless it's a CubeMap, in wich case it returns the :ref:`RID` of the image at one of the cubes sides. + .. _class_VisualServer_texture_get_flags: - :ref:`int` **texture_get_flags** **(** :ref:`RID` texture **)** const +Returns the flags of a texture. + .. _class_VisualServer_texture_get_format: - :ref:`int` **texture_get_format** **(** :ref:`RID` texture **)** const +Returns the format of the texture's image. + .. _class_VisualServer_texture_get_height: - :ref:`int` **texture_get_height** **(** :ref:`RID` texture **)** const +Returns the texture's height. + .. _class_VisualServer_texture_get_path: - :ref:`String` **texture_get_path** **(** :ref:`RID` texture **)** const +Returns the texture's path. + .. _class_VisualServer_texture_get_texid: - :ref:`int` **texture_get_texid** **(** :ref:`RID` texture **)** const +Returns the opengl id of the texture's image. + .. _class_VisualServer_texture_get_width: - :ref:`int` **texture_get_width** **(** :ref:`RID` texture **)** const +Returns the texture's width. + .. _class_VisualServer_texture_set_data: - void **texture_set_data** **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` cube_side=0 **)** +Sets the texture's image data. If it's a CubeMap, it sets the image data at a cube side. + .. _class_VisualServer_texture_set_flags: - void **texture_set_flags** **(** :ref:`RID` texture, :ref:`int` flags **)** +Sets the texture's flags. See enum TextureFlags for options + .. _class_VisualServer_texture_set_path: - void **texture_set_path** **(** :ref:`RID` texture, :ref:`String` path **)** +Sets the texture's path. + .. _class_VisualServer_texture_set_shrink_all_x2_on_set_data: - void **texture_set_shrink_all_x2_on_set_data** **(** :ref:`bool` shrink **)** +If ``true``, sets internal processes to shrink all image data to half the size. + .. _class_VisualServer_texture_set_size_override: - void **texture_set_size_override** **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height **)** +Overwrites the texture's width and height. + .. _class_VisualServer_textures_keep_original: - void **textures_keep_original** **(** :ref:`bool` enable **)** +If ``true``, the image will be stored in the texture's images array if overwritten. + .. _class_VisualServer_viewport_attach_camera: - void **viewport_attach_camera** **(** :ref:`RID` viewport, :ref:`RID` camera **)** +Sets a viewport's camera. + .. _class_VisualServer_viewport_attach_canvas: - void **viewport_attach_canvas** **(** :ref:`RID` viewport, :ref:`RID` canvas **)** +Sets a viewport's canvas. + .. _class_VisualServer_viewport_attach_to_screen: - void **viewport_attach_to_screen** **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ), :ref:`int` screen=0 **)** +Attaches a viewport to a screen. + .. _class_VisualServer_viewport_create: - :ref:`RID` **viewport_create** **(** **)** +Creates an empty viewport. + .. _class_VisualServer_viewport_detach: - void **viewport_detach** **(** :ref:`RID` viewport **)** +Detaches the viewport from the screen. + .. _class_VisualServer_viewport_get_render_info: - :ref:`int` **viewport_get_render_info** **(** :ref:`RID` viewport, :ref:`int` info **)** +Returns a viewport's render info. for options see VIEWPORT_RENDER_INFO\* constants. + .. _class_VisualServer_viewport_get_texture: - :ref:`RID` **viewport_get_texture** **(** :ref:`RID` viewport **)** const +Returns the viewport's last rendered frame. + .. _class_VisualServer_viewport_remove_canvas: - void **viewport_remove_canvas** **(** :ref:`RID` viewport, :ref:`RID` canvas **)** +Detaches a viewport from a canvas and vice versa. + .. _class_VisualServer_viewport_set_active: - void **viewport_set_active** **(** :ref:`RID` viewport, :ref:`bool` active **)** +If ``true``, sets the viewport active, else sets it inactive. + .. _class_VisualServer_viewport_set_canvas_layer: - void **viewport_set_canvas_layer** **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer **)** +Sets the renderlayer for a viewport's canvas. + .. _class_VisualServer_viewport_set_canvas_transform: - void **viewport_set_canvas_transform** **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`Transform2D` offset **)** +Sets the transformation of a viewport's canvas. + .. _class_VisualServer_viewport_set_clear_mode: - void **viewport_set_clear_mode** **(** :ref:`RID` viewport, :ref:`int` clear_mode **)** +Sets the clear mode of a viewport. See VIEWPORT_CLEAR_MODE\_\* constants for options. + .. _class_VisualServer_viewport_set_debug_draw: - void **viewport_set_debug_draw** **(** :ref:`RID` viewport, :ref:`int` draw **)** +Sets the debug draw mode of a viewport. See VIEWPORT_DEBUG_DRAW\_\* constants for options. + .. _class_VisualServer_viewport_set_disable_3d: - void **viewport_set_disable_3d** **(** :ref:`RID` viewport, :ref:`bool` disabled **)** +If ``true`` a viewport's 3D rendering should be disabled. + .. _class_VisualServer_viewport_set_disable_environment: - void **viewport_set_disable_environment** **(** :ref:`RID` viewport, :ref:`bool` disabled **)** +If ``true`` rendering of a viewport's environment should be disabled. + .. _class_VisualServer_viewport_set_global_canvas_transform: - void **viewport_set_global_canvas_transform** **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** +Sets the viewport's global transformation matrix. + .. _class_VisualServer_viewport_set_hdr: - void **viewport_set_hdr** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** +If ``true`` the viewport should render to hdr. + .. _class_VisualServer_viewport_set_hide_canvas: - void **viewport_set_hide_canvas** **(** :ref:`RID` viewport, :ref:`bool` hidden **)** +If ``true`` the viewport's canvas should not be rendered. + .. _class_VisualServer_viewport_set_hide_scenario: - void **viewport_set_hide_scenario** **(** :ref:`RID` viewport, :ref:`bool` hidden **)** @@ -1212,44 +1524,68 @@ The callback method must use only 1 argument which will be called with 'userdata - void **viewport_set_msaa** **(** :ref:`RID` viewport, :ref:`int` msaa **)** +Sets the anti-aliasing mode. see enum ViewportMSAA for options. + .. _class_VisualServer_viewport_set_parent_viewport: - void **viewport_set_parent_viewport** **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** +Sets the viewport's parent to another viewport. + .. _class_VisualServer_viewport_set_scenario: - void **viewport_set_scenario** **(** :ref:`RID` viewport, :ref:`RID` scenario **)** +Sets a viewport's scenario. + +The scenario contains information about the enum ScenarioDebugMode, environment information, reflection atlas etc. + .. _class_VisualServer_viewport_set_shadow_atlas_quadrant_subdivision: - void **viewport_set_shadow_atlas_quadrant_subdivision** **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** +Sets the shadow atlas quadrant's subdivision. + .. _class_VisualServer_viewport_set_shadow_atlas_size: - void **viewport_set_shadow_atlas_size** **(** :ref:`RID` viewport, :ref:`int` size **)** +Sets the size of the shadow atlas's images. + .. _class_VisualServer_viewport_set_size: - void **viewport_set_size** **(** :ref:`RID` viewport, :ref:`int` width, :ref:`int` height **)** +Sets the viewport's width and height. + .. _class_VisualServer_viewport_set_transparent_background: - void **viewport_set_transparent_background** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** +If ``true`` the viewport should render its background as transparent. + .. _class_VisualServer_viewport_set_update_mode: - void **viewport_set_update_mode** **(** :ref:`RID` viewport, :ref:`int` update_mode **)** +Sets when the viewport should be updated. See VIEWPORT_UPDATE_MODE\_\* constants for options. + .. _class_VisualServer_viewport_set_usage: - void **viewport_set_usage** **(** :ref:`RID` viewport, :ref:`int` usage **)** +Sets what should be rendered in the viewport. See VIEWPORT_USAGE\_\* constants for options. + .. _class_VisualServer_viewport_set_use_arvr: - void **viewport_set_use_arvr** **(** :ref:`RID` viewport, :ref:`bool` use_arvr **)** +If ``true`` the viewport should use augmented or virtual reality technologies. See :ref:`ARVRInterface`. + .. _class_VisualServer_viewport_set_vflip: - void **viewport_set_vflip** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** +If ``true`` the viewport's rendering should be flipped vertically. + diff --git a/classes/class_windowdialog.rst b/classes/class_windowdialog.rst index d28e42abb..5d463d5b0 100644 --- a/classes/class_windowdialog.rst +++ b/classes/class_windowdialog.rst @@ -30,11 +30,11 @@ Member Variables .. _class_WindowDialog_resizable: -- :ref:`bool` **resizable** +- :ref:`bool` **resizable** - If ``true`` the user can resize the window. Default value: ``false``. .. _class_WindowDialog_window_title: -- :ref:`String` **window_title** +- :ref:`String` **window_title** - The text displayed in the window's title bar. Default value: "Save a File". Description