Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | List of all members
Expansions.Serenity.RobotArmFX.RobotArmFXLaser Class Reference
Inheritance diagram for Expansions.Serenity.RobotArmFX.RobotArmFXLaser:
Expansions.Serenity.RobotArmFX.RobotArmScannerFX IConfigNode

Public Member Functions

override void Load (ConfigNode node)
 
override void OnEffectStart ()
 Called to set up effects just as animation starts. More...
 
override void OnEffectStop ()
 Called to stop effects just as animation ends or if there's an problem and the arm has to retract in the middle of the animation. More...
 
override void OnStart (Part part)
 Called to Initialize things when the RobotArm is started. More...
 
override void OnUpdate (float animationTime, float distanceFromSurface, Vector3 instrumentTargetPosition)
 Called to update effects as the animation plays. More...
 
 RobotArmFXLaser ()
 Constructor. More...
 
override void Save (ConfigNode node)
 
- Public Member Functions inherited from Expansions.Serenity.RobotArmFX.RobotArmScannerFX
 RobotArmScannerFX ()
 Constructor. More...
 

Public Attributes

string configLaserEffectColor = "#FF0000"
 Colour of the laser effect saved in the config file. More...
 
bool hasPerformedSetupRaycast = false
 Whether the laser VFX has performed the raycast to set itself up yet. More...
 
Color laserEffectColor = Color.red
 Colour of the laser effect. More...
 
Transform laserEffectTransform
 Transform to use for displaying the laser VFX. More...
 
string laserEffectTransformName = "LaserTransform"
 Name of the transform to use for displaying the laser VFX. More...
 
float laserEffectWidth = 0.01f
 Width of the line renderer use for the laser. More...
 
LineRenderer laserLineRenderer
 Line renderer to use for displaying the laser VFX. More...
 
Vector3 laserTarget
 The laser will aim at this point. More...
 
- Public Attributes inherited from Expansions.Serenity.RobotArmFX.RobotArmScannerFX
string className = string.Empty
 Class name of the effect to be instantiated. More...
 
float effectStartTime = 0
 Start time of the effect in the animation timescale. More...
 
float effectStopTime = 1
 Stop time of the effect in the animation timescale. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Expansions.Serenity.RobotArmFX.RobotArmScannerFX
static RobotArmScannerFX CreateInstanceOfRobotArmScannerFX (string className)
 Creates a new part module adjuster. More...
 
- Properties inherited from Expansions.Serenity.RobotArmFX.RobotArmScannerFX
bool IsReady [get, set]
 Is the effect ready to go. More...
 
Part Part [get, set]
 

Constructor & Destructor Documentation

Expansions.Serenity.RobotArmFX.RobotArmFXLaser.RobotArmFXLaser ( )
inline

Constructor.

Member Function Documentation

override void Expansions.Serenity.RobotArmFX.RobotArmFXLaser.Load ( ConfigNode  node)
inlinevirtual
override void Expansions.Serenity.RobotArmFX.RobotArmFXLaser.OnEffectStart ( )
inlinevirtual

Called to set up effects just as animation starts.

Implements Expansions.Serenity.RobotArmFX.RobotArmScannerFX.

override void Expansions.Serenity.RobotArmFX.RobotArmFXLaser.OnEffectStop ( )
inlinevirtual

Called to stop effects just as animation ends or if there's an problem and the arm has to retract in the middle of the animation.

Implements Expansions.Serenity.RobotArmFX.RobotArmScannerFX.

override void Expansions.Serenity.RobotArmFX.RobotArmFXLaser.OnStart ( Part  part)
inlinevirtual

Called to Initialize things when the RobotArm is started.

Parameters
partPart that this effect will be played on.

Reimplemented from Expansions.Serenity.RobotArmFX.RobotArmScannerFX.

override void Expansions.Serenity.RobotArmFX.RobotArmFXLaser.OnUpdate ( float  animationTime,
float  distanceFromSurface,
Vector3  instrumentTargetPosition 
)
inlinevirtual

Called to update effects as the animation plays.

Parameters
animationTimeTime that has passed for the scan animation.
distanceFromSurfaceDistance that the scanner head will stop at from the surface.
instrumentTargetPositionTarget position that the instrument should be pointing at.

Implements Expansions.Serenity.RobotArmFX.RobotArmScannerFX.

override void Expansions.Serenity.RobotArmFX.RobotArmFXLaser.Save ( ConfigNode  node)
inlinevirtual

Member Data Documentation

string Expansions.Serenity.RobotArmFX.RobotArmFXLaser.configLaserEffectColor = "#FF0000"

Colour of the laser effect saved in the config file.

bool Expansions.Serenity.RobotArmFX.RobotArmFXLaser.hasPerformedSetupRaycast = false

Whether the laser VFX has performed the raycast to set itself up yet.

Color Expansions.Serenity.RobotArmFX.RobotArmFXLaser.laserEffectColor = Color.red

Colour of the laser effect.

Transform Expansions.Serenity.RobotArmFX.RobotArmFXLaser.laserEffectTransform

Transform to use for displaying the laser VFX.

string Expansions.Serenity.RobotArmFX.RobotArmFXLaser.laserEffectTransformName = "LaserTransform"

Name of the transform to use for displaying the laser VFX.

float Expansions.Serenity.RobotArmFX.RobotArmFXLaser.laserEffectWidth = 0.01f

Width of the line renderer use for the laser.

LineRenderer Expansions.Serenity.RobotArmFX.RobotArmFXLaser.laserLineRenderer

Line renderer to use for displaying the laser VFX.

Vector3 Expansions.Serenity.RobotArmFX.RobotArmFXLaser.laserTarget

The laser will aim at this point.


The documentation for this class was generated from the following file: