Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

EditorVCSInterface

Hérite de : Object

Version Control System (VCS) interface, which reads and writes to the local VCS in use.

Description

Defines the API that the editor uses to extract information from the underlying VCS. The implementation of this API is included in VCS plugins, which are GDExtension plugins that inherit EditorVCSInterface and are attached (on demand) to the singleton instance of EditorVCSInterface. Instead of performing the task themselves, all the virtual functions listed below are calling the internally overridden functions in the VCS plugins to provide a plug-n-play experience. A custom VCS plugin is supposed to inherit from EditorVCSInterface and override each of these virtual functions.

Tutoriels

• Systèmes de contrôle de version

Méthodes

bool	_allow_amends() virtual
bool	_checkout_branch(branch_name: String) virtual required
void	_commit(msg: String, amend: bool) virtual
void	_create_branch(branch_name: String) virtual required
void	_create_remote(remote_name: String, remote_url: String) virtual required
void	_discard_file(file_path: String) virtual required
void	_fetch(remote: String) virtual required
Array[String]	_get_branch_list() virtual required
String	_get_current_branch_name() virtual required
Array[Dictionary]	_get_diff(identifier: String, area: int) virtual required
Array[Dictionary]	_get_line_diff(file_path: String, text: String) virtual required
Array[Dictionary]	_get_modified_files_data() virtual required
Array[Dictionary]	_get_previous_commits(max_commits: int) virtual required
Array[String]	_get_remotes() virtual required
String	_get_vcs_name() virtual required
bool	_initialize(project_path: String) virtual required
void	_pull(remote: String) virtual required
void	_push(remote: String, force: bool) virtual required
void	_remove_branch(branch_name: String) virtual required
void	_remove_remote(remote_name: String) virtual required
void	_set_credentials(username: String, password: String, ssh_public_key_path: String, ssh_private_key_path: String, ssh_passphrase: String) virtual required
bool	_shut_down() virtual required
void	_stage_file(file_path: String) virtual required
void	_unstage_file(file_path: String) virtual required
Dictionary	add_diff_hunks_into_diff_file(diff_file: Dictionary, diff_hunks: Array[Dictionary])
Dictionary	add_line_diffs_into_diff_hunk(diff_hunk: Dictionary, line_diffs: Array[Dictionary])
Dictionary	create_commit(msg: String, author: String, id: String, unix_timestamp: int, offset_minutes: int)
Dictionary	create_diff_file(new_file: String, old_file: String)
Dictionary	create_diff_hunk(old_start: int, new_start: int, old_lines: int, new_lines: int)
Dictionary	create_diff_line(new_line_no: int, old_line_no: int, content: String, status: String)
Dictionary	create_status_file(file_path: String, change_type: ChangeType, area: TreeArea)
void	popup_error(msg: String)

---

Énumérations

enum ChangeType: 🔗

ChangeType CHANGE_TYPE_NEW = 0

Un nouveau fichier a été ajouté.

ChangeType CHANGE_TYPE_MODIFIED = 1

Un fichier précédemment ajouté a été modifié.

ChangeType CHANGE_TYPE_RENAMED = 2

Un fichier précédemment ajouté a été renommé.

ChangeType CHANGE_TYPE_DELETED = 3

Un fichier précédemment ajouté a été supprimé.

ChangeType CHANGE_TYPE_TYPECHANGE = 4

Un fichier précédemment ajouté a changé de type.

ChangeType CHANGE_TYPE_UNMERGED = 5

Le fichier a été laissé non-fusionné.

---

enum TreeArea: 🔗

TreeArea TREE_AREA_COMMIT = 0

A commit is encountered from the commit area.

TreeArea TREE_AREA_STAGED = 1

A file is encountered from the staged area.

TreeArea TREE_AREA_UNSTAGED = 2

A file is encountered from the unstaged area.

---

Descriptions des méthodes

bool _allow_amends() virtual 🔗

Returns whether or not the plugin allows commit amends.

---

bool _checkout_branch(branch_name: String) virtual required 🔗

Checks out a branch_name in the VCS.

---

void _commit(msg: String, amend: bool) virtual 🔗

Commits the currently staged changes and applies the commit msg to the resulting commit. If amend is true the commit will modify the most recent commit instead.

---

void _create_branch(branch_name: String) virtual required 🔗

Creates a new branch named branch_name in the VCS.

---

void _create_remote(remote_name: String, remote_url: String) virtual required 🔗

Creates a new remote destination with name remote_name and points it to remote_url. This can be an HTTPS remote or an SSH remote.

---

void _discard_file(file_path: String) virtual required 🔗

Ignore les modifications faites dans le fichier à l'emplacement file_path.

---

void _fetch(remote: String) virtual required 🔗

Fetches new changes from the remote, but doesn't write changes to the current working directory. Equivalent to git fetch.

---

Array[String] _get_branch_list() virtual required 🔗

Gets an instance of an Array of Strings containing available branch names in the VCS.

---

String _get_current_branch_name() virtual required 🔗

