-
-
Notifications
You must be signed in to change notification settings - Fork 11
Constants Reference
Installation Paths (Constants.ahk)
The following constants may be used to refer to all the relevant locations of the Simulator Controller distribution.
kHomeDirectory, kResourcesDirectory, kSourcesDirectory, kFrameworkDirectory, kLibrariesDirectory, kPluginsDirectory, kBinariesDirectory, kConfigDirectory, kRulesDirectory, kGrammarsDirectory, kTranslationsDirectory
All these constants define paths pointing to a specific folder in the Simulator Controller distribution. In deviation to Windows standards, the paths contain a trailing backslash, since in allmost all cases, a filename will be concatenated to one of these constants in order to access this file.
kSplashMediaDirectory, kScreenImagesDirectory, kButtonBoxImagesDirectory, kStreamDeckImagesDirectory
Paths for graphical and audio resources contained in the Simulator Controller distribution.
kUserHomeDirectory, kUserConfigDirectory, kUserRulesDirectory, kUserGrammarsDirectory, kUserTranslationsDirectory, kUserSplashMediaDirectory, kUserScreenImagesDirectory, kUserPluginsDirectory, kLogsDirectory, kTempDirectory, kDatabaseDirectory
A special folder Simulator Controller will be created in the user Documents folder. It will contain various subfolders for adding user-specific extensions or substitutions (media, plugins, ...), and for storing configuration and log files.
Paths for the most important configuration files used by Simulator Controller.
Global Configuration Map (Constants.ahk)
One global configuration map exists for Simulator Controller, which define the capabilities, the controller mapping and the configuration of all active plugins.
The global configuration map, which is read from kSimulatorConfigurationFile. The content is fully maintained by the configuration tool.
Log Levels (Debug.ahk)
See the dcoumentation about Debugging & Logging for more information.
Define the various log levels used by the logging functions. These are numerical values where kLogInfo < kLogWarn < kLogCritical < kLogOff.
Controller Function Types (Constants.ahk)
Used to identify the different types of hardware controller functions in a configuration map. See the subclasses of Function for reference.
All currently defined controller function types.
Simulation Session Types (SimulatorPlugin.ahk)
Thse constants define the different session types, a given simulation might support. See the class SimulatorPlugin and its subclasses for more information about simulations and sessions.
kSessionFinished, kSessionPaused, kSessionOther, kSessionPractice, kSessionQualification, kSessionRace
All currently defined and supported simulator session types. kSessionFinished = 0 is special in the sense, that there is no current session, as is kSessionPaused = -1, which means, there is a current session, but the simulation is paused at the moment.
Messsaging Types (Messages.ahk)
Delivery method types used to supply to sendMessage.
These constants define the various delivery methods for messages send by the function sendMessage.
Miscellaneous Constants (Constants.ahk)
Additional constants used by Simulator Controller.
May be used by functions to denote a default value for optional parameters that might be boolean values.
Similar to kUndefined, denotes an undefined value. kNull typically is used for data contexts.
The current version of Simulator Controller according to the VERSION document in the root folder.
If this is true, most applications of Simulator Controller will adopt accordingly and will not use any splash screens or other visual or audio feedback.
Miscellaneous constants, which define string representations for often used code constants.
The names of the different applications (without the ".exe" extension). Foreground applications can have an UI, background applications will normally execute without an UI.
The names of all Race Assistants, for example ["Driving Coach", "Race Engineer", ...].
Simulator Controller - 2024 by Oliver Juwig (TheBigO), Creative Commons - BY-NC-SA
- Quick Start
- Installation
- Configuration
- Splash Screen Editor
- Translations Editor
- Controller Layout Editor
- System
- Tactile Feedback
- Motion Feedback
- Pedal Calibration
- Driving Coach
- Race Engineer
- Race Strategist
- Race Spotter
- Team Server
- ACC - Assetto Corsa Competizione
- AC - Assetto Corsa
- IRC - iRacing
- RF2 - rFactor 2
- LMU - Le Mans Ultimate
- R3E - RaceRoom Racing Experience
- AMS2 - Automobilista 2
- PCARS2 - Project CARS 2
- Integration
- Introduction
- Describing Setup Issues
- Understanding the Recommendations
- How it works
- Managing Car Setups
- Extending and Customizing
- Introduction
- Installation
- Interacting with Jona
- Racing with Jona
- Session Database
- Technical Information
- Troubleshooting
- Introduction
- Installation
- Interacting with Cato
- Racing with Cato
- Race Reports
- Practice Center
- Strategy Workbench
- Strategy Handling
- Technical Information
- Troubleshooting
- Introduction
- Installation
- Interacting with Elisa
- Alerts & Information
- Simulator Integration
- Track Mapping
- Track Automations
- Introduction
- Installation & Configuration
- Managing teams
- Preparing a team session
- Running a team session
- Race Center
- Server Administration
- How it works
- Troubleshooting