Package mindustry.type

Interface Publishable

All Known Implementing Classes:
Map, Mods.LoadedMod, Schematic
public interface Publishable
Defines a piece of content that can be published on the Workshop.

  • Method Details

    • getSteamID

      @Nullable String getSteamID()
      Returns:
      workshop item ID, or null if this isn't on the workshop.

    • addSteamID

      void addSteamID(String id)
      adds a steam ID to this item once it's published. should save the item to make sure this change is persisted.

    • removeSteamID

      void removeSteamID()
      removes the item ID; called when the item isn't found.

    • steamTitle

      String steamTitle()
      Returns:
      default title of the listing.

    • steamDescription

      @Nullable String steamDescription()
      Returns:
      standard steam listing description, may be null. this is editable by users after release.

    • steamTag

      String steamTag()
      Returns:
      the tag that this content has. e.g. 'schematic' or 'map'.

    • createSteamFolder

      Fi createSteamFolder(String id)
      Returns:
      a folder with everything needed for this piece of content in it; does not need to be a copy.

    • createSteamPreview

      Fi createSteamPreview(String id)
      Returns:
      a preview file PNG.

    • extraTags

      default Seq<String> extraTags()
      Returns:
      any extra tags to add to this item.

    • hasSteamID

      default boolean hasSteamID()
      Returns:
      whether this item is or was once on the workshop.

    • prePublish

      default boolean prePublish()
      called before this item is published.
      Returns:
      true to signify that everything is cool and good, or false to significy that the user has done something wrong. if false is returned, make sure to show a dialog explaining the error.