WaitForFloat Method

VirtualUserScript WaitForFloat Method

C# API

Returns a float stored in the data dictionary. If the float is not yet in the data dictionary, then this method will wait for up to the timeout for the float to be added. For example, a foreground script may need to wait for a background script to put a float into the data dictionary before continuing.

Namespace: Facilita.Fc.Runtime
Assembly: fc_clr (in fc_clr.dll) Version: 9.5.8.37

Syntax

C++

Copy to Clipboard Print

public float WaitForFloat(
	string key,
	TimeSpan timeout
)

public float WaitForFloat(
	string key,
	TimeSpan timeout
)

Parameters

key: Type: System String
The key to be looked up in the dictionary.

timeout: Type: System TimeSpan
The maximum amount of time to wait for the object to be added to the dictionary.

Return Value

A float value held in the dictionary.

Exceptions

Exception	Condition
TimeoutException	The float was not added to the dictionary before the timeout period elapsed.