# Uses of Class
com.mouseviator.fsuipc.FSUIPC

Packages that use FSUIPC
Package | Description
--- | ---
com.mouseviator.fsuipc | This package contains two main classes that implement the Java FSUIPC SDK.
com.mouseviator.fsuipc.helpers | This package (and sub-packages) contains helper classes to get data requests for use with `FSUIPC` class to gather various sim data.

- ## Uses of FSUIPC in com.mouseviator.fsuipc

  Methods in com.mouseviator.fsuipc that return FSUIPC
  Modifier and Type | Method | Description
  --- | --- | ---
  `static FSUIPC` | FSUIPC.`getInstance()` |

- ## Uses of FSUIPC in com.mouseviator.fsuipc.helpers

  Methods in com.mouseviator.fsuipc.helpers with parameters of type FSUIPC
  Modifier and Type | Method | Description
  --- | --- | ---
  `boolean` | LVarHelper.`createLVar​(java.lang.String lvar, int lvarValueOffset, java.lang.Object lvarValue, LVarHelper.LVarValueFormat lvarValueFormat, FSUIPC fsuipc)` | This is helper function to create Lvar.
  `MacroHelper.MacroResult` | MacroHelper.`executeMacro​(java.lang.String macro, int macroParam, FSUIPC fsuipc, boolean continual)` | This function will create requests required to execute a macro by FSUIPC.Executing a macro requires 2 requests.One is the macro parameter request - integer value written at offset 0x0D6C.The other is the macro execute request - written at offset 0x0D70 and it contains the String in the format "macro file:macro name".
  `MacroHelper.MacroResult` | MacroHelper.`executeMacro​(java.lang.String macro, FSUIPC fsuipc, boolean continual)` | This function will create requests required to execute a macro by FSUIPC.
  `MacroHelper.MacroResult` | MacroHelper.`executeMacro​(java.lang.String macroFile, java.lang.String macroName, int macroParam, FSUIPC fsuipc, boolean continual)` | This function will create requests required to execute a macro by FSUIPC.Executing a macro requires 2 requests.One is the macro parameter request - integer value written at offset 0x0D6C.
  `MacroHelper.MacroResult` | MacroHelper.`executeMacro​(java.lang.String macroFile, java.lang.String macroName, FSUIPC fsuipc, boolean continual)` | This function will create requests required to execute a macro by FSUIPC.Executing a macro requires 2 requests.
  `LuaHelper.LuaResult` | LuaHelper.`lua​(java.lang.String luaProgram, int luaParam, FSUIPC fsuipc)` | This function will construct data requests required by FSUIPC to run specified lua program (Performs the `LuaHelper.LuaControlRequestCommand.LUA` command.
  `LuaHelper.LuaResult` | LuaHelper.`lua​(java.lang.String luaProgram, FSUIPC fsuipc)` | This function will construct data requests required by FSUIPC to run specified lua program (Performs the `LuaHelper.LuaControlRequestCommand.LUA` command.
  `LuaHelper.LuaResult` | LuaHelper.`luaClear​(java.lang.String luaProgram, int luaFlag, FSUIPC fsuipc)` | This function will construct data requests required by FSUIPC to clear flag for specified lua program (Performs the `LuaHelper.LuaControlRequestCommand.LUA_CLEAR` command.
  `LuaHelper.LuaResult` | LuaHelper.`luaDebug​(java.lang.String luaProgram, int luaParam, FSUIPC fsuipc)` | This function will construct data requests required by FSUIPC to run and debug specified lua program (Performs the `LuaHelper.LuaControlRequestCommand.LUA_DEBUG` command.
  `LuaHelper.LuaResult` | LuaHelper.`luaDebug​(java.lang.String luaProgram, FSUIPC fsuipc)` | This function will construct data requests required by FSUIPC to run and debug specified lua program (Performs the `LuaHelper.LuaControlRequestCommand.LUA_DEBUG` command.
  `LuaHelper.LuaResult` | LuaHelper.`luaKill​(java.lang.String luaProgram, FSUIPC fsuipc)` | This function will construct data requests required by FSUIPC to kill specified lua program (Performs the `LuaHelper.LuaControlRequestCommand.LUA_KILL` command.
  `LuaHelper.LuaResult` | LuaHelper.`luaRequest​(java.lang.String luaProgram, int luaParam, LuaHelper.LuaControlRequestCommand luaCommand, FSUIPC fsuipc, boolean continual)` | This function will construct data requests required by FSUIPC to perform given operation with given lua program.
  `LuaHelper.LuaResult` | LuaHelper.`luaSet​(java.lang.String luaProgram, int luaFlag, FSUIPC fsuipc)` | This function will construct data requests required by FSUIPC to set flag for specified lua program (Performs the `LuaHelper.LuaControlRequestCommand.LUA_SET` command.
  `LuaHelper.LuaResult` | LuaHelper.`luaToggle​(java.lang.String luaProgram, int luaFlag, FSUIPC fsuipc)` | This function will construct data requests required by FSUIPC to toggle flag for specified lua program (Performs the `LuaHelper.LuaControlRequestCommand.LUA_SET` command.
  `LuaHelper.LuaResult` | LuaHelper.`luaValue​(java.lang.String luaProgram, int luaParam, FSUIPC fsuipc)` | This function will construct data requests required by FSUIPC to send parameter to specified lua program (Performs the `LuaHelper.LuaControlRequestCommand.LUA_VALUE` command.
  `LVarHelper.LVarResult` | LVarHelper.`readLVar​(java.lang.String lvar, int targetOffset, LVarHelper.LVarValueFormat lvarValueFormat, FSUIPC fsuipc, boolean continual)` | This is helper function to read Lvar.
  `boolean` | LVarHelper.`writeLVar​(java.lang.String lvar, int lvarValueOffset, java.lang.Object lvarValue, LVarHelper.LVarValueFormat lvarValueFormat, FSUIPC fsuipc, boolean continual)` | This is helper function to write Lvar.