fsVarsOVarGet

The fsVarsOVarGet function can be used to get the value of a specific OVar.

 

Syntax

FsVarError fsVarsOVarGet(
    FsOVarId oVarId,
    FsUnitId unitId,
    double* result,
    FsObjectId target
);

 

Parameters

Parameters	Description
iVarId	The ID of an OVar (found using fsVarsGetOVarId or fsVarsRegisterOVar).
unitId	The ID of a unit (found using fsVarsGetUnitId).
result	The variable that will receive the value of the OVar (if all others parameters are correct).
target	The ID of the object from which the variable is being retrieved. Possible targets are: FS_OBJECT_ID_USER_AIRCRAFT FS_OBJECT_ID_USER_AVATAR FS_OBJECT_ID_USER_CURRENT Default: FS_OBJECT_ID_USER_AIRCRAFT.

 

Return Values

The function returns FsVarError, where 0 means there is no error (in which case, the value of the OVar has been set in result).

 

Example

FsUnitId unitId = fsVarsGetUnitId("DEGREES");
FsOVarId oVarId = fsVarsRegisterOVar("Toto", "LIGHTING:EMISSIVE");
double result = 0;
if (fsVarsOVarGet(oVarId, unitId, &result) == FS_VAR_ERROR_NONE)
{
    // valid
}
else
{
    // error
}