Template:Data Preload

From Space Engineers Wiki
Jump to navigation Jump to search
Template Documentation:
Note: the template above may sometimes be partially or fully invisible.
Documentation controls: [purge] [edit] [view] (Help with documentation)

See Also

For help with the item and block infobox or its controls, see the Info Block documentation.

Description

This template is a preload for data pages. Use it to create all data pages, it includes all of the necessary variable declarations. Update existing data pages manually to reflect changes in the preload.

Variables

Each variable is named "Data<Variable>" and is declared using {{#vardefine:Data<Variable>|<value>}}

Fill in the appropriate value, or leave the value blank. Do not delete unused variable declarations. This is to prevent overlap in cases where multiple data files are loaded in sequence. Blank variables ensure that the values for the previous item are erased instead of "bleeding through" to the new item.

All of the variables are listed as follows:

  • Name: The name of the item.
    • This should match the item's page name as it is used to automatically general icon paths, etc.
    • Do not use a magic word such as {{BASEPAGENAME}} as it will have unpredictable results depending on what page the data is loaded for.
  • SortableName:: The name of the item as it would appear in a sorted list.
  • Icon: Filepath for the icon to display.
    • Only necessary for custom icons. The standard filepath should be generated automatically by most display templates.
    • Do not include "File:" but do include the extension.
  • Caption: A caption to display under the icon, if necessary.
  • Category: Block category.
    • Component - Items used to build blocks. Ex: Icon Item Steel Plate.png Steel Plate.
    • Decorative - Furniture and DLC blocks. Ex: Icon Block Kitchen.png Kitchen.
    • Defense - Weapons or defensive blocks. Ex: Icon Block Gatling Gun.png Gatling Gun.
    • Facility - Facilities and production blocks. Ex: Icon Block Medical Room.png Medical Room.
    • Functional - Blocks that keep the ship flying. Ex: Icon Block Cockpit.png Cockpit.
    • Material - Items used to make Components and Tools. Ex: Icon Item Iron Ingot.png Iron Ingot.
    • Mobility - Blocks that apply thrust, propulsion, rotation. Ex: Icon Block Gyroscope.png Gyroscope.
    • Ore - Items used to create Materials. Ex: Icon Item Iron Ore.png Iron Ore.
    • Power - Blocks that generate power. Ex: Icon Block Small Reactor.png Small Reactor.
    • Storage - Blocks that hold items. Ex: Icon Block Small Cargo Container.png Small Cargo Container.
    • Structural - Blocks that provide support. Ex: Icon Block Light Armor Block.png Light Armor Block.
    • Tool - Handheld equipment, tool items. Ex: Icon Item Hand Drill.png Hand Drill.
  • Function: A description of what the item or block does.
  • Per-size details: Each of the following variables are defined for small grid and large grid. They use the form "Data<Variable><Small|Large>".
    • Format all numbers with standard US style. e.g. #,###,###
    • Do not include units (i.e. Do not include "kg" or "N")
    • Fits: Can be installed/used on the given ship/station size.
      • Enter either "yes", or keep empty for "no".
      • All other values may be assumed as yes, so that should be avoided.
    • Mass: Mass of the object at the given grid size in kilograms.
    • Power: Energy generated/consumed in kilowatts.
      • Negative number for power consumption, or positive number for power production.
      • For items with variable energy draw (for example Icon Block Ion Thruster.png thrusters), include the maximum possible draw.
    • Force: Force applied in Newtons.
    • Range: Functional range in meters.
    • PCU: Performance cost in units.
    • Size: Height x Width x Depth.
    • Time: Time to build in seconds.