Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Protected Member Functions | Properties | List of all members
Expansions.Serenity.ControlledBase Class Referenceabstract

The base class for all controlled items managed by the ModuleRoboticController More...

Inheritance diagram for Expansions.Serenity.ControlledBase:
IConfigNode Expansions.Serenity.ControlledAction Expansions.Serenity.ControlledAxis

Public Member Functions

void ChangeSymmetryMaster (Part newPart)
 Change the part that is listed as the one this axis is connected to to be another of its symmetry partners More...
 
void Load (ConfigNode node)
 
void Save (ConfigNode node)
 
void SetPartNickName (string newNickName)
 

Protected Member Functions

abstract void AddSymmetryPart (Part part)
 Called by base class when rebuilding symmetry list More...
 
abstract void ClearSymmetryLists ()
 Called by base class to clear different list types in child classes More...
 
abstract bool OnAssignReferenceVars ()
 Called by AssignReferenceVars to assign the referencs in the inherited classes More...
 
abstract bool OnChangeSymmetryMaster (Part part, out uint oldPartId)
 Called by base class to clear different list types in child classes More...
 
abstract void OnLoad (ConfigNode node)
 
abstract void OnSave (ConfigNode node)
 

Properties

ModuleRoboticController Controller [get, set]
 Reference to Controller for this axis More...
 
PartModule Module [get, set]
 Reference to PartModule for this axis More...
 
Part Part [get, set]
 Reference to part for this axis More...
 
string PartNickName [get]
 friendly text for a controlled axis More...
 
uint PartPersistentId [get]
 Helper to get the part persistentId More...
 
uint PersistentActionId [get]
 
List< PartSymmetryParts [get]
 The parts that are in symmetry with this one More...
 

Detailed Description

The base class for all controlled items managed by the ModuleRoboticController

Member Function Documentation

abstract void Expansions.Serenity.ControlledBase.AddSymmetryPart ( Part  part)
protectedpure virtual

Called by base class when rebuilding symmetry list

Parameters
partTHe part to add to the symmetry list

Implemented in Expansions.Serenity.ControlledAxis, and Expansions.Serenity.ControlledAction.

void Expansions.Serenity.ControlledBase.ChangeSymmetryMaster ( Part  newPart)
inline

Change the part that is listed as the one this axis is connected to to be another of its symmetry partners

Call this BEFORE the master part is deleted to maintain the symmetry groups

Parameters
newPartPart that will take over the role as symmetry master
abstract void Expansions.Serenity.ControlledBase.ClearSymmetryLists ( )
protectedpure virtual

Called by base class to clear different list types in child classes

Implemented in Expansions.Serenity.ControlledAxis, and Expansions.Serenity.ControlledAction.

void Expansions.Serenity.ControlledBase.Load ( ConfigNode  node)
inline

Implements IConfigNode.

abstract bool Expansions.Serenity.ControlledBase.OnAssignReferenceVars ( )
protectedpure virtual

Called by AssignReferenceVars to assign the referencs in the inherited classes

Returns
True if assignmentys complete

Implemented in Expansions.Serenity.ControlledAxis, and Expansions.Serenity.ControlledAction.

abstract bool Expansions.Serenity.ControlledBase.OnChangeSymmetryMaster ( Part  part,
out uint  oldPartId 
)
protectedpure virtual

Called by base class to clear different list types in child classes

Parameters
partThe new master
oldPartIdThe old masters partid

Implemented in Expansions.Serenity.ControlledAxis, and Expansions.Serenity.ControlledAction.

abstract void Expansions.Serenity.ControlledBase.OnLoad ( ConfigNode  node)
protectedpure virtual
abstract void Expansions.Serenity.ControlledBase.OnSave ( ConfigNode  node)
protectedpure virtual
void Expansions.Serenity.ControlledBase.Save ( ConfigNode  node)
inline

Implements IConfigNode.

void Expansions.Serenity.ControlledBase.SetPartNickName ( string  newNickName)
inline

Property Documentation

ModuleRoboticController Expansions.Serenity.ControlledBase.Controller
getset

Reference to Controller for this axis

PartModule Expansions.Serenity.ControlledBase.Module
getset

Reference to PartModule for this axis

Part Expansions.Serenity.ControlledBase.Part
getset

Reference to part for this axis

string Expansions.Serenity.ControlledBase.PartNickName
get

friendly text for a controlled axis

uint Expansions.Serenity.ControlledBase.PartPersistentId
get

Helper to get the part persistentId

uint Expansions.Serenity.ControlledBase.PersistentActionId
get
List<Part> Expansions.Serenity.ControlledBase.SymmetryParts
get

The parts that are in symmetry with this one


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