improved docs

This commit is contained in:
Luan Nico
2019-01-01 22:46:40 -02:00
parent dc6154a9c6
commit a1b02a7f18
2 changed files with 8 additions and 4 deletions

View File

@ -1,14 +1,14 @@
import 'sprite.dart'; import 'sprite.dart';
/// Represents a single animation frame /// Represents a single animation frame.
class Frame { class Frame {
/// The [Sprite] to be displayed /// The [Sprite] to be displayed.
Sprite sprite; Sprite sprite;
/// The duration to display it, in seconds /// The duration to display it, in seconds.
double stepTime; double stepTime;
/// Create based on the parameters /// Create based on the parameters.
Frame(this.sprite, this.stepTime); Frame(this.sprite, this.stepTime);
} }

View File

@ -6,6 +6,10 @@ import 'package:synchronized/synchronized.dart';
typedef void Stoppable(); typedef void Stoppable();
/// An AudioPool is a provider of AudioPlayers that leaves them pre-loaded to minimize delays.
///
/// All AudioPlayers loaded are for the same [sound]. If you want multiple sounds use multiple [AudioPool].
/// Use this class if you'd like have extremely quick firing, repetitive and simultaneous sounds, like shooting a laser in a fast-paced spaceship game.
class AudioPool { class AudioPool {
AudioCache cache; AudioCache cache;
Map<String, AudioPlayer> currentPlayers = {}; Map<String, AudioPlayer> currentPlayers = {};