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...

GraphEdit¶

Inherits: Control < CanvasItem < Node < Object

GraphEdit es un área capaz de mostrar varios GraphNodes. Gestiona los eventos de conexión entre ellos.

Descripción¶

GraphEdit gestiona la visualización de los GraphNodes que contiene, así como las conexiones y desconexiones entre ellos. Se envían señales para cada uno de estos dos eventos. La desconexión entre las ranuras de GraphNode está desactivada por defecto.

Se recomienda encarecidamente habilitar el modo de uso de bajo procesador (ver OS.low_processor_usage_mode) al usar GraphEdits.

Propiedades¶

FocusMode	focus_mode	`2` (overrides Control)
bool	minimap_enabled	`true`
float	minimap_opacity	`0.65`
Vector2	minimap_size	`Vector2( 240, 160 )`
bool	rect_clip_content	`true` (overrides Control)
bool	right_disconnects	`false`
Vector2	scroll_offset	`Vector2( 0, 0 )`
bool	show_zoom_label	`false`
int	snap_distance	`20`
bool	use_snap	`true`
float	zoom	`1.0`
float	zoom_max	`2.0736`
float	zoom_min	`0.232568`
float	zoom_step	`1.2`

Métodos¶

void	add_valid_connection_type ( int from_type, int to_type )
void	add_valid_left_disconnect_type ( int type )
void	add_valid_right_disconnect_type ( int type )
void	clear_connections ( )
Error	connect_node ( String from, int from_port, String to, int to_port )
void	disconnect_node ( String from, int from_port, String to, int to_port )
Array	get_connection_list ( ) const
HBoxContainer	get_zoom_hbox ( )
bool	is_node_connected ( String from, int from_port, String to, int to_port )
bool	is_valid_connection_type ( int from_type, int to_type ) const
void	remove_valid_connection_type ( int from_type, int to_type )
void	remove_valid_left_disconnect_type ( int type )
void	remove_valid_right_disconnect_type ( int type )
void	set_connection_activity ( String from, int from_port, String to, int to_port, float amount )
void	set_selected ( Node node )

Propiedades del Theme¶

Color	activity	`Color( 1, 1, 1, 1 )`
Color	grid_major	`Color( 1, 1, 1, 0.2 )`
Color	grid_minor	`Color( 1, 1, 1, 0.05 )`
Color	selection_fill	`Color( 1, 1, 1, 0.3 )`
Color	selection_stroke	`Color( 1, 1, 1, 0.8 )`
int	bezier_len_neg	`160`
int	bezier_len_pos	`80`
int	port_grab_distance_horizontal	`24`
int	port_grab_distance_vertical	`6`
Texture	minimap
Texture	minus
Texture	more
Texture	reset
Texture	snap
StyleBox	bg

Señales¶

_begin_node_move ( )

Emitido al principio de un movimiento de GraphNode.

_end_node_move ( )

Emitido al principio de un GraphNode.

connection_from_empty ( String to, int to_slot, Vector2 release_position )

Emitido cuando el usuario arrastra la conexión del puerto de entrada al espacio vacío del gráfico.

connection_request ( String from, int from_slot, String to, int to_slot )

Emitido al GraphEdit cuando se intenta crear la conexión entre la ranura from_slot del from GraphNode y la ranura to_slot del to GraphNode.

connection_to_empty ( String from, int from_slot, Vector2 release_position )

Emitido cuando el usuario arrastra la conexión del puerto de salida al espacio vacío del gráfico.

copy_nodes_request ( )

Emitted when the user presses Ctrl + C.

delete_nodes_request ( )

Emitido cuando se intenta eliminar un GraphNode del GraphEdit.

disconnection_request ( String from, int from_slot, String to, int to_slot )

Emitido al GraphEdit cuando se intenta eliminar la conexión entre la ranura from_slot de from GraphNode y la ranura to_slot de to GraphNode.

duplicate_nodes_request ( )

Emitido cuando se intenta duplicar un GraphNode en el GraphEdit.

node_selected ( Node node )

Emitido cuando se selecciona un GraphNode.

node_unselected ( Node node )

paste_nodes_request ( )

Emitted when the user presses Ctrl + V.

Emitido cuando se solicita un popup. Ocurre al hacer clic con el botón derecho del ratón en el GraphEdit. position es la posición del puntero del ratón cuando se envía la señal.

scroll_offset_changed ( Vector2 ofs )

Emitido cuando el desplazamiento de la pantalla es cambiado por el usuario. No se emitirá cuando se cambie el código.

Descripciones de Propiedades¶

bool minimap_enabled

Default	`true`
Setter	set_minimap_enabled(value)
Getter	is_minimap_enabled()

If true, the minimap is visible.

float minimap_opacity

Default	`0.65`
Setter	set_minimap_opacity(value)
Getter	get_minimap_opacity()

The opacity of the minimap rectangle.

Vector2 minimap_size

Default	`Vector2( 240, 160 )`
Setter	set_minimap_size(value)
Getter	get_minimap_size()

The size of the minimap rectangle. The map itself is based on the size of the grid area and is scaled to fit this rectangle.

bool right_disconnects

Default	`false`
Setter	set_right_disconnects(value)
Getter	is_right_disconnects_enabled()

