Class GameModeDef
- java.lang.Object
-
- de.extio.spacecraft.shared.model.game.GameModeDef
-
public final class GameModeDef extends Object
-
-
Constructor Summary
Constructors Constructor Description GameModeDef()
GameModeDef(GameModeDef other)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>
getClientModules()
Starts these modules on client side if the game mode is activated / Stops if deactivated.String
getDescription()
Localization id of a short description of the game mode.GameModeDefHighScore
getHighscore()
If this mod submits highscores, enable this section to have it displayed in highscores view in main menu.String
getLogo()
Logo of your game mode, displayed in lobby.String
getModName()
String
getName()
Technical name in plain text, please use English languageString
getNameLocalized()
Localization id of the name, displayed to the userint
getQuickMatchMaxPlayers()
Maximum number of players that are assigned by the metaserver to the game session when using quick match making or quick join.List<String>
getServerModules()
Starts these modules on server side if the game mode is activated / Stops if deactivated.List<GameModeDefShipSlot>
getShipSlots()
Defines ship slots.boolean
isMultiplayer()
Whether the game mode is relevant for multiplayer games.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.boolean
isVisible()
Defines whether the game mode can be selected by the user in lobbyvoid
setClientModules(List<String> clientModules)
void
setDescription(String description)
void
setHighscore(GameModeDefHighScore highscore)
void
setLogo(String logo)
void
setModName(String modName)
void
setMultiplayer(boolean multiplayer)
void
setName(String name)
void
setNameLocalized(String nameLocalized)
void
setQuickMatchMaxPlayers(int quickMatchMaxPlayers)
void
setServerModules(List<String> serverModules)
void
setShipSlots(List<GameModeDefShipSlot> shipSlots)
void
setStartImmediately(boolean startImmediately)
void
setVisible(boolean visible)
-
-
-
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.
-
setShipSlots
public void setShipSlots(List<GameModeDefShipSlot> shipSlots)
-
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
-
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
-
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.
-
setHighscore
public void setHighscore(GameModeDefHighScore highscore)
-
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)
-
-