🎛️ Modes
Feel free to contribute and don't worry about perfection - other editors can make corrections if necessary. Just get creating!
Navigate
- Airlock (modding)
- AreaBuffProvider
- BaseCollider
- BasePartBuffProvider
- BaseResourceStorage
- BeamEmitter
- BuffableValue
- ChainablePartComponent
- CircleBuffProvider
- ContinuousEffects
- DeathEffects
- Emitter
- FixedWeapon
- FlexResourceGrid
- FtlDrive
- GridBuffProvider
- InlineResourceConverter
- Modding/Components/Buffs
- Modding/Components/DistanceThreshold
- Modding/Components/PartToggleProxy
- Modding/Components/UI
- MultiValue
- OperationalChainablePartComponent
- OperationalPartComponent
- Other components
- PartComponent
- PartSprite
- PartToggledComponents
- PartUIToggle
- ProgressBar
- ResourceStorage
- ResourceStorageProxy
- Rotation (modding)
- SelfBuffProvider
- ShipRenderLayerRules
- Storage components
- Thruster (modding)
- TurretWeapon
- TypedResourceGrid
- Weapon (modding)
- WeaponAutoTargetRules
- ⏲️Timers
- ⚡ Triggers
- 🎚️Toggles
- 🎛️ Modes
- 🔟 Values
Components that implement modes expose an integer value, that signifies the mode the component is in.
Component list
Here is a list of components that can supply modes:
Name | Category | Short description
(click component for more details) |
Code reference | 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.
Name | Type | Required? | Buffable? | Default value | Description |
---|---|---|---|---|---|
DefaultMode | int | - | - | 0 | The mode that this component will be set to when it is created. |
Examples
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.
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
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.
Name | Type | Required? | Buffable? | Default value | Description |
---|---|---|---|---|---|
Mode | int | Yes | - | - | The mode that this component will be set to. |
Examples
Feel free to contribute to make it better!