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
ROCDefinition Class Reference

Class for ROC_DEFINITION confignode. Contains the data for the definition of a ROC More...

Public Member Functions

bool ContainsCBBiome (string cbName, string biomeName)
 Determine if the Definition contains an entry matching the CB name and Biome Name More...
 
void Load (ConfigNode node)
 Load the info of the ROC from the config file More...
 
 ROCDefinition (string type, string displayName, string prefabName, string modelName, bool orientateUp, float depth, bool canBeTaken, float frequency, bool castShadows, bool receiveShadows, float collisionThreshold, bool smallRoc, bool randomDepth, bool randomOrientation, List< Vector3 > localSpaceScanPoints, float burstEmitterMinWait, float burstEmitterMaxWait, bool randomRotation, float scale, float sfxVolume, string idleClipPath, string burstClipPath, FloatCurve vfxCurveForce, float vfxBaseForce, Vector2 vfxForceRadius, Vector3 forceDirection, Vector3 radiusCenter)
 Constructor More...
 

Public Attributes

bool applyForces
 Defines if the ROC VFX applies forces. More...
 
string burstClipPath
 Burst clip file path. More...
 
float burstEmitterMaxWait
 The ROCs' particle burst emitter max wait time. More...
 
float burstEmitterMinWait
 The ROCs' particle burst emitter min wait time. More...
 
bool canBeTaken
 True if a Kerbal can pick up this ROC More...
 
bool castShadows = true
 If this ROC casts shadows More...
 
float collisionThreshold
 ROC Collision resistance More...
 
float depth
 The Depth the ROC should be into the terrain. More...
 
string displayName
 The display name of the ROC. More...
 
Vector3 forceDirection
 Direction vector to apply the force in. More...
 
float frequency
 The Frequency this ROC appears per sq km More...
 
string idleClipPath
 Idle clip file path. More...
 
List< Vector3 > localSpaceScanPoints
 List of all the local space points to be used when the robot arm scanner tries to scan the ROC. More...
 
string modelName
 The name of the ROC model. More...
 
List< RocCBDefinitionmyCelestialBodies
 
bool orientateUp
 True if the ROC is to be always orientated Up More...
 
string prefabName
 The name of the ROC prefab. More...
 
Vector3 radiusCenter
 Defines the radius position. More...
 
bool randomDepth
 If this ROC has random depth More...
 
bool randomOrientation
 If this ROC has random orientation More...
 
bool randomRotation
 If this ROC has random rotation More...
 
bool receiveShadows = true
 If this ROC receives shadows More...
 
float scale = 1f
 Scale of the ROC More...
 
float sfxVolume
 ROCs' sfx audio source volume (0.0 to 1.0). More...
 
bool smallRoc
 If this ROC it's a small one More...
 
string type
 The name of the ROC (type) More...
 
float vfxBaseForce
 Defines the burst emitter force base unit. More...
 
FloatCurve vfxCurveForce
 Sets the preconfigured force scale keys for the burst emitter. More...
 
Vector2 vfxForceRadius
 Defines the VFX force collider dimensions. More...
 

Detailed Description

Class for ROC_DEFINITION confignode. Contains the data for the definition of a ROC

Constructor & Destructor Documentation

ROCDefinition.ROCDefinition ( string  type,
string  displayName,
string  prefabName,
string  modelName,
bool  orientateUp,
float  depth,
bool  canBeTaken,
float  frequency,
bool  castShadows,
bool  receiveShadows,
float  collisionThreshold,
bool  smallRoc,
bool  randomDepth,
bool  randomOrientation,
List< Vector3 >  localSpaceScanPoints,
float  burstEmitterMinWait,
float  burstEmitterMaxWait,
bool  randomRotation,
float  scale,
float  sfxVolume,
string  idleClipPath,
string  burstClipPath,
FloatCurve  vfxCurveForce,
float  vfxBaseForce,
Vector2  vfxForceRadius,
Vector3  forceDirection,
Vector3  radiusCenter 
)
inline

Constructor

