Package me.iron.WarpSpace.Mod

Class WarpJumpEvent

java.lang.Object
api.listener.events.Event
me.iron.WarpSpace.Mod.WarpJumpEvent
public class WarpJumpEvent
extends api.listener.events.Event
STARMADE MOD CREATOR: Max1M DATE: 16.12.2020 TIME: 13:52 mod-owned event fired whenever an entity enters or leaves warp

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  WarpJumpEvent.WarpJumpType  

    Nested classes/interfaces inherited from class api.listener.events.Event

    api.listener.events.Event.Condition

  • Field Summary

    Fields 
    Modifier and Type Field Description
    private org.schema.common.util.linAlg.Vector3i end  
    private org.schema.game.common.controller.SegmentController ship  
    private org.schema.common.util.linAlg.Vector3i start  
    private WarpJumpEvent.WarpJumpType type  

    Fields inherited from class api.listener.events.Event

    canceled, condition, server

  • Constructor Summary

    Constructors 
    Constructor Description
    WarpJumpEvent​(org.schema.game.common.controller.SegmentController ship, WarpJumpEvent.WarpJumpType type, org.schema.common.util.linAlg.Vector3i start, org.schema.common.util.linAlg.Vector3i end)
    constructor

  • Method Summary

    Modifier and Type Method Description
    void cancel​(java.lang.String pilotMessage)
    cancel warpevent
    org.schema.common.util.linAlg.Vector3i getEnd()
    get target sector of jump
    org.schema.game.common.controller.SegmentController getShip()
    get segmentcontroller that is warping
    org.schema.common.util.linAlg.Vector3i getStart()
    get origin sector of jump
    WarpJumpEvent.WarpJumpType getType()
    get type of warpevent
    java.lang.String toString()  

    Methods inherited from class api.listener.events.Event

    getCondition, isCanceled, isServer, setCanceled

    Methods inherited from class java.lang.Object

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

  • Field Details

    • ship

      private org.schema.game.common.controller.SegmentController ship

    • type

      private WarpJumpEvent.WarpJumpType type

    • start

      private org.schema.common.util.linAlg.Vector3i start

    • end

      private org.schema.common.util.linAlg.Vector3i end

  • Constructor Details

    • WarpJumpEvent

      public WarpJumpEvent​(org.schema.game.common.controller.SegmentController ship, WarpJumpEvent.WarpJumpType type, org.schema.common.util.linAlg.Vector3i start, org.schema.common.util.linAlg.Vector3i end)
      constructor
      Parameters:
      ship - ship
      type - jumptype
      start - start sector
      end - end sector

  • Method Details

    • getShip

      public org.schema.game.common.controller.SegmentController getShip()
      get segmentcontroller that is warping
      Returns:
      ship

    • getType

      public WarpJumpEvent.WarpJumpType getType()
      get type of warpevent
      Returns:
      type

    • getStart

      public org.schema.common.util.linAlg.Vector3i getStart()
      get origin sector of jump
      Returns:
      sector

    • getEnd

      public org.schema.common.util.linAlg.Vector3i getEnd()
      get target sector of jump
      Returns:
      sector

    • cancel

      public void cancel​(java.lang.String pilotMessage)
      cancel warpevent
      Parameters:
      pilotMessage - message to be displayed to pilots for cause of failed warp

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object