com.fs.starfarer.api

Class Global

java.lang.Object

com.fs.starfarer.api.Global

public class Global
extends java.lang.Object

The primary way to access most of the game's state (fleets, stars, ships, people, etc) and many useful classes for creating and modifying state.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	CODEX_TOOLTIP_MODE
static boolean	LOADING_SAVE

Constructor Summary

Constructors

Constructor and Description
Global()

Method Summary

Modifier and Type	Method and Description
static CombatEngineAPI	getCombatEngine() Gets the CombatEngineAPI, which is typically active in combat, on the main menu, and on the refit screen.
static GameState	getCurrentState()
static FactoryAPI	getFactory() Used to create fleets, markets, cargo, crew compositions, jump points, progress indicators, memory objects, persons, officer data, battles, cargo stacks, communication messages, fleet stubs, and fleet AI, along with various orbit configurations and fleet members.
static org.apache.log4j.Logger	getLogger(java.lang.Class c) Creates a new Logger that will add the given class to all log messages it produces.
static SectorAPI	getSector() Gets the currently loaded save game's SectorAPI, which contains all StarSystemAPIs, FleetAPIs, the sectory MemoryAPI, and more.
static SectorAPI	getSectorAPI() Deprecated. use getSector() instead
static SettingsAPI	getSettings() Gets the SettingsAPI, which contains access to current settings and many useful utility methods.
static SettingsAPI	getSettingsAPI() Deprecated. use getSettings() instead
static SoundPlayerAPI	getSoundPlayer() Gets the SoundPlayerAPI, which is used to play sound effects and music.
static void	setCombatEngine(CombatEngineAPI combatEngine)
static void	setFactory(FactoryAPI factory)
static void	setSector(SectorAPI api)
static void	setSettings(SettingsAPI api)
static void	setSoundPlayer(SoundPlayerAPI sound)

Methods inherited from class java.lang.Object

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

Field Detail

CODEX_TOOLTIP_MODE

public static boolean CODEX_TOOLTIP_MODE

LOADING_SAVE

public static boolean LOADING_SAVE

Constructor Detail

Global

public Global()

Method Detail

getCurrentState

public static GameState getCurrentState()

getLogger

public static org.apache.log4j.Logger getLogger(java.lang.Class c)

Creates a new Logger that will add the given class to all log messages it produces.

 
  class MyClass {
    Logger log = Global.getLogger(MyClass.class);

    void myMethod() {
      log.info("Hello, world!");
    }
  }

 

Parameters:

c - the class to add to the log messages

getFactory

public static FactoryAPI getFactory()

Used to create fleets, markets, cargo, crew compositions, jump points, progress indicators, memory objects, persons, officer data, battles, cargo stacks, communication messages, fleet stubs, and fleet AI, along with various orbit configurations and fleet members. Should only be used in the campaign.

setFactory

public static void setFactory(FactoryAPI factory)

getSoundPlayer

public static SoundPlayerAPI getSoundPlayer()

Gets the SoundPlayerAPI, which is used to play sound effects and music.

setSoundPlayer

public static void setSoundPlayer(SoundPlayerAPI sound)

getSettings

public static SettingsAPI getSettings()

Gets the SettingsAPI, which contains access to current settings and many useful utility methods.

setSettings

public static void setSettings(SettingsAPI api)

getSector

public static SectorAPI getSector()

Gets the currently loaded save game's SectorAPI, which contains all StarSystemAPIs, FleetAPIs, the sectory MemoryAPI, and more.

On the main menu, this may or may not be null.

getCombatEngine

public static CombatEngineAPI getCombatEngine()

Gets the CombatEngineAPI, which is typically active in combat, on the main menu, and on the refit screen. Mainly used to get info about and modify battles.

setCombatEngine

public static void setCombatEngine(CombatEngineAPI combatEngine)

setSector

public static void setSector(SectorAPI api)

getSettingsAPI

@Deprecated
public static SettingsAPI getSettingsAPI()

Deprecated. use getSettings() instead

getSectorAPI

@Deprecated
public static SectorAPI getSectorAPI()

Deprecated. use getSector() instead