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

@ -38,8 +38,9 @@ VShapeAnimationEvent::VShapeAnimationEvent( void ) :
//-----------------------------------------------------------------------------
void VShapeAnimationEvent::initPersistFields( void )
void VShapeAnimationEvent::initPersistFields()
{
docsURL;
Parent::initPersistFields();
addField( "AnimationData", TypeRealString, Offset( mAnimationData, VShapeAnimationEvent ), "The name of the Animation Sequence to play upon triggering." );
@ -151,4 +152,4 @@ F32 VShapeAnimationEvent::getAnimationPosition( const S32 &pTime )
const S32 loopInterp = S32( mDuration * interp ) % duration;
return ( F32 )loopInterp / ( F32 )duration;
}
}

View file

@ -46,7 +46,7 @@ public:
VShapeAnimationEvent( void );
static void initPersistFields( void );
static void initPersistFields();
// Callback Methods.

View file

@ -38,8 +38,9 @@ VShapeAnimationTrack::VShapeAnimationTrack( void ) :
//-----------------------------------------------------------------------------
void VShapeAnimationTrack::initPersistFields( void )
void VShapeAnimationTrack::initPersistFields()
{
docsURL;
Parent::initPersistFields();
addField( "ThreadIndex", TypeS32, Offset( mThreadIndex, VShapeAnimationTrack ), "The index of the Animation Thread to play." );

View file

@ -43,7 +43,7 @@ public:
VShapeAnimationTrack( void );
static void initPersistFields( void );
static void initPersistFields();
// Controller Methods.

View file

@ -39,8 +39,9 @@ VCameraShakeEvent::VCameraShakeEvent( void ) :
setLabel( "CameraShakeEvent" );
}
void VCameraShakeEvent::initPersistFields( void )
void VCameraShakeEvent::initPersistFields()
{
docsURL;
Parent::initPersistFields();
addField( "Amplitude", TypePoint3F, Offset( mAmplitude, VCameraShakeEvent ), "Amplitude of the Camera Shake event." );
@ -80,4 +81,4 @@ void VCameraShakeEvent::onTrigger( const S32 &pTime, const S32 &pDelta )
// Shake Camera.
VTorque::startCameraShake( duration, mFalloff, mAmplitude, mFrequency );
}
}

View file

@ -43,7 +43,7 @@ public:
VCameraShakeEvent( void );
static void initPersistFields( void );
static void initPersistFields();
// Event Methods.

View file

@ -35,8 +35,9 @@ VDirectorEvent::VDirectorEvent( void ) :
// Void.
}
void VDirectorEvent::initPersistFields( void )
void VDirectorEvent::initPersistFields()
{
docsURL;
Parent::initPersistFields();
addField( "Target", TypeRealString, Offset( mTarget, VDirectorEvent ), "The name of the CameraGroup that will be activated upon triggering." );
@ -72,4 +73,4 @@ void VDirectorEvent::onTrigger( const S32 &pTime, const S32 &pDelta )
// Change Camera.
targetGroup->setActive();
}
}

View file

@ -45,7 +45,7 @@ public:
VDirectorEvent( void );
static void initPersistFields( void );
static void initPersistFields();
// Event Methods.

View file

@ -38,8 +38,9 @@ VSceneJumpEvent::VSceneJumpEvent( void ) :
setLabel( "SceneJumpEvent" );
}
void VSceneJumpEvent::initPersistFields( void )
void VSceneJumpEvent::initPersistFields()
{
docsURL;
Parent::initPersistFields();
addField( "Target", TypeRealString, Offset( mTarget, VSceneJumpEvent ), "The name of the Scene that the controller will jump to upon triggering." );
@ -79,4 +80,4 @@ void VSceneJumpEvent::onTrigger( const S32 &pTime, const S32 &pDelta )
// Go To Scene.
getController()->jump( VController::k_JumpTime, event->getTriggerTime() );
}
}

View file

@ -41,7 +41,7 @@ public:
VSceneJumpEvent( void );
static void initPersistFields( void );
static void initPersistFields();
// Event Methods.

View file

@ -36,8 +36,9 @@ VSlowMoEvent::VSlowMoEvent( void ) :
setLabel( "SlowMoEvent" );
}
void VSlowMoEvent::initPersistFields( void )
void VSlowMoEvent::initPersistFields()
{
docsURL;
Parent::initPersistFields();
addField( "TimeScale", TypeF32, Offset( mTimeScale, VSlowMoEvent ), "The Time Scale to be applied to the Root Controller." );
@ -127,4 +128,4 @@ void VSlowMoEvent::onComplete( const S32 &pTime, const S32 &pDelta )
// Tidy Up.
controller->setTimeScale( mTimeScale );
}
}

