FSUIPC Client DLL
.NET interface for FSUIPC
MSFSVariableServices Class Reference

Allows direct access to LVars and HVars via John Dowson's WASM module. Only works for MSFS. You and your users must have John's WASM module installed. John's FSUIPC_WAPID.dll must also be accessible from your .exe. Either include it in your distribution to be in the same folder as your exe file. OR place the DLL in a folder included in the windows PATH. More...

Static Public Member Functions

static void Init ()
 Initialises the MSFSVariableServices.
 
static void Start ()
 Tells the WASM module to begin getting data from the Flight Sim.
 
static void Stop ()
 Tells the WASM module to stop getting data from the Flight Sim.
 
static void Reload ()
 Tells the WASM module to rescan for variables. NOTE: This will first delete all the current FsLVar and FsHVar instances from MSFSVariableServices.
 
static void LogHVars ()
 Tells the WASM module to write a log entry for all known HVars. Handle the OnLogEntryReceived to receive these log entries.
 
static void LogLVars ()
 Tells the WASM module to write a log entry for all known LVars. Handle the OnLogEntryReceived to receive these log entries.
 
static bool CreateLVar (string Name, double Value)
 Creates a new LVar.
 
static void ExecuteCalculatorCode (string Code)
 Tells the WASM module to executes the code passed in.
 

Properties

static int LVARUpdateFrequency [get, set]
 The number of times per second that the WAPID DLL will get the LVar values from the WASM Module. Normally you do not need to set this as the WASM module has an internal update frequency. You only need to set this if the WASM module has it's update frequency set to 0.
 
static LOGLEVEL LogLevel [set]
 Defines how detailed the log generated by the WASM plugin should be.
 
static int SimConfigConnection [set]
 Specifies the SimConnect Connection to use as defined in the WASM config file.
 
static bool IsRunning [get]
 Returns true if the WASM service is connected and running correctly.
 
static HVarCollection HVars [get]
 Returns a collection of all the HVars currently in existence.
 
static LVarCollection LVars [get]
 Returns a collection of all the LVars currently in existence.
 
static LVarCollection LVarsChanged [get]
 Returns a collection of all the LVars whose values where changed during the last RefreshData() call.
 

Events

static EventHandler< LogEventArgsOnLogEntryReceived
 Event fired every time a log entry is received from the WASM plug in.
 
static EventHandler OnValuesChanged
 Event fired when at least 1 of the LVar values has changed.
 
static EventHandler OnVariableListChanged
 Event fired when the list of available variables has changed.
 

Detailed Description

Allows direct access to LVars and HVars via John Dowson's WASM module. Only works for MSFS. You and your users must have John's WASM module installed. John's FSUIPC_WAPID.dll must also be accessible from your .exe. Either include it in your distribution to be in the same folder as your exe file. OR place the DLL in a folder included in the windows PATH.

Member Function Documentation

◆ CreateLVar()

static bool CreateLVar ( string Name,
double Value )
inlinestatic

Creates a new LVar.

Parameters
NameThe name of the new LVar
ValueThe value to set for the new LVar
Returns
True if the LVar was created.

◆ ExecuteCalculatorCode()

static void ExecuteCalculatorCode ( string Code)
inlinestatic

Tells the WASM module to executes the code passed in.

Parameters
CodeThe code to execute