Les classes Animation

Classe Animation

class pygame_animations.Animation(target, duration[, effect] [, flags=None], **attrs)

Une animation.

Paramètres

  • target (object): l’objet à animer.

  • duration (int, float): durée de l’animation, en secondes.

  • effect (callable): effet à appliquer à l’animation. Il peut être un effet natif ou un effet personnalisé.

  • flags (str): servent à repérer l’animation. les étiquettes doivent être alphanumériques et séparées par des virgules.

  • attrs : propriétés à animer. pour désigner une sous-propriété a.b.c, utilisez a__b__c

target

(Lecture seule) L’objet ciblé par l’animation.

duration

(Lecture seule) La durée de l’animation, convertie et arrondie en millisecondes.

start()

Lance l’animation. Elle ne peut être appelée qu’une seule fois.

Paramètres

Aucuns

Renvoie

None

stop([noerror=False])

Arrête l’animation et laisse l’objet animé tel quel. Une fois arrêtée, elle ne peut pas être relancée.

Paramètres

  • noerror (bool): quand la méthode est appelée sur une animation qui n’est pas en cours, ignore si True ou lève une RuntimeError si False.

Renvoie

None

cancel([noerror=False])

Pareil que stop(), mais remet l’objet animé dans son état initial.

Paramètre
Renvoie

None

fastforward([noerror=False])

Pareil que stop(), mais met l’objet animé dans son état final.

Paramètre
Renvoie

None

is_running()

Renvoie True si l’animation est en cours.

Paramètres

Aucuns

Renvoie

bool

can_run()

Renvoie True si l’animation n’a pas encore été lancée.

Paramètres

Aucuns

Renvoie

bool

match(flags)

Renvoie True si les étiquettes de l’animation correspondent aux étiquettes données.

Paramètres

  • flags (str): les étiquettes à tester, séparées par des virgules. L’étiquette * correspond à n’importe quoi et flag1|flag2 correspond soit à flag1 soit à flag2.

Renvoie

bool

Note

match() renverra toujours False pour une animation sans étiquettes

Classe AnimationSequence

class pygame_animations.AnimationSequence(a, b, [*others] [, flag=None])

Inhérite de pygame_animations.Animation

Plusieurs animations lancées les une après les autres. Une séquence peut être créée en additionnant plusieurs animations : anim1 + anim2 + anim3 vaut AnimationSequence(anim1, anim2, anim3)

Paramètres

  • a, b et others (Animation): les animations de la séquence

  • flags (str): servent à repérer l’animation. les étiquettes doivent être alphanumériques et séparées par des virgules.

animations

(Lecture seule) Les animations qui composent la séquence.

duration

(Lecture seule) La durée de l’animation, égale à la somme des durées des animations.

start()
stop([noerror=False])

Arrête la séquence et appelle stop() sur toutes les animations.

Paramètres

  • noerror (bool): quand la méthode est appelée sur une animation qui n’est pas en cours, ignore si True ou lève une RuntimeError si False.

Renvoie

None

cancel([noerror=False])

Pareil que stop(), mais appelle cancel() sur toutes les animations.

Paramètre
Renvoie

None

fastforward([noerror=False])

Pareil que stop(), mais appelle fastforward() sur toutes les animations.

Paramètre
Renvoie

None

is_running()
can_run()
match(flags)

Classe AnimationGroup

class pygame_animations.AnimationGroup(a, b, [*others] [, flag=None])

Inhérite de pygame_animations.Animation

Plusieurs animations lancées en même temps. Un groupe peut être créé en utilisant l’opérateur & entre plusieurs animations : anim1 & anim2 & anim3 vaut AnimationGroup(anim1, anim2, anim3)

Paramètres

  • a, b et others (Animation): les animations du groupe

  • flags (str): servent à repérer l’animation. les étiquettes doivent être alphanumériques et séparées par des virgules.

animations

(Lecture seule) Les animations qui composent le groupe.

duration

(Lecture seule) La durée de l’animation, égale à la durée la plus longue de toutes les animations.

start()
stop([noerror=False])

Arrête la séquence et appelle stop() sur toutes les animations.

Paramètres

  • noerror (bool): quand la méthode est appelée sur une animation qui n’est pas en cours, ignore si True ou lève une RuntimeError si False.

Renvoie

None

cancel([noerror=False])

Pareil que stop(), mais appelle cancel() sur toutes les animations.

Paramètre
Renvoie

None

fastforward([noerror=False])

Pareil que stop(), mais appelle fastforward() sur toutes les animations.

Paramètre
Renvoie

None

is_running()
can_run()
match(flags)