SpriteButton class

A StatelessWidget that uses SpriteWidgets to render a pressable button

Inheritance

Constructors

SpriteButton({required Sprite sprite, required Sprite pressedSprite, required VoidCallback onPressed, required double width, required double height, required Widget label, Vector2? srcPosition, Vector2? srcSize, Vector2? pressedSrcPosition, Vector2? pressedSrcSize, WidgetBuilder? errorBuilder, WidgetBuilder? loadingBuilder, Key? key})
SpriteButton.asset({required String path, required String pressedPath, required VoidCallback onPressed, required double width, required double height, required Widget label, Images? images, Vector2? srcPosition, Vector2? srcSize, Vector2? pressedSrcPosition, Vector2? pressedSrcSize, WidgetBuilder? errorBuilder, WidgetBuilder? loadingBuilder, Key? key})
Loads the images from the asset path and pressedPath and renders it as a widget.
SpriteButton.future({required Future<Sprite> sprite, required Future<Sprite> pressedSprite, required VoidCallback onPressed, required double width, required double height, required Widget label, Vector2? srcPosition, Vector2? srcSize, Vector2? pressedSrcPosition, Vector2? pressedSrcSize, WidgetBuilder? errorBuilder, WidgetBuilder? loadingBuilder, Key? key})

Properties

errorBuilder WidgetBuilder?
A builder function that is called if the loading fails
final
hashCode int
The hash code for this object.
no setterinherited
height double
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
label Widget
final
loadingBuilder WidgetBuilder?
A builder function that is called while the loading is on the way
final
onPressed VoidCallback
final
pressedSrcPosition Vector2?
Holds the position of the sprite on the image
final
pressedSrcSize Vector2?
Holds the size of the sprite on the image
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
srcPosition Vector2?
Holds the position of the sprite on the image
final
srcSize Vector2?
Holds the size of the sprite on the image
final
width double
final

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
override
createElement() StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
inherited
toStringShort() String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited