blockly > Variablen > getVariable
Funktion „Variables.getVariable()“
Eine Variable im angegebenen Arbeitsbereich suchen. Die Suche wird immer zuerst im Hauptarbeitsbereich und dann im Ausklapparbeitsbereich durchgeführt. Die Suche nach ID wird immer der Suche nach Name + Typ vorgezogen.
Unterschrift:
export declare function getVariable(workspace: Workspace, id: string | null, opt_name?: string, opt_type?: string): IVariableModel<IVariableState> | null;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| Arbeitsbereich | Workspace | Der Arbeitsbereich, in dem nach der Variablen gesucht werden soll. Es kann sich um einen Ausklapp-Arbeitsbereich oder den Hauptarbeitsbereich handeln. |
| id | string | null | Die ID, mit der die Variable ermittelt werden soll, oder „null“. |
| opt_name | String | Optional: Der String, mit dem die Variable gesucht werden soll. Wird nur verwendet, wenn die Suche nach ID fehlschlägt. |
| opt_type | String | Optional: Der Typ, der zum Nachschlagen der Variablen verwendet werden soll. Wird nur verwendet, wenn die Suche nach ID fehlschlägt. |
Gibt zurück:
IVariableModel<IVariableState> | null
Die Variable, die der angegebenen ID oder der Kombination aus Name und Typ entspricht, oder „null“, wenn keine gefunden wird.