Si true, permite la desconexión de las conexiones existentes en el GraphEdit arrastrando el extremo derecho.

Vector2 scroll_offset

Default	`Vector2( 0, 0 )`
Setter	set_scroll_ofs(value)
Getter	get_scroll_ofs()

El desplazamiento del scroll.

bool show_zoom_label

Default	`false`
Setter	set_show_zoom_label(value)
Getter	is_showing_zoom_label()

If true, makes a label with the current zoom level visible. The zoom value is displayed in percents.

int snap_distance

Default	`20`
Setter	set_snap(value)
Getter	get_snap()

La distancia de snapping en pixeles.

bool use_snap

Default	`true`
Setter	set_use_snap(value)
Getter	is_using_snap()

Si true, habilita el snapping.

float zoom

Default	`1.0`
Setter	set_zoom(value)
Getter	get_zoom()

El valor de zoom actual.

float zoom_max

Default	`2.0736`
Setter	set_zoom_max(value)
Getter	get_zoom_max()

The upper zoom limit.

float zoom_min

Default	`0.232568`
Setter	set_zoom_min(value)
Getter	get_zoom_min()

The lower zoom limit.

float zoom_step

Default	`1.2`
Setter	set_zoom_step(value)
Getter	get_zoom_step()

The step of each zoom level.

Descripciones de Métodos¶

void add_valid_connection_type ( int from_type, int to_type )

Hace posible la conexión entre dos tipos de ranuras diferentes. El tipo se define con el método GraphNode.set_slot.

void add_valid_left_disconnect_type ( int type )

Permite desconectar los nodos al arrastrarlos desde la ranura de la izquierda si tiene el tipo especificado.

void add_valid_right_disconnect_type ( int type )

Permite desconectar los nodos al arrastrarlos desde la ranura de la derecha si tiene el tipo especificado.

void clear_connections ( )

Elimina todas las conexiones entre los nodos.

Error connect_node ( String from, int from_port, String to, int to_port )

Crear una conexión entre la ranura from_port del from GraphNode y la ranura to_port del to GraphNode. Si la conexión ya existe, no se crea ninguna conexión.

void disconnect_node ( String from, int from_port, String to, int to_port )

Elimina la conexión entre la ranura from_port del from GraphNode y la ranura to_port del to GraphNode. Si la conexión no existe, no se elimina ninguna conexión.

Array get_connection_list ( ) const

Devuelve un Array que contiene la lista de conexiones. Una conexión consiste en una estructura de la forma { from_port: 0, from: "GraphNode name 0", to_port: 1, to: "GraphNode name 1" }.

HBoxContainer get_zoom_hbox ( )

Gets the HBoxContainer that contains the zooming and grid snap controls in the top left of the graph. You can use this method to reposition the toolbar or to add your own custom controls to it.

Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their CanvasItem.visible property.

bool is_node_connected ( String from, int from_port, String to, int to_port )

Devuelve true si la ranura from_port del from GraphNode está conectada a la ranura to_port del to GraphNode.

bool is_valid_connection_type ( int from_type, int to_type ) const

Devuelve si es posible conectar ranuras de los tipos especificados.

void remove_valid_connection_type ( int from_type, int to_type )

No es posible conectar entre dos tipos de ranuras diferentes. El tipo se define con el método GraphNode.set_slot.

void remove_valid_left_disconnect_type ( int type )

Elimina la posibilidad de desconectar los nodos al arrastrarlos de la ranura de la izquierda si tiene el tipo especificado.

void remove_valid_right_disconnect_type ( int type )

Elimina la posibilidad de desconectar los nodos al arrastrarlos de la ranura de la derecha si tiene el tipo especificado.

void set_connection_activity ( String from, int from_port, String to, int to_port, float amount )

Establece la coloración de la conexión entre from's from_port y to's to_port con el color proporcionado en la propiedad del tema activity.

void set_selected ( Node node )

Establece el nodo especificado como el seleccionado.

Theme Property Descriptions¶

Color activity

Default

Color( 1, 1, 1, 1 )

Color grid_major

Default

Color( 1, 1, 1, 0.2 )

El color de las principales líneas de la cuadrícula.

Color grid_minor

Default

Color( 1, 1, 1, 0.05 )

El color de las líneas de la cuadrícula menor.

Color selection_fill

Default

Color( 1, 1, 1, 0.3 )

El color de relleno del rectángulo de selección.

Color selection_stroke

Default

Color( 1, 1, 1, 0.8 )

El color del contorno del rectángulo de selección.

int bezier_len_neg

Default

160

int bezier_len_pos

Default

80

int port_grab_distance_horizontal

Default

24

El rango horizontal dentro del cual se puede agarrar un puerto (en ambos lados).

int port_grab_distance_vertical

Default

6

El rango vertical dentro del cual se puede agarrar un puerto (en ambos lados).

Texture minimap

Texture minus

El icono para el botón de alejamiento del zoom.

Texture more

El icono para el botón de acercamiento del zoom.

Texture reset

El icono del botón de reinicio del zoom.

Texture snap

El icono para el botón de conmutado de encaje.

StyleBox bg

El fondo dibujado bajo la cuadrícula.