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.

AnimationNodeStateMachinePlayback

Hérite de : Resource < RefCounted < Object

Fournit le contrôle de la lecture pour une AnimationNodeStateMachine.

Description

Permet le contrôle d'automates AnimationTree créés avec AnimationNodeStateMachine. Récupérez avec [code]$AnimationTree.get("parameters/playback").

var automate = $AnimationTree.get("parameters/playback")
automate.travel("un_etat")

Tutoriels

Propriétés

bool

resource_local_to_scene

true (overrides Resource)

Méthodes

float

get_current_length() const

StringName

get_current_node() const

float

get_current_play_position() const

float

get_fading_from_length() const

StringName

get_fading_from_node() const

float

get_fading_from_play_position() const

float

get_fading_length() const

float

get_fading_position() const

Array[StringName]

get_travel_path() const

bool

is_playing() const

void

next()

void

start(node: StringName, reset: bool = true)

void

stop()

void

travel(to_node: StringName, reset_on_teleport: bool = true)


Signaux

state_finished(state: StringName) 🔗

Émis lorsque l'état state finit la lecture. Si state est un automate en mode groupé, ses signaux sont passés avec son nom en préfixe.

S'il y a un fondu croisé, cela sera émis lorsque l'influence de l'animation get_fading_from_node() n'est plus présente.


state_started(state: StringName) 🔗

Émis lorsque l'état state commence la lecture. Si state est un automate en mode groupé, ses signaux sont passés avec son nom en préfixe.


Descriptions des méthodes

float get_current_length() const 🔗

Renvoie la longueur de l'état actuel.

Note : Il est possible que tout AnimationRootNode soit des nœuds ainsi que des animations. Cela signifie qu'il peut y avoir plusieurs animations dans un seul état. Quelle durée d'animation a la priorité dépend des nœuds connectés à l'intérieur. De plus, si une transition ne se réinitialise pas, la longueur restante à ce moment sera renvoyée.


StringName get_current_node() const 🔗

Renvoie l'état de l'animation jouant actuellement.

Note : Lors de l'utilisation d'un fondu enchaîné, l'état actuel change immédiatement à l'état suivant après que le fondu enchaîné commence.


float get_current_play_position() const 🔗

Renvoie la position de lecture pour l'état actuel de l'animation.


float get_fading_from_length() const 🔗

Returns the playback state length of the node from get_fading_from_node(). Returns 0 if no animation fade is occurring.


StringName get_fading_from_node() const 🔗

Renvoie l'état de départ de l'animation en cours de fondu.


float get_fading_from_play_position() const 🔗

Renvoie la position de l’élément qui a actuellement le focus. Ou renvoie 0 si aucun n'a le focus.


float get_fading_length() const 🔗

Renvoie la durée de l'animation de fondu actuelle. Renvoie 0 si aucune animation de fondu ne se produit.


float get_fading_position() const 🔗

Returns the playback position of the current fade animation. Returns 0 if no animation fade is occurring.


Array[StringName] get_travel_path() const 🔗

Renvoie le chemin de voyage actuel tel que calculé en interne par l’algorithme A*.


bool is_playing() const 🔗

Renvoie true si une animation est en lecture.


void next() 🔗

S'il y a un chemin suivant par lequel voyager ou avancer automatiquement, transitionne immédiatement de l'état actuel à l'état suivant.


void start(node: StringName, reset: bool = true) 🔗

Commence à jouer l'animation donnée.

Si reset vaut true, l'animation est jouée depuis le début.


void stop() 🔗

Arrête l’animation en cours de lecture.


void travel(to_node: StringName, reset_on_teleport: bool = true) 🔗

Transitionne de l'état actuel à un autre, en suivant le chemin le plus court.

Si le chemin ne se connecte pas depuis l'état actuel, l'animation jouera après les téléportations d'état.

Si reset_on_teleport vaut true, l'animation est jouée depuis le début lorsque la transition cause une téléportation.