Propriétés

Defold expose des propriétés pour les objets de jeu (game objects), les composants (components) et les nœuds d’interface graphique, que vous pouvez lire, définir et animer. Les types de propriétés suivants sont disponibles :

• Transformations des objets de jeu définies par le système (position, rotation et échelle) et propriétés propres aux composants (par exemple, la taille en pixels d’un sprite ou la masse d’un objet de collision)
• Propriétés des composants script définies par l’utilisateur dans des scripts Lua (consultez la documentation des propriétés de script pour plus de détails)
• Propriétés des nœuds d’interface graphique
• Constantes de shader définies dans les shaders et les fichiers de matériau (consultez la documentation des matériaux pour plus de détails)

Les propriétés numériques affichent une poignée de déplacement lorsque vous survolez leur champ de saisie. Vous pouvez augmenter ou diminuer leur valeur en faisant glisser la poignée respectivement vers la droite ou la gauche, ou vers le haut ou le bas.

Selon l’emplacement d’une propriété, vous y accédez au moyen d’une fonction générique ou d’une fonction propre à cette propriété. De nombreuses propriétés peuvent être animées automatiquement. Il est vivement recommandé d’animer les propriétés à l’aide du système intégré plutôt que de les manipuler vous-même (dans une fonction update()), aussi bien pour les performances que pour la simplicité d’utilisation.

Les propriétés composites de type vector3, vector4 ou quaternion exposent également leurs sous-composantes (x, y, z et w). Vous pouvez accéder aux composantes individuellement en ajoutant au nom un point (.) suivi du nom de la composante. Par exemple, pour définir la composante x de la position d’un objet de jeu :

-- Set the x position of "game_object" to 10.
go.set("game_object", "position.x", 10)

Les fonctions go.get(), go.set() et go.animate() prennent une référence comme premier paramètre et un identifiant de propriété comme deuxième paramètre. La référence identifie l’objet de jeu ou le composant et peut être une chaîne de caractères, une valeur hachée ou une URL. Les URL sont expliquées en détail dans le manuel d’adressage. L’identifiant de propriété est une chaîne de caractères ou une valeur hachée qui désigne la propriété :

-- Set the x-scale of the sprite component
local url = msg.url("#sprite")
local prop = hash("scale.x")
go.set(url, prop, 2.0)

Pour les nœuds d’interface graphique, le nœud est fourni comme premier paramètre soit à une fonction propre à une propriété, soit aux fonctions génériques gui.get() et gui.set() :

-- Get the color of the button
local node = gui.get_node("button")
local color = gui.get_color(node)
local same_color = gui.get(node, "color")
gui.set(node, "color.x", 1)

Propriétés des objets de jeu et des composants

Tous les objets de jeu et certains types de composants possèdent des propriétés que vous pouvez lire et manipuler à l’exécution. Lisez ces valeurs avec go.get() et modifiez-les avec go.set(). Selon le type de valeur de la propriété, vous pouvez animer les valeurs avec go.animate(). Un petit nombre de propriétés sont en lecture seule.

get

Peut être lue avec go.get().

get+set

Peut être lue avec go.get() et modifiée avec go.set(). Les valeurs numériques peuvent être animées avec go.animate().

Propriétés des objets de jeu

Propriétés des composants sprite

Propriétés des composants objet de collision

Propriétés des composants modèle (3D)

Propriétés des composants label

Propriétés des nœuds d’interface graphique

Les nœuds d’interface graphique possèdent des fonctions de lecture et d’écriture propres à chaque propriété, comme gui.get_position() et gui.set_position(). Les propriétés intégrées répertoriées ci-dessous peuvent également être lues et modifiées avec gui.get(node, property) et gui.set(node, property, value). D’autres valeurs des nœuds peuvent encore nécessiter leurs fonctions dédiées. Les constantes de matériau des nœuds d’interface graphique utilisent également les fonctions génériques. Pour accéder à une composante d’une propriété vectorielle, ajoutez son nom, par exemple gui.set(node, "color.x", 1).

Les fonctions génériques et les fonctions propres aux propriétés n’utilisent pas toujours des types de valeurs identiques. gui.get() renvoie un vector4 pour les propriétés complètes position, scale, size et euler, tandis que les fonctions correspondantes propres à ces propriétés renvoient un vector3. gui.set() accepte un vector3 ou un vector4 pour ces propriétés. La propriété générique rotation utilise un quaternion ; utilisez euler pour définir la rotation en degrés.

• position (ou gui.PROP_POSITION)
• rotation (ou gui.PROP_ROTATION)
• euler (ou gui.PROP_EULER)
• scale (ou gui.PROP_SCALE)
• color (ou gui.PROP_COLOR)
• outline (ou gui.PROP_OUTLINE)
• shadow (ou gui.PROP_SHADOW)
• size (ou gui.PROP_SIZE)
• fill_angle (ou gui.PROP_FILL_ANGLE)
• inner_radius (ou gui.PROP_INNER_RADIUS)
• leading (ou gui.PROP_LEADING)
• tracking (ou gui.PROP_TRACKING)
• slice9 (ou gui.PROP_SLICE9)

Toutes les valeurs de couleur sont encodées dans un vector4 dont les composantes correspondent aux valeurs RGBA :

x

La composante rouge

y

La composante verte

z

La composante bleue

w

La composante alpha

Propriétés des nœuds d’interface graphique