[1.9.x+] ModuleAnimateGenericEffects

[linuxgurugamer]

 

ModuleAnimateGenericEffects

The stock ModuleAnimateGeneric does not allow for any effects (ie: audio, or other).  This module extends the stock module and adds effects

 

This is an expansion of the stock  ModuleAnimateGeneric module.  It adds the following:

1. Associate effects with the moving animation
2. Modules now follow part symmetry
3. animSpeed is now working to set the animation speed

Usage

This works by utilizing the stock EFFECTS stanzas as used in many parts.  See the stock documentation for information on how to set up the EFFECTS stanzas

The syntax for the module itself is identical to the stock ModuleAnimateGeneric, with the following additions:

        deployEffectName = deploy
        postDeployEffectName = deployed
        postDeployEffectLength = 0.5
        retractEffectName = retract
        postRetractEffectName = retracted
        postRetractEffectLength = 0.5
        animSpeed = 0.1

where

    deployEffectName is the effect(s) which should be played when deploying
    postDeployEffectName is the effect(s) which should be played when deployment is completed.
    postDeployEffectLength is how long the post-deployment effect should be played
    retractEffectName is the effect(s) which should be played when retracting
    postRetractEffectName is the effect(s) which should be played when retractment is completed
    postRetractEffectLength is how long the post-retractment effect should be played
    animationRampSpeed controls how quickly the animation gets up to speed.  If not specified, starts at full speed
    customAnimationSpeed is a multiplier to adust the speed without having to change the model
    reverseGUIName is the text to put into the PAW to reverse the motion.  If not specified, then will not be active
 

Default Values

        deployEffectName = deploy
        postDeployEffectName = 
        postDeployEffectLength = 0.5
        retractEffectName = retract
        postRetractEffectName = 
        postRetractEffectLength = 0.5
        animSpeed = 1
        animationRampSpeed = 0.005
        customAnimationSpeed = 1
        reverseGUIName = 
 

    If no value is specified, no effect will be played

Incompatible Option

This mod is not compatible with the stock option:

allowDeployLimit = true

 

Availability

• Download:https://spacedock.info/mod/2345/ModuleAnimateGenericEffects
• Source: https://github.com/linuxgurugamer/ModuleAnimateGenericEffects
• License: CC-BY-NC-SA-4.0

Available via CKAN

Edited July 27, 2022 by linuxgurugamer

[Stone Blue]

OMG... THANK YOU for this LGG..
I know just how I want to try implementing this, for the first time, on Something™...

[JadeOfMaar]

@linuxgurugamer Delivering more things we didn't know we needed!

Epic "YES!" gif in the spoiler

Spoiler

 

[pmborg]

Hello @linuxgurugamer please note that the content of CKAN and spacedock.info don't mach.

Maybe a kind of refresh is needed.

CKAN vs spacedock download.

[linuxgurugamer]

It's not a problem.  The spacedock one was hand generated, the CKAN (from Github) was automatic.  This was the initial release, will be consistent in any future releases

[linuxgurugamer]

New release, 0.0.1.1

• Fixed actions in editor not working

[Probus]

I'm guessing this will work with DMagic's Science Animate

[linuxgurugamer]

31 minutes ago, Probus said:

I'm guessing this will work with DMagic's Science Animate

Ummm, only if his uses ModuleAnimateGeneric

[AlphaMensae]

@linuxgurugamer How hard would it be to add customized names for deploy limit sliders?  So they don't say "Deploy Limit", but anything you'd want.

[linuxgurugamer]

5 minutes ago, AlphaMensae said:

@linuxgurugamer How hard would it be to add customized names for deploy limit sliders?  So they don't say "Deploy Limit", but anything you'd want.

Probably not too difficult.  I'm busy with some other stuff, but make an issue and I'll look at it.

 

[AlphaMensae]

52 minutes ago, linuxgurugamer said:

Probably not too difficult.  I'm busy with some other stuff, but make an issue and I'll look at it.

 

