rearrange things so that when EntityItem::setActionData is called before the entity-tree is set up, the data is set aside and used once the entity-tree is ready.

assignment-client/src/AssignmentActionFactory.cpp

@@ -26,11 +26,10 @@ EntityActionPointer AssignmentActionFactory::factory(EntitySimulation* simulatio
     if (action) {
         bool ok = action->updateArguments(arguments);
         if (ok) {
-            ownerEntity->addAction(simulation, action);
             return action;
         }
     }
-    return action;
+    return nullptr;
 }
 
 
@@ -46,7 +45,8 @@ EntityActionPointer AssignmentActionFactory::factoryBA(EntitySimulation* simulat
 
     EntityActionPointer action = assignmentActionFactory(type, id, ownerEntity);
 
-    action->deserialize(data);
+    if (action) {
-    ownerEntity->addAction(simulation, action);
+        action->deserialize(data);
+    }
     return action;
 }

examples/stick.js

@@ -42,6 +42,9 @@ function makeNewStick() {
         actionID = Entities.addAction("hold", stickID, {relativePosition: {x: 0.0, y: 0.0, z: -0.9},
                                                         hand: hand,
                                                         timeScale: 0.15});
+        if (actionID == nullActionID) {
+            cleanUp();
+        }
         makingNewStick = false;
     }, 3000);
 }

interface/src/InterfaceActionFactory.cpp

@@ -44,11 +44,10 @@ EntityActionPointer InterfaceActionFactory::factory(EntitySimulation* simulation
     if (action) {
         bool ok = action->updateArguments(arguments);
         if (ok) {
-            ownerEntity->addAction(simulation, action);
             return action;
         }
     }
-    return action;
+    return nullptr;
 }
 
 
@@ -64,7 +63,8 @@ EntityActionPointer InterfaceActionFactory::factoryBA(EntitySimulation* simulati
 
     EntityActionPointer action = interfaceActionFactory(type, id, ownerEntity);
 
-    action->deserialize(data);
+    if (action) {
-    ownerEntity->addAction(simulation, action);
+        action->deserialize(data);
+    }
     return action;
 }

libraries/entities/src/EntityItem.cpp

