mirror of
https://github.com/TorqueGameEngines/Torque3D.git
synced 2026-07-11 14:44:36 +00:00
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:
parent
a0bbe0ec18
commit
f5a34308f9
382 changed files with 588 additions and 130 deletions
|
|
@ -101,6 +101,7 @@ void afxAnimClipData::onStaticModified(const char* slot, const char* newValue)
|
|||
|
||||
void afxAnimClipData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addField("clipName", TYPEID< StringTableEntry >(), myOffset(clip_name),
|
||||
"The name of an animation sequence to be played by a ShapeBase-derived object to which this effect is "
|
||||
"constrained. Also works on afxModel effects.\n"
|
||||
|
|
|
|||
|
|
@ -70,6 +70,7 @@ afxAnimLockData::afxAnimLockData()
|
|||
|
||||
void afxAnimLockData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
Parent::initPersistFields();
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -74,6 +74,7 @@ afxAreaDamageData::afxAreaDamageData(const afxAreaDamageData& other, bool temp_c
|
|||
|
||||
void afxAreaDamageData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addField("flavor", TypeString, myOffset(flavor),
|
||||
"An arbitrary string which is passed as an argument to a spell's onDamage() script "
|
||||
"method. It is used to classify a type of damage such as 'melee', 'magical', or "
|
||||
|
|
|
|||
|
|
@ -121,6 +121,7 @@ void afxAudioBank::onPerformSubstitutions()
|
|||
|
||||
void afxAudioBank::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addField("path", TypeFilename, Offset(mPath, afxAudioBank),
|
||||
"A filesystem path to the folder containing the sound files specified by the "
|
||||
"filenames[] field. All sound files used in a single AudioBank must be located in "
|
||||
|
|
|
|||
|
|
@ -91,6 +91,7 @@ EndImplementEnumType;
|
|||
|
||||
void afxBillboardData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addField("color", TypeColorF, myOffset(color),
|
||||
"The color assigned to the quadrangle geometry. The way it combines with the given "
|
||||
"texture varies according to the setting of the textureFunction field.");
|
||||
|
|
|
|||
|
|
@ -80,6 +80,7 @@ afxCameraPuppetData::afxCameraPuppetData(const afxCameraPuppetData& other, bool
|
|||
|
||||
void afxCameraPuppetData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addField("cameraSpec", TypeString, myOffset(cam_spec),
|
||||
"This field is like the effect-wrapper fields for specifying constraint sources, "
|
||||
"but here it specifies a target for the camera-puppet effect.");
|
||||
|
|
@ -129,4 +130,4 @@ void afxCameraPuppetData::gather_cons_defs(Vector<afxConstraintDef>& defs)
|
|||
defs.push_back(cam_def);
|
||||
};
|
||||
|
||||
//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
|
||||
//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
|
||||
|
|
|
|||
|
|
@ -66,6 +66,7 @@ afxCameraShakeData::afxCameraShakeData(const afxCameraShakeData& other, bool tem
|
|||
|
||||
void afxCameraShakeData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addField("frequency", TypePoint3F, Offset(camShakeFreq, afxCameraShakeData),
|
||||
"The camera shake frequencies for all three axes: X, Y, Z.");
|
||||
addField("amplitude", TypePoint3F, Offset(camShakeAmp, afxCameraShakeData),
|
||||
|
|
|
|||
|
|
@ -65,6 +65,7 @@ afxCollisionEventData::afxCollisionEventData(const afxCollisionEventData& other,
|
|||
|
||||
void afxCollisionEventData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addField("methodName", TypeString, myOffset(method_name),
|
||||
"...");
|
||||
addField("scriptData", TypeString, myOffset(script_data),
|
||||
|
|
|
|||
|
|
@ -61,6 +61,7 @@ afxConsoleMessageData::afxConsoleMessageData(const afxConsoleMessageData& other,
|
|||
|
||||
void afxConsoleMessageData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addField("message", TypeString, myOffset(message_str),
|
||||
"A text message to be displayed when the effect is executed.");
|
||||
|
||||
|
|
|
|||
|
|
@ -74,6 +74,7 @@ afxDamageData::afxDamageData(const afxDamageData& other, bool temp_clone) : Game
|
|||
|
||||
void afxDamageData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addField("label", TypeString, myOffset(label),
|
||||
"An arbitrary string which is passed as an argument to a spell's onDamage() script "
|
||||
"method. It can be used to identify which damage effect the damage came from in "
|
||||
|
|
|
|||
|
|
@ -74,6 +74,7 @@ afxFootSwitchData::afxFootSwitchData(const afxFootSwitchData& other, bool temp_c
|
|||
|
||||
void afxFootSwitchData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addField("overrideAll", TypeBool, myOffset(override_all),
|
||||
"When true, all of a Player's footstep effects are turned off for the duration of "
|
||||
"the foot-switch effect.");
|
||||
|
|
|
|||
|
|
@ -66,6 +66,7 @@ afxGuiControllerData::afxGuiControllerData(const afxGuiControllerData& other, bo
|
|||
|
||||
void afxGuiControllerData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addField("controlName", TypeString, myOffset(control_name),
|
||||
"Specifies the name of an existing gui-control.");
|
||||
addField("preservePosition", TypeBool, myOffset(preserve_pos),
|
||||
|
|
|
|||
|
|
@ -63,6 +63,7 @@ afxGuiTextData::afxGuiTextData(const afxGuiTextData& other, bool temp_clone) : G
|
|||
|
||||
void afxGuiTextData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addField("text", TypeString, myOffset(text_str),
|
||||
"The literal text to display on the afxGuiTextHud. The center of the text will be "
|
||||
"placed at the projection of the 3D constraint position into 2D screen space.\n"
|
||||
|
|
|
|||
|
|
@ -93,6 +93,7 @@ afxT3DLightBaseData::afxT3DLightBaseData(const afxT3DLightBaseData& other, bool
|
|||
//
|
||||
void afxT3DLightBaseData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
// We only add the basic lighting options that all lighting
|
||||
// systems would use... the specific lighting system options
|
||||
// are injected at runtime by the lighting system itself.
|
||||
|
|
|
|||
|
|
@ -65,6 +65,7 @@ afxMachineGunData::afxMachineGunData(const afxMachineGunData& other, bool temp_c
|
|||
|
||||
void afxMachineGunData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addField("projectile", TYPEID<ProjectileData>(), myOffset(projectile_data),
|
||||
"A ProjectileData datablock describing the projectile to be launched.");
|
||||
addField("roundsPerMinute", TypeS32, myOffset(rounds_per_minute),
|
||||
|
|
|
|||
|
|
@ -172,6 +172,7 @@ bool afxModelData::preload(bool server, String &errorStr)
|
|||
|
||||
void afxModelData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addGroup("Shapes");
|
||||
INITPERSISTFIELD_SHAPEASSET(Shape, afxModelData, "The name of a .dts format file to use for the model.");
|
||||
addGroup("Shapes");
|
||||
|
|
|
|||
|
|
@ -67,6 +67,7 @@ afxMooringData::afxMooringData(const afxMooringData& other, bool temp_clone) : G
|
|||
|
||||
void afxMooringData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addField("displayAxisMarker", TypeBool, myOffset(display_axis_marker),
|
||||
"Specifies whether to display an axis to help visualize the position and orientation "
|
||||
"of the mooring.");
|
||||
|
|
|
|||
|
|
@ -232,6 +232,7 @@ afxParticleEmitterVectorData::afxParticleEmitterVectorData(const afxParticleEmit
|
|||
|
||||
void afxParticleEmitterVectorData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
Parent::initPersistFields();
|
||||
}
|
||||
|
||||
|
|
@ -289,6 +290,7 @@ afxParticleEmitterConeData::afxParticleEmitterConeData(const afxParticleEmitterC
|
|||
|
||||
void afxParticleEmitterConeData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addField("spreadMin", TypeF32, Offset(spread_min, afxParticleEmitterConeData),
|
||||
"...");
|
||||
addField("spreadMax", TypeF32, Offset(spread_max, afxParticleEmitterConeData),
|
||||
|
|
@ -399,6 +401,7 @@ EndImplementEnumType;
|
|||
|
||||
void afxParticleEmitterPathData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addField("paths", TypeString, Offset(epaths_string, afxParticleEmitterPathData),
|
||||
"...");
|
||||
|
||||
|
|
@ -642,6 +645,7 @@ afxParticleEmitterDiscData::afxParticleEmitterDiscData(const afxParticleEmitterD
|
|||
|
||||
void afxParticleEmitterDiscData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addField("radiusMin", TypeF32, Offset(pe_radius_min, afxParticleEmitterDiscData),
|
||||
"...");
|
||||
addField("radiusMax", TypeF32, Offset(pe_radius_max, afxParticleEmitterDiscData),
|
||||
|
|
|
|||
|
|
@ -139,6 +139,7 @@ EndImplementEnumType;
|
|||
|
||||
void afxPhraseEffectData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addField("duration", TypeF32, myOffset(duration),
|
||||
"Specifies a duration for the phrase-effect. If set to infinity, the phrase-effect "
|
||||
"needs to have a phraseType of continuous. Set infinite duration using "
|
||||
|
|
|
|||
|
|
@ -75,6 +75,7 @@ afxPhysicalZoneData::afxPhysicalZoneData(const afxPhysicalZoneData& other, bool
|
|||
|
||||
void afxPhysicalZoneData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addField("velocityMod", TypeF32, myOffset(mVelocityMod),
|
||||
"A multiplier that biases the velocity of an object every tick it is within the "
|
||||
"zone.");
|
||||
|
|
@ -111,4 +112,4 @@ void afxPhysicalZoneData::unpackData(BitStream* stream)
|
|||
}
|
||||
|
||||
|
||||
//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
|
||||
//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
|
||||
|
|
|
|||
|
|
@ -80,6 +80,7 @@ EndImplementEnumType;
|
|||
|
||||
void afxPlayerMovementData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addField("speedBias", TypeF32, myOffset(speed_bias),
|
||||
"A floating-point multiplier that scales the constraint Player's movement speed.");
|
||||
addField("movement", TypePoint3F, myOffset(movement),
|
||||
|
|
@ -137,4 +138,4 @@ bool afxPlayerMovementData::hasMovementOverride()
|
|||
}
|
||||
|
||||
|
||||
//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
|
||||
//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
|
||||
|
|
|
|||
|
|
@ -73,6 +73,7 @@ afxPlayerPuppetData::afxPlayerPuppetData(const afxPlayerPuppetData& other, bool
|
|||
|
||||
void afxPlayerPuppetData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addField("objectSpec", TypeString, myOffset(obj_spec),
|
||||
"...");
|
||||
addField("networking", TypeS8, myOffset(networking),
|
||||
|
|
@ -119,4 +120,4 @@ void afxPlayerPuppetData::gather_cons_defs(Vector<afxConstraintDef>& defs)
|
|||
defs.push_back(obj_def);
|
||||
};
|
||||
|
||||
//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
|
||||
//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
|
||||
|
|
|
|||
|
|
@ -62,6 +62,7 @@ afxT3DPointLightData::afxT3DPointLightData(const afxT3DPointLightData& other, bo
|
|||
//
|
||||
void afxT3DPointLightData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addGroup( "Light" );
|
||||
|
||||
addField( "radius", TypeF32, Offset( mRadius, afxT3DPointLightData ),
|
||||
|
|
|
|||
|
|
@ -82,6 +82,7 @@ EndImplementEnumType;
|
|||
|
||||
void afxProjectileData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addGroup("Physics");
|
||||
addField("ignoreSourceTimeout", TypeBool, myOffset(ignore_src_timeout), "...");
|
||||
addField("dynamicCollisionMask", TypeS32, myOffset(dynamicCollisionMask), "...");
|
||||
|
|
|
|||
|
|
@ -63,6 +63,7 @@ afxScriptEventData::afxScriptEventData(const afxScriptEventData& other, bool tem
|
|||
|
||||
void afxScriptEventData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addField("methodName", TypeString, myOffset(method_name),
|
||||
"The name of a script method defined for the instance class of an effects "
|
||||
"choreographer. The arguments used to call this method are determined by the type "
|
||||
|
|
|
|||
|
|
@ -66,6 +66,7 @@ afxT3DSpotLightData::afxT3DSpotLightData(const afxT3DSpotLightData& other, bool
|
|||
//
|
||||
void afxT3DSpotLightData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addGroup( "Light" );
|
||||
|
||||
addField( "range", TypeF32, Offset( mRange, afxT3DSpotLightData ),
|
||||
|
|
|
|||
|
|
@ -70,6 +70,7 @@ afxStaticShapeData::afxStaticShapeData(const afxStaticShapeData& other, bool tem
|
|||
|
||||
void afxStaticShapeData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
addGroup("Animation");
|
||||
addField("sequence", TypeString, myOffset(sequence),
|
||||
"An animation sequence in the StaticShape to play.");
|
||||
|
|
|
|||
|
|
@ -156,6 +156,7 @@ EndImplementEnumType;
|
|||
|
||||
void afxZodiacData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
INITPERSISTFIELD_IMAGEASSET(Texture, afxZodiacData, "An image to use as the zodiac's texture.");
|
||||
addField("radius", TypeF32, Offset(radius_xy, afxZodiacData),
|
||||
"The zodiac's radius in scene units.");
|
||||
|
|
|
|||
|
|
@ -111,6 +111,7 @@ EndImplementEnumType;
|
|||
|
||||
void afxZodiacPlaneData::initPersistFields()
|
||||
{
|
||||
docsURL;
|
||||
INITPERSISTFIELD_IMAGEASSET(Texture, afxZodiacPlaneData, "An image to use as the zodiac's texture.");
|
||||
|
||||
addField("radius", TypeF32, myOffset(radius_xy),
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue