Rigs of Rods 2023.09
Soft-body Physics Simulation
•All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Loading...
Searching...
No Matches
Public Member Functions
RoR::TuneupDef Struct Reference

Dual purpose: More...

#include <TuneupFileFormat.h>

+ Inheritance diagram for RoR::TuneupDef:

Public Member Functions

TuneupDefPtr clone ()
 
void reset ()
 
Protection helpers
bool isPropProtected (PropID_t propid) const
 
bool isFlexbodyProtected (FlexbodyID_t flexbodyid) const
 
bool isWheelProtected (WheelID_t wheelid) const
 
bool isNodeProtected (NodeNum_t nodenum) const
 
bool isCineCameraProtected (CineCameraID_t cinecamid) const
 
bool isFlareProtected (FlareID_t flareid) const
 
bool isExhaustProtected (ExhaustID_t exhaustid) const
 
bool isManagedMatProtected (const std::string &matname) const
 
Unwanted-state helpers
bool isPropUnwanted (PropID_t propid)
 
bool isFlexbodyUnwanted (FlexbodyID_t flexbodyid)
 
bool isFlareUnwanted (FlareID_t flareid)
 
bool isExhaustUnwanted (ExhaustID_t exhaustid)
 
bool isManagedMatUnwanted (const std::string &matname)
 
Forced-state helpers
bool isPropForceRemoved (PropID_t propid)
 
bool isFlexbodyForceRemoved (FlexbodyID_t flexbodyid)
 
bool isWheelSideForced (WheelID_t wheelid, WheelSide &out_val) const
 
bool isFlareForceRemoved (FlareID_t flareid)
 
bool isExhaustForceRemoved (ExhaustID_t exhaustid)
 
bool isManagedMatForceRemoved (const std::string &matname)
 
bool isVideoCameraRoleForced (VideoCameraID_t camera_id, VideoCamRole &out_val) const
 
- Public Member Functions inherited from RefCountingObject< TuneupDef >
 RefCountingObject ()
 
virtual ~RefCountingObject ()
 
void AddRef ()
 
void Release ()
 

Data Fields

General info
std::string name
 
std::string guid
 target vehicle GUID
 
std::string filename
 target vehicle filename
 
std::string thumbnail
 
std::string description
 
std::string author_name
 
int author_id = -1
 
CacheCategoryId category_id = CID_None
 
Addonparts and extracted data
std::set< std::string > use_addonparts
 Addonpart filenames.
 
std::map< NodeNum_t, TuneupNodeTweak > node_tweaks
 Node position overrides via 'addonpart_tweak_node'.
 
std::map< CineCameraID_t, TuneupCineCameraTweak > cinecam_tweaks
 Cinecam position overrides via 'addonpart_tweak_cinecam'.
 
std::map< WheelID_t, TuneupWheelTweak > wheel_tweaks
 Mesh name and radius overrides via 'addonpart_tweak_wheel'.
 
std::map< PropID_t, TuneupPropTweak > prop_tweaks
 Mesh name(s), offset and rotation overrides via 'addonpart_tweak_prop'.
 
std::map< FlexbodyID_t, TuneupFlexbodyTweak > flexbody_tweaks
 Mesh name, offset and rotation overrides via 'addonpart_tweak_flexbody'.
 
std::map< std::string, TuneupManagedMatTweak > managedmat_tweaks
 Managed material overrides via 'addonpart_tweak_managedmaterial'.
 
std::set< PropID_t > unwanted_props
 'addonpart_unwanted_prop' directives.
 
std::set< FlexbodyID_t > unwanted_flexbodies
 'addonpart_unwanted_flexbody' directives.
 
std::set< FlareID_t > unwanted_flares
 'addonpart_unwanted_flare' directives.
 
std::set< ExhaustID_t > unwanted_exhausts
 'addonpart_unwanted_exhaust' directives.
 
std::set< std::string > unwanted_managedmats
 'addonpart_unwanted_managedmaterial' directives.
 
UI-controlled forced changes (override addonparts)
std::set< PropID_t > force_remove_props
 UI overrides.
 
std::set< FlexbodyID_t > force_remove_flexbodies
 UI overrides.
 
std::map< WheelID_t, WheelSide > force_wheel_sides
 UI overrides.
 
std::map< VideoCameraID_t, VideoCamRole > force_video_cam_roles
 UI overrides.
 
std::set< FlareID_t > force_remove_flares
 User unticked an UI checkbox in Tuning menu, section Flares.
 
std::set< ExhaustID_t > force_remove_exhausts
 User unticked an UI checkbox in Tuning menu, section Exhausts.
 
