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.

SkeletonModification2D

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

Hérite de : Resource < RefCounted < Object

Hérité par : SkeletonModification2DCCDIK, SkeletonModification2DFABRIK, SkeletonModification2DJiggle, SkeletonModification2DLookAt, SkeletonModification2DPhysicalBones, SkeletonModification2DStackHolder, SkeletonModification2DTwoBoneIK

Classe de base pour les ressources qui fonctionnent sur des Bone2Ds dans un Skeleton2D.

Description

Cette ressource fournit une interface qui peut être étendue pour que du code fonctionne sur des nœuds Bone2D dans un Skeleton2D puisse être mélangé et associé ensemble pour créer des interactions complexes.

Ceci est utilisé pour fournir à Godot une solution de cinématique inverse flexible et puissante qui peut être adaptée pour de nombreuses utilisations différentes.

Propriétés

bool

enabled

true

int

execution_mode

0

Méthodes

void

_draw_editor_gizmo() virtual

void

_execute(delta: float) virtual

void

_setup_modification(modification_stack: SkeletonModificationStack2D) virtual

float

clamp_angle(angle: float, min: float, max: float, invert: bool)

bool

get_editor_draw_gizmo() const

bool

get_is_setup() const

SkeletonModificationStack2D

get_modification_stack()

void

set_editor_draw_gizmo(draw_gizmo: bool)

void

set_is_setup(is_setup: bool)


Descriptions des propriétés

bool enabled = true 🔗

  • void set_enabled(value: bool)

  • bool get_enabled()

Si true, la fonction _execute() de la modification sera appelée par SkeletonModificationStack2D.


int execution_mode = 0 🔗

  • void set_execution_mode(value: int)

  • int get_execution_mode()

Le mode d'exécution pour la modification. Cela indique à la pile de modifications quand exécuter la modification. Certaines modifications ont des paramètres qui ne sont disponibles que dans certains modes d'exécution.


Descriptions des méthodes

void _draw_editor_gizmo() virtual 🔗

Utilisé pour dessiner des manipulateur de modification uniquement dans l'éditeur. Cette fonction ne sera appelée que dans l'éditeur Godot et peut être redéfinie pour dessiner des manipulateurs personnalisés.

Note : Vous aurez besoin d'utiliser le Skeleton2D de SkeletonModificationStack2D.get_skeleton() et ses fonctions de dessin, car la ressource SkeletonModification2D ne peut pas dessiner seule.


void _execute(delta: float) virtual 🔗

Exécute la modification donnée. C'est ici que la modification effectue la fonction pour laquelle elle est conçue.


void _setup_modification(modification_stack: SkeletonModificationStack2D) virtual 🔗

Appelée lorsque la modification est mise en place. C'est ici que la modification effectue son initialisation.


float clamp_angle(angle: float, min: float, max: float, invert: bool) 🔗

Prends un angle et le borne de sorte à ce qu'il soit à l'intérieur de la plage min et max. invert bornera l'angle de manière inverse, le bornant en dehors des bornes données.


bool get_editor_draw_gizmo() const 🔗

Renvoie si cette modification appellera _draw_editor_gizmo() dans l'éditeur Godot pour dessiner des manipulateurs spécifiques à la modification.


bool get_is_setup() const 🔗

Renvoie si cette modification a été installée avec succès ou non.


SkeletonModificationStack2D get_modification_stack() 🔗

Renvoie le SkeletonModificationStack2D auquel cette modification est liée. Grâce à la pile de modification, vous pouvez accéder au Skeleton2D sur lequel cette modification opère.


void set_editor_draw_gizmo(draw_gizmo: bool) 🔗

Définit si cette modification appellera _draw_editor_gizmo() dans l'éditeur Godot pour dessiner des manipulateurs spécifiques à la modification.


void set_is_setup(is_setup: bool) 🔗

Vous permet de configurer manuellement l'état de configuration de la modification. Cette fonction ne devrait être utilisée que rarement, puisque la SkeletonModificationStack2D à laquelle la modification est liée devrait gérer la mise en place de la modification.