Data fields

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!

Definition

«Data fields» are the individual fields that are present in every .rules file. A field is a place where you can write text.

They act like variables that help define the nature and function of the part.

Tip

To see the basic usage of data fields for modding purposes, check out the example mod.

"Part" data fields

^{Code location (what's this?): Cosmoteer.Ships.Parts.PartRules}

This section describes the data fields used in parts.

Inheritance

The class PartRules itself inherits nothing.

However base_part.rules is the .rules that ALL other parts inherit from (directly on not). It's in the game's Data directory, in the ships folder.

Info

Technically, asteroid bits are parts too, and inherit from base_part like all the others.

Here is the inheritance visualized :

• base_part
  • base_part_terran
    • most parts you are familiar with
  • base_part_asteroid
  • base_part_megaroid

This means that even fields defined below as "Required" may not be present in parts you look at or make, but that's not a problem as long as they are defined in base_part.rules.or base_part_terran.rules .

List of fields

Work in Progress

This list is currently work-in-progress. Some things may be missing.

Feel free to contribute to make it better!

Name	Type	Required	Buffable?	Default value	Description
NameKey	KeyString	Yes	-	-	The part's name, displayed when selected or hovered over.
IconNameKey	KeyString?	-	-	-	The part name as it shows up in the ship editor's menus.
JobsNameKey	KeyString?	-	-	-	??
ID	ID<PartRules>	Yes	-	-	Game-wide unique ID of the part, which must start with the author's name.
OtherIDs	ID<PartRules>[]?	-	-	-
FlipWhenLoadingIDs	(see description)	-	-	-	HashSet<Cosmoteer.Data.ID<PartRules>>?
EditorGroups	ID<EditorGroupRules>[]? meaning : A list of names in [].	Yes	-	-	These are the names of the tabs in which the part will appear, in the ship editor. Example: EditorGroups = ["Defenses", "Utilities"] Do not use EditorGroups when assigning parts to only one group! Use EditorGroup instead.
EditorGroup	ID<EditorGroupRules>	Yes	-	-	This is the name of the tab in which the part will appear, in the ship editor. Example: EditorGroup = "Crew" Do not use EditorGroup when assigning parts to multiple groups! Use EditorGroups instead.
IsBuildable	bool	-	-	true	If "false", you cannot build it. The part will not appear in the build menus, and is considered an invalid part when found in a ship. Whether or not you can paste such a ship in depends on your settings.
Resources	(see description)	Yes	-	-	Type : (Cosmoteer.Data.ID<ResourceRules> Type, int Quantity)[] An array of "Resource Name & Cost" pairs in [] which define what a part costs. Presumably goes up to 2,147,483,647 and accepts negative values (needs testing). The Cost part of each pair also accepts formulas, E.g. 8 * 4. Note that reducing this in copies of base game parts can lead to a crash when the part is destroyed.
FractionalCostToRepair	float (%)	Yes	-	25% (base_part)	How much of the building cost at most will be spent to repair the part to full health. Note that this does not seem to affect rare resources, which seem ignored in repair costs entirely. (verify)
Size	IntVector2	Yes	-	-	An array which defines the width and height of a part. The minimum value for both width and height is 1. Cannot accept decimal values.
Density	float	Yes	-	1 (base_part)	How much 1 tile of the part weighs in tons. The total mass of the part, not accounting for other Colliders, is (Size_X * Size_Y * Density). It is not reduced when the part becomes more damaged. More massive parts are harder to move. Example mod. See also : BaseCollider
MaxHealth	int	Yes	-	-	How much damage the part can endure before being destroyed. Repair is only possible before this reaches 0.
HealthType	HealthType	Yes	-	Operational (base_part)	See HealthTypes.
Flammable	bool	Yes	-	true (base_part)	Can the part catch on fire. Structures and armor blocks have "false".
Part placement blocking	-	-	-	-	Used for thruster and weapon exclusion zones. Has more potential. Click the Name for details. This includes: Prohibits, ProhibitedBy, ProhibitLeft, ProhibitRight, ProhibitAbove, ProhibitBelow, ProhibitRects,
HasNonContiguousPathing	bool	-	-	-	For optimization. Set it to "true" if there are any tiles/cells of your custom part that crew can't walk on in any direction.
CrewSpeedFactor	float, or {Up, Left, Right, Down}	-	No?	0.5 (base_part)	The speed at which the crew moves in the part. Corridors are set to CrewSpeedFactor = 1. CrewSpeedFactor can be set to a single float value. Or it can be set to have different speeds depending on which direction the crew is moving. For example conveyor.rules: CrewSpeedFactor { Up = 2 Left = .75 Right = .75 Down = .25 }
CrewCongestedSpeedFactor	float, or {Up, Left, Right, Down}	-	No?	0.3 (base_part)	Presumably, the speed at which the crew moves in the part while passing other crew. Corridors are set to CrewCongestedSpeedFactor = 0.5. CrewCongestedSpeedFactor can be set to a single float value. Or it can be set to have different speeds depending on which direction the crew is moving. Look at CrewSpeedFactor for an example.
CrewFireSpeedFactor	float, or {Up, Left, Right, Down}	-	No?	0.2 (base_part)	The speed at which the crew moves in the part while the part is on fire. CrewFireSpeedFactor can be set to a single float value. Or it can be set to have different speeds depending on which direction the crew is moving. Look at CrewSpeedFactor for an example.
SelectionPriority	int	Yes	-	-
SelectionTypeID	ID<PartRules>?	-	-	-
SelectionTypeByRotation	bool	Yes	-	false	If true, double-clicking the part in-game will only select all parts of the same type that are facing the same direction. That's usually the case for thrusters and weapons.
IsExternal	bool	Yes	-	false (base_part)	If false, the part can have either no doors between itself and anything else, or all doors that have legal placement. If true, the part can have doors with other parts but not between itself and other parts with the same part ID. Only ion_beam_prism and all structures have "true". See the examples below. Also see IsWalled.
IsRotateable	bool	Yes	-	true (base_part)
IsFlippable	bool	Yes	-	false (base_part)
IsWalled	bool	Yes	-	true (base_part)	If false, the part can only have doors to parts where it is not false (other parts don't need doors to be accessible), unless IsExternal is true, in which case it can have doors to other "non-walled" parts. Armors have "true". Only corridor, conveyor, ion_beam_prism and all structures have "false". See the examples below.
JobsIcon	ISprite?	-	-	-
FlipHRotate	int[]	Yes	-	[0, 3, 2, 1] (base_part)
FlipVRotate	int[]	Yes	-	[2, 1, 0, 3] (base_part)
AIValueFactor	float	-	-	1	Presumably, how much the AI wants to destroy this part on ships it considers enemies. As of (0.27.1): Parts like: (Armor, Corridor, Conveyor, Structure) have AIValueFactor = 0 Parts like: (Control Rooms, Reactors, Shields) have AIValueFactor = 5 All other parts appear to be unchanged. Presumably 1?
ReceivableBuffIDs alias ReceivableBuffs	(see description)	-	-	-	Type : HashSet<Cosmoteer.Data.ID<BuffType>>? The list containing the identifiers of the buffs this part can be affected by.
MinBuffValues	(see description)	-	-	-	Type : Dictionary<Cosmoteer.Data.ID<BuffType>, float>?
MaxBuffValues	(see description)	-	-	-	Type : Dictionary<Cosmoteer.Data.ID<BuffType>, float>?
TypeCategories	(see description)	-	-	[ ] (base_part)	Type: HashSet<Cosmoteer.Data.ID<PartCategory>>? The PartCategory ftl has a comment in the hyperdrive rules files: // 'ftl' is a magic category that allows the FTL overlay to efficiently find FTL drives. Categories found in-game (0.27.1) Categories is_crewed, weapon, storage, thruster, airlock, armor, asteroid, command, corridor, defense, engine_room, explosives, fire_extinguisher, mining, reactor, structure, tractor_beam, ftl, Provides provides_power, provides_crew, provides_ammo, provides_coil2, provides_coils, provides_diamonds, provides_emps, provides_enriched_uranium, provides_launcher_parts, provides_mines, provides_missiles, provides_nukes, provides_processors, provides_steel, provides_tristeel, Uses uses_carbon, uses_coils, uses_copper, uses_emps, uses_gold, uses_iron, uses_launcher_parts, uses_mines, uses_missiles, uses_nukes, uses_sulfur, uses_tritanium, uses_uranium, uses_power, uses_ammo, Chaingun chaingun, chaingun_ammo_requester, chaingun_ammo_supplier, Ion ion, ion_beam_emitter, ion_beam_prism, Railgun railgun, railgun_ammo, railgun_power,

Other fields

This section describes the part's data fields that don't fit into other categories.

Name	Type	Defines types	Default value	Description
EditorGroup	string		none	The one and only group where the part will appear in Build Mode. If you put more than 1 group there, the game crashes.
EditorGroups	list [string, string]		none	The multiple groups where the part will appear in Build Mode. If you forgot the "s" in the data field's name, it becomes the singular version, and the game crashes.

To-do fields

These fields have not been added to this page, and thus require research and descriptions.

If you document any fields, please remove them from the table afterwards.

header

Fields: public ViKey[]? DefaultEditorHotkey; public Cosmoteer.Data.ID<PartRules> EditorReplacementPartID; public KeyString? DescriptionKey; public readonly int Cost; public Dictionary<Cosmoteer.Data.ID<ResourceRules>, int> ResourcesByType; public IntRect? PhysicalRect; public IntRect? SaveRect; public AdjacencyFlags AllowedContiguity = AdjacencyFlags.Sides;h public bool GenerateRectCollider = true; public PartRectType RectColliderRectType = PartRectType.Physical; public PartRectType BoundingRectType; public int SelectionPriority; public Cosmoteer.Data.ID<PartRules>? SelectionTypeID; public int[] SelectionTypeRotations = new int[1]; public bool IgnoreRotationForMirroredSelection; public Time? ConstructionDuration; public Time ConstructionSwapDelay; public Time? RepairDuration; public MultiMediaEffectRules? SalvageProgressMediaEffects; public Time SalvageProgressMediaEffectsTimeout; public MultiMediaEffectRules? ConstructionProgressMediaEffects; public Time ConstructionProgressMediaEffectsTimeout; public MultiMediaEffectRules? ConstructionFinishedMediaEffects; public Range<BuffableFloat> ExplosiveDamageAbsorption; public Dictionary<Cosmoteer.Data.ID<DamageType>, Range<BuffableFloat>> DamageResistances = new Dictionary<Cosmoteer.Data.ID<DamageType>, Range<BuffableFloat>>(); public Cosmoteer.Data.ID<PartRules> UnderlyingPart; public Cosmoteer.Data.ID<PartRules> UnderlyingPartPerTile; public bool CreateUnderlyingWhenDestroyed = true; public Cosmoteer.Data.ID<PartRules> TempConstructionPartPerTile; public Cosmoteer.Data.ID<PartRules> CreatePartPerTileWhenGrabbed; public float DestroyedPartHealthFraction = 1f; public float CrewKillChanceWhenDestroyed; public float CrewThrowSpeedWhenDestroyed; public Range<BuffableFloat> InitialPenetrationResistance; public Range<BuffableFloat> ContinuingPenetrationResistance; public DirectionalCrewSpeeds CrewSpeedFactor; public DirectionalCrewSpeeds CrewCongestedSpeedFactor; public DirectionalCrewSpeeds CrewFireSpeedFactor; public BuffableFloat FireDamageFactor = (BuffableFloat) 1f; public bool IsCrewSalvageable = true; public HashSet<IntVector2>? BlockedTravelCells; public Dictionary<IntVector2, TravelDirection[]>? BlockedTravelCellDirections; public bool ForceManhattanPathInPart; public int ContiguityOriginPriority; public bool IsSelfDestructible; public bool IsLowPriorityDeconstruction; public bool? ForceBrushCompatibility; public IntVector2[]? AllowedDoorLocations; public int MaxDoors = int.MaxValue; public bool GeneratorRequiresDoor; public int AutoDoorMaxPathLength; public bool NoAutoDoors; public AdjacencyFlags ExternalWalls; public AdjacencyFlags? BlueprintExternalWalls; public Dictionary<IntVector2, AdjacencyFlags>? ExternalWallsByCell; public Dictionary<IntVector2, AdjacencyFlags>? BlueprintExternalWallsByCell; public AdjacencyFlags InternalWalls; public AdjacencyFlags? BlueprintInternalWalls; public Dictionary<IntVector2, AdjacencyFlags>? InternalWallsByCell; public Dictionary<IntVector2, AdjacencyFlags>? BlueprintInternalWallsByCell; public VirtualInternalCell[]? VirtualInternalCells; public HashSet<Cosmoteer.Data.ID<PartCategory>> TypeCategories; public HashSet<Cosmoteer.Data.ID<PartCategory>> RequiresCategories; public HashSet<Cosmoteer.Data.ID<PartCategory>>? AffectsValidityOfCategories; public ISprite EditorIcon; public readonly List<PartComponentRules> Components = new List<PartComponentRules>(); public readonly List<PartComponentRules> PhysicalComponents = new List<PartComponentRules>(); public readonly List<PartComponentRules> BlueprintComponents = new List<PartComponentRules>(); public readonly List<PartComponentRules> DestroyedComponents = new List<PartComponentRules>(); public readonly List<PartComponentRules> BlueprintDrawableComponents = new List<PartComponentRules>(); public readonly Dictionary<Cosmoteer.Data.ID<PartComponentRules>, PartComponentRules> ComponentsByID = new Dictionary<Cosmoteer.Data.ID<PartComponentRules>, PartComponentRules>(); public readonly Dictionary<Cosmoteer.Data.ID<PartToggleGuiRules>, PartUIToggleRules> UIToggleComponentsByID = new Dictionary<Cosmoteer.Data.ID<PartToggleGuiRules>, PartUIToggleRules>(); public readonly Dictionary<Cosmoteer.Data.ID<PartColorGuiRules>, PartUIColorRules> UIColorComponentsByID = new Dictionary<Cosmoteer.Data.ID<PartColorGuiRules>, PartUIColorRules>(); public Dictionary<Cosmoteer.Data.ID<PartStatRules>, PartStatValues>? Stats; public List<PartStatsCategory>? StatsByCategory; public KeyString? StatsNotesKey; public ShipRules ShipRules; public readonly List<PriorityInfo> PriorityInfos = new List<PriorityInfo>(); public HashSet<IntVector2>? FlexResourceGridCells; BuffableFloat ExplosiveDamageResistance;

Examples

IsExternal = true

IsExternal examples

IsExternal when "false" (images on the left), and when "true" (image on the right) (both courtesy of Ahlgreen) :

IsWalled = false | IsWalled = true

See also

• Part components
• Projectile components