Package 

Class SampleGuiLauncher

  • All Implemented Interfaces:
    com.fs.starfarer.api.combat.CombatEnginePlugin , com.fs.starfarer.api.combat.EveryFrameCombatPlugin 
    
public abstract class SampleGuiLauncher
extends BaseEveryFrameCombatPlugin

    Class that, when added to engine via e.g. addPlugin, will open/close GUI when specified hotkey is pressed. Extend this class by overriding constructGui to construct a GuiObject that extends GuiBase. This class is mainly intended as an example or to quickly get started. In the long term, you probably want to implement your own GUI launching logic in order to be able to customize things.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract GuiBase constructGui() override this to return a new GUI object from this function, e.g.
      Unit advance(Float amount, List<InputEventAPI> events)
      Unit renderInUICoords(ViewportAPI viewport)

      • Methods inherited from class com.dp.advancedgunnerycontrol.combatgui.SampleGuiLauncher

        init, processInputPreCoreControls, renderInWorldCoords

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • SampleGuiLauncher

        SampleGuiLauncher(Character hotkey)
        Parameters:
        hotkey - lowercase char representation of hotkey to press to open/close the GUI.