Sprite

    General-purpose sprite node.

    A node that displays a 2D texture. The texture displayed can be a region from a larger atlas texture, or a frame from a sprite sheet animation.

    Tutorials

    Methods

    Rect2

    ( ) const

    bool

    ( Vector2 pos ) const

    • frame_changed ( )

    Emitted when the frame changes.

    • texture_changed ( )

    Property Descriptions

    Default

    true

    Setter

    set_centered(value)

    Getter

    is_centered()

    If true, texture is centered.

    • flip_h

    Default

    false

    Setter

    set_flip_h(value)

    Getter

    is_flipped_h()

    If true, texture is flipped horizontally.

    Default

    false

    Setter

    set_flip_v(value)

    Getter

    is_flipped_v()

    If true, texture is flipped vertically.

    • frame

    Current frame to display from sprite sheet. hframes or 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 property. hframes or must be greater than 1.

    Default

    1

    Setter

    set_hframes(value)

    Getter

    get_hframes()

    The number of columns in the sprite sheet.

    Setter

    set_normal_map(value)

    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 for a comparison of normal map coordinates expected by popular engines.

    Default

    Setter

    set_offset(value)

    Getter

    get_offset()

    The texture’s drawing offset.

    • region_enabled

    If true, texture is cut from a larger atlas texture. See region_rect.

    • region_filter_clip

    Default

    false

    Setter

    set_region_filter_clip(value)

    Getter

    is_region_filter_clip_enabled()

    If true, the outermost pixels get blurred out.

    Default

    Rect2( 0, 0, 0, 0 )

    Setter

    set_region_rect(value)

    Getter

    get_region_rect()

    The region of the atlas texture to display. must be true.

    Setter

    set_texture(value)

    Getter

    get_texture()

    object to draw.

    Default

    1

    Setter

    set_vframes(value)

    Getter

    get_vframes()

    The number of rows in the sprite sheet.

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

    • is_pixel_opaque ( Vector2 pos ) const

    Note: It also returns , if the sprite’s texture is null or if the given position is invalid.