Sprite

Inherits: Node2D < CanvasItem < Node < Object

Nodo de sprites de propósito general.

Descripción

Un nodo que muestra una textura 2D. La textura mostrada puede ser una región de una textura de atlas más grande, o un cuadro de una animación de hoja de sprite.

Tutoriales

Propiedades

bool

centered

true

bool

flip_h

false

bool

flip_v

false

int

frame

0

Vector2

frame_coords

Vector2( 0, 0 )

int

hframes

1

Texture

normal_map

Vector2

offset

Vector2( 0, 0 )

bool

region_enabled

false

bool

region_filter_clip

false

Rect2

region_rect

Rect2( 0, 0, 0, 0 )

Texture

texture

int

vframes

1

Métodos

Rect2

get_rect ( ) const

bool

is_pixel_opaque ( Vector2 pos ) const

Señales

  • frame_changed ( )

Emitido cuando el frame cambia.


  • texture_changed ( )

Emitido cuando la texture cambia.

Descripciones de Propiedades

Default

true

Setter

set_centered(value)

Getter

is_centered()

Si true, la textura se centra.


Default

false

Setter

set_flip_h(value)

Getter

is_flipped_h()

Si true, la textura se voltea horizontalmente.


Default

false

Setter

set_flip_v(value)

Getter

is_flipped_v()

Si true, la textura se voltea verticalmente.


Default

0

Setter

set_frame(value)

Getter

get_frame()

Current frame to display from sprite sheet. hframes or vframes must be greater than 1.


Default

Vector2( 0, 0 )

Setter

set_frame_coords(value)

Getter

get_frame_coords()

Coordinates of the frame to display from sprite sheet. This is as an alias for the frame property. hframes or vframes must be greater than 1.


Default

1

Setter

set_hframes(value)

Getter

get_hframes()

El número de columnas en la hoja de sprites.


Setter

set_normal_map(value)

Getter

get_normal_map()

The normal map gives depth to the Sprite.

Note: Godot expects the normal map to use X+, Y-, and Z+ coordinates. See this page for a comparison of normal map coordinates expected by popular engines.


Default

Vector2( 0, 0 )

Setter

set_offset(value)

Getter

get_offset()

El desplazamiento al dibujar de la textura.


  • bool region_enabled

Default

false

Setter

set_region(value)

Getter

is_region()

Si true, la textura se corta de una textura de atlas más grande. Ver region_rect.


  • bool region_filter_clip

Default

false

Setter

set_region_filter_clip(value)

Getter

is_region_filter_clip_enabled()

Si true, los píxeles más externos se desdibujan.


Default

Rect2( 0, 0, 0, 0 )

Setter

set_region_rect(value)

Getter

get_region_rect()

La región de la textura del atlas a mostrar. region_enabled debe ser true.


Setter

set_texture(value)

Getter

get_texture()

Texture object to draw.


Default

1

Setter

set_vframes(value)

Getter

get_vframes()

El número de filas en la hoja de sprites.

Descripciones de Métodos

  • Rect2 get_rect ( ) const

Returns a Rect2 representing the Sprite's boundary in local coordinates. Can be used to detect if the Sprite was clicked. Example:

func _input(event):
    if event is InputEventMouseButton and event.pressed and event.button_index == BUTTON_LEFT:
        if get_rect().has_point(to_local(event.position)):
            print("A click!")

Devuelve true, si el píxel en la posición dada es opaco y false en otro caso.

Nota: También devuelve false, si la textura del sprite es null o si la posición dada es inválida.