Aller au contenu principal

Définir la valeur d’un contrôle (ui_element.set_value)

Cette fonction est disponible à partir des versions postérieures au 20260507

Déclaration​

etat, info_ou_erreur = ui_element.set_value(selecteur_ou_element, valeur [, options ])

Paramètres​

  • selecteur_ou_element
    type table, peut être un sélecteur, un élément renvoyé par une requête ou une table de coordonnées { x = coord_x, y = coord_y }.
  • valeur
    type texte, entier, réel ou booléen, valeur du contrôle à définir.
  • options
    paramètre facultatif de type table ; consultez la description des options générales.

Valeur renvoyée​

  • etat
    type booléen, vaut true en cas de réussite et nil en cas d’échec.
  • info_ou_erreur
    type table contenant les informations de l’action en cas de réussite, ou texte décrivant la cause de l’échec.

Description​

Cette interface convient aux contrôles qui prennent en charge la définition directe d’une valeur. Pour un curseur, vous pouvez essayer de fournir un réel compris entre 0.0 ~ 1.0, ou un texte de pourcentage tel que "50%". Si le contrôle cible ne change pas réellement, l’interface peut renvoyer nil, "value unchanged".

Exemple​

local ui_element = require("ui_element")

ui_element.set_value({
    role = "slider",
    index = 1,
}, 0.5)