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.

Personalizando o cursor do mouse

Você pode querer alterar a aparência do cursor do mouse em seu jogo para adequá-lo ao design geral. Existem duas maneiras de personalizar o cursor do mouse:

  1. Usando as configurações do projeto. Isto é mais simples, porém mais limitado.

  2. Usando um script. Isto é mais personalizável, porém envolve programação.

Nota

Você poderia exibir um cursor de mouse via "software" ocultando o cursor do mouse e movendo um Sprite2D para a posição do cursor em um método _process(), mas isso adicionará pelo menos um quadro de latência em comparação com um cursor de mouse via "hardware". Portanto, recomenda-se usar a abordagem descrita aqui sempre que possível.

Se você tiver que usar a abordagem de "software", considere adicionar uma etapa de extrapolação para exibir melhor a entrada real do mouse.

Usando as configurações do projeto

Abra as Configurações do Projeto (Project Settings) e vá em Display > Mouse Cursor. Você verá as configurações Custom Image, Custom Image Hotspot, e Tooltip Position Offset.

../../_images/cursor_project_settings.webp

Imagem Personalizada é a imagem desejada que você gostaria de definir como o cursor do mouse. Ponto de Destaque Personalizado é o ponto na imagem que você gostaria de usar como o ponto de detecção do cursor.

Aviso

A imagem personalizada deve ter no máximo 256×256 pixels. Para evitar problemas de renderização, tamanhos de 128×128 ou menores são recomendados.

Na plataforma web, o tamanho máximo permitido para a imagem do cursor é 128×128.

Usando um script

Crie um nó e anexe o seguinte script.

extends Node


# Load the custom images for the mouse cursor.
var arrow = load("res://arrow.png")
var beam = load("res://beam.png")


func _ready():
    # Changes only the arrow shape of the cursor.
    # This is similar to changing it in the project settings.
    Input.set_custom_mouse_cursor(arrow)

    # Changes a specific shape of the cursor (here, the I-beam shape).
    Input.set_custom_mouse_cursor(beam, Input.CURSOR_IBEAM)

Ver também

Verifique a documentação de Input.set_custom_mouse_cursor() para mais informações sobre o uso e ressalvas específicas de cada plataforma.

Lista de cursores

Existem múltiplos cursores de mouse que você pode definir, documentados no enum Input.CursorShape. Quais você deseja usar depende do seu caso de uso.