std::set< std::string > force_remove_managedmats
 User unticked an UI checkbox in Tuning menu, section Managed Materials.
 
UI-controlled protection from addonpart tweaks
std::set< NodeNum_t > protected_nodes
 Nodes that cannot be altered via 'addonpart_tweak_node'.
 
std::set< CineCameraID_t > protected_cinecams
 Cinecams that cannot be altered via 'addonpart_tweak_cinecam'.
 
std::set< WheelID_t > protected_wheels
 Wheels that cannot be altered via 'addonpart_tweak_wheel'.
 
std::set< PropID_t > protected_props
 Props which cannot be altered via 'addonpart_tweak_prop' or 'addonpart_unwanted_prop' directive.
 
std::set< FlexbodyID_t > protected_flexbodies
 Flexbodies which cannot be altered via 'addonpart_tweak_flexbody' or 'addonpart_unwanted_flexbody' directive.
 
std::set< FlareID_t > protected_flares
 Flares which cannot be altered via 'addonpart_unwanted_flare' directive.
 
std::set< ExhaustID_t > protected_exhausts
 Exhausts which cannot be altered via 'addonpart_unwanted_exhaust' directive.
 
std::set< std::string > protected_managedmats
 Managed materials which cannot be altered via 'addonpart_tweak_managedmaterial' directive.
 
- Data Fields inherited from RefCountingObject< TuneupDef >
int m_refcount
 
std::mutex m_refcount_mtx
 

Additional Inherited Members

- Static Public Member Functions inherited from RefCountingObject< TuneupDef >
static void RegisterRefCountingObject (AS_NAMESPACE_QUALIFIER asIScriptEngine *engine, const char *name)
 

Detailed Description

Dual purpose:

  1. representing a .tuneup file, see CacheEntry::tuneup_def (the obvious use)
  2. holding addonpart data for conflict resolution, see CacheEntry::addonpart_data_only (an additional hack)

Definition at line 100 of file TuneupFileFormat.h.

Member Function Documentation

◆ clone()

TuneupDefPtr TuneupDef::clone ( )

Definition at line 38 of file TuneupFileFormat.cpp.

◆ isCineCameraProtected()

bool RoR::TuneupDef::isCineCameraProtected ( CineCameraID_t  cinecamid) const
inline

Definition at line 163 of file TuneupFileFormat.h.

◆ isExhaustForceRemoved()

bool RoR::TuneupDef::isExhaustForceRemoved ( ExhaustID_t  exhaustid)
inline

Definition at line 184 of file TuneupFileFormat.h.

◆ isExhaustProtected()

bool RoR::TuneupDef::isExhaustProtected ( ExhaustID_t  exhaustid) const
inline

Definition at line 165 of file TuneupFileFormat.h.

◆ isExhaustUnwanted()

bool RoR::TuneupDef::isExhaustUnwanted ( ExhaustID_t  exhaustid)
inline

Definition at line 174 of file TuneupFileFormat.h.

◆ isFlareForceRemoved()

bool RoR::TuneupDef::isFlareForceRemoved ( FlareID_t  flareid)
inline

Definition at line 183 of file TuneupFileFormat.h.

◆ isFlareProtected()

bool RoR::TuneupDef::isFlareProtected ( FlareID_t  flareid) const
inline

Definition at line 164 of file TuneupFileFormat.h.

◆ isFlareUnwanted()

bool RoR::TuneupDef::isFlareUnwanted ( FlareID_t  flareid)
inline

Definition at line 173 of file TuneupFileFormat.h.

◆ isFlexbodyForceRemoved()

bool RoR::TuneupDef::isFlexbodyForceRemoved ( FlexbodyID_t  flexbodyid)
inline

Definition at line 181 of file TuneupFileFormat.h.

◆ isFlexbodyProtected()

bool RoR::TuneupDef::isFlexbodyProtected ( FlexbodyID_t  flexbodyid) const
inline

Definition at line 160 of file TuneupFileFormat.h.

◆ isFlexbodyUnwanted()

bool RoR::TuneupDef::isFlexbodyUnwanted ( FlexbodyID_t  flexbodyid)
inline

Definition at line 172 of file TuneupFileFormat.h.

◆ isManagedMatForceRemoved()

bool RoR::TuneupDef::isManagedMatForceRemoved ( const std::string &  matname)
inline

Definition at line 185 of file TuneupFileFormat.h.

◆ isManagedMatProtected()

bool RoR::TuneupDef::isManagedMatProtected ( const std::string &  matname) const
inline

Definition at line 166 of file TuneupFileFormat.h.

