Files
godot-docs-l10n/classes/fr/class_navigationlink2d.rst
2025-12-19 14:34:07 +01:00

334 lines
17 KiB
ReStructuredText
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

:github_url: hide
.. _class_NavigationLink2D:
NavigationLink2D
================
**Expérimental:** This class may be changed or removed in future versions.
**Hérite de:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
Un lien entre deux positions sur des :ref:`NavigationRegion2D<class_NavigationRegion2D>`\ s que des agents peuvent rejoindre.
.. rst-class:: classref-introduction-group
Description
-----------
Un lien entre deux positions sur des :ref:`NavigationRegion2D<class_NavigationRegion2D>`\ s que des agents peuvent traverser. Ces positions peuvent être sur la même :ref:`NavigationRegion2D<class_NavigationRegion2D>` ou sur deux régions différentes. Les liens sont utiles pour exprimer des méthodes de navigation autre que le voyage sur la surface du polygone de navigation, comme des tyroliennes, des téléporteurs ou des trous par-dessus lesquels on peut sauter.
.. rst-class:: classref-introduction-group
Tutoriels
------------------
- :doc:`Utiliser des NavigationLinks <../tutorials/navigation/navigation_using_navigationlinks>`
.. rst-class:: classref-reftable-group
Propriétés
--------------------
.. table::
:widths: auto
+-------------------------------+-----------------------------------------------------------------------------+-------------------+
| :ref:`bool<class_bool>` | :ref:`bidirectional<class_NavigationLink2D_property_bidirectional>` | ``true`` |
+-------------------------------+-----------------------------------------------------------------------------+-------------------+
| :ref:`bool<class_bool>` | :ref:`enabled<class_NavigationLink2D_property_enabled>` | ``true`` |
+-------------------------------+-----------------------------------------------------------------------------+-------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`end_position<class_NavigationLink2D_property_end_position>` | ``Vector2(0, 0)`` |
+-------------------------------+-----------------------------------------------------------------------------+-------------------+
| :ref:`float<class_float>` | :ref:`enter_cost<class_NavigationLink2D_property_enter_cost>` | ``0.0`` |
+-------------------------------+-----------------------------------------------------------------------------+-------------------+
| :ref:`int<class_int>` | :ref:`navigation_layers<class_NavigationLink2D_property_navigation_layers>` | ``1`` |
+-------------------------------+-----------------------------------------------------------------------------+-------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`start_position<class_NavigationLink2D_property_start_position>` | ``Vector2(0, 0)`` |
+-------------------------------+-----------------------------------------------------------------------------+-------------------+
| :ref:`float<class_float>` | :ref:`travel_cost<class_NavigationLink2D_property_travel_cost>` | ``1.0`` |
+-------------------------------+-----------------------------------------------------------------------------+-------------------+
.. rst-class:: classref-reftable-group
Méthodes
----------------
.. table::
:widths: auto
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_global_end_position<class_NavigationLink2D_method_get_global_end_position>`\ (\ ) |const| |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_global_start_position<class_NavigationLink2D_method_get_global_start_position>`\ (\ ) |const| |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_navigation_layer_value<class_NavigationLink2D_method_get_navigation_layer_value>`\ (\ layer_number\: :ref:`int<class_int>`\ ) |const| |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_RID>` | :ref:`get_navigation_map<class_NavigationLink2D_method_get_navigation_map>`\ (\ ) |const| |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_RID>` | :ref:`get_rid<class_NavigationLink2D_method_get_rid>`\ (\ ) |const| |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_global_end_position<class_NavigationLink2D_method_set_global_end_position>`\ (\ position\: :ref:`Vector2<class_Vector2>`\ ) |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_global_start_position<class_NavigationLink2D_method_set_global_start_position>`\ (\ position\: :ref:`Vector2<class_Vector2>`\ ) |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_navigation_layer_value<class_NavigationLink2D_method_set_navigation_layer_value>`\ (\ layer_number\: :ref:`int<class_int>`, value\: :ref:`bool<class_bool>`\ ) |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_navigation_map<class_NavigationLink2D_method_set_navigation_map>`\ (\ navigation_map\: :ref:`RID<class_RID>`\ ) |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Descriptions des propriétés
------------------------------------------------------
.. _class_NavigationLink2D_property_bidirectional:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **bidirectional** = ``true`` :ref:`🔗<class_NavigationLink2D_property_bidirectional>`
.. rst-class:: classref-property-setget
- |void| **set_bidirectional**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_bidirectional**\ (\ )
Si ce lien peut être traversé dans les deux sens ou seulement de :ref:`start_position<class_NavigationLink2D_property_start_position>` vers :ref:`end_position<class_NavigationLink2D_property_end_position>`.
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink2D_property_enabled:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **enabled** = ``true`` :ref:`🔗<class_NavigationLink2D_property_enabled>`
.. rst-class:: classref-property-setget
- |void| **set_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_enabled**\ (\ )
Si ce lien est actuellement actif. Si ``false``, :ref:`NavigationServer2D.map_get_path()<class_NavigationServer2D_method_map_get_path>` ignorera ce lien.
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink2D_property_end_position:
.. rst-class:: classref-property
:ref:`Vector2<class_Vector2>` **end_position** = ``Vector2(0, 0)`` :ref:`🔗<class_NavigationLink2D_property_end_position>`
.. rst-class:: classref-property-setget
- |void| **set_end_position**\ (\ value\: :ref:`Vector2<class_Vector2>`\ )
- :ref:`Vector2<class_Vector2>` **get_end_position**\ (\ )
Position de fin du lien.
Cette position cherchera le polygone le plus proche dans le maillage de navigation auquel s'attacher.
La distance de recherche du lien est contrôlée par :ref:`NavigationServer2D.map_set_link_connection_radius()<class_NavigationServer2D_method_map_set_link_connection_radius>`.
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink2D_property_enter_cost:
.. rst-class:: classref-property
:ref:`float<class_float>` **enter_cost** = ``0.0`` :ref:`🔗<class_NavigationLink2D_property_enter_cost>`
.. rst-class:: classref-property-setget
- |void| **set_enter_cost**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_enter_cost**\ (\ )
Lorsque la recherche de chemin entre dans ce lien à partir du maillage de navigation d'une autre région, la valeur de :ref:`enter_cost<class_NavigationLink2D_property_enter_cost>` est ajoutée à la distance du chemin pour déterminer le chemin le plus court.
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink2D_property_navigation_layers:
.. rst-class:: classref-property
:ref:`int<class_int>` **navigation_layers** = ``1`` :ref:`🔗<class_NavigationLink2D_property_navigation_layers>`
.. rst-class:: classref-property-setget
- |void| **set_navigation_layers**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_navigation_layers**\ (\ )
Un bitfield déterminant toutes les couches de navigation auxquelles le lien appartient. Ces couches de navigation seront vérifiées lors de la demande d'un chemin avec :ref:`NavigationServer2D.map_get_path()<class_NavigationServer2D_method_map_get_path>`.
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink2D_property_start_position:
.. rst-class:: classref-property
:ref:`Vector2<class_Vector2>` **start_position** = ``Vector2(0, 0)`` :ref:`🔗<class_NavigationLink2D_property_start_position>`
.. rst-class:: classref-property-setget
- |void| **set_start_position**\ (\ value\: :ref:`Vector2<class_Vector2>`\ )
- :ref:`Vector2<class_Vector2>` **get_start_position**\ (\ )
Position de départ du lien.
Cette position cherchera le polygone le plus proche dans le maillage de navigation auquel s'attacher.
La distance de recherche du lien est contrôlée par :ref:`NavigationServer2D.map_set_link_connection_radius()<class_NavigationServer2D_method_map_set_link_connection_radius>`.
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink2D_property_travel_cost:
.. rst-class:: classref-property
:ref:`float<class_float>` **travel_cost** = ``1.0`` :ref:`🔗<class_NavigationLink2D_property_travel_cost>`
.. rst-class:: classref-property-setget
- |void| **set_travel_cost**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_travel_cost**\ (\ )
Lorsque la recherche de chemin se déplace le long de ce lien, la distance parcourue est multipliée par :ref:`travel_cost<class_NavigationLink2D_property_travel_cost>` pour déterminer le chemin le plus court.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Descriptions des méthodes
--------------------------------------------------
.. _class_NavigationLink2D_method_get_global_end_position:
.. rst-class:: classref-method
:ref:`Vector2<class_Vector2>` **get_global_end_position**\ (\ ) |const| :ref:`🔗<class_NavigationLink2D_method_get_global_end_position>`
Renvoie la position de fin :ref:`end_position<class_NavigationLink2D_property_end_position>` qui est relative au lien en tant que position globale.
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink2D_method_get_global_start_position:
.. rst-class:: classref-method
:ref:`Vector2<class_Vector2>` **get_global_start_position**\ (\ ) |const| :ref:`🔗<class_NavigationLink2D_method_get_global_start_position>`
Renvoie la position de début :ref:`start_position<class_NavigationLink2D_property_start_position>` qui est relative au lien en tant que position globale.
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink2D_method_get_navigation_layer_value:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **get_navigation_layer_value**\ (\ layer_number\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_NavigationLink2D_method_get_navigation_layer_value>`
Renvoie si la couche spécifiée du masque de bits :ref:`navigation_layers<class_NavigationLink2D_property_navigation_layers>` est activée, étant donné un numéro de couche ``layer_number`` entre 1 et 32.
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink2D_method_get_navigation_map:
.. rst-class:: classref-method
:ref:`RID<class_RID>` **get_navigation_map**\ (\ ) |const| :ref:`🔗<class_NavigationLink2D_method_get_navigation_map>`
Renvoie le :ref:`RID<class_RID>` de la carte de navigation actuelle utilisée par ce lien.
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink2D_method_get_rid:
.. rst-class:: classref-method
:ref:`RID<class_RID>` **get_rid**\ (\ ) |const| :ref:`🔗<class_NavigationLink2D_method_get_rid>`
Renvoie le :ref:`RID<class_RID>` de ce lien sur le :ref:`NavigationServer2D<class_NavigationServer2D>`.
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink2D_method_set_global_end_position:
.. rst-class:: classref-method
|void| **set_global_end_position**\ (\ position\: :ref:`Vector2<class_Vector2>`\ ) :ref:`🔗<class_NavigationLink2D_method_set_global_end_position>`
Définit la position de fin :ref:`end_position<class_NavigationLink2D_property_end_position>` qui est relative au lien, depuis une ``position`` globale.
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink2D_method_set_global_start_position:
.. rst-class:: classref-method
|void| **set_global_start_position**\ (\ position\: :ref:`Vector2<class_Vector2>`\ ) :ref:`🔗<class_NavigationLink2D_method_set_global_start_position>`
Définit la position de début :ref:`start_position<class_NavigationLink2D_property_start_position>` qui est relative au lien, depuis une ``position`` globale.
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink2D_method_set_navigation_layer_value:
.. rst-class:: classref-method
|void| **set_navigation_layer_value**\ (\ layer_number\: :ref:`int<class_int>`, value\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_NavigationLink2D_method_set_navigation_layer_value>`
Selon ``value``, active ou désactive la couche spécifiée dans le masque de bits :ref:`navigation_layers<class_NavigationLink2D_property_navigation_layers>`, étant donné un numéro de couche ``layer_number`` entre 1 et 32.
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink2D_method_set_navigation_map:
.. rst-class:: classref-method
|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_NavigationLink2D_method_set_navigation_map>`
Définit le :ref:`RID<class_RID>` de la carte de navigation que ce lien devrait utiliser. Par défaut, le lien se joindra automatiquement à la carte de navigation par défaut du :ref:`World2D<class_World2D>` de sorte que cette fonction ne soit nécessaire que pour redéfinir la carte par défaut.
.. |virtual| replace:: :abbr:`virtual (Cette méthode doit typiquement être redéfinie par l'utilisateur pour avoir un effet.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |const| replace:: :abbr:`const (Cette méthode n'a pas d'effets de bord. Elle ne modifie aucune des variables membres de l'instance.)`
.. |vararg| replace:: :abbr:`vararg (Cette méthode accepte n'importe quel nombre d'arguments après ceux décris ici.)`
.. |constructor| replace:: :abbr:`constructor (Cette méthode est utilisée pour construire un type.)`
.. |static| replace:: :abbr:`static (Cette méthode n'a pas besoin d'instance pour être appelée, elle peut donc être directement appelée en utilisant le nom de la classe.)`
.. |operator| replace:: :abbr:`operator (Cette méthode décrit un opérateur valide à utiliser avec ce type en tant qu'opérande gauche.)`
.. |bitfield| replace:: :abbr:`BitField (Cette valeur est un nombre entier composé d'un masque de bits des options suivantes.)`
.. |void| replace:: :abbr:`void (Aucune valeur de retour.)`