blockly > Variables > getVariable

Fonction Variables.getVariable()

Recherchez une variable dans l'espace de travail donné. Recherche toujours dans l'espace de travail principal avant de rechercher dans l'espace de travail développé. La recherche par ID est toujours privilégiée par rapport à la recherche par nom et type.

Signature :

export declare function getVariable(workspace: Workspace, id: string | null, opt_name?: string, opt_type?: string): IVariableModel<IVariableState> | null;

Paramètres

Paramètre Type Description
espace de travail Workspace Espace de travail dans lequel rechercher la variable. Il peut s'agir d'un espace de travail développé ou d'un espace de travail principal.
id string | null ID à utiliser pour rechercher la variable, ou valeur nulle.
opt_name chaîne (Facultatif) Chaîne à utiliser pour rechercher la variable. Utilisé uniquement si la recherche par ID échoue.
opt_type chaîne (Facultatif) Type à utiliser pour rechercher la variable. Utilisé uniquement si la recherche par ID échoue.

Renvoie :

IVariableModel<IVariableState> | null

Variable correspondant à l'ID ou à la combinaison nom + type donnés, ou valeur nulle si aucun résultat n'est trouvé.