Event Handler

Planetslib provides an alternative to the event handler library found in factorio's core mod,

Comes with the following additional features:

• event filtering. the add_filter(event,filter) method can add a filter to every registered event handler. The filters are added to all of your handlers, if you use a filter in one spot then use the same event elsewhere then you need to add the filters for that event as well.

  This is the same as using the script.on_event directly, and adding a filter.

• composite events. Some frequently used event combinations can be declared together. You have to write the handler in a way that supports all included events.

  • on_built: Every event that could fire when a new entity was built.
  • on_removed: Every event when the entity was mined or destroyed.

Example

Filtering:

    local handler = require("__PlanetsLib__.lib.event-handler.event-handler")

-- all built events will get this filter
handler.add_filter(defines.events.on_built_entity,{
  filter="name",
  name="orbital-cannon"
})
handler.add_lib(require("script.orbital-cannon"))

Composite events:

    local handler = require("__PlanetsLib__.lib.event-handler.event-handler")
    -- include the built in "on_built" and "on_removed" composite events
    handler.add_composite_events(require("__PlanetsLib__.lib.event-handler.composite-events"))


    -- using the name of a composite event is also valid for a filter, it will apply to every included event.
    handler.add_filter("on_built",{
        filter="name",
        name="orbital-cannon"
    })
   --in your handler code
   local lib = {
        composite_events = {
            on_built= function(event) end,
            on_removed= function(event) end
        }
    }
    return lib