reference.cfg

/*
*								Version 0.21
*			For Reference Only - Do Not Simply Copy All Fields Into Your part.cfg
*				Most Fields Are Unnecessary - All Fields Have Default Values
*/


MODULE
	{
    name = DMModuleScienceAnimateGeneric			//Name of the module - don't change this
	
	--------------------------
	
	//Animation Fields**** Similar to ModuleAnimateGeneric (default values shown)
	
	animationName = *"your animation name"			//Name of your animation - get the name from Unity scene
	sampleAnim = *"your sample fill animation name" //Name of the animation to be played when a sample is stored in a multiple-use experiment, experimentsLimit must be greater than 1 to function correctly
	animSpeed = 1						//Speed to play animation
	endEventGUIName = Retract				//Title of retract animation event/action group
	showEndEvent = true					//Do you want to show the retract event/action group - only displayed in-flight after deploy event triggered
	startEventGUIName = Deploy				//Title of deploy animation event/action group
	showStartEvent = true					//Do you want to show the deploy event/action group
	toggleEventGUIName = Toggle 				//Title of toggle animation event/action group - Plays deploy or retract animation based on current state - Is reversible while playing
	showToggleEvent = false					//Do you want to show the toggle event/action group - not recommended to be used together with deploy/retract events, too many unnecessary buttons
	showEditorEvents = true					//Do you want to be able to preview the animation in the VAB/SPH
	useSampleTransforms = false				//Do you have mesh transforms that represent physical samples which should be removed when an experiment is collected or transmited
	sampleTransformName = "transformName"	//The name of the mesh transform representing the sample
											//If collection of more than one sample is allowed then the number of transforms must equal the number of samples
											//And the transforms must use the same name prefix followed by a .00x number; sampleTransform.000, sampleTransform.001, etc...
											//Only the tranform prefix should be entered in this field, sampleTransform for this example
	useReplacementTransforms = false			//Do you want to have a mesh that is activated only when a sample is collected or transmitted from the part?
	replacementTransformScale = 1				//The scale of the replacement mesh
	replacementTransformName = "transformName"	//The name of the replacement mesh transform - the same rules specified for "sampleTransformName" apply when multiple samples can be collected

	dataRemovalAnimation = false							//Do you want to play an animation when a sample is collected or transmitted?
	dataRemovalAnimationReverse = false						//Do you want the animation to play in reverse when the experiment is reset?
	dataRemovalAnimationName = "Data removal animation name"//The name of the data removal animation
	waitForDataRemoval = false								//Do you want to wait for the animation to complete before sample transforms are disabled or enabled.

	*****\\
	
	--------------------------
	
	//Science Experiment Fields**** The same as ModuleScienceExperiment (default values shown)
		
	collectActionName = Collect Data			//Name of the EVA data collection event
	collectWarningText = *empty string			//Warning text to display when retrieving data from the part during EVA - Only applicable with non-rerunnable parts
	dataIsCollectable = true				//Allow EVA Kerbals to collect science reports from the part
	experimentActionName = Collect Data			//Name for action group and right-click data collection function
	experimentID = *"your experiment id"			//Experiment name - from the "id = " field in your ScienceDefs.cfg for this experiment
	hideUIwhenUnavailable = false				//Hide the right-click data collection buttons when experiment cannot be used
	interactionRange = 1.2					//Range for EVA interaction in meters
	rerunnable = true					//Can the part be used more than once
	resettable = true					//Does nothing???
	resettableOnEVA = true					//Allow EVA Kerbals to reset the part - removes any existing science reports
	resourceResetCost = 1					//Multiplier for the resource cost to reset the experiment with a science lab
	resourceToReset = ElectricCharge			//Can't change????
	resetActionName = Reset Experiment			//Name for action group and right-click reset function
	reviewActionName = Review Data				//Name for action group and right-click review data function
	transmitWarningText = *empty string			//Warning text when transmitting data - only applicable for non-rerunnable parts - do not add anything here unless you want the warning to show
	useActionGroups = True					//Are the VAB/SPH action groups available - does not affect the availability of right-click functions
	useStaging = False					//Control experiment activation through staging (may not actually work)
	xmitDataScalar = 0.5					//Transmission data value, determines the percentage of the baseValue (from your ScienceDefs.cfg) recovered from a transmission
	usageReqMaskExternal = -1				//Bit Mask to define external usage conditions; 8 specifies that the EVA kerbal must be a scientist to deploy the experiment; 4 will allow any Kerbal to deploy from EVA; -1 means nothing can use the experiment externally
		
	*****\\
	
	--------------------------
	
	//Science Experiment - Animation Fields**** (fields are from my magnetometer setup)
	
	customFailMessage = The magnetometer is not suitable for use during atmospheric flight, try again on the ground or in space.
						//Default = Can't conduct experiment here
								//Message to be displayed when you attempt an experiment in an unsuitable situation - from the situationMask in your ScienceDefs.cfg file
	deployingMessage = Close proximity to the craft scrambles the magnetometer's sensors, deploying the scanner now.
						//Default = empty string	//Message to be displayed when you try to conduct experiment with the part undeployed
	experimentAnimation = true		//Default = true		//Do you want your experiment to be dependent on the animation playing/already being deployed - why else would you be using this plugin?
	experimentWaitForAnimation = true	//Default = false		//Do you want to wait for the animation to complete before you begin the experiment (or any other arbitrary amount of time)
	keepDeployedMode = 2			//Default = 0			//Determines when to play the retract animation
									//Value of 0 is the stock behavior (mostly) - Parts retract when the experiment is reset or the data is transmitted 
									//Value of 1 - Retracts the part immediately after conducting the experiment - i.e. when the experiment results page appears - *probably better to set up a one way animation
									//Value of 2 - Part will not retract - only manual controls can retract the part
	waitForAnimationTime = -1		//Default = -1 (value set to the length of the animation)
									//Amount of time to wait after deploying the animation before the experiment begins - 0 will begin immediately, -1 waits for the animation to complete (this does take into account animSpeed specified above)
	oneWayAnimation = false			//Default = false		//Do you want the animation to only play in one direction - The animation should begin and end in the same position
	resourceExperiment = *empty string	//Default = ElectricCharge	//Do you want to use resources while collecting data, and what type do you want to use
										//This only functions while waitForAnimationTime and resourceExpCost both != 0, experimentWaitForAnimation can be set to false
										//Experiment will fail if you run out of the resource
	resourceExpCost = 0			//Default = 0			//The cost, in units per second, of resources used while collecting data
	asteroidReports = true			//Default = false		//Do you want to be able to collect results while landed on and/or near an asteroid
									//Asteroid reports in the ScienceDefs.cfg file follow the format: "AsteroidSrfLandedClassA" or "AsteroidInSpaceLowClassA" for each asteroid class, A-E
									//Only SrfLanded and InSpaceLow experimental situations are allowed
	planetaryMask = 524287			//Default = 524287	//Bitmask defining which planets the experiment can be performed on/around, works everywhere by default
	planetFailMessage = Can't conduct experiment here	//Default = Can't conduct experiment here 		//Message to be displayed if the experiment can't be performed on the current planet/moon
	storageFullMessage = No more samples can be collected //Message to play when you can't collect any more data
	experimentsLimit = 1          	//Default = 1		//Sets the limit for how many experiments can be collected and stored by an individual part
	labDataBoost = 0				//Default = 0		//Set the gain for transmission after lab processing; the default value, 0, will set the boost to 50% of the regular transmission value
	externalDeploy = true			//Default = false	//Allow the experiment to be triggered by an EVA Kerbal; still requires power if applicable
	resetLevel = 0				//Default = 0 		//Level of scientist required to reset a used experiment on EVA
	
	excludeAtmosphere = false			//Default = false	//Specify experiments that can only run on planets/moons without an atmosphere
	excludeAtmosphereMessage = This experiment can't be conducted within an atmosphere       //Message to be displayed when an experiment fails because an atmosphere is present
	
	requiredParts = *empty string		//Default = none	//A list of part names that are required to be on the vessel for the experiment to work - separate part names by a , - all specified parts must be on the current vessel - use the actual part name (the name = myPart field in the part config), not the in-game title
	requiredModules = *empty string 	//Default = none	//A list of part modules that are required to be used by parts on the vessel for the experiment to work - separate modules by a , - all specified modules must be used by parts on the vessel
	
	requiredPartsMessage = *empty string 	//Default = empty string	//A message to indicate which parts are required
	requiredModulesMessage = *empty string 	//Default = empty string	//A message to indicate which part modules are required
	
	allowEVACleanUp = true					//Default = true			//Allow for an EVA scientist to reset a used experiment
	
	totalScienceLevel = 1		//Set to less than 1 to allow for experiments that collect less than 100% of an experiments max value; allows for multiple parts to conduct the same experiment with differing levels of max science available
	*****\\
	}