agulev / jstodef

Library for sending messages from JavaScript to Defold (Lua)

JsToDef

This is Native Extension for the Defold Game Engine that makes possible to send messages from JavaScript to Lua in HTML5 build.

Installation

To use this library in your Defold project, add the needed version URL to your game.project dependencies from Releases

API JavaScript side

JsToDef.send(message_id, message)

Where message_id is a string that helps you to identify this message on Lua side.

message is a custom value that might be one of the next types: object, number, boolean, string, undefined(if you don't need any extra data).

Example:

JsToDef.send("MyCustomMessageName", "custom message");
JsToDef.send("ObjectEvent", {foo:"bar", num:16, isAv:true});
JsToDef.send("FloatEvent", 19.2);
JsToDef.send("IntEvent", 18);
JsToDef.send("StrintEvent", "custom string");
JsToDef.send("EmptyEvent");
JsToDef.send("BooleanEvent", true);
JsToDef.send("BooleanEvent", false);

API Lua side

If you are working on cross-platform application the best practice to check the existence of jstodef module, this module exists only in html5 build:

if jstodef then
  -- any operations with jstodef
end

Add Listener

jstodef.add_listener(listener)

Where listener is a function with the next parameters:

self is the current script self.

message_id is a string that helps you to identify this message.

message is a custom value that might be one of the next types: table, number, boolean, string, nil.

It is possible to add a few listeners.

Example:

local function js_listener(self, message_id, message)
  if message_id == "MyCustomMessageName" then
    -- do something
  end
end

function init(self)
  if jstodef then
    jstodef.add_listener(js_listener)
  end
end

Remove Listener

jstodef.remove_listener(listener)

Where listener is the function that was previously added as a listener with jstodef.add_listener() method.

function final(self)
  if jstodef then
    jstodef.remove_listener(js_listener)
  end
end

Issues and suggestions

If you have any issues, questions or suggestions please create an issue or contact me: [email protected]

jstodef's Issues

Might be good candidate to use for implementing gamepads for HTML5 targets

/jstodef/src/jstodef.cpp Line 82: too few arguments to function call, expected 5, have 3

just add to dependencies
fetch library
and build html5

log.zip

p/s defold 1.3.7

please help

Callbacks both ways useful?

I feel like this supporting sending messages / doing callbacks going both ways out of the box would be useful.

Is there a complete working example?

Hello,

I am work some with the Defold engine and wanted to know if there was a complete simple working example using this library?

.script_api support for auto-complete

https://forum.defold.com/t/attention-extension-creators/59718

https://www.defold.com/manuals/extensions-script-api/

Defold 1.2.178 dynCall error

Hi @AGulev I am getting this error:
Uncaught ReferenceError: dynCall is not defined

It only started after upgrading to the latest 1.2.178 Defold version. Probably related to the Emscripten update?

How can this be fixed?

Thanks!