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...
AccessibilityServer
Hereda: Object
A server interface for screen reader support.
Métodos
Enumeraciones
enum AccessibilityRole: 🔗
AccessibilityRole ROLE_UNKNOWN = 0
Rol desconocido o personalizado.
AccessibilityRole ROLE_DEFAULT_BUTTON = 1
Elemento de botón de diálogo por defecto.
AccessibilityRole ROLE_AUDIO = 2
Elemento de reproductor de audio.
AccessibilityRole ROLE_VIDEO = 3
Elemento de reproductor de vídeo.
AccessibilityRole ROLE_STATIC_TEXT = 4
Etiqueta de texto no editable.
AccessibilityRole ROLE_CONTAINER = 5
Elemento contenedor. Los elementos con este rol se utilizan para la estructura interna y son ignorados por los lectores de pantalla.
AccessibilityRole ROLE_PANEL = 6
Elemento contenedor de panel.
AccessibilityRole ROLE_BUTTON = 7
Elemento de botón.
AccessibilityRole ROLE_LINK = 8
Elemento de enlace.
AccessibilityRole ROLE_CHECK_BOX = 9
Elemento de casilla de verificación.
AccessibilityRole ROLE_RADIO_BUTTON = 10
Elemento de botón de opción.
AccessibilityRole ROLE_CHECK_BUTTON = 11
Elemento de botón de verificación.
AccessibilityRole ROLE_SCROLL_BAR = 12
Elemento de barra de desplazamiento.
AccessibilityRole ROLE_SCROLL_VIEW = 13
Elemento contenedor de desplazamiento.
AccessibilityRole ROLE_SPLITTER = 14
Elemento de manejador de divisor de contenedor.
AccessibilityRole ROLE_SLIDER = 15
Elemento deslizador.
AccessibilityRole ROLE_SPIN_BUTTON = 16
Elemento de cuadro de giro.
AccessibilityRole ROLE_PROGRESS_INDICATOR = 17
Elemento indicador de progreso.
AccessibilityRole ROLE_TEXT_FIELD = 18
Elemento de campo de texto editable.
AccessibilityRole ROLE_MULTILINE_TEXT_FIELD = 19
Elemento de campo de texto editable multilínea.
AccessibilityRole ROLE_COLOR_PICKER = 20
Elemento selector de color.
AccessibilityRole ROLE_TABLE = 21
Elemento de tabla.
AccessibilityRole ROLE_CELL = 22
Elemento de celda de tabla/árbol.
AccessibilityRole ROLE_ROW = 23
Elemento de fila de tabla/árbol.
AccessibilityRole ROLE_ROW_GROUP = 24
Elemento de grupo de filas de tabla/árbol.
AccessibilityRole ROLE_ROW_HEADER = 25
Elemento de encabezado de fila de tabla/árbol.
AccessibilityRole ROLE_COLUMN_HEADER = 26
Elemento de encabezado de columna de tabla/árbol.
AccessibilityRole ROLE_TREE = 27
Elemento de vista de árbol.
AccessibilityRole ROLE_TREE_ITEM = 28
Elemento de ítem de vista de árbol.
AccessibilityRole ROLE_LIST = 29
Elemento de lista.
AccessibilityRole ROLE_LIST_ITEM = 30
Elemento de ítem de lista.
AccessibilityRole ROLE_LIST_BOX = 31
Elemento de vista de lista.
AccessibilityRole ROLE_LIST_BOX_OPTION = 32
Elemento de ítem de vista de lista.
AccessibilityRole ROLE_TAB_BAR = 33
Elemento de barra de pestañas.
AccessibilityRole ROLE_TAB = 34
Elemento de ítem de barra de pestañas.
AccessibilityRole ROLE_TAB_PANEL = 35
Elemento del panel de pestañas.
Elemento de barra de menú.
Elemento de menú emergente.
Elemento de menú emergente.
Elemento de ítem de botón de verificación de menú emergente.
Elemento de ítem de botón de opción de menú emergente.
AccessibilityRole ROLE_IMAGE = 41
Elemento de Imágen.
AccessibilityRole ROLE_WINDOW = 42
Elemento de ventana.
AccessibilityRole ROLE_TITLE_BAR = 43
Elemento de barra de título de ventana incrustado.
AccessibilityRole ROLE_DIALOG = 44
Elemento de ventana de diálogo.
AccessibilityRole ROLE_TOOLTIP = 45
Tooltip element.
AccessibilityRole ROLE_REGION = 46
Region/landmark element. Screen readers can navigate between regions using landmark navigation.
AccessibilityRole ROLE_TEXT_RUN = 47
Unifor text run.
Note: This role is used for internal text elements, and should not be assigned to nodes.
enum AccessibilityPopupType: 🔗
Menú de popup.
AccessibilityPopupType POPUP_LIST = 1
Lista de popup.
AccessibilityPopupType POPUP_TREE = 2
Vista de árbol de popup.
AccessibilityPopupType POPUP_DIALOG = 3
Diálogo de popup.
enum AccessibilityFlags: 🔗
El elemento está oculto para las herramientas de accesibilidad.
AccessibilityFlags FLAG_MULTISELECTABLE = 1
Element supports multiple item selection.
AccessibilityFlags FLAG_REQUIRED = 2
El elemento requiere la entrada del usuario.
AccessibilityFlags FLAG_VISITED = 3
El elemento es un enlace visitado.
AccessibilityFlags FLAG_BUSY = 4
El contenido del elemento no está listo (p. ej., cargando).
AccessibilityFlags FLAG_MODAL = 5
El elemento es una ventana modal.
AccessibilityFlags FLAG_TOUCH_PASSTHROUGH = 6
El elemento permite realizar toques cuando un lector de pantalla está en modo de exploración táctil.
AccessibilityFlags FLAG_READONLY = 7
El elemento es un campo de texto con texto seleccionable pero de solo lectura.
AccessibilityFlags FLAG_DISABLED = 8
El elemento está deshabilitado.
AccessibilityFlags FLAG_CLIPS_CHILDREN = 9
El elemento recorta los hijos.
enum AccessibilityAction: 🔗
AccessibilityAction ACTION_CLICK = 0
Acción de clic único, el argumento de callback no está establecido.
AccessibilityAction ACTION_FOCUS = 1
Acción de enfocar, el argumento de callback no está establecido.
AccessibilityAction ACTION_BLUR = 2
Acción de desenfocar, el argumento de callback no está establecido.
AccessibilityAction ACTION_COLLAPSE = 3
Acción de contraer, el argumento de callback no está establecido.
AccessibilityAction ACTION_EXPAND = 4
Acción de expandir, el argumento de callback no está establecido.
AccessibilityAction ACTION_DECREMENT = 5
Acción de decrementar, el argumento de callback no está establecido.
AccessibilityAction ACTION_INCREMENT = 6
Acción de incrementar, el argumento de callback no está establecido.
AccessibilityAction ACTION_HIDE_TOOLTIP = 7
Acción de ocultar tooltip, el argumento de callback no está establecido.
AccessibilityAction ACTION_SHOW_TOOLTIP = 8
Acción de mostrar tooltip, el argumento de callback no está establecido.
AccessibilityAction ACTION_SET_TEXT_SELECTION = 9
Set text selection action, callback argument is set to Dictionary with the following keys:
"start_element"accessibility element of the selection start."start_char"character offset relative to the accessibility element of the selection start."end_element"accessibility element of the selection end."end_char"character offset relative to the accessibility element of the selection end.
AccessibilityAction ACTION_REPLACE_SELECTED_TEXT = 10
Acción de reemplazar texto, el argumento de callback se establece en String con el texto de reemplazo.
AccessibilityAction ACTION_SCROLL_BACKWARD = 11
Acción de desplazamiento hacia atrás, el argumento de callback no está establecido.
AccessibilityAction ACTION_SCROLL_DOWN = 12
Scroll down action, callback argument is set to AccessibilityScrollUnit.
AccessibilityAction ACTION_SCROLL_FORWARD = 13
Acción de desplazamiento hacia adelante, el argumento de callback no está establecido.
AccessibilityAction ACTION_SCROLL_LEFT = 14
Scroll left action, callback argument is set to AccessibilityScrollUnit.
AccessibilityAction ACTION_SCROLL_RIGHT = 15
Scroll right action, callback argument is set to AccessibilityScrollUnit.
AccessibilityAction ACTION_SCROLL_UP = 16
Scroll up action, callback argument is set to AccessibilityScrollUnit.
AccessibilityAction ACTION_SCROLL_INTO_VIEW = 17
Scroll into view action, callback argument is set to AccessibilityScrollHint.
AccessibilityAction ACTION_SCROLL_TO_POINT = 18
Acción de desplazamiento a un punto, el argumento de callback se establece en Vector2 con las coordenadas del punto relativo.
AccessibilityAction ACTION_SET_SCROLL_OFFSET = 19
Acción de establecer el desplazamiento, el argumento de callback se establece en Vector2 con el desplazamiento.
AccessibilityAction ACTION_SET_VALUE = 20
Set value action, callback argument is set to String or number with the new value.
Acción de mostrar menú contextual, el argumento de callback no está establecido.
AccessibilityAction ACTION_CUSTOM = 22
Custom action, callback argument is set to the integer action ID.
enum AccessibilityLiveMode: 🔗
AccessibilityLiveMode LIVE_OFF = 0
Indica que las actualizaciones de la región activa no deben presentarse.
AccessibilityLiveMode LIVE_POLITE = 1
Indica que las actualizaciones de la región activa deben presentarse en la siguiente oportunidad (por ejemplo, al final de la frase actual).
AccessibilityLiveMode LIVE_ASSERTIVE = 2
Indica que las actualizaciones de la región activa tienen la máxima prioridad y deben presentarse inmediatamente.
enum AccessibilityScrollUnit: 🔗
AccessibilityScrollUnit SCROLL_UNIT_ITEM = 0
The amount by which to scroll. A single item of a list, line of text.
AccessibilityScrollUnit SCROLL_UNIT_PAGE = 1
The amount by which to scroll. A single page.
enum AccessibilityScrollHint: 🔗
AccessibilityScrollHint SCROLL_HINT_TOP_LEFT = 0
A preferred position for the node scrolled into view. Top-left edge of the scroll container.
AccessibilityScrollHint SCROLL_HINT_BOTTOM_RIGHT = 1
A preferred position for the node scrolled into view. Bottom-right edge of the scroll container.
AccessibilityScrollHint SCROLL_HINT_TOP_EDGE = 2
A preferred position for the node scrolled into view. Top edge of the scroll container.
AccessibilityScrollHint SCROLL_HINT_BOTTOM_EDGE = 3
A preferred position for the node scrolled into view. Bottom edge of the scroll container.
AccessibilityScrollHint SCROLL_HINT_LEFT_EDGE = 4
A preferred position for the node scrolled into view. Left edge of the scroll container.
AccessibilityScrollHint SCROLL_HINT_RIGHT_EDGE = 5
A preferred position for the node scrolled into view. Right edge of the scroll container.
Descripciones de Métodos
RID create_element(window_id: int, role: AccessibilityRole) 🔗
Crea un nuevo recurso de elemento de accesibilidad vacío.
Nota: Se crea y libera automáticamente un elemento de accesibilidad para cada Node. En general, esta función no debe ser llamada manualmente.
RID create_sub_element(parent_rid: RID, role: AccessibilityRole, insert_pos: int = -1) 🔗
Creates a new, empty accessibility sub-element resource. Sub-elements can be used to provide accessibility information for objects which are not Nodes, such as list items, table cells, or menu items. Sub-elements are freed automatically when the parent element is freed, or can be freed early using the free_element() method.
RID create_sub_text_edit_elements(parent_rid: RID, shaped_text: RID, min_height: float, insert_pos: int = -1, is_last_line: bool = false) 🔗
Creates a new, empty accessibility sub-element from the shaped text buffer. Sub-elements are freed automatically when the parent element is freed, or can be freed early using the free_element() method.
If is_last_line is true, no trailing newline is appended to the text content. Set to true for the last line in multi-line text fields and for single-line text fields.
Variant element_get_meta(id: RID) const 🔗
Devuelve los metadatos del elemento de accesibilidad id.
void element_set_meta(id: RID, meta: Variant) 🔗
Establece los metadatos del elemento de accesibilidad id a meta.
Frees the accessibility element id created by create_element(), create_sub_element(), or create_sub_text_edit_elements().
RID get_window_root(window_id: int) const 🔗
Devuelve el elemento de accesibilidad principal de la ventana nativa del sistema operativo.
bool has_element(id: RID) const 🔗
Devuelve true si id es un elemento de accesibilidad válido.
Devuelve true si esta implementación admite el lector de pantalla.
void set_window_focused(window_id: int, focused: bool) 🔗
Establece el estado de foco de la ventana para aplicaciones de asistencia.
Nota: Este método está implementado en Linux, macOS y Windows.
Nota: ¡Solo para usuarios avanzados! Los objetos Window llaman a este método automáticamente.
void set_window_rect(window_id: int, rect_out: Rect2, rect_in: Rect2) 🔗
Establece los límites exteriores (con decoraciones) e interiores (sin decoraciones) de la ventana para aplicaciones de asistencia.
Nota: Este método está implementado en Linux, macOS y Windows.
Nota: ¡Solo para usuarios avanzados! Los objetos Window llaman a este método automáticamente.
void update_add_action(id: RID, action: AccessibilityAction, callable: Callable) 🔗
Añade una devolución de llamada para la acción de accesibilidad (acción que se puede realizar usando un comando especial del lector de pantalla o botones en la pantalla Braille), y marca esta acción como compatible. La devolución de llamada de la acción recibe un argumento Variant, cuyo valor depende del tipo de acción.
void update_add_child(id: RID, child_id: RID) 🔗
Añade un elemento de accesibilidad hijo.
Nota: Los hijos y subelementos de Node se añaden automáticamente a la lista de hijos.
void update_add_custom_action(id: RID, action_id: int, action_description: String) 🔗
Adds support for a custom accessibility action. action_id is passed as an argument to the callback of ACTION_CUSTOM action.
Añade un elemento que es controlado por este elemento.
Añade un elemento que describe este elemento.
Añade un elemento que detalla este elemento.
Agrega un elemento hacia el cual fluye este elemento.
Añade un elemento que etiqueta este elemento.
Añade un elemento que forma parte del mismo grupo de radio.
Nota: Este método debe ser llamado en cada elemento del grupo, usando todos los demás elementos como related_id.
void update_set_active_descendant(id: RID, other_id: RID) 🔗
Agrega un elemento que es un descendiente activo de este elemento.
void update_set_background_color(id: RID, color: Color) 🔗
Establece el color de fondo del elemento.
void update_set_bounds(id: RID, rect: Rect2) 🔗
Establece el cuadro delimitador del elemento, en relación con la posición del nodo.
void update_set_braille_label(id: RID, name: String) 🔗
Sets element accessibility label for Braille display.
void update_set_braille_role_description(id: RID, description: String) 🔗
Sets element accessibility role description for Braille display.
void update_set_checked(id: RID, checekd: bool) 🔗
Establece el estado del elemento marcado.
void update_set_classname(id: RID, classname: String) 🔗
Establece el nombre de la clase del elemento.
void update_set_color_value(id: RID, color: Color) 🔗
Establece el valor del color del elemento.
void update_set_description(id: RID, description: String) 🔗
Establece la descripción de accesibilidad del elemento.
void update_set_error_message(id: RID, other_id: RID) 🔗
Establece un elemento que contiene un mensaje de error para este elemento.
void update_set_extra_info(id: RID, name: String) 🔗
Establece información extra de accesibilidad del elemento, añadida al nombre del elemento.
void update_set_flag(id: RID, flag: AccessibilityFlags, value: bool) 🔗
Establece la bandera del elemento.
void update_set_focus(id: RID) 🔗
Establece el elemento enfocado actualmente.
void update_set_foreground_color(id: RID, color: Color) 🔗
Establece el color de primer plano del elemento.
void update_set_in_page_link_target(id: RID, other_id: RID) 🔗
Establece el elemento de destino para el enlace.
void update_set_language(id: RID, language: String) 🔗
Establece el idioma del texto del elemento.
void update_set_list_item_count(id: RID, size: int) 🔗
Establece el número de elementos en la lista.
void update_set_list_item_expanded(id: RID, expanded: bool) 🔗
Establece el estado de expandido de un elemento de lista/árbol.
void update_set_list_item_index(id: RID, index: int) 🔗
Establece la posición del elemento en la lista.
void update_set_list_item_level(id: RID, level: int) 🔗
Establece el nivel jerárquico del elemento en la lista.
void update_set_list_item_selected(id: RID, selected: bool) 🔗
Establece el estado seleccionado del elemento de lista/árbol.
void update_set_list_orientation(id: RID, vertical: bool) 🔗
Establece la orientación de los elementos de la lista.
void update_set_live(id: RID, live: AccessibilityLiveMode) 🔗
Establece la prioridad de las actualizaciones de la región en vivo.
void update_set_member_of(id: RID, group_id: RID) 🔗
Establece el elemento para que sea miembro del grupo.
void update_set_name(id: RID, name: String) 🔗
Establece el nombre de accesibilidad del elemento.
void update_set_next_on_line(id: RID, other_id: RID) 🔗
Establece el siguiente elemento en la línea.
void update_set_num_jump(id: RID, jump: float) 🔗
Establece el salto del valor numérico.
void update_set_num_range(id: RID, min: float, max: float) 🔗
Establece un rango de valores numéricos.
void update_set_num_step(id: RID, step: float) 🔗
Establece el paso del valor numérico.
void update_set_num_value(id: RID, position: float) 🔗
Establece el valor numérico.
void update_set_placeholder(id: RID, placeholder: String) 🔗
Establece el texto de marcador de posición.
void update_set_popup_type(id: RID, popup: AccessibilityPopupType) 🔗
Establece el tipo de popup para los botones emergentes.
void update_set_previous_on_line(id: RID, other_id: RID) 🔗
Establece el elemento anterior en la línea.
void update_set_role(id: RID, role: AccessibilityRole) 🔗
Modifica el rol de accesibilidad del elemento.
void update_set_role_description(id: RID, description: String) 🔗
Establece el texto de descripción del rol de accesibilidad del elemento.
void update_set_scroll_x(id: RID, position: float) 🔗
Establece la posición x de la barra de desplazamiento.
void update_set_scroll_x_range(id: RID, min: float, max: float) 🔗
Establece el rango X de la barra de desplazamiento.
void update_set_scroll_y(id: RID, position: float) 🔗
Establece la posición y de la barra de desplazamiento.
void update_set_scroll_y_range(id: RID, min: float, max: float) 🔗
Establece el rango Y de la barra de desplazamiento.
void update_set_shortcut(id: RID, shortcut: String) 🔗
Establece la lista de atajos de teclado utilizados por elemento.
void update_set_state_description(id: RID, description: String) 🔗
Establece una descripción legible por humanos del estado actual marcado.
void update_set_table_cell_position(id: RID, row_index: int, column_index: int) 🔗
Establece la posición de la celda en la tabla.
void update_set_table_cell_span(id: RID, row_span: int, column_span: int) 🔗
Establece el espacio entre filas y columnas de celdas.
void update_set_table_column_count(id: RID, count: int) 🔗
Establece el número de columnas en la tabla.
void update_set_table_column_index(id: RID, index: int) 🔗
Establece la posición de la columna.
void update_set_table_row_count(id: RID, count: int) 🔗
Establece el número de filas en la tabla.
void update_set_table_row_index(id: RID, index: int) 🔗
Establece la posición de la fila en la tabla.
void update_set_text_align(id: RID, align: HorizontalAlignment) 🔗
Establece la alineación del texto del elemento.
void update_set_text_decorations(id: RID, underline: bool, strikethrough: bool, overline: bool, color: Color = Color(0, 0, 0, 1)) 🔗
Establece el subrayado/sobrelineado/tachado del texto.
void update_set_text_orientation(id: RID, vertical: bool) 🔗
Establece la orientación del texto.
void update_set_text_selection(id: RID, text_start_id: RID, start_char: int, text_end_id: RID, end_char: int) 🔗
Sets text selection to the text field. text_start_id and text_end_id should be elements created by create_sub_text_edit_elements(). Character offsets are relative to the corresponding element.
void update_set_tooltip(id: RID, tooltip: String) 🔗
Establece el texto de la información sobre herramientas.
void update_set_transform(id: RID, transform: Transform2D) 🔗
Establece la transformación 2D del elemento.
void update_set_url(id: RID, url: String) 🔗
Establece la URL del enlace.
void update_set_value(id: RID, value: String) 🔗
Establece el valor del texto del elemento.