Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

AnimationNodeOneShot

Hérite de : AnimationNodeSync < AnimationNode < Resource < RefCounted < Object

Joue une animation une fois dans un AnimationNodeBlendTree.

Description

Une ressource pour ajouter à un AnimationNodeBlendTree. Ce nœud d'animation exécutera une sous-animation et renverra une fois qu'il aura terminé. Les temps de mélange pour les fondus d'ouverture et de fermeture peuvent être personnalisés, ainsi que les filtres.

Après avoir paramétré la requête et modifié la lecture de l'animation, ce nœud à lecture unique efface automatiquement la requête lors de la prochaine trame de traitement en définissant sa valeur request à ONE_SHOT_REQUEST_NONE.

# Jouer l'animation enfant liée au port "shot".
animation_tree.set("parameters/OneShot/request", AnimationNodeOneShot.ONE_SHOT_REQUEST_FIRE)
# Syntaxe alternative (même résultat qu'au dessus).
animation_tree["parameters/OneShot/request"] = AnimationNodeOneShot.ONE_SHOT_REQUEST_FIRE

# Annuler l'animation enfant liée au port "shot".
animation_tree.set("parameters/OneShot/request", AnimationNodeOneShot.ONE_SHOT_REQUEST_ABORT)
# Syntaxe alternative (même résultat qu'au dessus).
animation_tree["parameters/OneShot/request"] = AnimationNodeOneShot.ONE_SHOT_REQUEST_ABORT

# Annuler l'animation enfant liée au port "shot" avec un fondu de fermeture.
animation_tree.set("parameters/OneShot/request", AnimationNodeOneShot.ONE_SHOT_REQUEST_FADE_OUT)
# Syntaxe alternative (même résultat qu'au dessus).
animation_tree["parameters/OneShot/request"] = AnimationNodeOneShot.ONE_SHOT_REQUEST_FADE_OUT

# Obtenir l'état actuel (lecture seule).
animation_tree.get("parameters/OneShot/active")
# Syntaxe alternative (même résultat qu'au dessus).
animation_tree["parameters/OneShot/active"]

# Obtenir l'état interne actuel (lecture seule).
animation_tree.get("parameters/OneShot/internal_active")
# Syntaxe alternative (même résultat qu'au dessus).
animation_tree["parameters/OneShot/internal_active"]

Tutoriels

Propriétés

bool

abort_on_reset

false

bool

autorestart

false

float

autorestart_delay

1.0

float

autorestart_random_delay

0.0

bool

break_loop_at_end

false

Curve

fadein_curve

float

fadein_time

0.0

Curve

fadeout_curve

float

fadeout_time

0.0

MixMode

mix_mode

0


Énumérations

enum OneShotRequest: 🔗

OneShotRequest ONE_SHOT_REQUEST_NONE = 0

L'état par défaut de la demande. Rien n'est fait.

OneShotRequest ONE_SHOT_REQUEST_FIRE = 1

La demande de jouer l'animation connectée au port "shot".

OneShotRequest ONE_SHOT_REQUEST_ABORT = 2

La demande pour arrêter l'animation connectée au port "shot".

OneShotRequest ONE_SHOT_REQUEST_FADE_OUT = 3

La demande de faire un fondu sortant avec l'animation connectée au port "shot".


enum MixMode: 🔗

MixMode MIX_MODE_BLEND = 0

Mélange deux animations. Voir aussi AnimationNodeBlend2.

MixMode MIX_MODE_ADD = 1

Mélange deux animations additivement. Voir aussi AnimationNodeAdd2.


Descriptions des propriétés

bool abort_on_reset = false 🔗

  • void set_abort_on_reset(value: bool)

  • bool is_aborted_on_reset()

Si true, la sous-animation sera interrompue si elle est relancée avec une réinitialisation après une interruption préalable.


bool autorestart = false 🔗

  • void set_autorestart(value: bool)

  • bool has_autorestart()

Si true, la sous-animation redémarre automatiquement après avoir fini.

En d'autres termes, pour commencer le redémarrage automatique, l'animation doit être jouée une fois avec la requête ONE_SHOT_REQUEST_FIRE. La requête ONE_SHOT_REQUEST_ABORT arrête le redémarrage automatique, mais elle ne désactive pas la propriété autorestart elle-même. Ainsi, la requête ONE_SHOT_REQUEST_FIRE va démarrer encore le redémarrage automatique.


float autorestart_delay = 1.0 🔗

  • void set_autorestart_delay(value: float)

  • float get_autorestart_delay()

Le délai après lequel le redémarrage automatique est déclenché, en secondes.


float autorestart_random_delay = 0.0 🔗

  • void set_autorestart_random_delay(value: float)

  • float get_autorestart_random_delay()

Si autorestart est true, un délai additionnel (en secondes) aléatoirement choisi entre 0 et cette valeur sera ajouté à autorestart_delay.


bool break_loop_at_end = false 🔗

  • void set_break_loop_at_end(value: bool)

  • bool is_loop_broken_at_end()

Si true, brise la boucle à la fin du cycle de boucle pour la transition, même si l'animation boucle.


Curve fadein_curve 🔗

  • void set_fadein_curve(value: Curve)

  • Curve get_fadein_curve()

Détermine comment le fondu enchaîné entre les animations est amorti. Si vide, la transition sera linéaire. Devrait être une Curve unitaire.


float fadein_time = 0.0 🔗

  • void set_fadein_time(value: float)

  • float get_fadein_time()

La durée du fondu d'ouverture. Par exemple, définir ceci à 1.0 pour une animation de 5 secondes produira un fondu enchaîné qui commence à 0 seconde et se termine à 1 seconde pendant l'animation.

Note : AnimationNodeOneShot transitionne l'état actuel après la fin du fondu.


Curve fadeout_curve 🔗

  • void set_fadeout_curve(value: Curve)

  • Curve get_fadeout_curve()

Détermine comment le fondu enchaîné entre les animations est amorti. Si vide, la transition sera linéaire. Devrait être une Curve unitaire.


float fadeout_time = 0.0 🔗

  • void set_fadeout_time(value: float)

  • float get_fadeout_time()

La durée du fondu de fermeture. Par exemple, définir ceci à 1.0 pour une animation de 5 secondes produira un fondu enchaîné qui commence à 4 secondes et se termine à 5 secondes pendant l'animation.

Note : AnimationNodeOneShot transitionne l'état actuel après la fin du fondu.


MixMode mix_mode = 0 🔗

Le type de mélange.