我的书签
添加书签
移除书签Sprite
Category: Core
General purpose Sprite node.
Properties
| get_rect ( ) const | |
| is_pixel_opaque ( pos ) const |
Signals
Emitted when the frame changes.
- texture_changed ( )
Emitted when the changes.
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.
Property Descriptions
- bool centered
| Setter | set_centered(value) |
| Getter | is_centered() |
If , texture is centered. Default value: true.
- flip_h
| Setter | set_flip_h(value) |
| Getter | is_flipped_h() |
- bool flip_v
If , texture is flipped vertically. Default value: false.
- frame
| Setter | set_frame(value) |
| Getter | get_frame() |
Current frame to display from sprite sheet. vframes or must be greater than 1.
- int hframes
| Setter | set_hframes(value) |
| Getter | get_hframes() |
The number of columns in the sprite sheet.
- normal_map
| Setter | set_normal_map(value) |
| Getter | get_normal_map() |
The normal map gives depth to the Sprite.
The texture’s drawing offset.
- bool region_enabled
| Setter | set_region(value) |
| Getter | is_region() |
If true, texture is cut from a larger atlas texture. See . Default value: false.
- bool region_filter_clip
| Setter | set_region_filter_clip(value) |
| Getter | is_region_filter_clip_enabled() |
- region_rect
| Setter | set_region_rect(value) |
| Getter | get_region_rect() |
The region of the atlas texture to display. region_enabled must be true.
- texture
Texture object to draw.
- vframes
| Setter | set_vframes(value) |
| Getter | get_vframes() |
The number of rows in the sprite sheet.
- Rect2 get_rect ( ) const
Returns a representing the Sprite’s boundary in local coordinates. Can be used to detect if the Sprite was clicked. Example:
- bool is_pixel_opaque ( pos ) const
Returns true, if the pixel at the given position is opaque and false in other case.
Note: It also returns , if the sprite’s texture is null or if the given position is invalid.
