Data Structures

Here are the data structures with brief descriptions:

[detail level 1234]

►NAngelOgre	OGRE-AngelScript bindings; Actually named Ogre in the scripts, just changed for docs to separate things
CAnimationState	Represents a single named skeletal animation track present in the mesh
CAnimationStateSet	A manager for skeletal animation tracks in the entity
CEntity	Defines an instance of a discrete, movable object based on a Mesh
CMovableObject	Abstract class defining a movable object in a scene
CNode
CRoot	Singleton - use Ogre::Root::getSingleton() to retrieve instance
CSceneManager	Encapsulates everything renderable by OGRE - use game.getSceneManager() to get it
CSceneNode	Class representing a node in the scene graph
CTextureManager	Singleton - use Ogre::TextureManager::getSingleton() to retrieve instance
CTexturePtr
►NForests
CRandomTreeLoader
►NHydrax
►NModule
CModule	Base module class, Override it for create different ways of create water noise
►CProjectedGrid	Hydrax projected grid module
COptions	Struct wich contains Hydrax projected grid module options
►CRadialGrid	Hydrax radial grid module
COptions	Struct wich contains Hydrax simple grid module options
►CSimpleGrid	Hydrax simple grid module
COptions	Struct wich contains Hydrax simple grid module options
►NNoise
►CFFT	FFT noise module class
COptions	Struct wich contains fft noise module options
CNoise	Base noise class, Override it for create different ways of create water noise
►CPerlin	Perlin noise module class
COptions	Struct wich contains Perlin noise module options
CPressurePoint	A PressurePoint defined by the origen, pressure pulse, Maximum time of perturbation and wave longitude. Pressure points can be used to add object falling at sea, or, adding sucessive point, to simulate ship Kelvin wakes
CReal	This class is a sea elevation module that combines several effects: Waves, defined by direction, amplitude, period and optionally, phase. Perlin noise, used to randomize the sea surface. Pressure points, used to create puntual waves
CWave	A wave defined by the direction, amplitude, period, and optionally phase
CCfgFileManager	Class to load/save all Hydrax options from/to a config file
CDecal	Decal class
CDecalsManager	Decals manager class
►CGodRaysManager	Underwater god rays manager class God rays
CDepthMapListener	GodRaysManager::DepthMapListener class
CGPUNormalMapManager	Class to manager GPU normal maps
►CHydrax	Main Hydrax class
CDeviceListener	Device listener
►CImage	Class for store variable channels of an image
CPixel	Pixel structure
►CMaterialManager	Material/Shader manager class
COptions	Material options
CUnderwaterCompositorListener	Underwater compositor listener
CMath	Math class with some help funtions
►CMesh	Class wich contains all funtions/variables related to Hydrax water mesh
COptions	Base Hydrax mesh options
CPOS_NORM_UV_VERTEX	Vertex struct for position, normals and uv data
CPOS_NORM_VERTEX	Vertex struct for position and normals data
CPOS_UV_VERTEX	Vertex struct for position and uv data
CPOS_VERTEX	Vertex struct for position data
►CRttManager	Rtt's manager class
CCDepthListener
CCDepthReflectionListener
CCGPUNormalMapListener
►CCReflectionListener	RttManager::CReflectionListener class
CCReflectionQueueListener	Used for avoid near clip plane clipping during the reflection Rtt
CCRefractionListener	RttManager::CRefractionListener class
CRttListener	Rtt Listener class
CRttOptions	Rtt options struct
CSize	Struct wich contains an especific width and height value
CTextureManager	Class for manager Normal maps
►NMyGUI
CRTTLayer
►NOgre
►CExtinguishableFireAffector	This class defines a ParticleAffector which deflects particles
CCmdIntensity	Command object for intensity (see ParamCommand)
CCmdIntensityGrowth	Command object for intensity growth (see ParamCommand)
CCmdMaxIntensity	Command object for maximum intensity (see ParamCommand)
CCmdMiddlePoint	Command object for middle point (see ParamCommand)
CCmdRadius	Command object for radius (see ParamCommand)
CExtinguishableFireAffectorFactory	Factory class for DeflectorPlaneAffector
►CFireExtinguisherAffector	This class defines a ParticleAffector which deflects particles
CCmdEffectiveness	Command object for bounce (see ParamCommand)
CFireExtinguisherAffectorFactory	Factory class for DeflectorPlaneAffector
►CImGuiOverlay
CImGUIRenderable
CParticleCustomParam	Custom visual data for shader renderer
►CShaderParticleRenderer	Specialisation of ParticleSystemRenderer to render particles using a custom shaders
CCmdVertexFormatColour	Command objects for defining vertex format (see ParamCommand)
CCmdVertexFormatDirection	Direction
CCmdVertexFormatRotation	Rotation
CCmdVertexFormatRotationSpeed	Rotation speed (rad/s)
CCmdVertexFormatSize	Particle size
CCmdVertexFormatTexture	General texture coord
CCmdVertexFormatTimeFrag	TTL / total_TTL
CCmdVertexFormatTimeFragInv	1.0f - TTL / total_TTL
CCmdVertexFormatTotalTTL	Total time-to-live
CCmdVertexFormatTTL	Time-to-live
CShaderParticleRendererFactory	Factory class for ShaderParticleRenderer
►CTerrainPSSMMaterialGenerator	A TerrainMaterialGenerator which can cope with normal mapped, specular mapped terrain
►CSM2Profile	Shader model 2 profile target
CShaderHelper	Interface definition for helper class to generate shaders
CShaderHelperCg	Utility class to help with generating shaders for Cg / HLSL
CShaderHelperGLSL	Utility class to help with generating shaders for GLSL
CShaderHelperGLSLES	Utility class to help with generating shaders for GLSL ES
CShaderHelperHLSL
►NRigDef
CAeroAnimator
CAirbrake
►CAnimation
CMotorSource
CAnimator
CAntiLockBrakes
CAssetpack
CAuthor
CAxle
CBaseMeshWheel
CBaseWheel
CBaseWheel2
CBeam
CBeamDefaults
CBeamDefaultsScale
CBrakes
CCab
CCamera
CCameraRail
CCameraSettings
CCinecam
CCollisionBox
CCollisionRange
CCommand2
CCruiseControl
CDefaultMinimass
CDefaultSkin
►CDocument
CModule
CEngine
CEngoption
CEngturbo
CExhaust
CExtCamera
CFileFormatVersion
CFileinfo
CFlare2
CFlare3
CFlexbody
CFlexBodyWheel
CFusedrag
CGlobals
CGuid
CGuiSettings
CHelp
CHook
CHydro
CInertia
CInterAxle
CLockgroup
CManagedMaterial
CManagedMaterialsOptions
CMaterialFlareBinding
CMeshWheel
CMeshWheel2
CMinimass
►CNode
CId	Abstract node ID (numbered or named) Node name is always available
CRange
CRef	Legacy parser resolved references on-the-fly and the condition to check named nodes was "are there any named nodes defined at this point?" The new parser defers node resolution, so every ref
CNodeDefaults
►CParser	Checks the rig-def file syntax and pulls data to File object
CToken
CParticle
CPistonprop
►CProp
CBeaconSpecial
CDashboardSpecial
CRailGroup
CRopable
CRope
CRotator
CRotator2
CScrewprop
CScript
►CSequentialImporter
CMessage
CNodeMapEntry
CSerializer	Serializes the RigDef::Document data structure to file
CShadowOptions
CShock
CShock2
CShock3
CSkeletonSettings
CSlideNode
CSoundSource
CSoundSource2
CSpeedLimiter
CSubmesh
CTexcoord
CTie
►CTorqueCurve
CSample
CTractionControl
CTransferCase
CTrigger
CTurbojet
CTurboprop2
►CValidator	Performs a formal validation of the file (missing required parts, conflicts of modules, etc...)
CMessage
CVideoCamera
CWheel
CWheel2
CWheelDetacher
CWing
►NRoR
►NGUI
CCollisionsDebug	Diagnostic view for static terrain collisions and script event-boxes
CConsoleView	Configurable console renderer, implements filtering, colorized text, incons
CConsoleWindow
CDirectionArrow
CFlexbodyDebug	Flexbody and prop diagnostic
►CFrictionSettings
CEntry
CGameAbout
CGameChatBox	Overlay showing chat/console messages on screen, with optional entry field
CGameControls
CGameMainMenu
CGameSettings
CLoadingWindow
►CMainSelector
CDisplayCategory
CDisplayEntry
CMessageBoxButton
CMessageBoxConfig
CMessageBoxDialog
CMpClientList
CMpServerInfo
CMultiplayerSelector
CNodeBeamUtils
CRepositorySelector
CResourceCategories
CResourceFiles
CResourceItem
CResourcesCollection
CScriptMonitor
CSimPerfStats
CSurveyMap	In-game map widget Has 3 display modes (see SurveyMapMode), cycled using input SURVEY_MAP_TOGGLE_VIEW
CTextureToolWindow
CTopMenubar
CVehicleInfoTPanel
►CActor	Softbody object; can be anything from soda can to a space shuttle Constructed from a truck definition file, see https://docs.rigsofrods.org/vehicle-creation/fileformat-truck/ To spawn in-game, use MSG_SIM_SPAWN_ACTOR_REQUESTED, see GameContext::PushMessage(), in AngelScript use game.pushMessage(); Gameplay states are described by enum ActorState
CNetUpdate
CVehicleForceSensors
CActorLinkingRequest	Estabilishing a physics linkage between 2 actors modifies a global linkage table and triggers immediate update of every actor's linkage tables, so it has to be done sequentially on main thread
CActorManager	Builds and manages softbody actors (physics on background thread, networking)
CActorModifyRequest
CActorSB
►CActorSpawner	Processes a RigDef::Document (parsed from 'truck' file format) into a simulated gameplay object (Actor)
CActorMemoryRequirements
CActorSpawnState
CCustomMaterial
CException
CActorSpawnRequest
CAddonPartConflict	< Conflict between two addonparts tweaking the same element
CAddonPartUtility	NOTE: Modcache processes this format directly using RoR::GenericDocument, see RoR::CacheSystem::FillAddonPartDetailInfo()
CAeroDashOverlay
CAeroEngine
CAeroEngineOverlay
CAeroEngineSB
CAeroSwitchOverlay
CAeroTrimOverlay
►CAirbrake
CCoVertice_t
CAirbrakeGfx
CAirbrakeSB
CAirfoil	Represents an airfoil http://en.wikipedia.org/wiki/Airfoil
CAngelScriptExamples
CAppContext	Central setup and event handler for input/windowing/rendering
CAuthorInfo
Cauthorinfo_t
CAutopilot
Cbeam_simple_t
Cbeam_t	Simulation: An edge in the softbody structure
CBeamGfx	Visuals of softbody beam (beam_t struct); Partially updated along with SimBuffer
CBuoyance
CCabSubmesh	Submesh for old-style actor body (the "cab")
CCabTexcoord	Texture coordinates for old-style actor body (the "cab")
CCacheEntry
CCacheQuery
CCacheQueryResult
CCacheSystem	A content database MOTIVATION: RoR users usually have A LOT of content installed
CCameraManager
CCharacter
CCharacterFactory
CCmdKeyArray	For backwards compatibility of the 'triggers' feature, the commandkey array must support negative indices of any size without breaking memory
CCmdKeyInertia	Designed to be run in physics loop (2khz)
CCmdKeyInertiaConfig	Loads and manages 'inertia_models.cfg'
Ccollcab_rate_t
Ccollision_box_t
Ccollision_mesh_t	Records which collision triangles belong to which mesh
Ccollision_tri_t
►CCollisions
Chash_coll_element_t
Ccommand_t
Ccommandbeam_state_t
Ccommandbeam_t
CCommandKeySB
CConfigFile	Adds direct parsing of custom types
►CConsole	Global game console backend
CMessage
CMsgLockGuard
CConsoleCmd	Base (abstract) console command
►CContentManager
CResourcePack
Ccparticle_t
CCReadonlyScriptArrayView
CCReadonlyScriptDictView
CCreateProjectRequest	Creates subdirectory in 'My Games\Rigs of Rods\projects', pre-populates it with files and adds modcache entry
CCSHA1
CCurlFailInfo
CCurlTaskContext
CCVar	Quake-style console variable, defined in RoR.cfg or crated via Console UI and scripts
►CDashBoard
ClayoutLink_t
CDashBoardManager
CdashData_t
CdataContainer_t
CDifferential
CDifferentialData
CDiscordRpc	Wrapper class, just for code consistency with other subsystems
CDustPool
CEngineSim	A land vehicle engine + transmission
Cevent_trigger_t
Ceventsource_t	< Scripting
Cexhaust_t
Cflare_t
CFlareMaterial
CFlexable
►CFlexAirfoil
CCoVertice_t
CFlexBody	Flexbody = A deformable mesh; updated on CPU every frame, then uploaded to video memory
CFlexBodyCacheData
►CFlexBodyFileIO	Enables saving and loading flexbodies from/to binary file
CFlexBodyFileMetadata
CFlexBodyRecordHeader
CFlexFactory
►CFlexMesh
CFlexMeshVertex
►CFlexMeshWheel	Consists of static mesh, representing the rim, and dynamic mesh, representing the tire
CFlexMeshWheelVertex
►CFlexObj	A visual mesh, forming a chassis for softbody actor At most one instance is created per actor
CFlexObjVertex
CForceFeedback
CFreeForce	Global force affecting particular (base) node of particular (base) actor; added ad-hoc by scripts
CFreeForceRequest	Common for ADD and MODIFY requests; tailored for use with AngelScript thru GameScript::pushMessage()
CGameContext	Central game state manager
CGameContextSB
CGameScript	Proxy class that can be called by script functions
CGenericDocContext
CGenericDocument
CGfxActor
►CGfxCharacter
CSimBuffer	< Buffered simulation state for async gfx scene update
CGfxEnvmap	A dynamic environment probe; Creates a cubemap with realtime reflections around specified point
CGfxScene	Provides a 3D graphical representation of the simulation Idea: simulation runs at it's own constant rate, scene updates and rendering run asynchronously
Cground_model_t	Surface friction properties
►CGUIManager
CGuiTheme
Chook_t
CHydraxWater
Chydrobeam_t
CImTextFeeder	Helper for drawing multiline wrapped & colored text
CInputEngine	Manages controller configuration, evaluates input events
CInputEvent
CIWater	< TODO: Mixed gfx+physics (waves) - must be separated ~ only_a_ptr, 02/2018
CLandusemap
CLanguageEngine
CLoadScriptRequest
CLocalStorage	A class that allows scripts to store data persistently
CLocator_t
CMessage	Unified game event system - all requests and state changes are reported using a message
CModifyProjectRequest
CMovableText
CNetCharacterMsgAttach
CNetCharacterMsgGeneric
CNetCharacterMsgPos
CNetRecvPacket
CNetSendPacket
CNetwork
Cnode_simple_t
Cnode_t	Physics: A vertex in the softbody structure
CNodeGfx	Gfx attributes/state of a softbody node
CNodeSB
CODefAnimation
CODefCollisionBox
CODefCollisionMesh
►CODefFile
CODefFileHeader
►CODefParser
CODefParserContext
CODefParticleSys
CODefPointLight
CODefSpotlight
CODefTexPrint
COTCFile	Rembember OGRE coordinates are {X = right/left, Y = up/down, Z = front/back}
COTCLayer
COTCPage
COTCParser
COutGauge
►COverlayWrapper
CLoadedOverlay
CVisibleOverlays	RoR needs to temporarily hide all overlays when player enters editor
CPerVehicleCameraContext
►CPointColDetector
Ckdnode_t
Cpointid_t
Crefelem_t
CProceduralManager
CProceduralObject
CProceduralPoint
►CProceduralRoad
CCoVertice_t
CProp	A mesh attached to vehicle frame via 3 nodes
CPropAnim
CPropAnimKeySB
CPropAnimKeyState	User input state for animated props with 'source:event'
CPSSM_Shadows_Data
CRaceSystem
CRailGroup	A series of RailSegment-s for SlideNode to slide along. Can be closed in a loop
CRailSegment	A single beam in a chain
CRenderdash	'renderdash' is a name of a classic Render-To-Texture animated material with gauges and other dashboard info
CRepairMode	Interactive recovery and repair mode, operates on player vehicle Formerly 'advanced repair' or 'interactive reset'
CReplay
Cropable_t
Crope_t
Crotator_t
CSceneMouse
CScrewprop
CScrewpropSB
CScriptCallbackArgs
CScriptEngine	This class represents the angelscript scripting interface
CScriptEventArgs	Args for eventCallbackEx() queued via MSG_SIM_SCRIPT_EVENT_TRIGGERED See descriptions at enum RoR::scriptEvents
CScriptUnit	Represents a loaded script and all associated resources/handles
CShadowManager
Cshock_t
CSimpleInertia	Designed to be run on main/rendering loop (FPS)
►CSkidmark
CSkidmarkSegment	< Also reffered to as 'bucket'
►CSkidmarkConfig	< Skidmark config file parser and data container
CSkidmarkDef
CSkinDef
CSkinParser
CSkyXManager
CSlideNode
CSound
CSoundManager
CSoundScriptInstance
CSoundScriptManager
CSoundScriptTemplate
Csoundsource_t
CStr	Wrapper for classic c-string (local buffer) Refresher: strlen() excludes '\0' terminator; strncat() Appends '\0' terminator
CSurveyMapEntity
CSurveyMapTextureCreator
CTask	/brief Handle for a task executed by ThreadPool
CTerrain
CTerrainEditor	Minimalist editor mode; orig
CTerrainGeometryManager	This class handles all interactions with the Ogre Terrain system
►CTerrainObjectManager
CAnimatedObject
CEditorObject
Clocalizer_t
Cobject_t
CPredefinedActor
CStaticObject
CTerrn2Author
CTerrn2Def
CTerrn2Parser
CTerrn2Telepoint	< Teleport drop location
CThreadPool	Facilitates execution of (small) tasks on separate threads
Ctie_t
CTObjEntry
CTObjFile
CTObjGrass	Unified 'grass' and 'grass2'
CTObjParser
CTObjTree
CTObjVehicle
CToken
CTorqueCurve	This class loads and processes a torque curve for a vehicle
CTransferCase
CTuneupDef	Dual purpose:
CTuneupFlexbodyTweak	< Data of 'addonpart_tweak_flexbody <flexbody ID> <offsetX> <offsetY> <offsetZ> <rotX> <rotY> <rotZ> <meshName>'
CTuneupManagedMatTweak	< Data of 'addonpart_tweak_managedmaterial <name> <type> <media1> <media2> [<media3>]'
CTuneupNodeTweak	< Data of 'addonpart_tweak_node <nodenum> <posX> <posY> <posZ>'
CTuneupPropTweak	< Data of 'addonpart_tweak_prop <prop ID> <offsetX> <offsetY> <offsetZ> <rotX> <rotY> <rotZ> <media1> <media2>'
CTuneupUtil
CTuneupWheelTweak	< Data of 'addonpart_tweak_wheel <wheel ID> <media1> <media2> <side flag> <tire radius> <rim radius>'
CTurbojet
CTurbojetVisual
CTurboprop
CTyrePressure	Land vehicle feat Simulates tyre pressurization by adjusting springness of in-wheel beams
CUniqueCommandKeyPair	UI helper for displaying command control keys to user
CVehicleAI
CVideoCamera	An Ogre::Camera mounted on the actor and rendering into either in-scene texture or external window
►CWater
CReflectionListener
CRefractionListener
CWaveTrain
Cwheel_t
Cwheeldetacher_t
CWheelGfx
Cwing_t
CWorld2ScreenConverter	< Keeps data close for faster access
►NRoRnet
CActorStreamRegister	< Must preserve mem. layout of RoRnet::StreamRegister
CHeader	< Common header for every packet
CLegacyServerInfo
CServerInfo
CStreamRegister	< Sent from the client to server and vice versa, to broadcast a new stream
CStreamUnRegister
CUserInfo
CVehicleState	< Formerly oob_t
►NScript2Game	Pseudo-namespace; it doesn't exist in code or script runtime, only in this documentation
CBeamClass	Binding of RoR::Actor; a softbody-physics gameplay object, can be anything from soda can to space shuttle
CConsoleClass	Binding of RoR::Console; provides console variables (cvars), usually defined in RoR.cfg file
CCVarClass	Binding of RoR::CVar; A console variable, usually defined in RoR.cfg but also created by users or scripts
CGameScriptClass	Binding of RoR::GameScript; A general class that will provide you with general functions
CGenericDocContextClass	Binding of RoR::GenericDocContext; Traverses document tokens; See 'demo_script.as' for an example
CGenericDocumentClass	Binding of RoR::GenericDocument; Parses TRUCK/TOBJ/ODEF/CHARACTER file formats
CInputEngineClass	Binding of RoR::InputEngine; Manages input devices, their configuration (input.map ...) and state
CLocalStorageClass	Binding of RoR::LocalStorage; A class that allows your script to store data persistently
CProceduralManagerClass	Binding of RoR::ProceduralManager; generates dynamic roads for terrain
CProceduralObjectClass	Binding of RoR::ProceduralObject; a spline for generating dynamic roads
CProceduralPointClass	Binding of RoR::ProceduralPoint;
CProceduralRoadClass	Binding of RoR::ProceduralRoad; a dynamically generated road mesh
CSoundClass	Binding of RoR::Sound; a single sound sample positioned in 3D space (spatial audio)
CSoundScriptInstanceClass	Binding of RoR::SoundScriptInstance; instance of SoundScriptTemplateClass
CSoundScriptTemplateClass	Binding of RoR::SoundScriptTemplate; a customizable sound effect
CTerrainClass	Binding of RoR::Terrain; represents a loaded terrain
CVehicleAIClass	Binding of RoR::VehicleAI; Vehicle driving AI using waypoints
►NScript2Script	Pseudo-namespace; it doesn't exist in code or script runtime, only in this documentation
CraceBuilder	This class manages a race (singular!) You should only use this directly if the racesManager doesn't suit your needs
CracesManager	This class allows you to organize races
►NScript2Server	Pseudo-namespace; it doesn't exist in code or script runtime, only in this documentation
CServerScriptClass	A global server object
CStreamRegister	Binding of RoRnet::StreamRegister class
►NScriptValueTypes	Pseudo-namespace; it doesn't exist in code or script runtime, only in this documentation
Ccolor	Binding of Ogre::ColourValue
Cdegree	Binding of Ogre::Degree
Cquaternion	Binding of Ogre::Quaternion
Cradian	Binding of Ogre::Radian
Cvector2	Binding of Ogre::Vector2
Cvector3	Binding of Ogre::Vector3
►NSkyX
►NVClouds
►CDataManager
CCell	Cell struct
CEllipsoid	Ellipsoid class x^2 y^2 z^2 / + / + / = 1 a^2 b^2 c^2
CFastFakeRandom
►CGeometryBlock
CVERTEX	Vertex struct
CGeometryManager
►CLightning
CSegment	Segment struct
►CLightningManager
CListener	Listener class
►CVClouds
CCameraData	Camera data struct
CGeometrySettings	Geometry settings
CRenderQueueGroups	Render queue groups
►CAtmosphereManager
COptions	Atmosphere options
CBasicController	Basic controller class
CCfgFileManager	Config file manager
►CCloudLayer
COptions	Cloud layer options
CCloudsManager
CColorGradient
CController	Controller base class
CGPUManager
►CMeshManager
CVERTEX	Vertex struct
CMoonManager
►CSkyX	SkyX class Create simple and beautiful skies!
CRenderQueueGroups	Render queue groups
CVCloudsManager
CAdvancedScreen
Cai_events
CAsCmd
►CCartesianToTriangleTransform	Defines a linear transformation from cartesian coordinates to local (barycentric) coordinates of a specified triangle
CTriangleCoord	Return type of CartesianToTriangleTransform transformation
CClearCmd
CColoredTextAreaOverlayElement
CColoredTextAreaOverlayElementFactory	Factory for creating TextAreaOverlayElement instances
CDocumentParser
CErrorUtils
CGotoCmd
CGravityCmd
CHelpCmd
CImprovedConfigFile	Used by AngelScript local storage
CInterThreadStoreVector	This class is a helper to exchange data in a class between different threads, it can be pushed and pulled in various threads
CLoadScriptCmd
CLogCmd
CMeshObject
COgreImGui	DearIMGUI integration
COgreScriptBuilder
CPosCmd
CQuitCmd
CRefCountingObject	Self reference-counting objects, as requred by AngelScript garbage collector
CRefCountingObjectPtr
CRepoProgressContext
CSetboolCmd
CSetCmd
CSetCVarCmd
CSetfloatCmd
CSetintCmd
CSetstringCmd
CSHA1_WORKSPACE_BLOCK
Csort_cats
CSpawnobjectCmd
CTerrainheightCmd
►CTerrn2CustomMaterial
CProfile
CTriangle	Represents a triangle in three-dimensional space
CVarsCmd
CVerCmd
CWaterlevelCmd