Done! And thanks!

[linuxgurugamer]

New release, 0.1.3

• Added AssemblyFileVersion
• Updated version file for 1.12

[ColdJ]

@linuxgurugamer

Hi. I am trying to use your plugin to get some gear for the Millenium Falcon to make noise when closing and opening.

I have installed the plugin in the folder structure as it came.

C:\KSP1.12.2\Kerbal Space Program\GameData\ModuleAnimateGenericEffects\Plugins\ModuleAnimateGenericEffects.dll

I do have the latest Module Manager if that is required. No dependencies were stated. I have set up the config as follows and the actual animation works fine. I tried the default set up at first and when no sound came I increased the value of length, though I do not know what unit you are using. Could you please look at the following and tell me if I missed something?
 

Spoiler

    MODULE
    {
        name = ModuleAnimateGeneric
        animationName = LandingGear
        startEventGUIName = Gear Up
        endEventGUIName = Gear Down
        actionGUIName = Landing Gear
        defaultActionGroup = Gear

        deployEffectName = deploy

        postDeployEffectName = deployed
 
        postDeployEffectLength = 5.0
        retractEffectName = retract

        postRetractEffectName = retracted
 
        postRetractEffectLength = 5.0

        animSpeed = 1

    
    }

    EFFECTS
    {
        deploy
        {
            AUDIO
            {
                channel = Ship
                clip = Squad/Sounds/elev_start
                volume = 0 0
                volume = 1 0.7
                pitch = 0.75
            }
            AUDIO_LOOP
            {
                channel = Ship
                clip = Squad/Sounds/elev_loop
                volume = 0 0
                volume = 1 0.7
                pitch = 0.55
            }
        }
        deployed
        {
            AUDIO
            {
                channel = Ship
                clip = Squad/Sounds/elev_stop
                volume = 0 0
                volume = 1 0.7
                pitch = 0.50
            }
        }
        retract
        {
            AUDIO
            {
                channel = Ship
                clip = Squad/Sounds/elev_stop
                volume = 0 0
                volume = 1 0.7
                pitch = 0.60
            }
            AUDIO_LOOP
            {
                channel = Ship
                clip = Squad/Sounds/elev_loop
                volume = 0 0
                volume = 1 0.7
                pitch = 0.50
            }
        }
        retracted
        {
            AUDIO
            {
                channel = Ship
                clip = Squad/Sounds/elev_start
                volume = 0 0
                volume = 1 0.7
                pitch = 0.75
            }
        }
    }

 

[linuxgurugamer]

14 minutes ago, ColdJ said:

postDeployEffectLength = 5.0

is in seconds

I would have to look at the parts, etc. to have an idea of what's oging on.  If you send them to me, I can take a look

[linuxgurugamer]

On 2/7/2022 at 12:25 PM, ColdJ said:

@linuxgurugamer

Hi. I am trying to use your plugin to get some gear for the Millenium Falcon to make noise when closing and opening.

I have installed the plugin in the folder structure as it came.

C:\KSP1.12.2\Kerbal Space Program\GameData\ModuleAnimateGenericEffects\Plugins\ModuleAnimateGenericEffects.dll

