reference.cfg

PART
{
name = yourPart

Part stuff ****

/*
*
*			For Reference Only - Do Not Simply Copy All Fields Into Your part.cfg
*				Most Fields Are Unnecessary - All Fields Have Default Values
*						Values below are used by my magnetometer
*/


MODULE
	{
    name = DMModuleScienceAnimate					//Name of the module - don't change this
	
	
	//Science Experiment / Animation Fields - Probably why you need this module****	
	
	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)
	
	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)
																					//Also determines how long experiment will consume resources if applicable
	
	deployingMessage = Close proximity to the craft scrambles the magnetometer's sensors, deploying the scanner now.
													//Default = null				//Message to be displayed when you try to conduct experiment with the part undeployed
		
	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 (will not effect part deployment though)
		
	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 = ElectricCharge				//Default = ElectricCharge		//What type of resource should the experiment consume?
	
	resourceExpCost = 0								//Default = 0					//How much resources should be consumed? Value is given in resource per second. The amount of time resources are consumed is determined by the waitForAnimationTime value (even if experimentWaitForAnimation = false)
	
	*****\\
	
	
	//Animation Fields****
	
	animationName = magBoom							//Default = null				//Name of your animation - get the name from Unity scene
	
	allowManualControl = false						//Default = false				//Does something???
	
	animSpeed = 2									//Default = 1					//Speed to play animation
	
	animSwitch = false								//Default ???
	
	animTime = 0									//Default = 0?					//Sets when in the animation to start?
	
	endEventGUIName = Retract Magnetometer			//Default = Retract				//Title of retract animation event/action group
	
	showEndEvent = false							//Default = true				//Do you want to show the retract event/action group - only displayed in-flight after deploy event triggered
	
	startEventGUIName = Deploy Magnetometer			//Default = Deploy				//Title of deploy animation event/action group
	
	showStartEvent = false							//Default = true				//Do you want to show the deploy event/action group
	
	toggleEventGUIName = Toggle Magnetometer		//Default = Toggle				//Title of toggle animation event/action group - Plays deploy or retract animation based on current state - Is reversible while playing
	
	showToggleEvent = true							//Default = 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							//Default = true				//Do you want to be able to preview the animation in the VAB/SPH
	
	*****\\
	
	
	//Science Experiment Fields****
		
	collectActionName = Collect Data				//Default = Collect Data		//Name of the EVA data collection event
	
	collectWarningText = 							//Default = null				//Warning text to display when retrieving data from the part during EVA - Only applicable with non-rerunnable parts
	
	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
	
	dataIsCollectable = true						//Default = true				//Allow EVA Kerbals to collect science reports from the part
		
	experimentActionName = Log Magnetometer Data	//Default = Collect Data		//Name for action group and right-click data collection function
		
	experimentID = magScan							//Default = null				//Experiment name - from the "id = " field in your ScienceDefs.cfg for this experiment
		
	hideUIwhenUnavailable = false					//Default = false				//Hide the right-click data collection buttons when experiment cannot be used
		
	interactionRange = 1.2							//Default = 1.2					//Range for EVA interaction in meters
	
	rerunnable = true								//Default = true				//Can the part be used more than once
	
	resettable = true								//Default = true				//Does nothing??? Something to do with science lab reset???
	
	resettableOnEVA = true							//Default = true				//Allow EVA Kerbals to remove any existing science reports
		
	resourceResetCost = 1							//Default = 1					//Multiplier for the resource cost to reset the experiment with a science lab
	
	resourceToReset = ElectricCharge				//Default = ElectricCharge		//Can't change????
		
	resetActionName = Discard Magnetometer Data		//Default = Reset Experiment 	//Name for action group and right-click reset function
	
	reviewActionName = Review Magnetometer Data		//Default = Review Data			//Name for action group and right-click review data function
	
	transmitWarningText = 							//Default = "" (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							//Default = true				//Are the VAB/SPH action groups available - does not affect the availability of right-click functions
	
	useStaging = False								//Default = false				//Control experiment activation through staging (may not actually work)
	
	xmitDataScalar = 1.0							//Default = 1					//Transmission data value, determines the percentage of the baseValue (from your ScienceDefs.cfg) recovered from a transmission
		
	*****\\
	
	
	}

}