diff --git a/examples/entityScripts/createParamsEntity.js b/examples/entityScripts/createParamsEntity.js new file mode 100644 index 0000000000..991bb0d667 --- /dev/null +++ b/examples/entityScripts/createParamsEntity.js @@ -0,0 +1,42 @@ +// +// createParamsEntity.js +// +// Created by James B. Pollack @imgntn on 11/6/2015 +// Copyright 2015 High Fidelity, Inc. +// +// This script demonstrates creating an entity and sending it a method call with parameters. +// +// Distributed under the Apache License, Version 2.0. +// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html +// + +var PARAMS_SCRIPT_URL = Script.resolvePath('paramsEntity.js'); + +var testEntity = Entities.addEntity({ + name: 'paramsTestEntity', + dimensions: { + x: 1, + y: 1, + z: 1 + }, + type: 'Box', + position: { + x: 0, + y: 0, + z: 0 + }, + visible: false, + script: PARAMS_SCRIPT_URL +}); + + +var subData1 = ['apple', 'banana', 'orange']; +var subData2 = { + thing: 1, + otherThing: 2 +}; +var data = [subData1, JSON.stringify(subData2), 'third']; +Script.setTimeout(function() { + print('sending data to entity') + Entities.callEntityMethod(testEntity, 'testParams', data); +}, 1500) \ No newline at end of file diff --git a/examples/entityScripts/paramsEntity.js b/examples/entityScripts/paramsEntity.js new file mode 100644 index 0000000000..6cb5cb5833 --- /dev/null +++ b/examples/entityScripts/paramsEntity.js @@ -0,0 +1,45 @@ +// +// paramsEntity.js +// +// Script Type: Entity +// +// Created by James B. Pollack @imgntn on 11/6/2015 +// Copyright 2015 High Fidelity, Inc. +// +// This script demonstrates how to recieve parameters from a Entities.callEntityMethod call +// Distributed under the Apache License, Version 2.0. +// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html +// +(function() { + + function ParamsEntity() { + return; + } + + ParamsEntity.prototype = { + preload: function(entityID) { + print('entity loaded') + this.entityID = entityID; + }, + testParams: function(myID, paramsArray) { + + paramsArray.forEach(function(param) { + var p; + try { + p = JSON.parse(param); + print("it's a json param") + print('json param property:' + p.thing); + } catch (err) { + print('not a json param') + p = param; + print('param is:' + p); + } + + }); + + } + + } + + return new ParamsEntity(); +}); \ No newline at end of file diff --git a/libraries/entities/src/EntitiesScriptEngineProvider.h b/libraries/entities/src/EntitiesScriptEngineProvider.h index d112a6c0f9..69bf73e688 100644 --- a/libraries/entities/src/EntitiesScriptEngineProvider.h +++ b/libraries/entities/src/EntitiesScriptEngineProvider.h @@ -19,7 +19,7 @@ class EntitiesScriptEngineProvider { public: - virtual void callEntityScriptMethod(const EntityItemID& entityID, const QString& methodName) = 0; + virtual void callEntityScriptMethod(const EntityItemID& entityID, const QString& methodName, const QStringList& params = QStringList()) = 0; }; #endif // hifi_EntitiesScriptEngineProvider_h \ No newline at end of file diff --git a/libraries/entities/src/EntityScriptingInterface.cpp b/libraries/entities/src/EntityScriptingInterface.cpp index 01d46e0a91..8ca0e9b5fa 100644 --- a/libraries/entities/src/EntityScriptingInterface.cpp +++ b/libraries/entities/src/EntityScriptingInterface.cpp @@ -217,14 +217,13 @@ void EntityScriptingInterface::deleteEntity(QUuid id) { } } -void EntityScriptingInterface::callEntityMethod(QUuid id, const QString& method) { +void EntityScriptingInterface::callEntityMethod(QUuid id, const QString& method, const QStringList& params) { if (_entitiesScriptEngine) { EntityItemID entityID{ id }; - _entitiesScriptEngine->callEntityScriptMethod(entityID, method); + _entitiesScriptEngine->callEntityScriptMethod(entityID, method, params); } } - QUuid EntityScriptingInterface::findClosestEntity(const glm::vec3& center, float radius) const { EntityItemID result; if (_entityTree) { diff --git a/libraries/entities/src/EntityScriptingInterface.h b/libraries/entities/src/EntityScriptingInterface.h index 156f16cf46..8a4414a596 100644 --- a/libraries/entities/src/EntityScriptingInterface.h +++ b/libraries/entities/src/EntityScriptingInterface.h @@ -15,6 +15,7 @@ #define hifi_EntityScriptingInterface_h #include +#include #include #include @@ -93,7 +94,7 @@ public slots: /// Allows a script to call a method on an entity's script. The method will execute in the entity script /// engine. If the entity does not have an entity script or the method does not exist, this call will have /// no effect. - Q_INVOKABLE void callEntityMethod(QUuid entityID, const QString& method); + Q_INVOKABLE void callEntityMethod(QUuid entityID, const QString& method, const QStringList& params = QStringList()); /// finds the closest model to the center point, within the radius /// will return a EntityItemID.isKnownID = false if no models are in the radius diff --git a/libraries/script-engine/src/ScriptEngine.cpp b/libraries/script-engine/src/ScriptEngine.cpp index 381eef63db..405815aa5b 100644 --- a/libraries/script-engine/src/ScriptEngine.cpp +++ b/libraries/script-engine/src/ScriptEngine.cpp @@ -18,6 +18,7 @@ #include #include #include +#include #include #include @@ -1170,8 +1171,7 @@ void ScriptEngine::refreshFileScript(const EntityItemID& entityID) { recurseGuard = false; } - -void ScriptEngine::callEntityScriptMethod(const EntityItemID& entityID, const QString& methodName) { +void ScriptEngine::callEntityScriptMethod(const EntityItemID& entityID, const QString& methodName, const QStringList& params) { if (QThread::currentThread() != thread()) { #ifdef THREAD_DEBUGGING qDebug() << "*** WARNING *** ScriptEngine::callEntityScriptMethod() called on wrong thread [" << QThread::currentThread() << "], invoking on correct thread [" << thread() << "] " @@ -1180,7 +1180,8 @@ void ScriptEngine::callEntityScriptMethod(const EntityItemID& entityID, const QS QMetaObject::invokeMethod(this, "callEntityScriptMethod", Q_ARG(const EntityItemID&, entityID), - Q_ARG(const QString&, methodName)); + Q_ARG(const QString&, methodName), + Q_ARG(const QStringList&, params)); return; } #ifdef THREAD_DEBUGGING @@ -1195,6 +1196,7 @@ void ScriptEngine::callEntityScriptMethod(const EntityItemID& entityID, const QS if (entityScript.property(methodName).isFunction()) { QScriptValueList args; args << entityID.toScriptValue(this); + args << qScriptValueFromSequence(this, params); entityScript.property(methodName).call(entityScript, args); } diff --git a/libraries/script-engine/src/ScriptEngine.h b/libraries/script-engine/src/ScriptEngine.h index 43fbdc1b0e..c957b0c3b4 100644 --- a/libraries/script-engine/src/ScriptEngine.h +++ b/libraries/script-engine/src/ScriptEngine.h @@ -19,6 +19,7 @@ #include #include #include +#include #include #include @@ -115,7 +116,7 @@ public: Q_INVOKABLE void loadEntityScript(const EntityItemID& entityID, const QString& entityScript, bool forceRedownload = false); // will call the preload method once loaded Q_INVOKABLE void unloadEntityScript(const EntityItemID& entityID); // will call unload method Q_INVOKABLE void unloadAllEntityScripts(); - Q_INVOKABLE void callEntityScriptMethod(const EntityItemID& entityID, const QString& methodName); + Q_INVOKABLE void callEntityScriptMethod(const EntityItemID& entityID, const QString& methodName, const QStringList& params = QStringList()); Q_INVOKABLE void callEntityScriptMethod(const EntityItemID& entityID, const QString& methodName, const MouseEvent& event); Q_INVOKABLE void callEntityScriptMethod(const EntityItemID& entityID, const QString& methodName, const EntityItemID& otherID, const Collision& collision);