Skip to content

Coromon 1.5.4 classes.world.effects.plugins

Zreezy edited this page Nov 1, 2026 · 1 revision

classes.world.effects.plugins

Coromon 1.5.4. 13 module(s). Back to index

itemWorldEffectPlugin, temporaryItemWorldEffectPlugin, temporaryWorldEffectPlugin, traitWorldEffectPlugin, visibleOpenItemPopupWorldEffectPlugin, visibleOpenPopupWorldEffectPlugin, visibleOpenScreenWorldEffectPlugin, visibleOpenTraitPopupWorldEffectPlugin, visibleOpenUsableItemPopupWorldEffectPlugin, visibleOpenWearableUsableItemPopupWorldEffectPlugin, visibleTemporaryOpenPopupWorldEffectPlugin, visibleWorldEffectPlugin, worldEffectPlugin

itemWorldEffectPlugin

classes.world.effects.plugins.itemWorldEffectPlugin

  • returns t

  • itemWorldEffectPlugin:install(_worldEffect, _saveableOptions)

Instance / other functions (2)
  • worldEffect:getItem()
  • worldEffect:getItemUID()

temporaryItemWorldEffectPlugin

classes.world.effects.plugins.temporaryItemWorldEffectPlugin

  • returns t

  • temporaryItemWorldEffectPlugin:install(_worldEffect, _saveableOptions)

Instance / other functions (1)
  • worldEffect:onDepletion()

temporaryWorldEffectPlugin

classes.world.effects.plugins.temporaryWorldEffectPlugin

  • returns t

  • temporaryWorldEffectPlugin:install(_worldEffect, _saveableOptions)

Instance / other functions (9)
  • worldEffect.decreaseRemainingSecondsWrapper()
  • worldEffect:shouldDecreaseWhenPaused()
  • worldEffect:onActivatedInWorld()
  • worldEffect:onDeactivatedInWorld()
  • worldEffect:onDepletion()
  • worldEffect:onDecreasedRemainingSecond()
  • worldEffect:decreaseRemainingSeconds()
  • worldEffect:getRemainingSeconds()
  • worldEffect:getMaxSeconds()

traitWorldEffectPlugin

classes.world.effects.plugins.traitWorldEffectPlugin

  • returns t

  • traitWorldEffectPlugin:install(_worldEffect, _saveableOptions)

Instance / other functions (2)
  • worldEffect:getMonsterIdentifier()
  • worldEffect:getMonsterInSquad()

visibleOpenItemPopupWorldEffectPlugin

classes.world.effects.plugins.visibleOpenItemPopupWorldEffectPlugin

  • returns t

  • visibleOpenItemPopupWorldEffectPlugin:install(_worldEffect, _saveableOptions)

Instance / other functions (4)
  • worldEffect:createWorldEffectButtonIcon(_parent)
  • worldEffect:createPopupIcon(_parent)
  • worldEffect:getPopupTitle()
  • worldEffect:getPopupDescription()

visibleOpenPopupWorldEffectPlugin

classes.world.effects.plugins.visibleOpenPopupWorldEffectPlugin

  • returns t

  • requires: classes.interface.overlays.worldEffectPopupBuilder

  • visibleOpenPopupWorldEffectPlugin:install(_worldEffect, _saveableOptions)

Instance / other functions (9)
  • worldEffect:createPopupIcon(_parent)
  • worldEffect:getPopupTitle()
  • worldEffect:getPopupDescription()
  • worldEffect:getActionButtonLabel()
  • worldEffect:canBeUsedInPopup()
  • worldEffect:onUseInPopup(_closeWorldEffectPopup, _infoMessageToastOptions, _warningMessageToastOptions)
  • worldEffect:canBeDisabledInPopup()
  • worldEffect:onDisableInPopup()
  • worldEffect:onWorldEffectButtonPress(_activeWorldEffects)

visibleOpenScreenWorldEffectPlugin