@@ -1404,20 +1404,26 @@ void EntityItem::updateSimulatorID(const QUuid& value) {
 
 void EntityItem::clearSimulationOwnership() {
     _simulationOwner.clear();
-    // don't bother setting the DIRTY_SIMULATOR_ID flag because clearSimulationOwnership() 
+    // don't bother setting the DIRTY_SIMULATOR_ID flag because clearSimulationOwnership()
     // is only ever called entity-server-side and the flags are only used client-side
     //_dirtyFlags |= EntityItem::DIRTY_SIMULATOR_ID;
 
 }
 
 bool EntityItem::addAction(EntitySimulation* simulation, EntityActionPointer action) {
-    if (!_serializedActionsProcessed) {
+    checkWaitingToRemove(simulation);
-        setActionData(_serializedActions);
+    if (!checkWaitingActionData(simulation)) {
-        if (!_serializedActionsProcessed) {
+        return false;
-            return false;
-        }
     }
 
+    bool result = addActionInternal(simulation, action);
+    if (!result) {
+        removeAction(simulation, action->getID());
+    }
+    return result;
+}
+
+bool EntityItem::addActionInternal(EntitySimulation* simulation, EntityActionPointer action) {
     assert(action);
     assert(simulation);
     auto actionOwnerEntity = action->getOwnerEntity().lock();
@@ -1427,21 +1433,20 @@ bool EntityItem::addAction(EntitySimulation* simulation, EntityActionPointer act
     const QUuid& actionID = action->getID();
     assert(!_objectActions.contains(actionID) || _objectActions[actionID] == action);
     _objectActions[actionID] = action;
-
     simulation->addAction(action);
-    bool success = serializeActions();
+
-    if (!success) {
+    bool success;
-        removeAction(simulation, actionID);
+    QByteArray newDataCache = serializeActions(success);
+    if (success) {
+        _allActionsDataCache = newDataCache;
     }
     return success;
 }
 
 bool EntityItem::updateAction(EntitySimulation* simulation, const QUuid& actionID, const QVariantMap& arguments) {
-    if (!_serializedActionsProcessed) {
+    checkWaitingToRemove(simulation);
-        setActionData(_serializedActions);
+    if (!checkWaitingActionData(simulation)) {
-        if (!_serializedActionsProcessed) {
+        return false;
-            return false;
-        }
     }
 
     if (!_objectActions.contains(actionID)) {
@@ -1449,31 +1454,49 @@ bool EntityItem::updateAction(EntitySimulation* simulation, const QUuid& actionI
     }
     EntityActionPointer action = _objectActions[actionID];
     bool success = action->updateArguments(arguments);
+
     if (success) {
-        success = serializeActions();
+        _allActionsDataCache = serializeActions(success);
+    } else {
+        qDebug() << "EntityItem::updateAction failed";
     }
+
     return success;
 }
 
 bool EntityItem::removeAction(EntitySimulation* simulation, const QUuid& actionID) {
-    if (!_serializedActionsProcessed) {
+    checkWaitingToRemove(simulation);
-        setActionData(_serializedActions);
+    if (!checkWaitingActionData(simulation)) {
-        if (!_serializedActionsProcessed) {
+        return false;;
-            return false;
-        }
     }
 
+    return removeActionInternal(actionID);
+}
+
+bool EntityItem::removeActionInternal(const QUuid& actionID, EntitySimulation* simulation) {
     if (_objectActions.contains(actionID)) {
+        if (!simulation) {
+            EntityTree* entityTree = _element ? _element->getTree() : nullptr;
+            simulation = entityTree ? entityTree->getSimulation() : nullptr;
+        }
+
         EntityActionPointer action = _objectActions[actionID];
-        _objectActions.remove(actionID);
         action->setOwnerEntity(nullptr);
-        action->removeFromSimulation(simulation);
+        _objectActions.remove(actionID);
-        return serializeActions();
+
+        if (simulation) {
+            action->removeFromSimulation(simulation);
+        }
+
+        bool success = true;
+        _allActionsDataCache = serializeActions(success);
+        return success;
     }
     return false;
 }
 
 bool EntityItem::clearActions(EntitySimulation* simulation) {
+    _waitingActionData.clear();
     QHash<QUuid, EntityActionPointer>::iterator i = _objectActions.begin();
     while (i != _objectActions.end()) {
         const QUuid id = i.key();
@@ -1482,83 +1505,112 @@ bool EntityItem::clearActions(EntitySimulation* simulation) {
         action->setOwnerEntity(nullptr);
         action->removeFromSimulation(simulation);
     }
-    // empty _serializedActions means no actions for the EntityItem
+    _actionsToRemove.clear();
-    _serializedActions = QByteArray();
+    _allActionsDataCache.clear();
     return true;
 }
 
-void EntityItem::setActionData(QByteArray actionData) {
+bool EntityItem::deserializeActions(QByteArray allActionsData, EntitySimulation* simulation) const {
-    // it would be nice to take this shortcut, but a previous add may have failed
+    bool success = true;
-    // if (_serializedActions == actionData) {
-    //     return;
-    // }
-    _serializedActions = actionData;
-
     QVector<QByteArray> serializedActions;
-    if (_serializedActions.size() > 0) {
+    if (allActionsData.size() > 0) {
-        QDataStream serializedActionsStream(actionData);
+        QDataStream serializedActionsStream(allActionsData);
         serializedActionsStream >> serializedActions;
     }
 
     // Keep track of which actions got added or updated by the new actionData
     QSet<QUuid> updated;
 
-    _serializedActionsProcessed = true;
+    EntityTree* entityTree = _element ? _element->getTree() : nullptr;
-    foreach(QByteArray serializedAction, serializedActions) {
+    if (!simulation) {
-        QDataStream serializedActionStream(serializedAction);
+        simulation = entityTree ? entityTree->getSimulation() : nullptr;
-        EntityActionType actionType;
-        QUuid actionID;
-        serializedActionStream >> actionType;
-        serializedActionStream >> actionID;
-        updated << actionID;
-
-        if (_objectActions.contains(actionID)) {
-            EntityActionPointer action = _objectActions[actionID];
-            // TODO: make sure types match?  there isn't currently a way to
-            // change the type of an existing action.
-            action->deserialize(serializedAction);
-        } else {
-            auto actionFactory = DependencyManager::get<EntityActionFactoryInterface>();
-
-            EntityTree* entityTree = _element ? _element->getTree() : nullptr;
-            EntitySimulation* simulation = entityTree ? entityTree->getSimulation() : nullptr;
-            if (simulation) {
-                EntityItemPointer entity = entityTree->findEntityByEntityItemID(_id);
-                actionFactory->factoryBA(simulation, entity, serializedAction);
-            } else {
-                // we can't yet add the action.  This method will be called later.
-                _serializedActionsProcessed = false;
-            }
-        }
     }
 
-    // remove any actions that weren't included in the new data.
+    if (simulation && entityTree) {
-    EntityTree* entityTree = _element ? _element->getTree() : nullptr;
+        foreach(QByteArray serializedAction, serializedActions) {
-    EntitySimulation* simulation = entityTree ? entityTree->getSimulation() : nullptr;
+            QDataStream serializedActionStream(serializedAction);
-    if (simulation) {
+            EntityActionType actionType;
-        QHash<QUuid, EntityActionPointer>::iterator i = _objectActions.begin();
+            QUuid actionID;
+            serializedActionStream >> actionType;
+            serializedActionStream >> actionID;
+            updated << actionID;
+
+            if (_objectActions.contains(actionID)) {
+                EntityActionPointer action = _objectActions[actionID];
+                // TODO: make sure types match?  there isn't currently a way to
+                // change the type of an existing action.
+                action->deserialize(serializedAction);
+            } else {
+                auto actionFactory = DependencyManager::get<EntityActionFactoryInterface>();
+                if (simulation) {
+                    EntityItemPointer entity = entityTree->findEntityByEntityItemID(_id);
+                    EntityActionPointer action = actionFactory->factoryBA(simulation, entity, serializedAction);
+                    if (action) {
+                        entity->addActionInternal(simulation, action);
+                    }
+                } else {
+                    // we can't yet add the action.  This method will be called later.
+                    qDebug() << "\nCANT ADD ACTION YET";
+                    success = false;
+                }
+            }
+        }
+
+        // remove any actions that weren't included in the new data.
+        QHash<QUuid, EntityActionPointer>::const_iterator i = _objectActions.begin();
         while (i != _objectActions.end()) {
             const QUuid id = i.key();
-            if (updated.contains(id)) {
+            if (!updated.contains(id)) {
-                i++;
+                _actionsToRemove << id;
-                continue;
             }
-            EntityActionPointer action = _objectActions[id];
+            i++;
-            i = _objectActions.erase(i);
-            action->setOwnerEntity(nullptr);
-            action->removeFromSimulation(simulation);
         }
+    } else {
+        // no simulation
+        success = false;
+    }
+
+    return success;
+}
+
+bool EntityItem::checkWaitingActionData(EntitySimulation* simulation) const {
+    if (_waitingActionData.size() == 0) {
+        return true;
+    }
+    bool success = deserializeActions(_waitingActionData, simulation);
+    if (success) {
+        _waitingActionData.clear();
+    }
+    return success;
+}
+
+void EntityItem::checkWaitingToRemove(EntitySimulation* simulation) {
+    foreach(QUuid actionID, _actionsToRemove) {
+        removeActionInternal(actionID, simulation);
+    }
+    _actionsToRemove.clear();
+}
+
+void EntityItem::setActionData(QByteArray actionData) {
+    checkWaitingToRemove();
+    bool success = deserializeActions(actionData);
+    _allActionsDataCache = actionData;
+    if (success) {
+        _waitingActionData.clear();
+    } else {
+        _waitingActionData = actionData;
     }
 }
 
-bool EntityItem::serializeActions() const {
+QByteArray EntityItem::serializeActions(bool& success) const {
-    if (!_serializedActionsProcessed) {
+    QByteArray result;
-        return false;
+    if (!checkWaitingActionData()) {
+        return _waitingActionData;
     }
 
     if (_objectActions.size() == 0) {
-        _serializedActions = QByteArray();
+        success = true;
-        return true;
+        return QByteArray();
     }
 
     QVector<QByteArray> serializedActions;
@@ -1571,31 +1623,27 @@ bool EntityItem::serializeActions() const {
         i++;
     }
 
-    QByteArray result;
     QDataStream serializedActionsStream(&result, QIODevice::WriteOnly);
     serializedActionsStream << serializedActions;
 
     if (result.size() >= _maxActionsDataSize) {
-        return false;
+        success = false;
+        return result;
     }
 
-    _serializedActions = result;
+    success = true;
-    return true;
+    return result;
 }
 
 const QByteArray EntityItem::getActionData() const {
-    serializeActions();
+    return _allActionsDataCache;
-    return _serializedActions;
 }
 
-QVariantMap EntityItem::getActionArguments(const QUuid& actionID) {
+QVariantMap EntityItem::getActionArguments(const QUuid& actionID) const {
     QVariantMap result;
 
-    if (!_serializedActionsProcessed) {
+    if (!checkWaitingActionData()) {
-        setActionData(_serializedActions);
+        return result;
-        if (!_serializedActionsProcessed) {
-            return result;
-        }
     }
 
     if (_objectActions.contains(actionID)) {

libraries/entities/src/EntityItem.h

@@ -394,7 +394,7 @@ public:
     const QByteArray getActionData() const;
     bool hasActions() { return !_objectActions.empty(); }
     QList<QUuid> getActionIDs() { return _objectActions.keys(); }
-    QVariantMap getActionArguments(const QUuid& actionID);
+    QVariantMap getActionArguments(const QUuid& actionID) const;
 
 protected:
 
@@ -468,14 +468,20 @@ protected:
     void* _physicsInfo = nullptr; // set by EntitySimulation
     bool _simulated; // set by EntitySimulation
 
-    bool serializeActions() const;
+    bool addActionInternal(EntitySimulation* simulation, EntityActionPointer action);
+    bool removeActionInternal(const QUuid& actionID, EntitySimulation* simulation = nullptr);
+    bool deserializeActions(QByteArray allActionsData, EntitySimulation* simulation = nullptr) const;
+    QByteArray serializeActions(bool& success) const;
     QHash<QUuid, EntityActionPointer> _objectActions;
     static int _maxActionsDataSize;
-    mutable QByteArray _serializedActions;
+    mutable QByteArray _allActionsDataCache;
     // when an entity-server starts up, EntityItem::setActionData is called before the entity-tree is
-    // ready.  This means we can't find our EntityItemPointer or add the action to the simulation.  This
+    // ready.  This means we can't find our EntityItemPointer or add the action to the simulation.  These
-    // flag is used to keep track of and work around this situation.
+    // are used to keep track of and work around this situation.
-    bool _serializedActionsProcessed = false;
+    bool checkWaitingActionData(EntitySimulation* simulation = nullptr) const;
+    void checkWaitingToRemove(EntitySimulation* simulation = nullptr);
+    mutable QByteArray _waitingActionData;
+    mutable QSet<QUuid> _actionsToRemove;
 };
 
 #endif // hifi_EntityItem_h

libraries/entities/src/EntityScriptingInterface.cpp

@@ -574,7 +574,9 @@ QUuid EntityScriptingInterface::addAction(const QString& actionTypeString,
             if (actionType == ACTION_TYPE_NONE) {
                 return false;
             }
-            if (actionFactory->factory(simulation, actionType, actionID, entity, arguments)) {
+            EntityActionPointer action = actionFactory->factory(simulation, actionType, actionID, entity, arguments);
+            if (action) {
+                entity->addAction(simulation, action);
                 auto nodeList = DependencyManager::get<NodeList>();
                 const QUuid myNodeID = nodeList->getSessionUUID();
                 if (entity->getSimulatorID() != myNodeID) {