.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/EditorVCSInterface.xml. .. _class_EditorVCSInterface: EditorVCSInterface ================== **Inherits:** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_checkout_branch` **(** :ref:`String` branch_name **)** |virtual| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_commit` **(** :ref:`String` msg **)** |virtual| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_create_branch` **(** :ref:`String` branch_name **)** |virtual| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_create_remote` **(** :ref:`String` remote_name, :ref:`String` remote_url **)** |virtual| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_discard_file` **(** :ref:`String` file_path **)** |virtual| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_fetch` **(** :ref:`String` remote **)** |virtual| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String[]` | :ref:`_get_branch_list` **(** **)** |virtual| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_get_current_branch_name` **(** **)** |virtual| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary[]` | :ref:`_get_diff` **(** :ref:`String` identifier, :ref:`int` area **)** |virtual| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary[]` | :ref:`_get_line_diff` **(** :ref:`String` file_path, :ref:`String` text **)** |virtual| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary[]` | :ref:`_get_modified_files_data` **(** **)** |virtual| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary[]` | :ref:`_get_previous_commits` **(** :ref:`int` max_commits **)** |virtual| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String[]` | :ref:`_get_remotes` **(** **)** |virtual| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_get_vcs_name` **(** **)** |virtual| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_initialize` **(** :ref:`String` project_path **)** |virtual| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_pull` **(** :ref:`String` remote **)** |virtual| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_push` **(** :ref:`String` remote, :ref:`bool` force **)** |virtual| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_remove_branch` **(** :ref:`String` branch_name **)** |virtual| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_remove_remote` **(** :ref:`String` remote_name **)** |virtual| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_set_credentials` **(** :ref:`String` username, :ref:`String` password, :ref:`String` ssh_public_key_path, :ref:`String` ssh_private_key_path, :ref:`String` ssh_passphrase **)** |virtual| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_shut_down` **(** **)** |virtual| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_stage_file` **(** :ref:`String` file_path **)** |virtual| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_unstage_file` **(** :ref:`String` file_path **)** |virtual| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`add_diff_hunks_into_diff_file` **(** :ref:`Dictionary` diff_file, :ref:`Dictionary[]` diff_hunks **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`add_line_diffs_into_diff_hunk` **(** :ref:`Dictionary` diff_hunk, :ref:`Dictionary[]` line_diffs **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`create_commit` **(** :ref:`String` msg, :ref:`String` author, :ref:`String` id, :ref:`int` unix_timestamp, :ref:`int` offset_minutes **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`create_diff_file` **(** :ref:`String` new_file, :ref:`String` old_file **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`create_diff_hunk` **(** :ref:`int` old_start, :ref:`int` new_start, :ref:`int` old_lines, :ref:`int` new_lines **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`create_diff_line` **(** :ref:`int` new_line_no, :ref:`int` old_line_no, :ref:`String` content, :ref:`String` status **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`create_status_file` **(** :ref:`String` file_path, :ref:`ChangeType` change_type, :ref:`TreeArea` area **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`popup_error` **(** :ref:`String` msg **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_EditorVCSInterface_ChangeType: .. rst-class:: classref-enumeration enum **ChangeType**: .. _class_EditorVCSInterface_constant_CHANGE_TYPE_NEW: .. rst-class:: classref-enumeration-constant :ref:`ChangeType` **CHANGE_TYPE_NEW** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_EditorVCSInterface_constant_CHANGE_TYPE_MODIFIED: .. rst-class:: classref-enumeration-constant :ref:`ChangeType` **CHANGE_TYPE_MODIFIED** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_EditorVCSInterface_constant_CHANGE_TYPE_RENAMED: .. rst-class:: classref-enumeration-constant :ref:`ChangeType` **CHANGE_TYPE_RENAMED** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_EditorVCSInterface_constant_CHANGE_TYPE_DELETED: .. rst-class:: classref-enumeration-constant :ref:`ChangeType` **CHANGE_TYPE_DELETED** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_EditorVCSInterface_constant_CHANGE_TYPE_TYPECHANGE: .. rst-class:: classref-enumeration-constant :ref:`ChangeType` **CHANGE_TYPE_TYPECHANGE** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_EditorVCSInterface_constant_CHANGE_TYPE_UNMERGED: .. rst-class:: classref-enumeration-constant :ref:`ChangeType` **CHANGE_TYPE_UNMERGED** = ``5`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_EditorVCSInterface_TreeArea: .. rst-class:: classref-enumeration enum **TreeArea**: .. _class_EditorVCSInterface_constant_TREE_AREA_COMMIT: .. rst-class:: classref-enumeration-constant :ref:`TreeArea` **TREE_AREA_COMMIT** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_EditorVCSInterface_constant_TREE_AREA_STAGED: .. rst-class:: classref-enumeration-constant :ref:`TreeArea` **TREE_AREA_STAGED** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_EditorVCSInterface_constant_TREE_AREA_UNSTAGED: .. rst-class:: classref-enumeration-constant :ref:`TreeArea` **TREE_AREA_UNSTAGED** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_EditorVCSInterface_private_method__checkout_branch: .. rst-class:: classref-method :ref:`bool` **_checkout_branch** **(** :ref:`String` branch_name **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_private_method__commit: .. rst-class:: classref-method void **_commit** **(** :ref:`String` msg **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_private_method__create_branch: .. rst-class:: classref-method void **_create_branch** **(** :ref:`String` branch_name **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_private_method__create_remote: .. rst-class:: classref-method void **_create_remote** **(** :ref:`String` remote_name, :ref:`String` remote_url **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_private_method__discard_file: .. rst-class:: classref-method void **_discard_file** **(** :ref:`String` file_path **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_private_method__fetch: .. rst-class:: classref-method void **_fetch** **(** :ref:`String` remote **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_private_method__get_branch_list: .. rst-class:: classref-method :ref:`String[]` **_get_branch_list** **(** **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_private_method__get_current_branch_name: .. rst-class:: classref-method :ref:`String` **_get_current_branch_name** **(** **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_private_method__get_diff: .. rst-class:: classref-method :ref:`Dictionary[]` **_get_diff** **(** :ref:`String` identifier, :ref:`int` area **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_private_method__get_line_diff: .. rst-class:: classref-method :ref:`Dictionary[]` **_get_line_diff** **(** :ref:`String` file_path, :ref:`String` text **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_private_method__get_modified_files_data: .. rst-class:: classref-method :ref:`Dictionary[]` **_get_modified_files_data** **(** **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_private_method__get_previous_commits: .. rst-class:: classref-method :ref:`Dictionary[]` **_get_previous_commits** **(** :ref:`int` max_commits **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_private_method__get_remotes: .. rst-class:: classref-method :ref:`String[]` **_get_remotes** **(** **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_private_method__get_vcs_name: .. rst-class:: classref-method :ref:`String` **_get_vcs_name** **(** **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_private_method__initialize: .. rst-class:: classref-method :ref:`bool` **_initialize** **(** :ref:`String` project_path **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_private_method__pull: .. rst-class:: classref-method void **_pull** **(** :ref:`String` remote **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_private_method__push: .. rst-class:: classref-method void **_push** **(** :ref:`String` remote, :ref:`bool` force **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_private_method__remove_branch: .. rst-class:: classref-method void **_remove_branch** **(** :ref:`String` branch_name **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_private_method__remove_remote: .. rst-class:: classref-method void **_remove_remote** **(** :ref:`String` remote_name **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_private_method__set_credentials: .. rst-class:: classref-method void **_set_credentials** **(** :ref:`String` username, :ref:`String` password, :ref:`String` ssh_public_key_path, :ref:`String` ssh_private_key_path, :ref:`String` ssh_passphrase **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_private_method__shut_down: .. rst-class:: classref-method :ref:`bool` **_shut_down** **(** **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_private_method__stage_file: .. rst-class:: classref-method void **_stage_file** **(** :ref:`String` file_path **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_private_method__unstage_file: .. rst-class:: classref-method void **_unstage_file** **(** :ref:`String` file_path **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_method_add_diff_hunks_into_diff_file: .. rst-class:: classref-method :ref:`Dictionary` **add_diff_hunks_into_diff_file** **(** :ref:`Dictionary` diff_file, :ref:`Dictionary[]` diff_hunks **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_method_add_line_diffs_into_diff_hunk: .. rst-class:: classref-method :ref:`Dictionary` **add_line_diffs_into_diff_hunk** **(** :ref:`Dictionary` diff_hunk, :ref:`Dictionary[]` line_diffs **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_method_create_commit: .. rst-class:: classref-method :ref:`Dictionary` **create_commit** **(** :ref:`String` msg, :ref:`String` author, :ref:`String` id, :ref:`int` unix_timestamp, :ref:`int` offset_minutes **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_method_create_diff_file: .. rst-class:: classref-method :ref:`Dictionary` **create_diff_file** **(** :ref:`String` new_file, :ref:`String` old_file **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_method_create_diff_hunk: .. rst-class:: classref-method :ref:`Dictionary` **create_diff_hunk** **(** :ref:`int` old_start, :ref:`int` new_start, :ref:`int` old_lines, :ref:`int` new_lines **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_method_create_diff_line: .. rst-class:: classref-method :ref:`Dictionary` **create_diff_line** **(** :ref:`int` new_line_no, :ref:`int` old_line_no, :ref:`String` content, :ref:`String` status **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_method_create_status_file: .. rst-class:: classref-method :ref:`Dictionary` **create_status_file** **(** :ref:`String` file_path, :ref:`ChangeType` change_type, :ref:`TreeArea` area **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_EditorVCSInterface_method_popup_error: .. rst-class:: classref-method void **popup_error** **(** :ref:`String` msg **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`