[Plugin 0.16] Animation part module

[Kreuzung]

As of 1.4.2, the energy plugin also contains a part module called ModuleKrAnimation, which can be used for different things, such as cargo bay doors, landing legs, parts that deploy in some form if they activate (should work with anything activated by staging), stuff that can be "used" by EVAs etc.

Usage:

MODULE
{

[INDENT]name = ModuleKrAnimation
<parameters>
[/INDENT]

}

Do NOT use the string paramters with the Quotes!!!

extendAnim = used animation (this has to be set. If you don't know the name, just apply the part module without parameters and load the game. Place the part on a new ship, and open debug console with Alt+F2. It should show some lines that start with * or **, AFAIK the ** ones are the animation names.)

extendGUI = GUI name for extending (default: Extend)

retractGUI = GUI name for retracting (default: Retract). Set this to 'none' to disable the retract GUI option.

controllableInside = 'always' to always allow controlling it, 'commandable' to only allow if the vessel can be controlled, 'never' to disable manual control from inside the ship completely (default: always)

EVA_Range = range in meters in which Kerbals are able to control it from outside (default: 0, deactivates it completely)

stage = if set to 1, it will extend if the stage it is in is activated (default: 0)

landingGear = if set to 1, it will extend or retract if the landing gear key is pressed (default: 0)

key = Unity keycode for extend/retract. Please don't spam the keyboard for nothing.

state = if set to 1, it will show up the extended state in the editor and start extended on flight scene (default: 0)

animPlayStart = if set to -1, it will show the retract animation in the editor, if set to 1, it will show the extend animation (default: 0, might require state to be set to work)

energyConsumptionExtend = overall energy consumption while extending (default: 0)

energyConsumptionRetract = overall energy consumption while retracting (default: 0)

energyConsumptionExtended = energy consumption per second while extended (default: 0, may cause deadlock situations if energyConsumptionRetract is set too)

As for modeling, it requires a model in the .mu format with an animation called whatever exendAnim is set to (again, if you don't know which animations the model contains, use the way described in the spoiler to find all animations in the model). For retracting, the animation is played backwards.

Note that the part module assumes that the model is in retracted state by default, if it isn't, you might have to use extend as retract and the other way round for some parameters.

Get the plugin from the link in my signature, source code included, CC BY license.

Edited October 13, 2012 by Kreuzung
Updated for version 1.5

[Dani-Sang]

Perfect - I love you

[LaydeeDem]

I wont have to use landing gear for animations anymore! I love you as well.

[CardBoardBoxProcessor]

this si the best thing since slice bread

I noticed it will not work on decouples.

Edited September 17, 2012 by CardBoardBoxProcessor

[Kreuzung]

It might not always work, though I don't really know why it shouldn't. I'll look into it.

[Hyratel]

I know it'd probably be duplicating functionality to have it in both but does this play nice with PowerTech? as it seems that Powertech can set a variable drag factor for folded/deployed

[Kreuzung]

If you use the same animation on the same part it will probably fail horribly.

I'm currently working on improving it, I've got a very powerful system for changing values of the part in mind, hopefully it will work the way I want it to

[Kreuzung]

Just a warning because this seems to become popular, I had to remove retractAnim, so please don't create a separate animation for retracting as it won't work with the next release.

[Kreuzung]

New version contains optional key and energy consumption parameters, also fixed some issues, enjoy.

[Yogui87]

Hi, Kreuzung, can you tell me how to add an optional key to the .cfg file please? I don't find anywhere. Thanks.

[Kreuzung]

It's in the spoiler, I grouped it with stage and gear option because they're all keyboard-related.

key = Unity keycode for extend/retract. Please don't spam the keyboard for nothing.

Edit: Derp the link to the keycode list got lost when copying, look it up in the spoier if you need it. Most of them are easy to guess anyway.

[Yogui87]

Thanks, definitely I'm blind.