classes.world.effects.plugins.visibleOpenScreenWorldEffectPlugin

  • returns t

  • visibleOpenScreenWorldEffectPlugin:install(_worldEffect, _saveableOptions)

Instance / other functions (2)
  • worldEffect:getScreenParams()
  • worldEffect:onWorldEffectButtonPress()

visibleOpenTraitPopupWorldEffectPlugin

classes.world.effects.plugins.visibleOpenTraitPopupWorldEffectPlugin

  • returns t

  • visibleOpenTraitPopupWorldEffectPlugin:install(_worldEffect, _saveableOptions)

Instance / other functions (4)
  • worldEffect:createWorldEffectButtonIcon(_parent)
  • worldEffect:createPopupIcon(_parent)
  • worldEffect:getPopupTitle()
  • worldEffect:getPopupDescription()

visibleOpenUsableItemPopupWorldEffectPlugin

classes.world.effects.plugins.visibleOpenUsableItemPopupWorldEffectPlugin

  • returns t

  • visibleOpenUsableItemPopupWorldEffectPlugin:install(_worldEffect, _saveableOptions)

Instance / other functions (3)
  • worldEffect:getActionButtonLabel()
  • worldEffect:canBeUsedInPopup()
  • worldEffect:onUseInPopup(_closeWorldEffectPopup, _infoMessageToastOptions, _warningMessageToastOptions)

visibleOpenWearableUsableItemPopupWorldEffectPlugin

classes.world.effects.plugins.visibleOpenWearableUsableItemPopupWorldEffectPlugin

  • returns t

  • visibleOpenWearableUsableItemPopupWorldEffectPlugin:install(_worldEffect, _saveableOptions)

Instance / other functions (1)
  • worldEffect:getActionButtonLabel()

visibleTemporaryOpenPopupWorldEffectPlugin

classes.world.effects.plugins.visibleTemporaryOpenPopupWorldEffectPlugin

  • returns t

  • visibleTemporaryOpenPopupWorldEffectPlugin:install(_worldEffect, _saveableOptions)

Instance / other functions (8)
  • worldEffect:createWorldEffectButton(_parent)
  • worldEffectButton:setProgression(_progression)
  • worldEffect:updateWorldEffectButtonProgression()
  • worldEffect:registerWorldEffectButton(_worldEffectButton)
  • worldEffect:getActionButtonLabel()
  • worldEffect:canBeDisabledInPopup()
  • worldEffect:onDisableInPopup()
  • worldEffect:onDecreasedRemainingSecond()

visibleWorldEffectPlugin

classes.world.effects.plugins.visibleWorldEffectPlugin

  • returns t

  • visibleWorldEffectPlugin:install(_worldEffect, _saveableOptions)

Instance / other functions (7)
  • worldEffect:createWorldEffectButtonIcon(_parent)
  • worldEffect:shouldShowWorldEffectButton()
  • worldEffect:onWorldEffectButtonPress(_activeWorldEffects)
  • worldEffect:getWorldEffectButtonPriority()
  • worldEffect:createWorldEffectButton(_parent)
  • worldEffect:registerWorldEffectButton(_worldEffectButton)
  • worldEffect:hasRegisteredWorldEffectButton()
Fields with default values (3)
  • visibleWorldEffectPlugin.priorities.last = 2
  • visibleWorldEffectPlugin.priorities.default = 1
  • visibleWorldEffectPlugin.priorities.first = 0

worldEffectPlugin

classes.world.effects.plugins.worldEffectPlugin

  • returns t

  • worldEffectPlugin:install(_worldEffect, _saveableOptions)

Instance / other functions (5)
  • worldEffect:onActivatedInWorld()
  • worldEffect:onDeactivatedInWorld()
  • worldEffect:onWorldInit()
  • worldEffect:onWorldDestroy()
  • worldEffect:onWorldUnload()

Clone this wiki locally