View file

@ -42,7 +42,7 @@ public:
VSlowMoEvent( void );
static void initPersistFields( void );
static void initPersistFields();
// Event Methods.

View file

@ -34,8 +34,9 @@ VSpawnSphereSpawnTargetEvent::VSpawnSphereSpawnTargetEvent( void )
setLabel( "SpawnTargetEvent" );
}
void VSpawnSphereSpawnTargetEvent::initPersistFields( void )
void VSpawnSphereSpawnTargetEvent::initPersistFields()
{
docsURL;
Parent::initPersistFields();
}
@ -65,4 +66,4 @@ void VSpawnSphereSpawnTargetEvent::onTrigger( const S32 &pTime, const S32 &pDelt
// Spawn the Target.
track->spawnTarget();
}
}

View file

@ -40,7 +40,7 @@ public:
VSpawnSphereSpawnTargetEvent( void );
static void initPersistFields( void );
static void initPersistFields();
// Event Methods.

View file

@ -34,8 +34,9 @@ VSpawnSphereSpawnTargetTrack::VSpawnSphereSpawnTargetTrack( void )
setLabel( "SpawnTargetTrack" );
}
void VSpawnSphereSpawnTargetTrack::initPersistFields( void )
void VSpawnSphereSpawnTargetTrack::initPersistFields()
{
docsURL;
// Parent Call.
Parent::initPersistFields();

View file

@ -48,7 +48,7 @@ public:
VSpawnSphereSpawnTargetTrack( void );
static void initPersistFields( void );
static void initPersistFields();
// Controller Methods.

View file

@ -36,8 +36,9 @@ VLightObjectAnimationEvent::VLightObjectAnimationEvent( void ) :
setLabel( "AnimationEvent" );
}
void VLightObjectAnimationEvent::initPersistFields( void )
void VLightObjectAnimationEvent::initPersistFields()
{
docsURL;
Parent::initPersistFields();
addField( "AnimationData", TYPEID<VTorque::LightAnimationDataType>(), Offset( mAnimationData, VLightObjectAnimationEvent ) );
@ -89,4 +90,4 @@ void VLightObjectAnimationEvent::onComplete( const S32 &pTime, const S32 &pDelta
// Pause the Animation.
VTorque::pauseAnimation( lightObject );
}
}
}

View file

@ -45,7 +45,7 @@ public:
VLightObjectAnimationEvent( void );
static void initPersistFields( void );
static void initPersistFields();
// Event Methods.

View file

@ -34,8 +34,9 @@ VLightObjectToggleEvent::VLightObjectToggleEvent( void ) :
setLabel( "ToggleEvent" );
}
void VLightObjectToggleEvent::initPersistFields( void )
void VLightObjectToggleEvent::initPersistFields()
{
docsURL;
Parent::initPersistFields();
addField( "Action", TYPEID<VActionToggle>(), Offset( mEventType, VLightObjectToggleEvent ) );
@ -67,4 +68,4 @@ void VLightObjectToggleEvent::onTrigger( const S32 &pTime, const S32 &pDelta )
// Toggle Light.
VTorque::setLightObjectOn( lightObject, turnOn );
}
}
}

View file

@ -49,7 +49,7 @@ public:
VLightObjectToggleEvent( void );
static void initPersistFields( void );
static void initPersistFields();
// Event Methods.

View file

@ -39,8 +39,9 @@ VMotionTrack::VMotionTrack( void ) :
setLabel( "MotionTrack" );
}
void VMotionTrack::initPersistFields( void )
void VMotionTrack::initPersistFields()
{
docsURL;
Parent::initPersistFields();
addField( "Reference", TypeRealString, Offset( mDataReference, VMotionTrack ), "The name of the data field referencing the object to be attached to the path." );

View file

@ -53,7 +53,7 @@ public:
VMotionTrack( void );
static void initPersistFields( void );
static void initPersistFields();
// Controller Methods.

View file

@ -34,8 +34,9 @@ VParticleEffectToggleEvent::VParticleEffectToggleEvent( void ) :
setLabel( "ToggleEvent" );
}
void VParticleEffectToggleEvent::initPersistFields( void )
void VParticleEffectToggleEvent::initPersistFields()
{
docsURL;
Parent::initPersistFields();
addField( "Action", TYPEID<VActionToggle>(), Offset( mEventType, VParticleEffectToggleEvent ) );
@ -67,4 +68,4 @@ void VParticleEffectToggleEvent::onTrigger( const S32 &pTime, const S32 &pDelta
// Toggle Particle Effect.
VTorque::setParticleEffectOn( particleEffect, turnOn );
}
}
}

