add a docsURL; macro to link a given set of script config vars to git or similar storage urls via clicking on the inspector

This commit is contained in:
AzaezelX 2023-01-27 01:13:15 -06:00
parent a0bbe0ec18
commit f5a34308f9
382 changed files with 588 additions and 130 deletions

View file

@ -387,6 +387,7 @@ ExplosionData* ExplosionData::cloneAndPerformSubstitutions(const SimObject* owne
void ExplosionData::initPersistFields()
{
docsURL;
addGroup("Shapes");
INITPERSISTFIELD_SHAPEASSET(ExplosionShape, ExplosionData, "@brief Optional shape asset to place at the center of the explosion.\n\n"
"The <i>ambient</i> animation of this model will be played automatically at the start of the explosion.");
@ -980,6 +981,7 @@ void Explosion::setInitialState(const Point3F& point, const Point3F& normal, con
//--------------------------------------------------------------------------
void Explosion::initPersistFields()
{
docsURL;
Parent::initPersistFields();
addField("initialNormal", TypePoint3F, Offset(mInitialNormal, Explosion), "Initial starting Normal.");
//

View file

@ -345,6 +345,7 @@ fxFoliageReplicator::~fxFoliageReplicator()
void fxFoliageReplicator::initPersistFields()
{
docsURL;
// Add out own persistent fields.
addGroup( "Debugging" ); // MM: Added Group Header.
addField( "UseDebugInfo", TypeBool, Offset( mFieldData.mUseDebugInfo, fxFoliageReplicator ), "Culling bins are drawn when set to true." );

View file

@ -139,6 +139,7 @@ fxShapeReplicator::~fxShapeReplicator()
void fxShapeReplicator::initPersistFields()
{
docsURL;
// Add out own persistent fields.
addGroup( "Debugging" ); // MM: Added Group Header.
addField( "HideReplications", TypeBool, Offset( mFieldData.mHideReplications, fxShapeReplicator ), "Replicated shapes are hidden when set to true." );

View file

@ -540,6 +540,7 @@ IMPLEMENT_CO_NETOBJECT_V1(GroundCover);
void GroundCover::initPersistFields()
{
docsURL;
addGroup( "GroundCover General" );
INITPERSISTFIELD_MATERIALASSET(Material, GroundCover, "Material used by all GroundCover segments.");

View file

@ -262,6 +262,7 @@ LightningData::~LightningData()
//--------------------------------------------------------------------------
void LightningData::initPersistFields()
{
docsURL;
INITPERSISTFIELD_SOUNDASSET(StrikeSound, LightningData, "Sound to play when lightning STRIKES!");
@ -411,6 +412,7 @@ Lightning::~Lightning()
//--------------------------------------------------------------------------
void Lightning::initPersistFields()
{
docsURL;
addGroup( "Strikes" );
addField( "strikesPerMinute", TypeS32, Offset(strikesPerMinute, Lightning),
"@brief Number of lightning strikes to perform per minute.\n\n"

View file

@ -89,6 +89,7 @@ ParticleEmitterNodeData::~ParticleEmitterNodeData()
//-----------------------------------------------------------------------------
void ParticleEmitterNodeData::initPersistFields()
{
docsURL;
addField( "timeMultiple", TYPEID< F32 >(), Offset(timeMultiple, ParticleEmitterNodeData),
"@brief Time multiplier for particle emitter nodes.\n\n"
"Increasing timeMultiple is like running the emitter at a faster rate - single-shot "
@ -181,6 +182,7 @@ ParticleEmitterNode::~ParticleEmitterNode()
//-----------------------------------------------------------------------------
void ParticleEmitterNode::initPersistFields()
{
docsURL;
addField( "active", TYPEID< bool >(), Offset(mActive,ParticleEmitterNode),
"Controls whether particles are emitted from this node." );
addField( "emitter", TYPEID< ParticleEmitterData >(), Offset(mEmitterDatablock, ParticleEmitterNode),

View file

@ -143,6 +143,7 @@ PrecipitationData::PrecipitationData()
void PrecipitationData::initPersistFields()
{
docsURL;
INITPERSISTFIELD_SOUNDASSET(Sound, PrecipitationData, "Looping SFXProfile effect to play while Precipitation is active.");
addProtectedField( "dropTexture", TypeFilename, Offset(mDropName, PrecipitationData), &_setDropData, &defaultProtectedGetFn,
@ -367,6 +368,7 @@ IRangeValidator ValidNumDropsRange(1, 100000);
void Precipitation::initPersistFields()
{
docsURL;
addGroup("Precipitation");
addFieldV( "numDrops", TypeS32, Offset(mNumDrops, Precipitation), &ValidNumDropsRange,

View file

@ -68,6 +68,7 @@ RibbonData::RibbonData()
void RibbonData::initPersistFields()
{
docsURL;
Parent::initPersistFields();
addGroup("Ribbon");
@ -205,6 +206,7 @@ Ribbon::~Ribbon()
//--------------------------------------------------------------------------
void Ribbon::initPersistFields()
{
docsURL;
Parent::initPersistFields();
}

View file

@ -56,6 +56,7 @@ RibbonNodeData::~RibbonNodeData()
//-----------------------------------------------------------------------------
void RibbonNodeData::initPersistFields()
{
docsURL;
Parent::initPersistFields();
}
@ -90,6 +91,7 @@ RibbonNode::~RibbonNode()
//-----------------------------------------------------------------------------
void RibbonNode::initPersistFields()
{
docsURL;
addField( "active", TYPEID< bool >(), Offset(mActive,RibbonNode),
"Controls whether ribbon is emitted from this node." );
addField( "ribbon", TYPEID< RibbonData >(), Offset(mRibbonDatablock, RibbonNode),

View file

@ -114,8 +114,9 @@ SplashData::SplashData()
//--------------------------------------------------------------------------
// Init fields
//--------------------------------------------------------------------------
void SplashData::initPersistFields()
void SplashData::initPersistFields()
{
docsURL;
INITPERSISTFIELD_SOUNDASSET(Sound, SplashData, "Sound to play when splash, splashes.");
addField("scale", TypePoint3F, Offset(scale, SplashData), "The scale of this splashing effect, defined as the F32 points X, Y, Z.\n");