Obtient le nom de branche actuel défini dans le système de contrôle de version.

---

Array[Dictionary] _get_diff(identifier: String, area: int) virtual required 🔗

Returns an array of Dictionary items (see create_diff_file(), create_diff_hunk(), create_diff_line(), add_line_diffs_into_diff_hunk() and add_diff_hunks_into_diff_file()), each containing information about a diff. If identifier is a file path, returns a file diff, and if it is a commit identifier, then returns a commit diff.

---

Array[Dictionary] _get_line_diff(file_path: String, text: String) virtual required 🔗

Returns an Array of Dictionary items (see create_diff_hunk()), each containing a line diff between a file at file_path and the text which is passed in.

---

Array[Dictionary] _get_modified_files_data() virtual required 🔗

Renvoie un Array d'éléments Dictionary (voir create_status_file()), contenant chacun les données d'état de chaque fichier modifié dans le dossier du projet.

---

Array[Dictionary] _get_previous_commits(max_commits: int) virtual required 🔗

Returns an Array of Dictionary items (see create_commit()), each containing the data for a past commit.

---

Array[String] _get_remotes() virtual required 🔗

Renvoie un Array de String, chacune contient le nom d'un dépôt distant configuré dans le VCS.

---

String _get_vcs_name() virtual required 🔗

Renvoie le nom du fournisseur VCS utilisé.

---

bool _initialize(project_path: String) virtual required 🔗

Initializes the VCS plugin when called from the editor. Returns whether or not the plugin was successfully initialized. A VCS project is initialized at project_path.

---

void _pull(remote: String) virtual required 🔗

Tire les modifications depuis le dépôt distant. Cela peut provoquer des conflits de fusion.

---

void _push(remote: String, force: bool) virtual required 🔗

Pushes changes to the remote. If force is true, a force push will override the change history already present on the remote.

---

void _remove_branch(branch_name: String) virtual required 🔗

Remove a branch from the local VCS.

---

void _remove_remote(remote_name: String) virtual required 🔗

Supprimer un dépôt distant du VCS local.

---

void _set_credentials(username: String, password: String, ssh_public_key_path: String, ssh_private_key_path: String, ssh_passphrase: String) virtual required 🔗

Set user credentials in the underlying VCS. username and password are used only during HTTPS authentication unless not already mentioned in the remote URL. ssh_public_key_path, ssh_private_key_path, and ssh_passphrase are only used during SSH authentication.

---

bool _shut_down() virtual required 🔗

Shuts down VCS plugin instance. Called when the user either closes the editor or shuts down the VCS plugin through the editor UI.

---

void _stage_file(file_path: String) virtual required 🔗

Stages the file present at file_path to the staged area.

---

void _unstage_file(file_path: String) virtual required 🔗

Unstages the file present at file_path from the staged area to the unstaged area.

---

Dictionary add_diff_hunks_into_diff_file(diff_file: Dictionary, diff_hunks: Array[Dictionary]) 🔗

Assistant de fonction pour ajouter un tableau de diff_hunks dans un diff_file.

---

Dictionary add_line_diffs_into_diff_hunk(diff_hunk: Dictionary, line_diffs: Array[Dictionary]) 🔗

Fonction d'aide pour ajouter un tableau de line_diffs dans un diff_hunk.

---

Dictionary create_commit(msg: String, author: String, id: String, unix_timestamp: int, offset_minutes: int) 🔗

Une fonction d'aide pour créer un Dictionary des données d'un commit. msg est le message de commit. author est une simple chaîne intelligible contenant tous les détails de l'auteur, par exemple son e-mail et le nom comme configurés dans le VCS. id est le code de hachage du commit, dans le format préféré de votre VCS pour fournir un identifiant unique pour chaque commit. unix_timestamp est l'horodatage Unix basé sur UTC de la date de création de la commit. offset_minutes est le décalage horaire par rapport à UTC, en minutes, enregistré depuis la zone horaire du système lors de la création du commit.

---

Dictionary create_diff_file(new_file: String, old_file: String) 🔗

Helper function to create a Dictionary for storing old and new diff file paths.

---

Dictionary create_diff_hunk(old_start: int, new_start: int, old_lines: int, new_lines: int) 🔗

Helper function to create a Dictionary for storing diff hunk data. old_start is the starting line number in old file. new_start is the starting line number in new file. old_lines is the number of lines in the old file. new_lines is the number of lines in the new file.

---

Dictionary create_diff_line(new_line_no: int, old_line_no: int, content: String, status: String) 🔗

Helper function to create a Dictionary for storing a line diff. new_line_no is the line number in the new file (can be -1 if the line is deleted). old_line_no is the line number in the old file (can be -1 if the line is added). content is the diff text. status is a single character string which stores the line origin.

---

Dictionary create_status_file(file_path: String, change_type: ChangeType, area: TreeArea) 🔗

Helper function to create a Dictionary used by editor to read the status of a file.

---

void popup_error(msg: String) 🔗

Pops up an error message in the editor which is shown as coming from the underlying VCS. Use this to show VCS specific error messages.