SimApi Control

From SIMboxWiki
Jump to navigation Jump to search

Class SimApi_Control

Include api.Control.h
Provides core simulation services and information.

Public Class Members

NameDescription
Icon attributes.png  getCommandLineParameterValueOverloaded. Additional information is available.
Icon attributes.png  addCommandLineParameterOverloaded. Additional information is available.
Icon attributes.png  analizeSystemComponentOverloaded. Additional information is available.
Icon attributes.png  loadPluginOverloaded. Additional information is available.
Icon attributes.png  getDLLHandleOverloaded. Additional information is available.
Icon attributes.png  registerPropertyOverloaded. Additional information is available.
Icon attributes.png  getPluginInterfaceOverloaded. Additional information is available.
Icon attributes.png  setMissionNameOverloaded. Additional information is available.
Icon attributes.png  getConfigurationNameOverloaded. Additional information is available.
Icon attributes.png  initInstanceOverloaded. Additional information is available.
Icon attributes.png  resetInstanceOverloaded. Additional information is available.
Icon attributes.png  loadTerrainOverloaded. Additional information is available.
Icon attributes.png  getTerrainNameOverloaded. Additional information is available.
Icon attributes.png  getSimEngineVersionInfoOverloaded. Additional information is available.
Icon attributes.png  verifyOverloaded. Additional information is available.
Icon attributes.png  loadTerrainExOverloaded. Additional information is available.
Icon attributes.png  registerRestartablePluginOverloaded. Additional information is available.
Icon attributes.png  startSimiGon Internal Use Only.
Icon attributes.png  mainLoopSimiGon Internal Use Only.
Icon attributes.png  destroyInstanceSimiGon Internal Use Only.
Icon attributes.png  setRateSets new simulation rate (X4, X8 etc.).
Icon attributes.png  getMissionNameGets the current mission name in ANSI
Icon attributes.png  getMissionNameWGets the current mission name in UNICODE
Icon attributes.png  getSimulationStatusGets the current simulation status.
Icon attributes.png  windowSizeChangedNotifies the simulation that a certain window size has changed.
Icon attributes.png  getMainWindowHWNDGets the handle to the main simulation window.
Icon attributes.png  getMainWindowObjectGets the main simulation window object
Icon attributes.png  getMainHMENUGets the handle to the main simulation menu.
Icon attributes.png  getRateGets the current simulation rate.
Icon attributes.png  getDbPathGets the path to the simulation database directory. ANSI
Icon attributes.png  getDbPathWGets the path to the simulation database directory. UNICODE
Icon attributes.png  getResourcePathGets the path to the simulation resource directory. ANSI
Icon attributes.png  getResourcePathWGets the path to the simulation resource directory. UNICODE
Icon attributes.png  getSimulationModeSimiGon Internal Use Only.
Icon attributes.png  createInstanceSimiGon Internal Use Only.
Icon attributes.png  pausePauses the simulation.
Icon attributes.png  resumeResumes the simulation after it was paused.
Icon attributes.png  getGlobalDataSimiGon Internal Use Only.
Icon attributes.png  enablePauseToggles whether simulation pause is possible.
Icon attributes.png  isPauseEnabledDetermines whether it is possible to pause the simulation.
Icon attributes.png  getBinPathGets the path to current bin directory. ANSI
Icon attributes.png  getBinPathWGets the path to current bin directory. UNICODE
Icon attributes.png  cancelLoadingCancels the loading of the simulation.
Icon attributes.png  getConfigurationsNamesGets the names of all the loaded the extension collections. ANSI
Icon attributes.png  getConfigurationsNamesWGets the names of all the loaded the extension collections. UNICODE
Icon attributes.png  registerLogicComponentSimigon Internal Use Only.
Icon attributes.png  registerDisplayComponentSimigon Internal Use Only.
Icon attributes.png  adminPausePauses the simulation and stops the admin time.
Icon attributes.png  adminResumeResumes the simulation and resumes the admin time.
Icon attributes.png  isAdminPauseDeterminses whether the simulation is paused by calling adminPause.
Icon attributes.png  clearCommandLineClears the command line parameters
Icon attributes.png  setMainWindowSet a new simulation main window.
Icon attributes.png  getCurrentFrameNumberGets the number of simulation frames passed since simulation started.
Icon attributes.png  setMessageQueueTimerStarts a new alternative message queue
Icon attributes.png  deleteMessageQueueTimerDeletes an alternative message queue
Icon attributes.png  isMessageQueueTimerSetDetermines whether an aleternative message queue was set.
Icon attributes.png  verifyDSSimiGon Internal Use Only.
Icon attributes.png  getPauseCounterGets the number of times pause was called without resume.