blockly > Variables > getVariable

Função Variables.getVariable()

Procura uma variável no espaço de trabalho especificado. Sempre procura no espaço de trabalho principal antes de procurar no espaço de trabalho suspenso. Sempre prefira a pesquisa por ID em vez da pesquisa por nome e tipo.

Signature:

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

Parâmetros

Parâmetro Tipo Descrição
espaço de trabalho Workspace O espaço de trabalho em que a variável será pesquisada. Pode ser um espaço de trabalho suspenso ou principal.
id string | null O ID a ser usado para procurar a variável ou "null".
opt_name string (Opcional) A string a ser usada para procurar a variável. Só é usado se a pesquisa por ID falhar.
opt_type string (Opcional) O tipo a ser usado para pesquisar a variável. Só é usado se a pesquisa por ID falhar.

Retorna:

IVariableModel<IVariableState> | null

A variável correspondente à combinação de ID ou nome + tipo especificada ou "null" se não for encontrada.