I do have the latest Module Manager if that is required. No dependencies were stated. I have set up the config as follows and the actual animation works fine. I tried the default set up at first and when no sound came I increased the value of length, though I do not know what unit you are using. Could you please look at the following and tell me if I missed something?
 

  Reveal hidden contents

    MODULE
    {
        name = ModuleAnimateGeneric
        animationName = LandingGear
        startEventGUIName = Gear Up
        endEventGUIName = Gear Down
        actionGUIName = Landing Gear
        defaultActionGroup = Gear

        deployEffectName = deploy

        postDeployEffectName = deployed
 
        postDeployEffectLength = 5.0
        retractEffectName = retract

        postRetractEffectName = retracted
 
        postRetractEffectLength = 5.0

        animSpeed = 1

    
    }

    EFFECTS
    {
        deploy
        {
            AUDIO
            {
                channel = Ship
                clip = Squad/Sounds/elev_start
                volume = 0 0
                volume = 1 0.7
                pitch = 0.75
            }
            AUDIO_LOOP
            {
                channel = Ship
                clip = Squad/Sounds/elev_loop
                volume = 0 0
                volume = 1 0.7
                pitch = 0.55
            }
        }
        deployed
        {
            AUDIO
            {
                channel = Ship
                clip = Squad/Sounds/elev_stop
                volume = 0 0
                volume = 1 0.7
                pitch = 0.50
            }
        }
        retract
        {
            AUDIO
            {
                channel = Ship
                clip = Squad/Sounds/elev_stop
                volume = 0 0
                volume = 1 0.7
                pitch = 0.60
            }
            AUDIO_LOOP
            {
                channel = Ship
                clip = Squad/Sounds/elev_loop
                volume = 0 0
                volume = 1 0.7
                pitch = 0.50
            }
        }
        retracted
        {
            AUDIO
            {
                channel = Ship
                clip = Squad/Sounds/elev_start
                volume = 0 0
                volume = 1 0.7
                pitch = 0.75
            }
        }
    }

 

Your problem is on the third line. It still says ModuleAnimateGeneric.

I replaced it with:   ModuleAnimateGenericEffects   and the sounds worked

 

 

[ColdJ]

Thank you for that. I hadn't realised it was a different module. Thought it was an expansion to the original. I shall try that and let you know if I get the same.

[linuxgurugamer]

37 minutes ago, ColdJ said:

Thank you for that. I hadn't realised it was a different module. Thought it was an expansion to the original. I shall try that and let you know if I get the same.

It is an expansion, but in order to do that, the new module inherits all the settings from the original

[ColdJ]

@linuxgurugamerThank you again. Works as advertised. I have a number of things that this will be great for. It is amazing that it takes a modder like yourself to get useful stuff like this. You would think that it should be a stock module.

@AtomicTech Here is a great addition to your arsenal for useful mods to help with your own future mods.

[linuxgurugamer]

New release, 0.1.4

• Added ability to ramp up the speed of the animation
• Added ability to reverse the direction of the animation
   

[ColdJ]

@linuxgurugamer

Hi. I have a few people who when using the 0.1.4 version of the plugin get  animations stuttering and reseting before getting stuck part way. I personally use the 0.1.3 version and haven't had any issues with that version.

There are both varying levels of windows users and a Mac user.

[linuxgurugamer]

On 9/13/2022 at 12:58 AM, ColdJ said:

@linuxgurugamer

Hi. I have a few people who when using the 0.1.4 version of the plugin get  animations stuttering and reseting before getting stuck part way. I personally use the 0.1.3 version and haven't had any issues with that version.

There are both varying levels of windows users and a Mac user.

I'll take a look

[linuxgurugamer]

On 9/13/2022 at 12:58 AM, ColdJ said:

@linuxgurugamer

Hi. I have a few people who when using the 0.1.4 version of the plugin get  animations stuttering and reseting before getting stuck part way. I personally use the 0.1.3 version and haven't had any issues with that version.

There are both varying levels of windows users and a Mac user.

What parts are you having these issues with

[ColdJ]

13 hours ago, linuxgurugamer said:

What parts are you having these issues with

The last was in my Oblivion Bubble Patrol Ship mod but also got a report from my Thunderbird mod. I am guessing those who started using the mod before the last update were fine but those who got it afterwards had trouble. Many people don't take the time to report and just assume my mod is broken, so I don't know how many had trouble.

The bubble ship is all one piece and I used the plugin for 2 of the animations. The landing gear and the transition of the engines.

[linuxgurugamer]

I might revert the version until I get this figured out

[linuxgurugamer]

New release, 0.1.5

• Reverted back to 0.1.3 code, using 0.1.5 for CKAN support