Parameters
typeThe name (type) of ROC
displayNameThe display name of the ROC.
prefabNameThe name of the ROC prefab.
modelNameThe name of the ROC model.
orientateUpTrue if the ROC is to be always orientated Up
depthThe Depth the ROC should be into the terrain.
canBeTakenTrue if a Kerbal can pick up this ROC
frequencyThe Frequency this ROC appears per sq km
castShadowsIf this ROC casts shadows
receiveShadowsIf this ROC receives shadows
collisionThresholdROC Collision resistance
randomDepthIf this ROC has random depth
randomOrientationIf this ROC has random orientation
burstEmitterMinWaitThe ROCs' particle burst emitter min wait time.
burstEmitterMaxWaitThe ROCs' particle burst emitter max wait time.
localSpaceScanPointsPoints for the scanner arm to try to interact with.
sfxVolumeROCs' sfx audio source volume (0.0 to 1.0).
idleClipPathIdle clip file path.
burstClipPathBurst clip file path.
scaleScale of the ROC.
vfxBaseForceDefines the burst emitter force base unit.
vfxCurveForceThe floatCurve to control the vfx applied force.
applyForcesDefines if the ROC VFX applies forces.
forceDirectionDirection vector to apply the force in.
vfxForceRadiusDefines the VFX force collider dimensions.
radiusCenterDefines the radius position.

Member Function Documentation

bool ROCDefinition.ContainsCBBiome ( string  cbName,
string  biomeName 
)
inline

Determine if the Definition contains an entry matching the CB name and Biome Name

Parameters
cbNameThe CB name
biomeNameThe Biome name
Returns
True or Fase if there is a match
void ROCDefinition.Load ( ConfigNode  node)
inline

Load the info of the ROC from the config file

Member Data Documentation

bool ROCDefinition.applyForces

Defines if the ROC VFX applies forces.

string ROCDefinition.burstClipPath

Burst clip file path.

float ROCDefinition.burstEmitterMaxWait

The ROCs' particle burst emitter max wait time.

float ROCDefinition.burstEmitterMinWait

The ROCs' particle burst emitter min wait time.

bool ROCDefinition.canBeTaken

True if a Kerbal can pick up this ROC

bool ROCDefinition.castShadows = true

If this ROC casts shadows

float ROCDefinition.collisionThreshold

ROC Collision resistance

float ROCDefinition.depth

The Depth the ROC should be into the terrain.

string ROCDefinition.displayName

The display name of the ROC.

Vector3 ROCDefinition.forceDirection

Direction vector to apply the force in.

float ROCDefinition.frequency

The Frequency this ROC appears per sq km

string ROCDefinition.idleClipPath

Idle clip file path.

List<Vector3> ROCDefinition.localSpaceScanPoints

List of all the local space points to be used when the robot arm scanner tries to scan the ROC.

string ROCDefinition.modelName

The name of the ROC model.

List<RocCBDefinition> ROCDefinition.myCelestialBodies
bool ROCDefinition.orientateUp

True if the ROC is to be always orientated Up

string ROCDefinition.prefabName

The name of the ROC prefab.

Vector3 ROCDefinition.radiusCenter

Defines the radius position.

bool ROCDefinition.randomDepth

If this ROC has random depth

bool ROCDefinition.randomOrientation

If this ROC has random orientation

bool ROCDefinition.randomRotation

If this ROC has random rotation

bool ROCDefinition.receiveShadows = true

If this ROC receives shadows

float ROCDefinition.scale = 1f

Scale of the ROC

float ROCDefinition.sfxVolume

ROCs' sfx audio source volume (0.0 to 1.0).

bool ROCDefinition.smallRoc

If this ROC it's a small one

string ROCDefinition.type

The name of the ROC (type)

float ROCDefinition.vfxBaseForce

Defines the burst emitter force base unit.

FloatCurve ROCDefinition.vfxCurveForce

Sets the preconfigured force scale keys for the burst emitter.

Vector2 ROCDefinition.vfxForceRadius

Defines the VFX force collider dimensions.


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