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.

SkeletonModificationStack2D

Expérimental : This class may be changed or removed in future versions.

Hérite de : Resource < RefCounted < Object

Une ressource qui contient une pile de SkeletonModification2Ds.

Description

Cette ressource est utilisée par le Skeleton et possède une pile de SkeletonModification2Ds.

Cela contrôle l'ordre des modifications et comment elles sont appliquées. L'ordre des modifications est particulièrement important pour les configurations d'IK sur le corps entier, car vous devez exécuter les modifications dans le bon ordre pour obtenir les résultats souhaités. Par exemple, vous voulez exécuter une modification sur la colonne vertébrale avant les bras sur un squelette humanoïde.

Cette ressource contrôle la force avec laquelle toutes les modifications sont appliquées au Skeleton2D.

Propriétés

bool

enabled

false

int

modification_count

0

float

strength

1.0

Méthodes

void

add_modification(modification: SkeletonModification2D)

void

delete_modification(mod_idx: int)

void

enable_all_modifications(enabled: bool)

void

execute(delta: float, execution_mode: int)

bool

get_is_setup() const

SkeletonModification2D

get_modification(mod_idx: int) const

Skeleton2D

get_skeleton() const

void

set_modification(mod_idx: int, modification: SkeletonModification2D)

void

setup()


Descriptions des propriétés

bool enabled = false 🔗

  • void set_enabled(value: bool)

  • bool get_enabled()

Si true, les modifications dans la pile seront appelées. Ceci est géré automatiquement par le nœud Skeleton2D.


int modification_count = 0 🔗

  • void set_modification_count(value: int)

  • int get_modification_count()

Le nombre de modifications dans la pile.


float strength = 1.0 🔗

  • void set_strength(value: float)

  • float get_strength()

La force d'interpolation des modifications dans la pile. Une valeur de 0 fera que les modifications ne seront pas appliquées, une force de 0.5 fera qu'elles seront appliquées à moitié, et une force de 1 permettra d'appliquer pleinement les modifications et de redéfinir les poses des Bone2D du Skeleton2D.


Descriptions des méthodes

void add_modification(modification: SkeletonModification2D) 🔗

Ajoute à la pile le SkeletonModification2D donné.


void delete_modification(mod_idx: int) 🔗

Supprime la SkeletonModification2D à la position d'index mod_idx, si elle existe.


void enable_all_modifications(enabled: bool) 🔗

Active toutes les SkeletonModification2Ds dans la pile.


void execute(delta: float, execution_mode: int) 🔗

Exécute tous les SkeletonModification2Ds dans la pile qui utilisent le même mode d'exécution que le mode passé execution_mode, à partir de l'index 0 jusqu'à l'index modification_count.

Note : L'ordre des modifications peut être important en fonction des modifications. Par exemple, les modifications sur une colonne vertébrale doivent s'opérer avant les modifications sur les bras afin d'obtenir des résultats appropriés.


bool get_is_setup() const 🔗

Renvoie un booléen indiquant si la pile de modifications est installée et peut être exécutée.


SkeletonModification2D get_modification(mod_idx: int) const 🔗

Renvoie la SkeletonModification2D à l'index transmis, mod_idx.


Skeleton2D get_skeleton() const 🔗

Renvoie le nœud Skeleton2D auquel la SkeletonModificationStack2D est liée.


void set_modification(mod_idx: int, modification: SkeletonModification2D) 🔗

Définit la modification à l'index mod_idx à la modification transmise, modification.


void setup() 🔗

Met en place la pile de modifications pour qu'elle puisse exécuter. Cette fonction devrait être appelée par Skeleton2D et ne devrait pas être appelée manuellement à moins que vous ne sachiez ce que vous faites.