Pigeon - easy and safe messaging for Defold

The Defoldmine
21

I copy and edited and everything works great,
Thanks a lot for the help! :smiley:

1 Like
22

Pigeon has been updated to 1.2 :wink:

Release is added on Github, current link to add to game.project dependency:

https://github.com/paweljarosz/pigeon/archive/refs/tags/v1.2.zip

Quick Reference:

local insality_log = require "log.log"
pigeon.set_dependency_module_log(insality_log.get_logger("pigeon"))
6 Likes
23

Well done! :smiley:

1 Like
24

Pigeon has been updated to 1.3 :dove:

  • Added possibility to define multiple types in message definition using | as separator, e.g. string|number|nil. Example script extended with this usage. Change is not breaking and all legacy tests are passing. Quick Reference:
pigeon.define("test", { test_value = "string|number|nil" }) -- define message with one test_value being string, number or nil
pigeon.send("test", {test_value = 1 }) -- we can then send a message with number
pigeon.send("test", {test_value = "test" }) -- or string
pigeon.send("test", {test_value = nil }) -- or nil
pigeon.send("test". {}) -- and because the only defined key here can be nil, so we as well can pass empty table
pigeon.send("test") -- or nothing at all

  • Added Lua annotations to all functions in Pigeon!

  • Improved documentation.

  • Working with Defold 1.9.4 (library is pretty much version agnostic though unless msg API changes)

Release is added on Github as 1.3, current link to add to game.project dependency:

https://github.com/paweljarosz/pigeon/archive/refs/tags/v1.3.zip

11 Likes
25

Pigeon has been updated to 1.4 :dove:

This release is pretty huge, but it maintains a backward compatibility with 1.3. If anything is broken in your project after updating to 1.4, please let me know or write an issue on github repository. I closed the issues and updated it basing on the feedback from users, special thanks for @Bomborant for reporting. Code has been refactored and modularized and everything has proper Lua annotations.

Changelog:

  • NEW: Added optional context support for hooks in pigeon.subscribe().

The context is the subscriber’s data (e.g. self) passed at subscribe-time and stored with the subscription. When any script calls pigeon.send(), the hook fires immediately with the subscriber’s context — not the sender’s. This allows safe access to instance-specific data inside hooks.


-- Script B subscribes with its own self as context:
local function my_hook(message_id, message, ctx)
    go.set_position(ctx.my_id, message.new_pos)
end

pigeon.subscribe("move", my_hook, nil, self)

-- Script A sends a message and script B's hook fires immediately with B's self as context:
pigeon.send("move", { new_pos = vmath.vector3(100, 200, 0) } )

  • NEW: Added pigeon.extend_subscription(id, messages) — add new message ids to an existing subscription without creating a new one.

  • NEW: Added pigeon.reduce_subscription(id, messages) — remove specific message ids from an existing subscription. If all messages are removed, the subscription is automatically unsubscribed.

  • NEW: Added pigeon.new(handlers, tag?) — create a convenience handler instance that auto-subscribes to all message ids from the handlers table and dispatches them via on_message. Call handler:final() to clean up.

  • NEW: Added pigeon.define_batch(letters_table, is_overwriting?) — define multiple message schemas at once from a table of letter definitions.

  • NEW: pigeon.unsubscribe() now accepts a table of subscriber ids to unsubscribe multiple subscriptions at once.

  • FIX: Built-in Defold message ids (for example load, unload, enable) are protected from accidental redefinition (always blocked). This fixes issues, when users could accidentally overwrite internally used message_ids.

  • DEPRECATED: pigeon.set_dependency_module_hashed() is now a deprecated and if you call it it’s no-op. Pigeon always uses the internal hashed module.

  • UPDATE: Refactored internals (separate implementation pigeon_impl.lua, new separate module for checking types: pigeon.typer).

  • UPDATE: Added or expanded Lua annotations directly in pigeon/pigeon.lua and added pigeon/typer.lua as a dedicated runtime type checking module.

  • UPDATE: Added tests to cover new functionalities.

  • Version 1.4 should be backward compatible with 1.3, as all API functions remained unchanged, only new, safer behaviour is added via using trailing optional parameters in calls, while keeping default as in the previou version. Deprecated function (set_dependency_module_hashed) is still kept for backward compatibility.

11 Likes