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.

Polygon2D

Hérite de : Node2D < CanvasItem < Node < Object

Un polygone 2D.

Description

Un Polygon2D est défini par un ensemble de points. Chaque point est connecté au suivant, le point final étant relié au premier, ce qui résulte en un polygone fermé. Les Polygon2Ds peuvent être remplis avec de la couleur (solide ou gradient) ou une texture donnée.

Propriétés

bool

antialiased

false

Color

color

Color(1, 1, 1, 1)

int

internal_vertex_count

0

float

invert_border

100.0

bool

invert_enabled

false

Vector2

offset

Vector2(0, 0)

PackedVector2Array

polygon

PackedVector2Array()

Array

polygons

[]

NodePath

skeleton

NodePath("")

Texture2D

texture

Vector2

texture_offset

Vector2(0, 0)

float

texture_rotation

0.0

Vector2

texture_scale

Vector2(1, 1)

PackedVector2Array

uv

PackedVector2Array()

PackedColorArray

vertex_colors

PackedColorArray()

Méthodes

void

add_bone(path: NodePath, weights: PackedFloat32Array)

void

clear_bones()

void

erase_bone(index: int)

int

get_bone_count() const

NodePath

get_bone_path(index: int) const

PackedFloat32Array

get_bone_weights(index: int) const

void

set_bone_path(index: int, path: NodePath)

void

set_bone_weights(index: int, weights: PackedFloat32Array)


Descriptions des propriétés

bool antialiased = false 🔗

  • void set_antialiased(value: bool)

  • bool get_antialiased()

Si true, les bords du polygone seront anti-crénelés.


Color color = Color(1, 1, 1, 1) 🔗

La couleur de remplissage du polygone. Si texture est définie, elle sera multipliée par cette couleur. Elle sera également la couleur par défaut pour les sommets non définis dans vertex_colors.


int internal_vertex_count = 0 🔗

  • void set_internal_vertex_count(value: int)

  • int get_internal_vertex_count()

Nombre de sommets internes, utilisé pour l'UV mapping.


float invert_border = 100.0 🔗

  • void set_invert_border(value: float)

  • float get_invert_border()

Padding ajouté, appliqué à la boîte délimitante lorsque invert_enabled est défini à true. Définir cette valeur trop faiblement peut entraîner une erreur "Bad Polygon" (Mauvais polygone).


bool invert_enabled = false 🔗

  • void set_invert_enabled(value: bool)

  • bool get_invert_enabled()

Si true, le polygone sera inversé, contenant la zone en dehors des points définis et s'étendant à invert_border.


Vector2 offset = Vector2(0, 0) 🔗

Le décalage appliqué à chaque sommet.


PackedVector2Array polygon = PackedVector2Array() 🔗

La liste des sommets du polygone. Le dernier point sera connecté au premier.

Note: The returned array is copied and any changes to it will not update the original property value. See PackedVector2Array for more details.


Array polygons = [] 🔗

  • void set_polygons(value: Array)

  • Array get_polygons()

La liste des polygones, au cas où plus d'un est représenté. Chaque polygone individuel est stocké en tant que PackedInt32Array où chaque int est un index vers un point dans polygon. Si vide, cette propriété sera ignorée, et le polygone unique résultant sera composé de tous les points dans polygon, en utilisant l'ordre dans lequel ils sont stockés.


NodePath skeleton = NodePath("") 🔗

Chemin vers un nœud Skeleton2D utilisé pour les déformations basées sur le squelette de ce polygone. Si vide ou invalide, les déformations de squelette ne seront pas utilisées.


Texture2D texture 🔗

La texture de remplissage du polygone. Utilisez uv pour définir les coordonnées de texture.


Vector2 texture_offset = Vector2(0, 0) 🔗

  • void set_texture_offset(value: Vector2)

  • Vector2 get_texture_offset()

Décalage de la texture du polygone. Si définie à Vector2(0, 0), l'origine de la texture (son coin supérieur gauche) sera placée à la position du polygone.


float texture_rotation = 0.0 🔗

  • void set_texture_rotation(value: float)

  • float get_texture_rotation()

La rotation de la texture en radians.


Vector2 texture_scale = Vector2(1, 1) 🔗

Montant pour multiplier les coordonnées uv lors de l'utilisation d'une texture. Les valeurs plus grandes rendent la texture plus petite, et vice versa.


PackedVector2Array uv = PackedVector2Array() 🔗

Coordonnées de texture pour chaque sommet du polygone. Il devrait y avoir une valeur UV par sommet du polygone. S'il y en a moins, les sommets indéfinis utiliseront Vector2(0, 0).

Note: The returned array is copied and any changes to it will not update the original property value. See PackedVector2Array for more details.


PackedColorArray vertex_colors = PackedColorArray() 🔗

Couleur pour chaque sommet. Les couleurs sont interpolées entre les sommets, résultant en des gradients lisses. Il devrait y en avoir une par sommet du polygone. S'il y en a moins, les sommets indéfinis utiliseront color.

Note: The returned array is copied and any changes to it will not update the original property value. See PackedColorArray for more details.


Descriptions des méthodes

void add_bone(path: NodePath, weights: PackedFloat32Array) 🔗

Ajoute un os avec le chemin path et les poids weights spécifiés.


void clear_bones() 🔗

Retire tous les os pour ce Polygon2D.


void erase_bone(index: int) 🔗

Retire les os spécifiés de ce Polygon2D.


int get_bone_count() const 🔗

Renvoie le nombre d'os dans ce Polygon2D.


NodePath get_bone_path(index: int) const 🔗

Renvoie le chemin d’accès au nœud associé à l’os spécifié.


PackedFloat32Array get_bone_weights(index: int) const 🔗

Renvoie les valeurs de poids de l'os spécifié.


void set_bone_path(index: int, path: NodePath) 🔗

Définit le chemin du nœud associé avec l'os spécifié.


void set_bone_weights(index: int, weights: PackedFloat32Array) 🔗

Définit les valeurs de poids pour l'os spécifié.