Package mindustry.game

Class Schematic

java.lang.Object

mindustry.game.Schematic

All Implemented Interfaces:

Comparable<Schematic>, Publishable

public class Schematic
extends Object
implements Publishable, Comparable<Schematic>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Schematic.Stile

Field Summary

Fields

Modifier and Type	Field	Description
Fi	file
int	height
Seq<String>	labels	These are used for the schematic tag UI.
Mods.LoadedMod	mod	Associated mod.
StringMap	tags	Internal meta tags.
final Seq<Schematic.Stile>	tiles
int	width

Constructor Summary

Constructors

Constructor	Description
Schematic(Seq<Schematic.Stile> tiles, StringMap tags, int width, int height)

Method Summary

Modifier and Type	Method	Description
void	addSteamID(String id)	adds a steam ID to this item once it's published.
int	compareTo(Schematic schematic)
Fi	createSteamFolder(String id)
Fi	createSteamPreview(String id)
String	description()
CoreBlock	findCore()
String	getSteamID()
boolean	hasCore()
String	name()
float	powerConsumption()
float	powerProduction()
void	removeSteamID()	removes the item ID; called when the item isn't found.
ItemSeq	requirements()
void	save()
String	steamDescription()
String	steamTag()
String	steamTitle()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface mindustry.type.Publishable

extraTags, hasSteamID, prePublish

Field Details

tiles

public final Seq<Schematic.Stile> tiles

labels

public Seq<String> labels

These are used for the schematic tag UI.

tags

public StringMap tags

Internal meta tags.

width

public int width

height

public int height

file

@Nullable
public Fi file

mod

@Nullable
public Mods.LoadedMod mod

Associated mod. If null, no mod is associated with this schematic.

Constructor Details

Schematic

public Schematic(Seq<Schematic.Stile> tiles,
 StringMap tags,
 int width,
 int height)

Method Details

powerProduction

public float powerProduction()

powerConsumption

public float powerConsumption()

requirements

public ItemSeq requirements()

hasCore

public boolean hasCore()

findCore

public CoreBlock findCore()

name

public String name()

description

public String description()

save

public void save()

getSteamID

public String getSteamID()

Specified by:

getSteamID in interface Publishable

Returns:

workshop item ID, or null if this isn't on the workshop.

addSteamID

public void addSteamID(String id)

Description copied from interface: Publishable

adds a steam ID to this item once it's published. should save the item to make sure this change is persisted.

Specified by:

addSteamID in interface Publishable

removeSteamID

public void removeSteamID()

Description copied from interface: Publishable

removes the item ID; called when the item isn't found.

Specified by:

removeSteamID in interface Publishable

steamTitle

public String steamTitle()

Specified by:

steamTitle in interface Publishable

Returns:

default title of the listing.

steamDescription

public String steamDescription()

Specified by:

steamDescription in interface Publishable

Returns:

standard steam listing description, may be null. this is editable by users after release.

steamTag

public String steamTag()

Specified by:

steamTag in interface Publishable

Returns:

the tag that this content has. e.g. 'schematic' or 'map'.

createSteamFolder

public Fi createSteamFolder(String id)

Specified by:

createSteamFolder in interface Publishable

Returns:

a folder with everything needed for this piece of content in it; does not need to be a copy.

createSteamPreview

public Fi createSteamPreview(String id)

Specified by:

createSteamPreview in interface Publishable

Returns:

a preview file PNG.

compareTo

public int compareTo(Schematic schematic)

Specified by:

compareTo in interface Comparable<Schematic>