◆ isManagedMatUnwanted()

bool RoR::TuneupDef::isManagedMatUnwanted ( const std::string &  matname)
inline

Definition at line 175 of file TuneupFileFormat.h.

◆ isNodeProtected()

bool RoR::TuneupDef::isNodeProtected ( NodeNum_t  nodenum) const
inline

Definition at line 162 of file TuneupFileFormat.h.

◆ isPropForceRemoved()

bool RoR::TuneupDef::isPropForceRemoved ( PropID_t  propid)
inline

Definition at line 180 of file TuneupFileFormat.h.

◆ isPropProtected()

bool RoR::TuneupDef::isPropProtected ( PropID_t  propid) const
inline

Definition at line 159 of file TuneupFileFormat.h.

◆ isPropUnwanted()

bool RoR::TuneupDef::isPropUnwanted ( PropID_t  propid)
inline

Definition at line 171 of file TuneupFileFormat.h.

◆ isVideoCameraRoleForced()

bool TuneupDef::isVideoCameraRoleForced ( VideoCameraID_t  camera_id,
VideoCamRole &  out_val 
) const

Definition at line 105 of file TuneupFileFormat.cpp.

◆ isWheelProtected()

bool RoR::TuneupDef::isWheelProtected ( WheelID_t  wheelid) const
inline

Definition at line 161 of file TuneupFileFormat.h.

◆ isWheelSideForced()

bool TuneupDef::isWheelSideForced ( WheelID_t  wheelid,
WheelSide &  out_val 
) const

Definition at line 91 of file TuneupFileFormat.cpp.

◆ reset()

void RoR::TuneupDef::reset ( )

Field Documentation

◆ author_id

int RoR::TuneupDef::author_id = -1

Definition at line 110 of file TuneupFileFormat.h.

◆ author_name

std::string RoR::TuneupDef::author_name

Definition at line 109 of file TuneupFileFormat.h.

◆ category_id

CacheCategoryId RoR::TuneupDef::category_id = CID_None

Definition at line 111 of file TuneupFileFormat.h.

◆ cinecam_tweaks

std::map<CineCameraID_t, TuneupCineCameraTweak> RoR::TuneupDef::cinecam_tweaks

Cinecam position overrides via 'addonpart_tweak_cinecam'.

Definition at line 119 of file TuneupFileFormat.h.

◆ description

std::string RoR::TuneupDef::description

Definition at line 108 of file TuneupFileFormat.h.

◆ filename

std::string RoR::TuneupDef::filename

target vehicle filename

Definition at line 106 of file TuneupFileFormat.h.

◆ flexbody_tweaks

std::map<FlexbodyID_t, TuneupFlexbodyTweak> RoR::TuneupDef::flexbody_tweaks

Mesh name, offset and rotation overrides via 'addonpart_tweak_flexbody'.

Definition at line 122 of file TuneupFileFormat.h.

◆ force_remove_exhausts

std::set<ExhaustID_t> RoR::TuneupDef::force_remove_exhausts

User unticked an UI checkbox in Tuning menu, section Exhausts.

Definition at line 138 of file TuneupFileFormat.h.

◆ force_remove_flares

std::set<FlareID_t> RoR::TuneupDef::force_remove_flares

User unticked an UI checkbox in Tuning menu, section Flares.

Definition at line 137 of file TuneupFileFormat.h.

◆ force_remove_flexbodies

std::set<FlexbodyID_t> RoR::TuneupDef::force_remove_flexbodies

UI overrides.

Definition at line 134 of file TuneupFileFormat.h.

◆ force_remove_managedmats

std::set<std::string> RoR::TuneupDef::force_remove_managedmats

User unticked an UI checkbox in Tuning menu, section Managed Materials.

Definition at line 139 of file TuneupFileFormat.h.

◆ force_remove_props

std::set<PropID_t> RoR::TuneupDef::force_remove_props

UI overrides.

Definition at line 133 of file TuneupFileFormat.h.

◆ force_video_cam_roles

std::map<VideoCameraID_t, VideoCamRole> RoR::TuneupDef::force_video_cam_roles

UI overrides.

Definition at line 136 of file TuneupFileFormat.h.

◆ force_wheel_sides

std::map<WheelID_t, WheelSide> RoR::TuneupDef::force_wheel_sides

UI overrides.

Definition at line 135 of file TuneupFileFormat.h.

◆ guid

std::string RoR::TuneupDef::guid

target vehicle GUID

Definition at line 105 of file TuneupFileFormat.h.

◆ managedmat_tweaks

