RespawnShips

HomeModdingReferenceSBCRespawnShips

The RespawnShips SBC-file defines the respawn options available to the player in the spawn menu. It allows control over which respawn ship is available for what kind of location.

Wrapper & Entry Example

<?xml version="1.0"?>
<Definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <RespawnShips>
    <!-- One or more RespawnShip entries are placed here. -->
  </RespawnShips>
</Definitions>

A typical RespawnShips.sbc entry

    <Ship>
      <Id>
        <TypeId>RespawnShipDefinition</TypeId>
        <SubtypeId>RespawnMoonPod</SubtypeId>
      </Id>
      <DisplayName>DisplayName_PlanetaryLander</DisplayName>
      <Icon>Textures\GUI\Icons\RespawnShips\RespawnMoonPod.png</Icon>
      <CooldownSeconds>900</CooldownSeconds>
      <Prefab>RespawnMoonPod</Prefab>
      <PlanetDeployAltitude>8</PlanetDeployAltitude>
      <UseForPlanetsWithoutAtmosphere>true</UseForPlanetsWithoutAtmosphere>
      <HelpTextLocalizationId>RespawnScreeenHelpTextSpawn</HelpTextLocalizationId>
    </Ship>

This is the entry for the Moon respawn ship, the rover-version of the survival pod.

Elements

Element	Description
SubtypeId String: Identifier	This is the unique identifier by which this RespawnShip entry is differentiated from others.
DisplayName String: RESX Reference or Name	The reference to the RESX entry for the localized ingame name of the RespawnShip as shown in the Spawn-menu or a plaintext name, if RESX is not used.
Icon String: Path	This is the path to the icon file. The icon is displayed when this respawn ship is selected in the spawn screen. The file must be either PNG or DDS with BC7 compression.
HelpTextLocalizationId String: Identifier	The localization ID of the help text displayed in the popup when selecting a spawn option in the respawn screen. This is a RESX entry. If multiple respawn ships are valid for a planet, then the popup will not appear.
Prefab String: Identifier	The path to the prefab file of the grid that is to be used as the respawn ship. Note that the linked prefab should always also be available in its serialized sbcB5-format.
PlanetTypes Subelement: PlanetType	The list of planets by their ID that this respawn ship will be offered as a respawn option for. This element can contain one or multiple subelements called PlanetType, which define single entries into the list: <PlanetTypes> <PlanetType>SomePlanetSubtype</PlanetType> <PlanetType>SomeOtherSubtype</PlanetType> </PlanetTypes> If defined, it overrides all other location-related elements of this definition. If omitted, the planets offered are decided by the other related elements. It still obeys the atmosphere rules.
UseForPlanetsWithoutAtmosphere Boolean: true / false	Whether the respawn ship should be offered as a respawn option for planets without atmospheres. Note that for the purposes of modding, there is no distinction between moons and planets - both are categorized as planets by the game.
UseForPlanetsWithAtmosphere Boolean: true / false	Whether the respawn ship should be offered as a respawn option for planets with atmospheres. Note that for the purposes of modding, there is no distinction between moons and planets - both are categorized as planets by the game.
MinimalAirDensity Float: 0.0-x	The minimal air density as a decimal that a planet needs to have as a prerequisite of the respawn ship being offered for this planet.
PlanetDeployAltitude Float: 0.0-x	The altitude in meters above ground if the respawn ship spawns on a planet.
UseForSpace Boolean: true / false	Whether the respawn ship should be offered as a respawn option for space.
SpawnNearProceduralAsteroids Boolean: true / false	Whether the respawn ship should spawn near asteroids. This only works in conjunction with the SpawnPosition-setting.
SpawnPosition FloatVector3: X Y Z	The specific position in space this respawn ship should spawn. If SpawnPosition is sufficiently close to a planet, the respawn ship will be spawned in the planet’s orbit with its height above ground determined by PlanetDeployAltitude.
SpawnPositionDispersionMin Integer: 0-x	The minimum distance from the defined SpawnPosition this respawn ship should spawn.
SpawnPositionDispersionMax Integer: 0-x	The maximum distance from the defined SpawnPosition this respawn ship should spawn.
InitialLinearVelocity FloatVector3: X Y Z	The direction and speed of movement of the respawn ship when spawned. Be aware that the grid orientation is independent from which way the main cockpit faces, thus settings here may lead to unexpected results.
InitialAngularVelocity FloatVector3: X Y Z	The direction and speed of rotation of the respawn ship when spawned. Be aware that the grid orientation is independent from which way the main cockpit faces, thus settings here may lead to unexpected results.
SpawnWithDefaultItems Boolean: true / false	Whether or not the player starts with default items when spawning with this respawn ship. This is overridden to off if the world setting Spawn with Tools is set to off. But if the world setting is on and this element is false, the player will start without tools when first spawning with this ship, but then with tools when respawning on a med station or survival kit.
CooldownSeconds Integer: 0-x	The length of time in seconds for which this spawn option cannot be picked again by the same player. When multiple respawn ships are available, the lowest cooldown one will effectively apply to all of them!