Class WelcomeScreenEvent

java.lang.Object
net.storm.sdk.script.blocking_events.BlockingEvent
net.storm.sdk.script.blocking_events.WelcomeScreenEvent

public class WelcomeScreenEvent extends BlockingEvent
A blocking event that handles the welcome/play screen displayed after login.

After logging into the game, a welcome screen is displayed with a "Play" button that must be clicked to enter the game world. This event automatically clicks the play button to proceed.

Supports both the old welcome screen interface (widget 378) and the newer interface (widget 413).

See Also:
  • Constructor Details

    • WelcomeScreenEvent

      public WelcomeScreenEvent()
  • Method Details

    • getPlayButton

      public static IWidget getPlayButton()
      Gets the Play button widget from the welcome screen.

      Checks both the new (413) and old (378) welcome screen interfaces for a visible widget with the "Play" action.

      Returns:
      the Play button widget, or null if not found or not visible
    • isWelcomeScreenOpen

      public static boolean isWelcomeScreenOpen()
      Checks whether the welcome screen is currently open and visible.
      Returns:
      true if the welcome screen is open, false otherwise
    • validate

      public boolean validate()
      Validates whether the welcome screen event should be active.
      Specified by:
      validate in class BlockingEvent
      Returns:
      true if the welcome screen is open, false otherwise
    • loop

      public int loop()
      Executes the welcome screen event logic by clicking the Play button.
      Specified by:
      loop in class BlockingEvent
      Returns:
      -1 to indicate the event should complete after this iteration