🎛️ Modes

From Cosmoteer Wiki
Modding/Components/Modes
Jump to navigation Jump to search
CalloutIconWarning.png
Work in Progress
This page is currently WORK IN PROGRESS. Some things may not be up-to-date or documented at all.

Feel free to contribute and don't worry about perfection - other editors can make corrections if necessary. Just get creating!

CalloutIconNote.png
Info
This entire page was created with information gained from analysing the "Cosmoteer.dll" assembly for the "0.26.1d_steam" game version.

Components that implement modes expose an integer value, that signifies the mode the component is in.

CalloutIconTip.pngTip
Since the integer value is of a signed 32-bit integer type one can use negative values.

Component list

Here is a list of components that can supply modes:

Components and inheritance
Name Category Short description

(click component for more details)

Code reference

(what's this?)

Inherits from
DebugMode 🎛️ Mode

A part mode component whose mode can be changed via the part debugger. Cosmoteer.Ships.Parts.Logic.PartModeProxy PartComponent
ModeCycle 🎛️ Mode

A part component that cycles its mode when something is triggered. Cosmoteer.Ships.Parts.Logic.PartModeCycle PartComponent
ModeProxy 🔗Proxy A part sub-component that acts as a proxy to a mode component in another part. Cosmoteer.Ships.Parts.Logic.PartModeProxy PartComponent
StaticMode 🎛️ Mode

A part sub-component that stores a single unchanging integer mode value usable by other components. Cosmoteer.Ships.Parts.Logic.PartStaticMode PartComponent
UIToggle 🗔 UI A part sub-component that tracks a value whose state can be toggled by the player.

That's buttons like "Boost" and "Turn On/Off".

The provided mode signifies which of the available options is currently selected.

Cosmoteer.Ships.Parts.UI.PartUIToggle OperationalPartComponent

Component specification

DebugMode

Code location (what's this?): Cosmoteer.Ships.Parts.Logic.PartDebugMode

A part mode component whose mode can be changed via the part debugger.

Inherits from PartComponent.

Parameters for DebugMode (List excluding inhereted parameters)
Name Type Required? Buffable? Default value Description
DefaultMode int - - 0 The mode that this component will be set to when it is created.

Examples

CalloutIconWarning.pngWork in Progress
This subsection is currently work-in-progress: Some things may be missing.

Feel free to contribute to make it better!

ModeCycle

Code location (what's this?): Cosmoteer.Ships.Parts.Logic.PartModeCycle

A part component that cycles its mode when something is triggered.

Inherits from PartComponent.

Parameters for ModeCycle (List excluding inhereted parameters)
Name Type Required? Buffable? Default value Description
IncrementTrigger ID<PartComponentRules>? - - effectively:

never increment

The trigger that will increment the stored mode.
DecrementTrigger ID<PartComponentRules>? - - effectively:

never decrement

The trigger that will decrement the stored mode.
ModeRange Range<int> - - [0, 1] The contiguos range of modes that this component can increment & decrement in.
StartingMode int? - - ModeRange.Min The mode that this component will be set to when it is created.

If this parameter is not present, the mode that this component will be set to the minimum of the ModeRange parameter when it is created.

Clamp bool - - false If true, incrementing & decrementing will stop at the respective ends of the ModeRange parameter.

If false, incrementing & decrementing will wrap around to the other end of the ModeRange parameter.

Examples

CalloutIconWarning.pngWork in Progress
This subsection is currently work-in-progress: Some things may be missing.

Feel free to contribute to make it better!

StaticMode

Code location (what's this?): Cosmoteer.Ships.Parts.Logic.PartStaticMode

A part sub-component that stores a single unchanging integer mode value usable by other components.

Inherits from PartComponent.

Parameters for DebugMode (List excluding inhereted parameters)
Name Type Required? Buffable? Default value Description
Mode int Yes - - The mode that this component will be set to.

Examples

CalloutIconWarning.pngWork in Progress
This subsection is currently work-in-progress: Some things may be missing.

Feel free to contribute to make it better!

See also