fsVarsOVarSet

The fsVarsOVarSet function can be used to set the value of a specific OVar.

 

Syntax

FsVarError fsVarsOVarSet(
    FsOVarId oVarId,
    FsUnitId unitId,
    double value,
    FsObjectId target
);

 

Parameters

Parameters	Description
oVarId	The ID of an OVar (found using fsVarsGetOVarId or fsVarsRegisterOVar).
unitId	The ID of a unit (found using fsVarsGetUnitId).
value	The new value of the variable.
target	The ID of the object on which the variable is being set. 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.

 

Example

FsUnitId unitId = fsVarsGetUnitId("DEGREES");
FsOVarId oVarId = fsVarsRegisterOVar("Toto", "LIGHTING:EMISSIVE");
double value = 8;
if (fsVarsOVarSet(oVarId, unitId, value) == FS_VAR_ERROR_NONE)
{
    // valid
}
else
{
    // error
}