Skip to content

class_sprite

Jump to bottom Edit New page
reduz edited this page Feb 23, 2014 · 10 revisions

Sprite

####Inherits: Node2D ####Category: Core

Brief Description

General purpose Sprite node.

Member Functions

Description

General purpose Sprite node. This Sprite node can show any texture as a sprite. The texture can be used as a spritesheet for animation, or only a region from a bigger texture can referenced, like an atlas.

Member Function Description

set_texture

  • void set&#95texture ( Texture texture )

Set the base texture for the sprite.

get_texture

Return the base texture for the sprite.

set_centered

  • void set&#95centered ( bool centered )

Set whether the sprite should be centered on the origin.

is_centered

  • bool is&#95centered ( ) const

Return if the sprite is centered at the local origin.

set_offset

  • void set&#95offset ( Vector2 offset )

Set the sprite draw offset, useful for setting rotation pivots.

get_offset

Return sprite draw offst.

set_flip_h

  • void set&#95flip&#95h ( bool flip_h )

Set true to flip the sprite horizontaly.

is_flipped_h

  • bool is&#95flipped&#95h ( ) const

Return true if the sprite is flipped horizontally.

set_flip_v

  • void set&#95flip&#95v ( bool flip_v )

Set true to flip the sprite vertically.

is_flipped_v

  • bool is&#95flipped&#95v ( ) const

Return true if the sprite is flipped vertically.

set_region

  • void set&#95region ( bool enabled )

Set the sprite as a sub-region of a bigger texture. Useful for texture-atlases.

is_region

  • bool is&#95region ( ) const

Return if the sprite reads from a region.

set_region_rect

  • void set&#95region&#95rect ( Rect2 rect )

Set the region rect to read from.

get_region_rect

  • Rect2 get&#95region&#95rect ( ) const

Return the region rect to read from.

set_frame

  • void set&#95frame ( int frame )

Set the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1.

get_frame

  • int get&#95frame ( ) const

Return the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1.

set_vframes

  • void set&#95vframes ( int vframes )

Set the amount of vertical frames and converts the sprite into a sprite-sheet. This is useful for animation.

get_vframes

  • int get&#95vframes ( ) const

Return the amount of vertical frames. See [set_vframes].

set_hframes

  • void set&#95hframes ( int hframes )

Set the amount of horizontal frames and converts the sprite into a sprite-sheet. This is useful for animation.

get_hframes

  • int get&#95hframes ( ) const

Return the amount of horizontal frames. See [set_hframes].

set_modulate

  • void set&#95modulate ( Color modulate )

Set color modulation for the sprite. All sprite pixels are multiplied by this color.

get_modulate

  • Color get&#95modulate ( ) const

Return color modulation for the sprite. All sprite pixels are multiplied by this color.

Add a custom footer
Add a custom sidebar
Clone this wiki locally