easel.utils

Class UpdateSuppressor

java.lang.Object

easel.utils.UpdateSuppressor

public class UpdateSuppressor
extends java.lang.Object

Can be used to suppress updates to the base game. This patches into the regular game loop and prevents execution from occurring if suppression is enabled. The MoveContainer uses this suppressor to ensure that moving widgets around will not interact with the game elements underneath. Usage is done in pairs: first suppress the desired functionality by passing in true, do whatever you need to do, and then be sure to release afterwards by passing in false to the same functions you used to start the suppression. Not releasing suppressed code will mean the game will be stuck and won't update, so be sure to release at the end.

Note that these suppression patches affect the base game's update loop but shouldn't affect BaseMod's hooks. If you're using something other than BaseMod's update hooks (e.g. you're hooking directly into the game with some manual patches), you may accidentally suppress your own updates with this suppressor and make it impossible to do anything (or release the suppressor). So be sure to test that this suppressor does what you need it to do, or consider rolling your own variant to do what you need.

These functions are not thread-safe and will choose to suppress or allow based on whatever boolean it received most recently.

Constructor Summary

Constructors

Constructor and Description
UpdateSuppressor()

Method Summary

Modifier and Type	Method and Description
static boolean	isSuppressingTips() Used by the patches.
static boolean	isSuppressingUpdates() Used by the patches
static void	suppressAll(boolean shouldSuppressAll) Convenience function to suppress/release both tips (suppressTips(boolean)) and updates (suppressUpdates(boolean)) at the same time.
static void	suppressTips(boolean shouldSuppressTips) Suppress the rendering of tips from the base game's TipHelper.
static void	suppressUpdates(boolean shouldSuppressUpdates) Suppress any updates to the base game.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateSuppressor

public UpdateSuppressor()

Method Detail

suppressTips

public static void suppressTips(boolean shouldSuppressTips)

Suppress the rendering of tips from the base game's TipHelper.

Parameters:

shouldSuppressTips - if true, starts suppressing tips from being rendered; if false, lets tips render again

suppressUpdates

public static void suppressUpdates(boolean shouldSuppressUpdates)

Suppress any updates to the base game. Works while in a run (but not on the main menu, for example).

Parameters:

shouldSuppressUpdates - if true, starts suppressing updates from happening in the main game loop; if false, lets updates proceed as normal

suppressAll

public static void suppressAll(boolean shouldSuppressAll)

Convenience function to suppress/release both tips (suppressTips(boolean)) and updates (suppressUpdates(boolean)) at the same time.

Parameters:

shouldSuppressAll - if true, start suppressing; if false, release suppression

isSuppressingTips

public static boolean isSuppressingTips()

Used by the patches.

Returns:

whether tips should be prevented from rendering

isSuppressingUpdates

public static boolean isSuppressingUpdates()

Used by the patches

Returns:

whether updates should be prevented from occurring