View file

@ -49,7 +49,7 @@ public:
VParticleEffectToggleEvent( void );
static void initPersistFields( void );
static void initPersistFields();
// Event Methods.

View file

@ -36,8 +36,9 @@ VPostEffectToggleEvent::VPostEffectToggleEvent( void ) :
setLabel( "ToggleEvent" );
}
void VPostEffectToggleEvent::initPersistFields( void )
void VPostEffectToggleEvent::initPersistFields()
{
docsURL;
Parent::initPersistFields();
addField( "Action", TYPEID<VActionToggle>(), Offset( mEventType, VPostEffectToggleEvent ) );
@ -74,4 +75,4 @@ void VPostEffectToggleEvent::onTrigger( const S32 &pTime, const S32 &pDelta )
// Enable Effect.
VTorque::setPostEffectOn( track->getPostEffect(), turnOn );
}
}

View file

@ -49,7 +49,7 @@ public:
VPostEffectToggleEvent( void );
static void initPersistFields( void );
static void initPersistFields();
// Event Methods.

View file

@ -36,8 +36,9 @@ VPostEffectToggleTrack::VPostEffectToggleTrack( void ) :
setLabel( "PostEffectTrack" );
}
void VPostEffectToggleTrack::initPersistFields( void )
void VPostEffectToggleTrack::initPersistFields()
{
docsURL;
Parent::initPersistFields();
addField( "PostEffect", TYPEID<VTorque::PostEffectType>(), Offset( mPostEffect, VPostEffectToggleTrack ), "The name of the PostEffect object to be triggered." );
@ -100,4 +101,4 @@ bool VPostEffectToggleTrack::onCameraEvent( const VCameraGroup::eCameraEventType
}
return true;
}
}

View file

@ -45,7 +45,7 @@ public:
VPostEffectToggleTrack( void );
static void initPersistFields( void );
static void initPersistFields();
// Camera Methods.

View file

@ -36,8 +36,9 @@ VSceneObjectGroup::VSceneObjectGroup( void ) :
setLabel( "SceneObjectGroup" );
};
void VSceneObjectGroup::initPersistFields( void )
void VSceneObjectGroup::initPersistFields()
{
docsURL;
Parent::initPersistFields();
addField( "Reference", TypeRealString, Offset( mDataReference, VSceneObjectGroup ), "The name of the data field referencing the targeted object." );

View file

@ -48,7 +48,7 @@ public:
VSceneObjectGroup( void );
static void initPersistFields( void );
static void initPersistFields();
// Reference Methods.

View file

@ -46,8 +46,9 @@ VScriptEvent::VScriptEvent( void ) :
setLabel( "ScriptEvent" );
}
void VScriptEvent::initPersistFields( void )
void VScriptEvent::initPersistFields()
{
docsURL;
Parent::initPersistFields();
addField( "CommandType", TYPEID<eCommandType>(), Offset( mCommandType, VScriptEvent ), "The type of command to be evaluated." );

View file

@ -50,7 +50,7 @@ public:
VScriptEvent( void );
static void initPersistFields( void );
static void initPersistFields();
// Event Methods.

View file

@ -36,8 +36,9 @@ VSoundEffectEvent::VSoundEffectEvent( void ) :
setLabel( "SoundEvent" );
}
void VSoundEffectEvent::initPersistFields( void )
void VSoundEffectEvent::initPersistFields()
{
docsURL;
Parent::initPersistFields();
addProtectedField( "SoundEffect", TYPEID<VTorque::SoundEffectType>(), Offset( mSoundEffect, VSoundEffectEvent ), &setSoundData, &defaultProtectedGetFn, "" );
@ -128,4 +129,4 @@ bool VSoundEffectEvent::setSoundData( void *pObject, const char *pArray, const c
event->setDuration( 0 );
return false;
}
}

View file

@ -50,7 +50,7 @@ public:
VSoundEffectEvent( void );
static void initPersistFields( void );
static void initPersistFields();
static bool setSoundData( void *pObject, const char *pArray, const char *pData );