Package io.pzstorm.storm.event.lua

Interface LuaEvent

All Superinterfaces:
ZomboidEvent
All Known Implementing Classes:
AcceptedFactionInviteEvent, AcceptedTradeEvent, AddXPEvent, DoSpecialTooltipEvent, EveryDaysEvent, EveryHoursEvent, EveryOneMinuteEvent, EveryTenMinutesEvent, LevelPerkEvent, LoadGridsquareEvent, MngInvReceiveItemsEvent, OnAcceptInviteEvent, OnAddBuildingEvent, OnAddMessageEvent, OnAdminMessageEvent, OnAIStateChangeEvent, OnAIStateEnterEvent, OnAIStateExecuteEvent, OnAIStateExitEvent, OnAmbientSoundEvent, OnBeingHitByZombieEvent, OnCGlobalObjectSystemInitEvent, OnChallengeQueryEvent, OnChangeWeatherEvent, OnCharacterCollideEvent, OnCharacterCreateStatsEvent, OnCharacterDeathEvent, OnCharacterMeetEvent, OnChatWindowInitEvent, OnClientCommandEvent, OnClimateManagerInitEvent, OnClimateTickDebugEvent, OnClimateTickEvent, OnClothingUpdatedEvent, OnConnectedEvent, OnConnectFailedEvent, OnConnectionStateChangedEvent, OnContainerUpdateEvent, OnCoopJoinFailedEvent, OnCoopServerMessageEvent, OnCreateLivingCharacterEvent, OnCreatePlayerEvent, OnCreateSurvivorEvent, OnCreateUIEvent, OnCustomUIKeyEvent, OnCustomUIKeyPressedEvent, OnCustomUIKeyReleasedEvent, OnDawnEvent, OnDestroyIsoThumpableEvent, OnDeviceTextEvent, OnDisconnectEvent, OnDistributionMergeEvent, OnDoTileBuilding2Event, OnDoTileBuilding3Event, OnDoTileBuildingEvent, OnDuskEvent, OnEnterVehicleEvent, OnEquipPrimaryEvent, OnEquipSecondaryEvent, OnFETickEvent, OnFillContainerEvent, OnFillInventoryObjectContextMenuEvent, OnFillWorldObjectContextMenuEvent, OnGameBootEvent, OnGameStartEvent, OnGameTimeLoadedEvent, OnGameWindowInitEvent, OnGetDBSchemaEvent, OnGetTableResultEvent, OnGridBurntEvent, OnHitZombieEvent, OnInitModdedWeatherStageEvent, OnInitSeasonsEvent, OnInitWorldEvent, OnIsoThumpableLoadEvent, OnIsoThumpableSaveEvent, OnJoypadActivateEvent, OnJoypadActivateUIEvent, OnKeyKeepPressedEvent, OnKeyPressedEvent, OnKeyStartPressedEvent, OnLoadedTileDefinitionsEvent, OnLoadEvent, OnLoadMapZonesEvent, onLoadModDataFromServerEvent, OnLoadRadioScriptsEvent, OnLoadSoundBankEvent, OnLoginStateEvent, OnLoginStateSuccessEvent, OnMainMenuEnterEvent, OnMakeItemEvent, OnMapLoadCreateIsoObjectEvent, OnMechanicActionDoneEvent, OnMiniScoreboardUpdateEvent, OnModsModifiedEvent, OnMouseDownEvent, OnMouseMoveEvent, OnMouseUpEvent, OnMultiTriggerNPCEvent, OnNewFireEvent, OnNewGameEvent, OnNewSurvivorGroupEvent, OnNPCSurvivorUpdateEvent, OnObjectAboutToBeRemovedEvent, OnObjectAddedEvent, OnObjectCollideEvent, OnObjectLeftMouseButtonDownEvent, OnObjectLeftMouseButtonUpEvent, OnObjectRightMouseButtonDownEvent, OnObjectRightMouseButtonUpEvent, OnPlayerAttackFinishedEvent, OnPlayerDeathEvent, OnPlayerMoveEvent, OnPlayerSetSafehouseEvent, OnPlayerUpdateEvent, OnPostCharactersSquareDrawEvent, OnPostDistributionMergeEvent, OnPostFloorLayerDrawEvent, OnPostFloorSquareDrawEvent, OnPostMapLoadEvent, OnPostRenderEvent, OnPostSaveEvent, OnPostTileDrawEvent, OnPostTilesSquareDrawEvent, OnPostUIDrawEvent, OnPostWallSquareDrawEvent, OnPreDistributionMergeEvent, OnPreFillInventoryObjectContextMenuEvent, OnPreFillWorldObjectContextMenuEvent, OnPreGameStartEvent, OnPreMapLoadEvent, OnPressRackButtonEvent, OnPressReloadButtonEvent, OnPreUIDrawEvent, OnRadioInteractionEvent, OnRainStartEvent, OnRainStopEvent, OnReceiveItemListNetEvent, OnReceiveUserlogEvent, OnRefreshInventoryWindowContainersEvent, OnRenderTickEvent, OnRenderUpdateEvent, OnResetLuaEvent, OnResolutionChangeEvent, OnRightMouseDownEvent, OnRightMouseUpEvent, OnSafehousesChangedEvent, OnSaveEvent, OnScoreboardUpdateEvent, OnSeeNewRoomEvent, OnServerCommandEvent, OnServerFinishSavingEvent, OnServerStartedEvent, OnServerStartSavingEvent, OnServerWorkshopItemsEvent, OnSetDefaultTabEvent, OnSGlobalObjectSystemInitEvent, OnSpawnRegionsLoadedEvent, OnSteamGameJoinEvent, OnTabAddedEvent, OnTabRemovedEvent, OnThunderEvent, OnTickEvenPausedEvent, OnTickEvent, OnTileRemovedEvent, OnTriggerNPCEvent, OnUpdateModdedWeatherStageEvent, OnVehicleDamageTextureEvent, OnWaterAmountChangeEvent, OnWeaponHitCharacterEvent, OnWeaponHitTreeEvent, OnWeaponHitXpEvent, OnWeaponSwingEvent, OnWeaponSwingHitPointEvent, OnWorldMessageEvent, OnZombieDeadEvent, OnZombieUpdateEvent, ReceiveFactionInviteEvent, RequestTradeEvent, ReuseGridsquareEvent, SendCustomModDataEvent, ServerPingedEvent, SwitchChatStreamEvent, SyncFactionEvent, TradingUIAddItemEvent, TradingUIRemoveItemEvent, TradingUIUpdateStateEvent, ViewTicketsEvent
public interface LuaEvent extends ZomboidEvent

This class represents an in-game event dispatched to Lua mods. Lua events are handled by LuaEventManager. Storm intercepts these events and dispatches them as LuaEvent implementation instances. Subscribing to events being defined as Java classes offers much easier and safer interaction to subscribers then when subscribing from Lua.

Note for developers

When writing new event implementation classes do not forget to add the class references to LuaEventFactory static block so that the references are properly mapped and recognized by factory. If the references are not added the factory will not be able create new instances of those event.

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    getName()
    Returns a readable name that identifies this event.
    default void
    registerCallback()
     

  • Method Details

    • getName

      default String getName()
      Description copied from interface: ZomboidEvent
      Returns a readable name that identifies this event.
      Specified by:
      getName in interface ZomboidEvent

    • registerCallback

      default void registerCallback()