Package de.extio.spacecraft.shared.model.game

Class GameModeDef

  • public final class GameModeDef
extends Object

    • Constructor Detail

      • GameModeDef

        public GameModeDef()

      • GameModeDef

        public GameModeDef​(GameModeDef other)

    • Method Detail

      • getShipSlots

        public List<GameModeDefShipSlot> getShipSlots()
        Defines ship slots. Every ship a player can join must be assigned to a ship slot. Ship slots can also be displayed in lobby.

      • getName

        public String getName()
        Technical name in plain text, please use English language

      • setName

        public void setName​(String name)

      • getNameLocalized

        public String getNameLocalized()
        Localization id of the name, displayed to the user

      • setNameLocalized

        public void setNameLocalized​(String nameLocalized)

      • getDescription

        public String getDescription()
        Localization id of a short description of the game mode. It is displayed in the lobby

      • setDescription

        public void setDescription​(String description)

      • isVisible

        public boolean isVisible()
        Defines whether the game mode can be selected by the user in lobby

      • setVisible

        public void setVisible​(boolean visible)

      • getClientModules

        public List<String> getClientModules()
        Starts these modules on client side if the game mode is activated / Stops if deactivated. Fully qualified class name, e.g. de.extio.spacecraft.mod.package.ClassName

      • setClientModules

        public void setClientModules​(List<String> clientModules)

      • getServerModules

        public List<String> getServerModules()
        Starts these modules on server side if the game mode is activated / Stops if deactivated. string Fully qualified class name, e.g. de.extio.spacecraft.mod.package.ClassName

      • setServerModules

        public void setServerModules​(List<String> serverModules)

      • isStartImmediately

        public boolean isStartImmediately()
        If true, game session host (host player) does not need to have an active ship or even a ship slot joined before the game can start.

      • setStartImmediately

        public void setStartImmediately​(boolean startImmediately)

      • getLogo

        public String getLogo()
        Logo of your game mode, displayed in lobby. Place the logo in ./gfx/ui/ folder. If the filename is mode.png, the value for this element would be gfx/ui/mode.png

      • setLogo

        public void setLogo​(String logo)

      • getModName

        public String getModName()

      • setModName

        public void setModName​(String modName)

      • getHighscore

        public GameModeDefHighScore getHighscore()
        If this mod submits highscores, enable this section to have it displayed in highscores view in main menu.

      • isMultiplayer

        public boolean isMultiplayer()
        Whether the game mode is relevant for multiplayer games. If false it is only displayed in lobby for single player sessions

      • setMultiplayer

        public void setMultiplayer​(boolean multiplayer)

      • getQuickMatchMaxPlayers

        public int getQuickMatchMaxPlayers()
        Maximum number of players that are assigned by the metaserver to the game session when using quick match making or quick join.

      • setQuickMatchMaxPlayers

        public void setQuickMatchMaxPlayers​(int quickMatchMaxPlayers)