Files
godot-docs-l10n/classes/uk/class_editorvcsinterface.rst

581 lines
49 KiB
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

:github_url: hide
.. _class_EditorVCSInterface:
EditorVCSInterface
==================
**Успадковує:** :ref:`Object<class_Object>`
Система керування версіями (VCS) інтерфейс, який читає та пише локальним VCS у використанні.
.. rst-class:: classref-introduction-group
Опис
--------
Захищаючи API, який редактор використовує для отримання інформації з базових VCS. Реалізація цього API входить в плагіни VCS, які є плагінами GDExtension, які спадок **EditorVCSInterface** і кріпляться (на вимогу) до однотонної екземпляри **EditorVCSInterface**. Замість того, щоб виконати самі завдання, всі віртуальні функції, перераховані нижче, викличуть внутрішні функції перейменування в плагінах VCS для забезпечення досвіду плагіна. Призначений для користувача VCS плагін повинен успадкуватися від **EditorVCSInterface** і перенаречени кожну з цих віртуальних функцій.
.. rst-class:: classref-introduction-group
Посібники
------------------
- :doc:`Системи керування версіями <../tutorials/best_practices/version_control_systems>`
.. rst-class:: classref-reftable-group
Методи
------------
.. table::
:widths: auto
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`_checkout_branch<class_EditorVCSInterface_private_method__checkout_branch>`\ (\ branch_name\: :ref:`String<class_String>`\ ) |virtual| |required| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_commit<class_EditorVCSInterface_private_method__commit>`\ (\ msg\: :ref:`String<class_String>`\ ) |virtual| |required| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_create_branch<class_EditorVCSInterface_private_method__create_branch>`\ (\ branch_name\: :ref:`String<class_String>`\ ) |virtual| |required| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_create_remote<class_EditorVCSInterface_private_method__create_remote>`\ (\ remote_name\: :ref:`String<class_String>`, remote_url\: :ref:`String<class_String>`\ ) |virtual| |required| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_discard_file<class_EditorVCSInterface_private_method__discard_file>`\ (\ file_path\: :ref:`String<class_String>`\ ) |virtual| |required| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_fetch<class_EditorVCSInterface_private_method__fetch>`\ (\ remote\: :ref:`String<class_String>`\ ) |virtual| |required| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] | :ref:`_get_branch_list<class_EditorVCSInterface_private_method__get_branch_list>`\ (\ ) |virtual| |required| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`_get_current_branch_name<class_EditorVCSInterface_private_method__get_current_branch_name>`\ (\ ) |virtual| |required| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`_get_diff<class_EditorVCSInterface_private_method__get_diff>`\ (\ identifier\: :ref:`String<class_String>`, area\: :ref:`int<class_int>`\ ) |virtual| |required| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`_get_line_diff<class_EditorVCSInterface_private_method__get_line_diff>`\ (\ file_path\: :ref:`String<class_String>`, text\: :ref:`String<class_String>`\ ) |virtual| |required| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`_get_modified_files_data<class_EditorVCSInterface_private_method__get_modified_files_data>`\ (\ ) |virtual| |required| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`_get_previous_commits<class_EditorVCSInterface_private_method__get_previous_commits>`\ (\ max_commits\: :ref:`int<class_int>`\ ) |virtual| |required| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] | :ref:`_get_remotes<class_EditorVCSInterface_private_method__get_remotes>`\ (\ ) |virtual| |required| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`_get_vcs_name<class_EditorVCSInterface_private_method__get_vcs_name>`\ (\ ) |virtual| |required| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`_initialize<class_EditorVCSInterface_private_method__initialize>`\ (\ project_path\: :ref:`String<class_String>`\ ) |virtual| |required| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_pull<class_EditorVCSInterface_private_method__pull>`\ (\ remote\: :ref:`String<class_String>`\ ) |virtual| |required| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_push<class_EditorVCSInterface_private_method__push>`\ (\ remote\: :ref:`String<class_String>`, force\: :ref:`bool<class_bool>`\ ) |virtual| |required| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_remove_branch<class_EditorVCSInterface_private_method__remove_branch>`\ (\ branch_name\: :ref:`String<class_String>`\ ) |virtual| |required| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_remove_remote<class_EditorVCSInterface_private_method__remove_remote>`\ (\ remote_name\: :ref:`String<class_String>`\ ) |virtual| |required| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_set_credentials<class_EditorVCSInterface_private_method__set_credentials>`\ (\ username\: :ref:`String<class_String>`, password\: :ref:`String<class_String>`, ssh_public_key_path\: :ref:`String<class_String>`, ssh_private_key_path\: :ref:`String<class_String>`, ssh_passphrase\: :ref:`String<class_String>`\ ) |virtual| |required| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`_shut_down<class_EditorVCSInterface_private_method__shut_down>`\ (\ ) |virtual| |required| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_stage_file<class_EditorVCSInterface_private_method__stage_file>`\ (\ file_path\: :ref:`String<class_String>`\ ) |virtual| |required| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_unstage_file<class_EditorVCSInterface_private_method__unstage_file>`\ (\ file_path\: :ref:`String<class_String>`\ ) |virtual| |required| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`add_diff_hunks_into_diff_file<class_EditorVCSInterface_method_add_diff_hunks_into_diff_file>`\ (\ diff_file\: :ref:`Dictionary<class_Dictionary>`, diff_hunks\: :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\]\ ) |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`add_line_diffs_into_diff_hunk<class_EditorVCSInterface_method_add_line_diffs_into_diff_hunk>`\ (\ diff_hunk\: :ref:`Dictionary<class_Dictionary>`, line_diffs\: :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\]\ ) |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`create_commit<class_EditorVCSInterface_method_create_commit>`\ (\ msg\: :ref:`String<class_String>`, author\: :ref:`String<class_String>`, id\: :ref:`String<class_String>`, unix_timestamp\: :ref:`int<class_int>`, offset_minutes\: :ref:`int<class_int>`\ ) |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`create_diff_file<class_EditorVCSInterface_method_create_diff_file>`\ (\ new_file\: :ref:`String<class_String>`, old_file\: :ref:`String<class_String>`\ ) |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`create_diff_hunk<class_EditorVCSInterface_method_create_diff_hunk>`\ (\ old_start\: :ref:`int<class_int>`, new_start\: :ref:`int<class_int>`, old_lines\: :ref:`int<class_int>`, new_lines\: :ref:`int<class_int>`\ ) |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`create_diff_line<class_EditorVCSInterface_method_create_diff_line>`\ (\ new_line_no\: :ref:`int<class_int>`, old_line_no\: :ref:`int<class_int>`, content\: :ref:`String<class_String>`, status\: :ref:`String<class_String>`\ ) |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`create_status_file<class_EditorVCSInterface_method_create_status_file>`\ (\ file_path\: :ref:`String<class_String>`, change_type\: :ref:`ChangeType<enum_EditorVCSInterface_ChangeType>`, area\: :ref:`TreeArea<enum_EditorVCSInterface_TreeArea>`\ ) |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`popup_error<class_EditorVCSInterface_method_popup_error>`\ (\ msg\: :ref:`String<class_String>`\ ) |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Переліки
----------------
.. _enum_EditorVCSInterface_ChangeType:
.. rst-class:: classref-enumeration
enum **ChangeType**: :ref:`🔗<enum_EditorVCSInterface_ChangeType>`
.. _class_EditorVCSInterface_constant_CHANGE_TYPE_NEW:
.. rst-class:: classref-enumeration-constant
:ref:`ChangeType<enum_EditorVCSInterface_ChangeType>` **CHANGE_TYPE_NEW** = ``0``
Додано новий файл.
.. _class_EditorVCSInterface_constant_CHANGE_TYPE_MODIFIED:
.. rst-class:: classref-enumeration-constant
:ref:`ChangeType<enum_EditorVCSInterface_ChangeType>` **CHANGE_TYPE_MODIFIED** = ``1``
Змінюється раніше доданий файл.
.. _class_EditorVCSInterface_constant_CHANGE_TYPE_RENAMED:
.. rst-class:: classref-enumeration-constant
:ref:`ChangeType<enum_EditorVCSInterface_ChangeType>` **CHANGE_TYPE_RENAMED** = ``2``
Перейменовано раніше доданий файл.
.. _class_EditorVCSInterface_constant_CHANGE_TYPE_DELETED:
.. rst-class:: classref-enumeration-constant
:ref:`ChangeType<enum_EditorVCSInterface_ChangeType>` **CHANGE_TYPE_DELETED** = ``3``
Видалено попередній файл.
.. _class_EditorVCSInterface_constant_CHANGE_TYPE_TYPECHANGE:
.. rst-class:: classref-enumeration-constant
:ref:`ChangeType<enum_EditorVCSInterface_ChangeType>` **CHANGE_TYPE_TYPECHANGE** = ``4``
Змінюється раніше доданий файл.
.. _class_EditorVCSInterface_constant_CHANGE_TYPE_UNMERGED:
.. rst-class:: classref-enumeration-constant
:ref:`ChangeType<enum_EditorVCSInterface_ChangeType>` **CHANGE_TYPE_UNMERGED** = ``5``
Файл зліва не занурюється.
.. rst-class:: classref-item-separator
----
.. _enum_EditorVCSInterface_TreeArea:
.. rst-class:: classref-enumeration
enum **TreeArea**: :ref:`🔗<enum_EditorVCSInterface_TreeArea>`
.. _class_EditorVCSInterface_constant_TREE_AREA_COMMIT:
.. rst-class:: classref-enumeration-constant
:ref:`TreeArea<enum_EditorVCSInterface_TreeArea>` **TREE_AREA_COMMIT** = ``0``
Зустрінеться з зони замовлення.
.. _class_EditorVCSInterface_constant_TREE_AREA_STAGED:
.. rst-class:: classref-enumeration-constant
:ref:`TreeArea<enum_EditorVCSInterface_TreeArea>` **TREE_AREA_STAGED** = ``1``
Файл стикається з застарілою зоною.
.. _class_EditorVCSInterface_constant_TREE_AREA_UNSTAGED:
.. rst-class:: classref-enumeration-constant
:ref:`TreeArea<enum_EditorVCSInterface_TreeArea>` **TREE_AREA_UNSTAGED** = ``2``
Файл зустрічається з незареєстрованої ділянки.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Описи методів
--------------------------
.. _class_EditorVCSInterface_private_method__checkout_branch:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **_checkout_branch**\ (\ branch_name\: :ref:`String<class_String>`\ ) |virtual| |required| :ref:`🔗<class_EditorVCSInterface_private_method__checkout_branch>`
Перевірити ``пам'ятне відділення_name`` в VCS.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_private_method__commit:
.. rst-class:: classref-method
|void| **_commit**\ (\ msg\: :ref:`String<class_String>`\ ) |virtual| |required| :ref:`🔗<class_EditorVCSInterface_private_method__commit>`
Прийміть в даний час поетапні зміни та застосовуйте комітацію ``msg`` до отриманого коміту.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_private_method__create_branch:
.. rst-class:: classref-method
|void| **_create_branch**\ (\ branch_name\: :ref:`String<class_String>`\ ) |virtual| |required| :ref:`🔗<class_EditorVCSInterface_private_method__create_branch>`
Створює нове відділення, назване ``branch_name`` в VCS.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_private_method__create_remote:
.. rst-class:: classref-method
|void| **_create_remote**\ (\ remote_name\: :ref:`String<class_String>`, remote_url\: :ref:`String<class_String>`\ ) |virtual| |required| :ref:`🔗<class_EditorVCSInterface_private_method__create_remote>`
Створює новий віддалений пункт з назвою ``Remote_name`` і вказує на його ``Remote_url``. Це може бути віддалений HTTPS або пульт SSH.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_private_method__discard_file:
.. rst-class:: classref-method
|void| **_discard_file**\ (\ file_path\: :ref:`String<class_String>`\ ) |virtual| |required| :ref:`🔗<class_EditorVCSInterface_private_method__discard_file>`
Відхилити зміни, внесені в файл ``file_path``.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_private_method__fetch:
.. rst-class:: classref-method
|void| **_fetch**\ (\ remote\: :ref:`String<class_String>`\ ) |virtual| |required| :ref:`🔗<class_EditorVCSInterface_private_method__fetch>`
Віддалені від ``парення``, але не записують зміни до поточного робочого каталогу. ``git ftch``.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_private_method__get_branch_list:
.. rst-class:: classref-method
:ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **_get_branch_list**\ (\ ) |virtual| |required| :ref:`🔗<class_EditorVCSInterface_private_method__get_branch_list>`
Одержує екземпляр :ref:`Array<class_Array>` :ref:`String<class_String>`, що містить доступні галузеві імена в VCS.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_private_method__get_current_branch_name:
.. rst-class:: classref-method
:ref:`String<class_String>` **_get_current_branch_name**\ (\ ) |virtual| |required| :ref:`🔗<class_EditorVCSInterface_private_method__get_current_branch_name>`
Отримує поточний галузевий назву, визначений в VCS.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_private_method__get_diff:
.. rst-class:: classref-method
:ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **_get_diff**\ (\ identifier\: :ref:`String<class_String>`, area\: :ref:`int<class_int>`\ ) |virtual| |required| :ref:`🔗<class_EditorVCSInterface_private_method__get_diff>`
Повертає масив елементів :ref:`Dictionary<class_Dictionary>` (див. :ref:`create_diff_file()<class_EditorVCSInterface_method_create_diff_file>`, :ref:`create_diff_hunk()<class_EditorVCSInterface_method_create_diff_hunk>`, :ref:`create_diff_line()<class_EditorVCSInterface_method_create_diff_line>`, :ref:`add_line_diffs_into_diff_hunk()<class_EditorVCSInterface_method_add_line_diffs_into_diff_hunk>` і :ref:`add_diff_hunks_into_diff_file()<class_EditorVCSInterface_method_add_diff_hunks_into_diff_file>`), кожен з яких містить інформацію про дифу. Якщо ``identifier`` є файловим шляхом, повертає ідентифікатор файлу, і якщо він є ідентифікатором, то повертає ідентифікатор коміту.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_private_method__get_line_diff:
.. rst-class:: classref-method
:ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **_get_line_diff**\ (\ file_path\: :ref:`String<class_String>`, text\: :ref:`String<class_String>`\ ) |virtual| |required| :ref:`🔗<class_EditorVCSInterface_private_method__get_line_diff>`
Повертає :ref:`Array<class_Array>` елементів :ref:`Dictionary<class_Dictionary>` (див. :ref:`create_diff_hunk()<class_EditorVCSInterface_method_create_diff_hunk>`), кожен з яких містить рядок різниці між файлом за адресою ``file_path`` та ``text``, що передається.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_private_method__get_modified_files_data:
.. rst-class:: classref-method
:ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **_get_modified_files_data**\ (\ ) |virtual| |required| :ref:`🔗<class_EditorVCSInterface_private_method__get_modified_files_data>`
Повертає :ref:`Array<class_Array>` елементів :ref:`Dictionary<class_Dictionary>` (див. :ref:`create_status_file()<class_EditorVCSInterface_method_create_status_file>`), кожен з яких містить дані про стан кожного зміненого файлу в папці проекту.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_private_method__get_previous_commits:
.. rst-class:: classref-method
:ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **_get_previous_commits**\ (\ max_commits\: :ref:`int<class_int>`\ ) |virtual| |required| :ref:`🔗<class_EditorVCSInterface_private_method__get_previous_commits>`
Повертає :ref:`Array<class_Array>` з елементів :ref:`Dictionary<class_Dictionary>` (див. :ref:`create_commit()<class_EditorVCSInterface_method_create_commit>`), кожен з яких містить дані для минулого коміту.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_private_method__get_remotes:
.. rst-class:: classref-method
:ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **_get_remotes**\ (\ ) |virtual| |required| :ref:`🔗<class_EditorVCSInterface_private_method__get_remotes>`
Повертаємо :ref:`Array<class_Array>` :ref:`String<class_String>`\ s, кожен з яких містить назву віддаленого настроюється в VCS.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_private_method__get_vcs_name:
.. rst-class:: classref-method
:ref:`String<class_String>` **_get_vcs_name**\ (\ ) |virtual| |required| :ref:`🔗<class_EditorVCSInterface_private_method__get_vcs_name>`
Повертає ім'я основного постачальника VCS.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_private_method__initialize:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **_initialize**\ (\ project_path\: :ref:`String<class_String>`\ ) |virtual| |required| :ref:`🔗<class_EditorVCSInterface_private_method__initialize>`
Налаштування плагіна VCS при підключенні редактора. Повертаємо Вашу увагу на те, чи успішно ініціюється плагін. Проект VCS ініціюється на ``Project_path``.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_private_method__pull:
.. rst-class:: classref-method
|void| **_pull**\ (\ remote\: :ref:`String<class_String>`\ ) |virtual| |required| :ref:`🔗<class_EditorVCSInterface_private_method__pull>`
Витягує зміни з пульта дистанційного керування. Це може призвести до злиття конфліктів.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_private_method__push:
.. rst-class:: classref-method
|void| **_push**\ (\ remote\: :ref:`String<class_String>`, force\: :ref:`bool<class_bool>`\ ) |virtual| |required| :ref:`🔗<class_EditorVCSInterface_private_method__push>`
Пушки зміни до ``remote``. Якщо ``сила`` є ``true``, сила штовхач перенаправить історію змін вже присутній на пульті дистанційного керування.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_private_method__remove_branch:
.. rst-class:: classref-method
|void| **_remove_branch**\ (\ branch_name\: :ref:`String<class_String>`\ ) |virtual| |required| :ref:`🔗<class_EditorVCSInterface_private_method__remove_branch>`
Видаліть відділення з місцевих VCS.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_private_method__remove_remote:
.. rst-class:: classref-method
|void| **_remove_remote**\ (\ remote_name\: :ref:`String<class_String>`\ ) |virtual| |required| :ref:`🔗<class_EditorVCSInterface_private_method__remove_remote>`
Видаліть дистанційне з локальних VCS.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_private_method__set_credentials:
.. rst-class:: classref-method
|void| **_set_credentials**\ (\ username\: :ref:`String<class_String>`, password\: :ref:`String<class_String>`, ssh_public_key_path\: :ref:`String<class_String>`, ssh_private_key_path\: :ref:`String<class_String>`, ssh_passphrase\: :ref:`String<class_String>`\ ) |virtual| |required| :ref:`🔗<class_EditorVCSInterface_private_method__set_credentials>`
Встановити облікові дані користувача в основній VCS. ``Username`` і ``password`` використовуються тільки під час перевірки HTTPS, якщо не було зазначено в віддаленій URL. ``ssh_public_key_path``, ``ssh_private_key_path``, і ``ssh_passphrase`` використовуються тільки при автентифікації SSH.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_private_method__shut_down:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **_shut_down**\ (\ ) |virtual| |required| :ref:`🔗<class_EditorVCSInterface_private_method__shut_down>`
Вимкніть пристрій VCS. Зателефонуйте, коли користувач або закриває редактор або закриває плагін VCS через редактор UI.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_private_method__stage_file:
.. rst-class:: classref-method
|void| **_stage_file**\ (\ file_path\: :ref:`String<class_String>`\ ) |virtual| |required| :ref:`🔗<class_EditorVCSInterface_private_method__stage_file>`
Етапи подання файлу на ``file_path`` на стадію.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_private_method__unstage_file:
.. rst-class:: classref-method
|void| **_unstage_file**\ (\ file_path\: :ref:`String<class_String>`\ ) |virtual| |required| :ref:`🔗<class_EditorVCSInterface_private_method__unstage_file>`
Не пропустіть файл, присутній на ``file_path`` із застиглої площі до незареєстрованої площі.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_method_add_diff_hunks_into_diff_file:
.. rst-class:: classref-method
:ref:`Dictionary<class_Dictionary>` **add_diff_hunks_into_diff_file**\ (\ diff_file\: :ref:`Dictionary<class_Dictionary>`, diff_hunks\: :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\]\ ) :ref:`🔗<class_EditorVCSInterface_method_add_diff_hunks_into_diff_file>`
Функція Helper для додавання масиву ``diff_hunks`` в ``diff_file``.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_method_add_line_diffs_into_diff_hunk:
.. rst-class:: classref-method
:ref:`Dictionary<class_Dictionary>` **add_line_diffs_into_diff_hunk**\ (\ diff_hunk\: :ref:`Dictionary<class_Dictionary>`, line_diffs\: :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\]\ ) :ref:`🔗<class_EditorVCSInterface_method_add_line_diffs_into_diff_hunk>`
Функція Helper для додавання масиву ``line_diffs`` в ``diff_hunk``.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_method_create_commit:
.. rst-class:: classref-method
:ref:`Dictionary<class_Dictionary>` **create_commit**\ (\ msg\: :ref:`String<class_String>`, author\: :ref:`String<class_String>`, id\: :ref:`String<class_String>`, unix_timestamp\: :ref:`int<class_int>`, offset_minutes\: :ref:`int<class_int>`\ ) :ref:`🔗<class_EditorVCSInterface_method_create_commit>`
Функція помічника для створення коміту :ref:`Dictionary<class_Dictionary>` пункт. ``msg`` є комісією. ``author`` - єдиний людський рядок, що містить всі деталі автора, наприклад, електронну пошту та ім'я, налаштовану в VCS. ``id`` є ідентифікатором комісії, в якому в будь-якому форматі ваш VCS може надати ідентифікатор для комісій. ``unix_timestamp`` є UTC Unix timestamp, коли було створено комісію. ``offset_mins`` - це часовий пояс, який записується з системного часового поясу, де було створено комісію.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_method_create_diff_file:
.. rst-class:: classref-method
:ref:`Dictionary<class_Dictionary>` **create_diff_file**\ (\ new_file\: :ref:`String<class_String>`, old_file\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorVCSInterface_method_create_diff_file>`
Функція Helper для створення :ref:`Dictionary<class_Dictionary>` для зберігання старих і нових дифутичних шляхів.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_method_create_diff_hunk:
.. rst-class:: classref-method
:ref:`Dictionary<class_Dictionary>` **create_diff_hunk**\ (\ old_start\: :ref:`int<class_int>`, new_start\: :ref:`int<class_int>`, old_lines\: :ref:`int<class_int>`, new_lines\: :ref:`int<class_int>`\ ) :ref:`🔗<class_EditorVCSInterface_method_create_diff_hunk>`
Функція помічника для створення :ref:`Dictionary<class_Dictionary>` для зберігання даних жорсткого диска. ``old_start`` є початковим номером рядка в старій файлі. ``new_start`` є початковим номером рядка в новому файлі. ``old_lines`` є числом рядків у старому файлі. ``new_lines`` є числом рядків у новому файлі.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_method_create_diff_line:
.. rst-class:: classref-method
:ref:`Dictionary<class_Dictionary>` **create_diff_line**\ (\ new_line_no\: :ref:`int<class_int>`, old_line_no\: :ref:`int<class_int>`, content\: :ref:`String<class_String>`, status\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorVCSInterface_method_create_diff_line>`
Функція помічника для створення :ref:`Dictionary<class_Dictionary>` для зберігання дифусу лінії. ``new_line_no`` - номер рядка в новому файлі (може бути ``-1``, якщо рядок видалено). ``old_line_no`` - номер рядка в старому файлі (може бути ``-1``, якщо рядок додано). ``content`` це дифузний текст. ``stasus`` - один рядок символів, який зберігає походження рядків.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_method_create_status_file:
.. rst-class:: classref-method
:ref:`Dictionary<class_Dictionary>` **create_status_file**\ (\ file_path\: :ref:`String<class_String>`, change_type\: :ref:`ChangeType<enum_EditorVCSInterface_ChangeType>`, area\: :ref:`TreeArea<enum_EditorVCSInterface_TreeArea>`\ ) :ref:`🔗<class_EditorVCSInterface_method_create_status_file>`
Функція Helper для створення :ref:`Dictionary<class_Dictionary>`, що використовується редактором для читання статусу файлу.
.. rst-class:: classref-item-separator
----
.. _class_EditorVCSInterface_method_popup_error:
.. rst-class:: classref-method
|void| **popup_error**\ (\ msg\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorVCSInterface_method_popup_error>`
Поповнюйте повідомлення про помилку в редакторі, який відображається як надходить від основного VCS. Використовуйте це для відображення повідомлень про помилку VCS.
.. |virtual| replace:: :abbr:`virtual (Зазвичай, цей метод перевизначається користувачем, щоб він мав вплив.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |const| replace:: :abbr:`const (Цей метод не має побічних ефектів. Не змінює ніяку змінну екземпляра об'єкта.)`
.. |vararg| replace:: :abbr:`vararg (Цей метод приймає будь-яке число аргументів після описаних тут.)`
.. |constructor| replace:: :abbr:`constructor (Цей метод використовується для побудови типів.)`
.. |static| replace:: :abbr:`static (Цей метод не потребує екземпляра для виклику, його можна викликати безпосередньо за допомогою назви класу.)`
.. |operator| replace:: :abbr:`operator (Цей метод описує дійсний оператор для взаємодії з цим типом як з лівим операндом.)`
.. |bitfield| replace:: :abbr:`BitField (Це значення є цілим числом, складеним у вигляді бітової маски з наступних прапорів.)`
.. |void| replace:: :abbr:`void (Значення не повертається.)`