std::map<std::string, TuneupManagedMatTweak> RoR::TuneupDef::managedmat_tweaks

Managed material overrides via 'addonpart_tweak_managedmaterial'.

Definition at line 123 of file TuneupFileFormat.h.

◆ name

std::string RoR::TuneupDef::name

Definition at line 104 of file TuneupFileFormat.h.

◆ node_tweaks

std::map<NodeNum_t, TuneupNodeTweak> RoR::TuneupDef::node_tweaks

Node position overrides via 'addonpart_tweak_node'.

Definition at line 118 of file TuneupFileFormat.h.

◆ prop_tweaks

std::map<PropID_t, TuneupPropTweak> RoR::TuneupDef::prop_tweaks

Mesh name(s), offset and rotation overrides via 'addonpart_tweak_prop'.

Definition at line 121 of file TuneupFileFormat.h.

◆ protected_cinecams

std::set<CineCameraID_t> RoR::TuneupDef::protected_cinecams

Cinecams that cannot be altered via 'addonpart_tweak_cinecam'.

Definition at line 145 of file TuneupFileFormat.h.

◆ protected_exhausts

std::set<ExhaustID_t> RoR::TuneupDef::protected_exhausts

Exhausts which cannot be altered via 'addonpart_unwanted_exhaust' directive.

Definition at line 150 of file TuneupFileFormat.h.

◆ protected_flares

std::set<FlareID_t> RoR::TuneupDef::protected_flares

Flares which cannot be altered via 'addonpart_unwanted_flare' directive.

Definition at line 149 of file TuneupFileFormat.h.

◆ protected_flexbodies

std::set<FlexbodyID_t> RoR::TuneupDef::protected_flexbodies

Flexbodies which cannot be altered via 'addonpart_tweak_flexbody' or 'addonpart_unwanted_flexbody' directive.

Definition at line 148 of file TuneupFileFormat.h.

◆ protected_managedmats

std::set<std::string> RoR::TuneupDef::protected_managedmats

Managed materials which cannot be altered via 'addonpart_tweak_managedmaterial' directive.

Definition at line 151 of file TuneupFileFormat.h.

◆ protected_nodes

std::set<NodeNum_t> RoR::TuneupDef::protected_nodes

Nodes that cannot be altered via 'addonpart_tweak_node'.

Definition at line 144 of file TuneupFileFormat.h.

◆ protected_props

std::set<PropID_t> RoR::TuneupDef::protected_props

Props which cannot be altered via 'addonpart_tweak_prop' or 'addonpart_unwanted_prop' directive.

Definition at line 147 of file TuneupFileFormat.h.

◆ protected_wheels

std::set<WheelID_t> RoR::TuneupDef::protected_wheels

Wheels that cannot be altered via 'addonpart_tweak_wheel'.

Definition at line 146 of file TuneupFileFormat.h.

◆ thumbnail

std::string RoR::TuneupDef::thumbnail

Definition at line 107 of file TuneupFileFormat.h.

◆ unwanted_exhausts

std::set<ExhaustID_t> RoR::TuneupDef::unwanted_exhausts

'addonpart_unwanted_exhaust' directives.

Definition at line 127 of file TuneupFileFormat.h.

◆ unwanted_flares

std::set<FlareID_t> RoR::TuneupDef::unwanted_flares

'addonpart_unwanted_flare' directives.

Definition at line 126 of file TuneupFileFormat.h.

◆ unwanted_flexbodies

std::set<FlexbodyID_t> RoR::TuneupDef::unwanted_flexbodies

'addonpart_unwanted_flexbody' directives.

Definition at line 125 of file TuneupFileFormat.h.

◆ unwanted_managedmats

std::set<std::string> RoR::TuneupDef::unwanted_managedmats

'addonpart_unwanted_managedmaterial' directives.

Definition at line 128 of file TuneupFileFormat.h.

◆ unwanted_props

std::set<PropID_t> RoR::TuneupDef::unwanted_props

'addonpart_unwanted_prop' directives.

Definition at line 124 of file TuneupFileFormat.h.

◆ use_addonparts

std::set<std::string> RoR::TuneupDef::use_addonparts

Addonpart filenames.

Definition at line 116 of file TuneupFileFormat.h.

◆ wheel_tweaks

std::map<WheelID_t, TuneupWheelTweak> RoR::TuneupDef::wheel_tweaks

Mesh name and radius overrides via 'addonpart_tweak_wheel'.

Definition at line 120 of file TuneupFileFormat.h.

The documentation for this struct was generated from the following files:
Generated on Fri Jan 2 2026 09:37:04 for Rigs of Rods by doxygen 1.9.8