EditorVCSInterface¶

Inherits: Object

Interfaz del Sistema de Control de Versiones (VCS) que lee y escribe en el VCS local en uso.

Descripción¶

Usado por el editor para mostrar la información extraída del VCS en el editor. La implementación de esta API está incluida en los addons de VCS, que son esencialmente plugins GDNative que deben ser puestos en la carpeta del proyecto. Estos addons VCS son scripts que se adjuntan (bajo demanda) a la instancia de objeto de EditorVCSInterface. Todas las funciones enumeradas a continuación, en lugar de realizar la tarea por sí mismas, llaman a las funciones definidas internamente en los addons VCS para proporcionar una experiencia de plug-n-play.

Métodos¶

void	commit ( String msg )
Array	get_file_diff ( String file_path )
Dictionary	get_modified_files_data ( )
String	get_project_name ( )
String	get_vcs_name ( )
bool	initialize ( String project_root_path )
bool	is_addon_ready ( )
bool	is_vcs_initialized ( )
bool	shut_down ( )
void	stage_file ( String file_path )
void	unstage_file ( String file_path )

Descripciones de Métodos¶

void commit ( String msg )

Crea un commit de versión si el addon se inicializa, si no, regresa sin hacer nada. Utiliza los archivos que han sido preparados previamente, con el mensaje de confirmación establecido en un valor como el proporcionado en el argumento.

Array get_file_diff ( String file_path )

Devuelve una Array de objetos del Dictionary que contiene la diferencia desdel el VCS en uso, si se inicializa un addon VCS, si no, devuelve un objeto Array vacio. El contenido de la diferencia también consiste en algunas líneas contextuales que proporcionan contexto al cambio de línea observado en el archivo.

Cada objeto Dictionary tiene el contenido de la línea diferencia bajo las claves:

"content" para almacenar una String que contiene el contenido de la línea
"status" para almacenar una String que contiene "+" en caso de que el contenido sea una adición de línea pero almacena un "-" en caso de eliminación y una cadena vacía en caso de que el contenido de la línea no sea ni una adición ni una eliminación.
"new_line_number" para almacenar un número entero que contenga el nuevo número de línea del contenido de la línea.
"line_count" para almacenar un entero que contenga el número de líneas del contenido de la línea.
"old_line_number" para almacenar un entero que contiene el número de línea antiguo del contenido de la línea.
"offset" para almacenar el offset del cambio de línea desde el primer contenido de línea contextual.

Dictionary get_modified_files_data ( )

Returns a Dictionary containing the path of the detected file change mapped to an integer signifying what kind of change the corresponding file has experienced.

The following integer values are being used to signify that the detected file is:

0: New to the VCS working directory
1: Modified
2: Renamed
3: Deleted
4: Typechanged

String get_project_name ( )

Devuelve el nombre del proyecto del directorio de trabajo del VCS.

String get_vcs_name ( )

Devuelve el nombre del VCS si el VCS ha sido inicializado, si no, devuelve una cadena vacía.

bool initialize ( String project_root_path )

Inicializa el addon VCS si no lo ha hecho ya. Usa el valor del argumento como la ruta al directorio de trabajo del proyecto. Crea el commit inicial si es necesario. Devuelve true si no se produce ningún fallo, si no, devuelve false.

bool is_addon_ready ( )

Devuelve true si el addon está listo para responder a las llamadas de la función, si no, devuelve false.

bool is_vcs_initialized ( )

Devuelve true si el addon VCS ha sido inicializado, si no, devuelve false.

bool shut_down ( )

Apaga el complemento del VCS para permitir que el código de limpieza se ejecute cuando sea necesario. Devuelve true si no se produce ningún fallo, si no devuelve false.

void stage_file ( String file_path )

Establece el archivo que debe ser confirmado cuando se llama al commit. El argumento debería contener la ruta absoluta.

void unstage_file ( String file_path )

Devuelve al estado sin añadir el archivo que se preparó previamente para ser confirmado, de modo que ya no se confirma cuando se llama al commit. El argumento debe contener la ruta absoluta.