kOSProcessor

The type of structures returned by kOS when querying a module that contains a kOS processor.

structure kOSProcessor
Suffix Type Description
All suffixes of PartModule   kOSProcessor objects are a type of PartModule
MODE :ref:`string <string>` OFF, READY or STARVED
ACTIVATE None Activates this processor
DEACTIVATE None Deactivates this processor
TAG :ref:`string <string>` This processor’s name tag
VOLUME Volume This processor’s hard disk
BOOTFILENAME :ref:`string <string>` The filename for the boot file on this processor

Note

A kOSProcessor is a type of PartModule, and therefore can use all the suffixes of PartModule.

kOSProcessor:MODE
Access:Get only
Type::ref:`string <string>`

Indicates the current state of this processor. OFF - deactivated, READY - active, or STARVED - no power.

kOSProcessor:ACTIVATE()
Returns:None

Activate this processor

kOSProcessor:DEACTIVATE()
Returns:None

Deactivate this processor

kOSProcessor:TAG
Access:Get only
Type::ref:`string <string>`

This processor’s name tag

kOSProcessor:VOLUME
Access:Get only
Type:Volume

This processor’s hard disk.

kOSProcessor:BOOTFILENAME
Access:Get or Set
Type::ref:`string <string>`

The filename for the boot file on this processor. This may be set to an empty string “” or to “None” to disable the use of a boot file.