Function Script_Animate

engine/gameobject/src/gameobject/gameobject_script.cpp:1614–1733

animates a named property of the specified game object or component * * This is only supported for numerical properties. If the node property is already being * animated, that animation will be canceled and replaced by the new one. * * If a `complete_function` (lua function) is specified, that function will be called when the animation has completed. * By starting a n

     * ```
     */
    int Script_Animate(lua_State* L)
    {
        int top = lua_gettop(L);
        (void)top;

        DM_HASH_REVERSE_MEM(hash_ctx, 256);
        ScriptInstance* i = ScriptInstance_Check(L);
        Instance* instance = i->m_Instance;
        dmMessage::URL sender;
        dmScript::GetURL(L, &sender);
        dmMessage::URL target;
        dmScript::ResolveURL(L, 1, &target, &sender);
        HCollection collection = dmGameObject::GetCollection(instance);
        if (target.m_Socket != dmGameObject::GetMessageSocket(collection))
        {
            luaL_error(L, "go.animate can only animate instances within the same collection.");
        }
        dmhash_t property_id = 0;
        if (lua_isstring(L, 2))
        {
            property_id = dmHashString64(lua_tostring(L, 2));
        }
        else
        {
            property_id = dmScript::CheckHash(L, 2);
        }
        dmGameObject::HInstance target_instance = dmGameObject::GetInstanceFromIdentifier(collection, target.m_Path);
        if (target_instance == 0)
            return luaL_error(L, "Could not find any instance with id '%s'.", dmHashReverseSafe64Alloc(&hash_ctx, target.m_Path));
        lua_Integer playback = luaL_checkinteger(L, 3);
        if (playback >= PLAYBACK_COUNT)
            return luaL_error(L, "invalid playback mode when starting an animation");
        dmGameObject::PropertyVar property_var;
        dmGameObject::PropertyResult result = dmGameObject::LuaToVar(L, 4, property_var);
        if (result != PROPERTY_RESULT_OK)
        {
            return luaL_error(L, "only numerical values can be used as target values for animation");
        }

        dmEasing::Curve curve;
        if (lua_isnumber(L, 5))
        {
            curve.type = (dmEasing::Type)luaL_checkinteger(L, 5);
            if (curve.type >= dmEasing::TYPE_COUNT)
                return luaL_error(L, "invalid easing constant");
        }
        else if (dmScript::IsVector(L, 5))
        {
            curve.type = dmEasing::TYPE_FLOAT_VECTOR;
            curve.vector = dmScript::CheckVector(L, 5);

            lua_pushvalue(L, 5);
            curve.release_callback = LuaCurveRelease;
            curve.userdata1 = L;
            curve.userdata2 = (void*)(uintptr_t)dmScript::Ref(L, LUA_REGISTRYINDEX);
        }
        else
        {