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
ICommAntenna Interface Reference

An interface which any partmodule which offers antenna functionality should implement. More...

Inheritance diagram for ICommAntenna:
ModuleDataTransmitter ModuleGroundCommsPart ModuleGroundExpControl

Public Member Functions

bool CanComm ()
 Is currently active More...
 
bool CanCommUnloaded (ProtoPartModuleSnapshot mSnap)
 Is active, but called when the vessel is unloaded. This is called on the prefab module on the part prefab and passed the ProtoPartModuleSnapshot on the relevant unloaded vessel. More...
 
bool CanScienceTo (bool combined, double bPower, double sqrDistance)
 Can this antenna transmit to a node of the given strength at the given distance (NOTE: Squared distance) More...
 
double CommPowerUnloaded (ProtoPartModuleSnapshot mSnap)
 Called to get antenna power when unloaded More...
 

Properties

bool CommCombinable [get]
 Is this antenna combinable with others? More...
 
double CommCombinableExponent [get]
 Get the combinability exponent More...
 
double CommPower [get]
 The strength of this antenna More...
 
DoubleCurve CommRangeCurve [get]
 The range curve of this antenna More...
 
DoubleCurve CommScienceCurve [get]
 the science curve of this antenna More...
 
AntennaType CommType [get]
 The type of this antenna More...
 

Detailed Description

An interface which any partmodule which offers antenna functionality should implement.

Member Function Documentation

bool ICommAntenna.CanComm ( )

Is currently active

Returns

Implemented in ModuleDataTransmitter, and ModuleGroundCommsPart.

bool ICommAntenna.CanCommUnloaded ( ProtoPartModuleSnapshot  mSnap)

Is active, but called when the vessel is unloaded. This is called on the prefab module on the part prefab and passed the ProtoPartModuleSnapshot on the relevant unloaded vessel.

Parameters
mSnapThe ProtoPartModuleSnapshot of the partmodule on the relevant vessel
Returns

Implemented in ModuleDataTransmitter, and ModuleGroundCommsPart.

bool ICommAntenna.CanScienceTo ( bool  combined,
double  bPower,
double  sqrDistance 
)

Can this antenna transmit to a node of the given strength at the given distance (NOTE: Squared distance)

Parameters
combinedIs the active comm of this vessel combined mode?
bPowerthe strength of the other comm node
sqrDistancethe square of the magnitude of the displacement between the two nodes, i.e. distance*distance
Returns

Implemented in ModuleDataTransmitter, and ModuleGroundCommsPart.

double ICommAntenna.CommPowerUnloaded ( ProtoPartModuleSnapshot  mSnap)

Called to get antenna power when unloaded

Parameters
mSnap
Returns

Implemented in ModuleDataTransmitter, ModuleGroundExpControl, and ModuleGroundCommsPart.

Property Documentation

bool ICommAntenna.CommCombinable
get

Is this antenna combinable with others?

double ICommAntenna.CommCombinableExponent
get

Get the combinability exponent

double ICommAntenna.CommPower
get

The strength of this antenna

DoubleCurve ICommAntenna.CommRangeCurve
get

The range curve of this antenna

DoubleCurve ICommAntenna.CommScienceCurve
get

the science curve of this antenna

AntennaType ICommAntenna.CommType
get

The type of this antenna


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