Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Properties | List of all members
IScalarModule Interface Reference

Implies the module is capable of manifesting a continuous state transition based on a scalar parameter, like an animation, particle FX, speed of something, etc. More...

Inheritance diagram for IScalarModule:
ModuleAnimateGeneric ModuleAnimationSetter ModuleColorChanger ModuleDeployablePart ModuleJettison ModuleLight ModuleProceduralFairing ModuleServiceModule

Public Member Functions

bool IsMoving ()
 
void SetScalar (float t)
 Call to tell the module to assume the given state. Mind transition may not happen instantly. Check GetScalar for the actual state of the thing. More...
 
void SetUIRead (bool state)
 Call to set whether or not the module will display its own UI. Read and Write define which kinds of information are allowed to be displayed More...
 
void SetUIWrite (bool state)
 Call to set whether or not the module will display its own UI. Read and Write define which kinds of information are allowed to be displayed More...
 

Properties

bool CanMove [get]
 A flag stating whether or not the module is able to change state at all. More...
 
float GetScalar [get]
 
EventData< float, float > OnMoving [get]
 
EventData< float > OnStop [get]
 
string ScalarModuleID [get]
 

Detailed Description

Implies the module is capable of manifesting a continuous state transition based on a scalar parameter, like an animation, particle FX, speed of something, etc.

Member Function Documentation

bool IScalarModule.IsMoving ( )
void IScalarModule.SetScalar ( float  t)

Call to tell the module to assume the given state. Mind transition may not happen instantly. Check GetScalar for the actual state of the thing.

Parameters
s

Implemented in ModuleProceduralFairing, ModuleDeployablePart, ModuleLight, ModuleJettison, ModuleAnimateGeneric, ModuleColorChanger, ModuleServiceModule, and ModuleAnimationSetter.

void IScalarModule.SetUIRead ( bool  state)

Call to set whether or not the module will display its own UI. Read and Write define which kinds of information are allowed to be displayed

Implemented in ModuleProceduralFairing, ModuleDeployablePart, ModuleLight, ModuleJettison, ModuleAnimateGeneric, ModuleColorChanger, ModuleServiceModule, and ModuleAnimationSetter.

void IScalarModule.SetUIWrite ( bool  state)

Call to set whether or not the module will display its own UI. Read and Write define which kinds of information are allowed to be displayed

Implemented in ModuleProceduralFairing, ModuleDeployablePart, ModuleLight, ModuleJettison, ModuleAnimateGeneric, ModuleColorChanger, ModuleServiceModule, and ModuleAnimationSetter.

Property Documentation

bool IScalarModule.CanMove
get

A flag stating whether or not the module is able to change state at all.

float IScalarModule.GetScalar
get
EventData<float, float> IScalarModule.OnMoving
get
EventData<float> IScalarModule.OnStop
get
string IScalarModule.ScalarModuleID
get

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